gateways

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

Overview

Name	gateways
Type	Resource
Id	ovh.ssl_gateway.gateways

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
display_name	string	Custom name of your SSL Gateway (wire: displayName)
service_name	string	The internal name of your SSL Gateway (wire: serviceName)
allowed_source	array	Restrict SSL Gateway access to these ip block. No restriction if null (wire: allowedSource)
hsts	boolean	Set to true to enable Strict-Transport-Security HTTP header
https_redirect	boolean	Set to true to enable https redirect (wire: httpsRedirect)
iam	object	IAM resource metadata
ipv_4	string (ipv4)	The IPv4 you need to put in the A field of your domain name (example: 192.0.2.0) (wire: ipv4)
ipv_6	string (ipv6)	The IPv6 you need to put in the AAAA field of your domain name (example: 2001:41d0:1:1994::1) (wire: ipv6)
metrics_token	string	The metrics token associated with your SSL Gateway (wire: metricsToken)
offer	string	Current offer for your SSL Gateway (advanced, enterprise, free, internal)
reverse	string	Custom reverse for your SSL Gateway
server_https	boolean	Set to true to contact backend servers over HTTPS (wire: serverHttps)
ssl_configuration	string	Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null. (intermediate, internal, modern) (wire: sslConfiguration)
state	string	Current state of your SSL Gateway (creating, deleted, deleting, http-only, internal, ok, suspended, upgrading)
zones	array	Zones of your SSL Gateway

list

Your SSL Gateway

Name	Datatype	Description
display_name	string	Custom name of your SSL Gateway (wire: displayName)
service_name	string	The internal name of your SSL Gateway (wire: serviceName)
allowed_source	array	Restrict SSL Gateway access to these ip block. No restriction if null (wire: allowedSource)
hsts	boolean	Set to true to enable Strict-Transport-Security HTTP header
https_redirect	boolean	Set to true to enable https redirect (wire: httpsRedirect)
iam	object	IAM resource metadata
ipv_4	string (ipv4)	The IPv4 you need to put in the A field of your domain name (example: 192.0.2.0) (wire: ipv4)
ipv_6	string (ipv6)	The IPv6 you need to put in the AAAA field of your domain name (example: 2001:41d0:1:1994::1) (wire: ipv6)
metrics_token	string	The metrics token associated with your SSL Gateway (wire: metricsToken)
offer	string	Current offer for your SSL Gateway (advanced, enterprise, free, internal)
reverse	string	Custom reverse for your SSL Gateway
server_https	boolean	Set to true to contact backend servers over HTTPS (wire: serverHttps)
ssl_configuration	string	Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null. (intermediate, internal, modern) (wire: sslConfiguration)
state	string	Current state of your SSL Gateway (creating, deleted, deleting, http-only, internal, ok, suspended, upgrading)
zones	array	Zones of your SSL Gateway

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get an SSL Gateway (Beta version)
list	select		iam_tags, x_pagination_mode	List SSL Gateways (Beta version)
update	update	service_name		Update an SSL Gateway (Beta version)
change_contact	exec	serviceName		Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service. (Beta version)
confirm_termination	exec	serviceName, token		Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given. (Beta version)
renew_certificate	exec	serviceName		Renew certificates (Beta version)
terminate	exec	serviceName		Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call. (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"}})
serviceName	string	The internal name of your SSL Gateway
service_name	string	The internal name of your SSL Gateway (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 an SSL Gateway (Beta version)

SELECT
display_name,
service_name,
allowed_source,
hsts,
https_redirect,
iam,
ipv_4,
ipv_6,
metrics_token,
offer,
reverse,
server_https,
ssl_configuration,
state,
zones
FROM ovh.ssl_gateway.gateways
WHERE service_name = '{{ service_name }}' -- required
;

list

List SSL Gateways (Beta version)

SELECT
display_name,
service_name,
allowed_source,
hsts,
https_redirect,
iam,
ipv_4,
ipv_6,
metrics_token,
offer,
reverse,
server_https,
ssl_configuration,
state,
zones
FROM ovh.ssl_gateway.gateways
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update an SSL Gateway (Beta version)

UPDATE ovh.ssl_gateway.gateways
SET 
allowed_source = '{{ allowed_source }}',
display_name = '{{ display_name }}',
hsts = {{ hsts }},
https_redirect = {{ https_redirect }},
reverse = '{{ reverse }}',
server_https = {{ server_https }},
ssl_configuration = '{{ ssl_configuration }}'
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service. (Beta version)

EXEC ovh.ssl_gateway.gateways.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

confirm_termination

Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given. (Beta version)

EXEC ovh.ssl_gateway.gateways.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

renew_certificate

Renew certificates (Beta version)

EXEC ovh.ssl_gateway.gateways.renew_certificate 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"domain": "{{ domain }}"
}'
;

terminate

Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call. (Beta version)

EXEC ovh.ssl_gateway.gateways.terminate 
@serviceName='{{ serviceName }}' --required
;