Configuration
All operations require authentication.
List PoP configurationsProduction
Returns the IDs of the PoP configurations.
Path parameters
Service name
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ 0]
List availability zonesProduction
Returns the IDs of the availability zones this service can connect to.
Path parameters
Service name
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ 0]
List availability zone configurationsProduction
Returns the IDs of the availability zones connected through this PoP configuration.
Path parameters
Pop ID
Service name
Response
Example uses popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ 0]
List routing configurationsProduction
Returns the IDs of the BGP peers and static routes of this availability zone configuration.
Path parameters
Datacenter ID
Pop ID
Service name
Response
Example uses datacenterId = 0, popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ 0]
Get PoP configurationProduction
Returns the configuration's type, interface, subnet, AS numbers and status.
Path parameters
Pop ID
Service name
Response
Customer Private AS
ID of the Pop Configuration
ID of the interface
OVH Private AS
Status of the pop configuration
activeinittoDeleteSubnet should be a /30, first IP for OVH, second IP for customer
Type of the pop configuration
l2l3Example uses popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "customerBgpArea": 0, "id": 0, "interfaceId": 0, "ovhBgpArea": 0, "status": "active", "subnet": "192.0.2.0/24", "type": "l2"}
Get availability zoneProduction
Returns the availability zone's name, region, 1-AZ or 3-AZ type, and whether it accepts a new configuration.
Path parameters
Id
Service name
Response
Get availability to add new configuration on it
ID of the datacenter
name of the datacenter
region of the datacenter
af-north-lz-rbaap-south-mumap-southeast-sgpap-southeast-sydca-east-bhsca-east-toreu-central-lz-buheu-central-lz-prgeu-central-lz-sofeu-central-waweu-north-lz-cpheu-north-lz-heleu-north-lz-osleu-north-lz-stoeu-south-lz-liseu-south-lz-madeu-south-lz-mileu-south-mileu-west-erieu-west-graeu-west-gra-snceu-west-limeu-west-lz-amseu-west-lz-brueu-west-lz-dlneu-west-lz-luxeu-west-lz-mnceu-west-lz-mrseu-west-lz-vieeu-west-lz-zrheu-west-pareu-west-rbxeu-west-rbx-snceu-west-sbgeu-west-sbg-sncus-central-lz-slcus-central-lz-stlus-east-lz-atlus-east-lz-bosus-east-lz-chius-east-lz-dalus-east-lz-miaus-east-lz-nycus-east-vinus-west-hilus-west-lz-denus-west-lz-laxus-west-lz-paous-west-lz-searegion type of the datacenter
1-AZ3-AZExample uses id = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "available": true, "id": 0, "name": "string", "region": "af-north-lz-rba", "regionType": "1-AZ"}
Get availability zone configurationProduction
Returns the linked availability zone, subnet, OVHcloud AS and status.
Path parameters
Datacenter ID
Pop ID
Service name
Response
ID of the datacenter linked
ID of the Datacenter configuration
OVH Private AS
Status of the pop configuration
activeinittoDeleteSubnet should be a /28 min
Example uses datacenterId = 0, popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "datacenterId": 0, "id": 0, "ovhBgpArea": 0, "status": "active", "subnet": "192.0.2.0/24"}
Get routing configurationProduction
Returns the route type, its BGP peer or static subnet and next hop, and its status.
Path parameters
Datacenter ID
Extra ID
Pop ID
Service name
Response
BGP AS number
Router IP for BGP
ID of the extra configuration
Static route next hop
Status of the pop configuration
activeinittoDeleteStatic route ip
Type of the configuration
bgpnetworkExample uses datacenterId = 0, extraId = 0, popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "bgpNeighborArea": 0, "bgpNeighborIp": "192.0.2.0", "id": 0, "nextHop": "192.0.2.0", "status": "active", "subnet": "192.0.2.0/24", "type": "bgp"}
Create PoP configurationProduction
Sets configuration for an interface from interfaceList; Provided settings depends on type L2 or L3 (async task).
Path parameters
Service name
Request body (required)
Customer Private AS
ID of the Pop Configuration
ID of the interface
OVH Private AS
Status of the pop configuration
activeinittoDeleteSubnet should be a /30, first IP for OVH, second IP for customer
Type of the pop configuration
l2l3Response
Task function
addDatacenterConfigurationaddDatacenterExtraConfigurationaddPopConfigurationaddVrackconsumePairingKeydelDatacenterConfigurationdelDatacenterExtraConfigurationdelPopConfigurationdeleteCircuitdiagAccessEdgediagMacsdiagPeeringdiagPeeringExtradiagRouteslockInterfaceremoveVrackresetEdgeConfigurationunlockInterfaceTask id
Reference of the created resource
Task status
denieddoingdoneerrorpausetodoExample uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "function": "addDatacenterConfiguration", "id": 0, "resourceId": 0, "status": "denied"}
Create availability zone configurationProduction
Connects an availability zone to this PoP configuration; L3 also needs a /28 subnet and the OVHcloud AS (async task).
Path parameters
Pop ID
Service name
Request body (required)
ID of the datacenter linked
ID of the Datacenter configuration
OVH Private AS
Status of the pop configuration
activeinittoDeleteSubnet should be a /28 min
Response
Task function
addDatacenterConfigurationaddDatacenterExtraConfigurationaddPopConfigurationaddVrackconsumePairingKeydelDatacenterConfigurationdelDatacenterExtraConfigurationdelPopConfigurationdeleteCircuitdiagAccessEdgediagMacsdiagPeeringdiagPeeringExtradiagRouteslockInterfaceremoveVrackresetEdgeConfigurationunlockInterfaceTask id
Reference of the created resource
Task status
denieddoingdoneerrorpausetodoExample uses popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "function": "addDatacenterConfiguration", "id": 0, "resourceId": 0, "status": "denied"}
Create routing configurationProduction
Adds a BGP peer (bgp) or a static route (network) to this availability zone configuration (async task).
Path parameters
Datacenter ID
Pop ID
Service name
Request body (required)
BGP AS number
Router IP for BGP
ID of the extra configuration
Static route next hop
Status of the pop configuration
activeinittoDeleteStatic route ip
Type of the configuration
bgpnetworkResponse
Task function
addDatacenterConfigurationaddDatacenterExtraConfigurationaddPopConfigurationaddVrackconsumePairingKeydelDatacenterConfigurationdelDatacenterExtraConfigurationdelPopConfigurationdeleteCircuitdiagAccessEdgediagMacsdiagPeeringdiagPeeringExtradiagRouteslockInterfaceremoveVrackresetEdgeConfigurationunlockInterfaceTask id
Reference of the created resource
Task status
denieddoingdoneerrorpausetodoExample uses datacenterId = 0, popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "function": "addDatacenterConfiguration", "id": 0, "resourceId": 0, "status": "denied"}
Delete PoP configurationProduction
Removes the PoP configuration from its interface (async task).
Path parameters
Pop ID
Service name
Response
Task function
addDatacenterConfigurationaddDatacenterExtraConfigurationaddPopConfigurationaddVrackconsumePairingKeydelDatacenterConfigurationdelDatacenterExtraConfigurationdelPopConfigurationdeleteCircuitdiagAccessEdgediagMacsdiagPeeringdiagPeeringExtradiagRouteslockInterfaceremoveVrackresetEdgeConfigurationunlockInterfaceTask id
Reference of the created resource
Task status
denieddoingdoneerrorpausetodoExample uses popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "function": "addDatacenterConfiguration", "id": 0, "resourceId": 0, "status": "denied"}
Delete availability zone configurationProduction
Disconnects the availability zone from this PoP configuration (async task).
Path parameters
Datacenter ID
Pop ID
Service name
Response
Task function
addDatacenterConfigurationaddDatacenterExtraConfigurationaddPopConfigurationaddVrackconsumePairingKeydelDatacenterConfigurationdelDatacenterExtraConfigurationdelPopConfigurationdeleteCircuitdiagAccessEdgediagMacsdiagPeeringdiagPeeringExtradiagRouteslockInterfaceremoveVrackresetEdgeConfigurationunlockInterfaceTask id
Reference of the created resource
Task status
denieddoingdoneerrorpausetodoExample uses datacenterId = 0, popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "function": "addDatacenterConfiguration", "id": 0, "resourceId": 0, "status": "denied"}
Delete routing configurationProduction
Removes the BGP peer or static route (async task).
Path parameters
Datacenter ID
Extra ID
Pop ID
Service name
Response
Task function
addDatacenterConfigurationaddDatacenterExtraConfigurationaddPopConfigurationaddVrackconsumePairingKeydelDatacenterConfigurationdelDatacenterExtraConfigurationdelPopConfigurationdeleteCircuitdiagAccessEdgediagMacsdiagPeeringdiagPeeringExtradiagRouteslockInterfaceremoveVrackresetEdgeConfigurationunlockInterfaceTask id
Reference of the created resource
Task status
denieddoingdoneerrorpausetodoExample uses datacenterId = 0, extraId = 0, popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "function": "addDatacenterConfiguration", "id": 0, "resourceId": 0, "status": "denied"}