domains
Creates, updates, deletes, gets or lists a domains resource.
Overview​
| Name | domains |
| Type | Resource |
| Id | ovh.license_office.domains |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
domain_name | string | Domain name (wire: domainName) |
status | string | Domain status (ok, unverified) |
txt_entry | string | Domain status (wire: txtEntry) |
Office tenant
| Name | Datatype | Description |
|---|---|---|
domain_name | string | Domain name (wire: domainName) |
status | string | Domain status (ok, unverified) |
txt_entry | string | Domain status (wire: txtEntry) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain_name, service_name | Returns the status of the domain, ok or unverified, and the TXT record required to validate it. (Alpha version) | |
list | select | service_name | x_pagination_mode | Returns the names of the domains of the tenant. (Alpha 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"}}) |
domain_name | string | Domain name (wire: domainName) |
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
- list
Returns the status of the domain, ok or unverified, and the TXT record required to validate it. (Alpha version)
SELECT
domain_name,
status,
txt_entry
FROM ovh.license_office.domains
WHERE domain_name = '{{ domain_name }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the names of the domains of the tenant. (Alpha version)
SELECT
domain_name,
status,
txt_entry
FROM ovh.license_office.domains
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;