renews

Creates, updates, deletes, gets or lists a renews resource.

Overview

Name	renews
Type	Resource
Id	ovh.service.renews

Fields

The following fields are returned by SELECT queries:

list

List possible renews for service

Name	Datatype	Description
renew_period	string (duration)	ISO8601 formatted renewal duration (wire: renewPeriod)
strategies	array	List possible strategies

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_id	include_options	List possible renews for this service (Beta version)
create	insert	service_id, duration, services		Create a renew order (Beta version)

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
service_id	string	Service Id (wire: serviceId)
include_options	boolean	Include service's option(s) (wire: includeOptions)

SELECT examples

list

List possible renews for this service (Beta version)

SELECT
renew_period,
strategies
FROM ovh.service.renews
WHERE service_id = '{{ service_id }}' -- required
AND include_options = '{{ include_options }}'
;

INSERT examples

create

Create a renew order (Beta version)

INSERT INTO ovh.service.renews (
dry_run,
duration,
services,
service_id
)
SELECT 
{{ dry_run }},
'{{ duration }}' /* required */,
'{{ services }}' /* required */,
'{{ service_id }}'
RETURNING
order_id,
date,
expiration_date,
password,
pdf_url,
price_with_tax,
price_without_tax,
retraction_date,
tax,
url
;

Manifest

# Description fields are for documentation purposes
- name: renews
props:
  - name: service_id
    value: "{{ service_id }}"
    description: Required parameter for the renews resource.
  - name: dry_run
    value: {{ dry_run }}
    description: |
      Indicates if renew order is generated
  - name: duration
    value: "{{ duration }}"
    description: |
      Renew duration
  - name: services
    value:
      - {{ services }}
    description: |
      List of services to renew