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

Backends

All operations require authentication.

5 operationsv1/sslGateway/{serviceName}
OpenAPI
Agent setup

List serversBeta

GET
/1.0/sslGateway/{serviceName}/server

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}/server \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  0]

Add a serverBeta

POST
/1.0/sslGateway/{serviceName}/server

Path parameters

serviceName
required
string

The internal name of your SSL Gateway

Request body (required)

address
required
ip

IPv4 address of your server

port
required
integer

Port of your server

Response

200Serversuccessful operation
address
ip

IP address of the server attached to your SSL Gateway

id
read-only
integer

Id of your server

port
integer

Port of your server attached to your SSL Gateway

state
read-only
ServerStateEnum

Server state

Valuescreatingdeleteddeletinginternalokupdating

Example uses serviceName = string

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

Get a serverBeta

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

Path parameters

id
required
integer

Id of your server

serviceName
required
string

The internal name of your SSL Gateway

Response

200Serversuccessful operation
address
ip

IP address of the server attached to your SSL Gateway

id
read-only
integer

Id of your server

port
integer

Port of your server attached to your SSL Gateway

state
read-only
ServerStateEnum

Server state

Valuescreatingdeleteddeletinginternalokupdating

Example uses id = 0, serviceName = string

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

Remove a serverBeta

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

Path parameters

id
required
integer

Id of your server

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}/server/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a serverBeta

PUT
/1.0/sslGateway/{serviceName}/server/{id}

Path parameters

id
required
integer

Id of your server

serviceName
required
string

The internal name of your SSL Gateway

Request body (required)

address
ip

IP address of the server attached to your SSL Gateway

id
read-only
integer

Id of your server

port
integer

Port of your server attached to your SSL Gateway

state
read-only
ServerStateEnum

Server state

Valuescreatingdeleteddeletinginternalokupdating

Response

200—successful operation

Example uses id = 0, serviceName = string

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