Skip to content

Firewall

All operations require authentication.

12 operationsv1/xdsl/{serviceName}
Agent setup

List the port mappings of the modemProduction

GET
/1.0/xdsl/{serviceName}/modem/portMappings

Returns the names of the port mapping rules of the modem of the access.

Path parameters

serviceName
required
string

Service name

Response

200string[]successful operation

Example uses serviceName = string

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

Create a port mapping on the modemProduction

POST
/1.0/xdsl/{serviceName}/modem/portMappings

Adds a rule that forwards an external port range to a port of an internal client, optionally restricted to one remote IP. Returns the created rule.

Path parameters

serviceName
required
string

Service name

Request body (required)

allowedRemoteIp
ipv4

IPv4 address (e.g., 192.0.2.0)

description
string

Description of the Port Mapping

externalPortEnd
integer

The last port of the interval on the External Client that will get the connections

externalPortStart
required
integer

External Port that the modem will listen on

internalClient
required
ip

IP address (e.g., 192.0.2.0)

internalPort
required
integer

The port on the Internal Client that will get the connections

internalPortEnd
integer

The last port of the interval on the Internal Client that will get the connections

name
required
string

Name of the port mapping entry

protocol
required
ProtocolTypeEnum

Type of protocol for the Port Mapping

ValuesTCPUDP

Response

200PortMappingsuccessful operation
allowedRemoteIp
ipv4

An ip which will access to the defined rule. Default : no restriction applied

description
string

Description of the Port Mapping

externalPortEnd
integer

The last port of the interval on the External Client that will get the connections

externalPortStart
integer

External Port that the modem will listen on. List of externalPorts not available for now in the API : 8, 21, 68, 5060, 21800-21805, 51005

id
read-only
integer

ID of the port mapping entry

internalClient
ip

IP address (e.g., 192.0.2.0)

internalPort
integer

The port on the Internal Client that will get the connections

internalPortEnd
integer

The last port of the interval on the Internal Client that will get the connections

name
read-only
string

Name of the port mapping entry

protocol
ProtocolTypeEnum

Type of protocol for the Port Mapping

ValuesTCPUDP
taskId
read-only
integer

ID of the ongoing todo (NULL if none)

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/portMappings \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "allowedRemoteIp": "192.0.2.0", "description": "string", "externalPortEnd": 0, "externalPortStart": 0, "id": 0, "internalClient": "192.0.2.0", "internalPort": 0, "internalPortEnd": 0, "name": "string", "protocol": "TCP", "taskId": 0}

Update a port mapping of the modemProduction

PUT
/1.0/xdsl/{serviceName}/modem/portMappings/{name}

Changes the protocol, ports, internal client, allowed remote IP or description of a port mapping rule.

Path parameters

name
required
string

Name

serviceName
required
string

Service name

Request body (required)

allowedRemoteIp
ipv4

An ip which will access to the defined rule. Default : no restriction applied

description
string

Description of the Port Mapping

externalPortEnd
integer

The last port of the interval on the External Client that will get the connections

externalPortStart
integer

External Port that the modem will listen on. List of externalPorts not available for now in the API : 8, 21, 68, 5060, 21800-21805, 51005

id
read-only
integer

ID of the port mapping entry

internalClient
ip

IP address (e.g., 192.0.2.0)

internalPort
integer

The port on the Internal Client that will get the connections

internalPortEnd
integer

The last port of the interval on the Internal Client that will get the connections

name
read-only
string

Name of the port mapping entry

protocol
ProtocolTypeEnum

Type of protocol for the Port Mapping

ValuesTCPUDP
taskId
read-only
integer

ID of the ongoing todo (NULL if none)

Response

200—successful operation

Example uses name = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/portMappings/{name} \
  -H "authorization: Bearer $OVH_TOKEN"

Get a port mapping of the modemProduction

GET
/1.0/xdsl/{serviceName}/modem/portMappings/{name}

Returns a port mapping rule: its protocol, external and internal ports, internal client, allowed remote IP and description.

Path parameters

name
required
string

Name

serviceName
required
string

Service name

Response

200PortMappingsuccessful operation
allowedRemoteIp
ipv4

An ip which will access to the defined rule. Default : no restriction applied

description
string

Description of the Port Mapping

externalPortEnd
integer

The last port of the interval on the External Client that will get the connections

externalPortStart
integer

External Port that the modem will listen on. List of externalPorts not available for now in the API : 8, 21, 68, 5060, 21800-21805, 51005

id
read-only
integer

ID of the port mapping entry

internalClient
ip

IP address (e.g., 192.0.2.0)

internalPort
integer

The port on the Internal Client that will get the connections

internalPortEnd
integer

The last port of the interval on the Internal Client that will get the connections

name
read-only
string

Name of the port mapping entry

protocol
ProtocolTypeEnum

Type of protocol for the Port Mapping

ValuesTCPUDP
taskId
read-only
integer

ID of the ongoing todo (NULL if none)

Example uses name = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/portMappings/{name} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "allowedRemoteIp": "192.0.2.0", "description": "string", "externalPortEnd": 0, "externalPortStart": 0, "id": 0, "internalClient": "192.0.2.0", "internalPort": 0, "internalPortEnd": 0, "name": "string", "protocol": "TCP", "taskId": 0}

Delete a port mapping of the modemProduction

DELETE
/1.0/xdsl/{serviceName}/modem/portMappings/{name}

Removes the port mapping rule from the modem. Returns the task that performs the change.

Path parameters

name
required
string

Name

serviceName
required
string

Service name

Response

200Tasksuccessful operation
doneDate
read-only
stringdate-time

Date when the action was completed

function
read-only
string
—
id
read-only
integer
—
isArchived
read-only
boolean
—
status
read-only
TaskStatusEnum

Status of a task.

Valuescancelleddoingdoneerrorproblemtodo
todoDate
read-only
stringdate-time

Date when the action will start

updateDate
read-only
stringdate-time
—

Example uses name = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/portMappings/{name} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "isArchived": true, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z", "updateDate": "2024-01-01T12:00:00Z"}

Delete all the port mappings of the modemProduction

POST
/1.0/xdsl/{serviceName}/modem/resetPortMappingConfig

Removes every port mapping rule of the modem of the access.

Path parameters

serviceName
required
string

Service name

Response

200—successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/resetPortMappingConfig \
  -H "authorization: Bearer $OVH_TOKEN"

Get the IPsec ALG status of the modemProduction

GET
/1.0/xdsl/{serviceName}/modem/ipsecAlg

Returns whether the IPsec ALG service is enabled or disabled on the modem of the access.

Path parameters

serviceName
required
string

Service name

Response

200ServiceStatusEnumsuccessful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/ipsecAlg \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"disabled"

Enable or disable IPsec ALG on the modemProduction

POST
/1.0/xdsl/{serviceName}/modem/ipsecAlg

Changes the status of the IPsec ALG service on the modem of the access. Returns the task that performs the change.

Path parameters

serviceName
required
string

Service name

Request body (required)

ipsecAlg
required
ServiceStatusEnum

Status of the service

Valuesdisabledenabled

Response

200Tasksuccessful operation
doneDate
read-only
stringdate-time

Date when the action was completed

function
read-only
string
—
id
read-only
integer
—
isArchived
read-only
boolean
—
status
read-only
TaskStatusEnum

Status of a task.

Valuescancelleddoingdoneerrorproblemtodo
todoDate
read-only
stringdate-time

Date when the action will start

updateDate
read-only
stringdate-time
—

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/ipsecAlg \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "isArchived": true, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z", "updateDate": "2024-01-01T12:00:00Z"}

Get the SIP ALG status of the modemProduction

GET
/1.0/xdsl/{serviceName}/modem/sipAlg

Returns whether the SIP ALG service is enabled or disabled on the modem of the access.

Path parameters

serviceName
required
string

Service name

Response

200ServiceStatusEnumsuccessful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/sipAlg \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"disabled"

Enable or disable SIP ALG on the modemProduction

POST
/1.0/xdsl/{serviceName}/modem/sipAlg

Changes the status of the SIP ALG service on the modem of the access. Returns the task that performs the change.

Path parameters

serviceName
required
string

Service name

Request body (required)

sipAlg
required
ServiceStatusEnum

Status of the service

Valuesdisabledenabled

Response

200Tasksuccessful operation
doneDate
read-only
stringdate-time

Date when the action was completed

function
read-only
string
—
id
read-only
integer
—
isArchived
read-only
boolean
—
status
read-only
TaskStatusEnum

Status of a task.

Valuescancelleddoingdoneerrorproblemtodo
todoDate
read-only
stringdate-time

Date when the action will start

updateDate
read-only
stringdate-time
—

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/sipAlg \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "isArchived": true, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z", "updateDate": "2024-01-01T12:00:00Z"}

Get the UPnP status of the modemProduction

GET
/1.0/xdsl/{serviceName}/modem/upnp

Returns whether UPnP is enabled or disabled on the modem of the access.

Path parameters

serviceName
required
string

Service name

Response

200ServiceStatusEnumsuccessful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/upnp \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"disabled"

Enable or disable UPnP on the modemProduction

POST
/1.0/xdsl/{serviceName}/modem/upnp

Changes the status of UPnP on the modem of the access. Returns the task that performs the change.

Path parameters

serviceName
required
string

Service name

Request body (required)

upnp
required
ServiceStatusEnum

Status of the service

Valuesdisabledenabled

Response

200Tasksuccessful operation
doneDate
read-only
stringdate-time

Date when the action was completed

function
read-only
string
—
id
read-only
integer
—
isArchived
read-only
boolean
—
status
read-only
TaskStatusEnum

Status of a task.

Valuescancelleddoingdoneerrorproblemtodo
todoDate
read-only
stringdate-time

Date when the action will start

updateDate
read-only
stringdate-time
—

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/xdsl/{serviceName}/modem/upnp \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "isArchived": true, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z", "updateDate": "2024-01-01T12:00:00Z"}