options

Creates, updates, deletes, gets or lists an options resource.

Overview

Name	options
Type	Resource
Id	ovh.domain.options

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
expiration_date	string (date-time)	Expiration date of the option (wire: expirationDate)
option	string	The option name (dnsAnycast)
state	string	The state of the option (released, subscribed)

list

Information about the options of a domain

Name	Datatype	Description
expiration_date	string (date-time)	Expiration date of the option (wire: expirationDate)
option	string	The option name (dnsAnycast)
state	string	The state of the option (released, subscribed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	option, service_name		Get details on this domain option
list	select	service_name	x_pagination_mode	List domain options
delete	delete	option, service_name		Remove a given option

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"}})
option	string	Option
service_name	string	Service name (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get details on this domain option

SELECT
expiration_date,
option,
state
FROM ovh.domain.options
WHERE option = '{{ option }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List domain options

SELECT
expiration_date,
option,
state
FROM ovh.domain.options
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Remove a given option

DELETE FROM ovh.domain.options
WHERE option = '{{ option }}' --required
AND service_name = '{{ service_name }}' --required
;