domains

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

Overview

Name	domains
Type	Resource
Id	ovh.ssl_gateway.domains

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of your domain
domain	string	Domain name attached to your SSL Gateway
state	string	Domain state (creating, deleted, deleting, http-only, internal, ok)

list

Domain attached to an SSL Gateway

Name	Datatype	Description
id	integer	Id of your domain
domain	string	Domain name attached to your SSL Gateway
state	string	Domain state (creating, deleted, deleting, http-only, internal, ok)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get a domain (Beta version)
list	select	service_name	x_pagination_mode	List domains (Beta version)
create	insert	service_name, domain		Attach a domain (Beta version)
delete	delete	id, service_name		Detach a domain (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"}})
id	integer	Id of your domain
service_name	string	The internal name of your SSL Gateway (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 a domain (Beta version)

SELECT
id,
domain,
state
FROM ovh.ssl_gateway.domains
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List domains (Beta version)

SELECT
id,
domain,
state
FROM ovh.ssl_gateway.domains
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Attach a domain (Beta version)

INSERT INTO ovh.ssl_gateway.domains (
domain,
service_name
)
SELECT 
'{{ domain }}' /* required */,
'{{ service_name }}'
RETURNING
id,
domain,
state
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the domains resource.
  - name: domain
    value: "{{ domain }}"
    description: |
      Domain to attach

DELETE examples

delete

Detach a domain (Beta version)

DELETE FROM ovh.ssl_gateway.domains
WHERE id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;