Skip to content
Console(the OVHcloud Console, opens in a new tab)

Domains

All operations require authentication.

5 operationsv1/sslGateway/{serviceName}
OpenAPI
Agent setup

List domainsBeta

GET
/1.0/sslGateway/{serviceName}/domain

Path parameters

serviceName
required
string

The internal name of your SSL Gateway

Response

200integer[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/sslGateway/{serviceName}/domain \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  0]

Attach a domainBeta

POST
/1.0/sslGateway/{serviceName}/domain

Path parameters

serviceName
required
string

The internal name of your SSL Gateway

Request body (required)

domain
required
string

Domain to attach

Response

200Domainsuccessful operation
domain
read-only
string

Domain name attached to your SSL Gateway

id
read-only
integer

Id of your domain

state
read-only
DomainStateEnum

Domain state

Valuescreatingdeleteddeletinghttp-onlyinternalok

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/sslGateway/{serviceName}/domain \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "domain": "string",  "id": 0,  "state": "creating"}

Get a domainBeta

GET
/1.0/sslGateway/{serviceName}/domain/{id}

Path parameters

id
required
integer

Id of your domain

serviceName
required
string

The internal name of your SSL Gateway

Response

200Domainsuccessful operation
domain
read-only
string

Domain name attached to your SSL Gateway

id
read-only
integer

Id of your domain

state
read-only
DomainStateEnum

Domain state

Valuescreatingdeleteddeletinghttp-onlyinternalok

Example uses id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/sslGateway/{serviceName}/domain/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "domain": "string",  "id": 0,  "state": "creating"}

Detach a domainBeta

DELETE
/1.0/sslGateway/{serviceName}/domain/{id}

Path parameters

id
required
integer

Id of your domain

serviceName
required
string

The internal name of your SSL Gateway

Response

200—successful operation

Example uses id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/sslGateway/{serviceName}/domain/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

Renew certificatesBeta

POST
/1.0/sslGateway/{serviceName}/renewCertificate

Path parameters

serviceName
required
string

The internal name of your SSL Gateway

Request body (required)

domain
string

Domain on which you want to renew certificate

Response

200string[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/sslGateway/{serviceName}/renewCertificate \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]