resource_website_domains

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

Overview

Name	resource_website_domains
Type	Resource
Id	ovh.webhosting.resource_website_domains

Fields

The following fields are returned by SELECT queries:

list

Webhosting Domain

Name	Datatype	Description
id	string	Unique identifier of the domain
checksum	string	Computed hash used to control concurrent modification requests. Here, it represents the current target specification value.
current_state	object	Current state of the domain (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the website's domain (wire: currentTasks)
resource_status	string	Webhosting Domain readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	name, website_id	x_pagination_cursor, x_pagination_size	Returns the domains linked to the website, with their path, CDN and firewall status. (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"}})
name	string	Name
website_id	string (uuid)	Website ID (wire: websiteId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the domains linked to the website, with their path, CDN and firewall status. (Beta version)

SELECT
id,
checksum,
current_state,
current_tasks,
resource_status
FROM ovh.webhosting.resource_website_domains
WHERE name = '{{ name }}' -- required
AND website_id = '{{ website_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;