certificates

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

Overview

Name	certificates
Type	Resource
Id	ovh.ssl.certificates

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
common_name	string	The CN field in your certificate (wire: commonName)
service_name	string	The internal name of your certificate offer (wire: serviceName)
subject_alt_name	array	The SAN field for multidomain certificate (wire: subjectAltName)
authority	string	The authority your certificate is issued from (comodo, sectigo)
certificate	string	Your certificate
chain	string	The issuer chain of your certificate
csr	string	The CSR used to create your certificate
iam	object	IAM resource metadata
status	string	Current status of your certificate (creating, error, ok, validating)
type	string	Type of your certificate (DV, EV, OV)
validity_end	string (date-time)	Your certificate is invalid from this date (wire: validityEnd)
validity_start	string (date-time)	Your certificate is valid from this date (wire: validityStart)

list

Certificate of an SSL customer

Name	Datatype	Description
common_name	string	The CN field in your certificate (wire: commonName)
service_name	string	The internal name of your certificate offer (wire: serviceName)
subject_alt_name	array	The SAN field for multidomain certificate (wire: subjectAltName)
authority	string	The authority your certificate is issued from (comodo, sectigo)
certificate	string	Your certificate
chain	string	The issuer chain of your certificate
csr	string	The CSR used to create your certificate
iam	object	IAM resource metadata
status	string	Current status of your certificate (creating, error, ok, validating)
type	string	Type of your certificate (DV, EV, OV)
validity_end	string (date-time)	Your certificate is invalid from this date (wire: validityEnd)
validity_start	string (date-time)	Your certificate is valid from this date (wire: validityStart)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns an SSL certificate: status, type (DV, OV or EV), issuing authority, common name, alternative names, validity dates, and the certificate and its issuer chain once issued.
list	select		iam_tags, x_pagination_mode	Returns the identifiers of the SSL certificates of the account.

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"}})
service_name	string	Service name (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

Returns an SSL certificate: status, type (DV, OV or EV), issuing authority, common name, alternative names, validity dates, and the certificate and its issuer chain once issued.

SELECT
common_name,
service_name,
subject_alt_name,
authority,
certificate,
chain,
csr,
iam,
status,
type,
validity_end,
validity_start
FROM ovh.ssl.certificates
WHERE service_name = '{{ service_name }}' -- required
;

list

Returns the identifiers of the SSL certificates of the account.

SELECT
common_name,
service_name,
subject_alt_name,
authority,
certificate,
chain,
csr,
iam,
status,
type,
validity_end,
validity_start
FROM ovh.ssl.certificates
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;