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

Service references

All operations require authentication.

1 operationv2/publicCloud/project
OpenAPI
Agent setup

List gateway modelsProduction

GET
/v2/publicCloud/project/{projectId}/reference/gateway/model

Returns the gateway models with their bandwidth in Mbit/s, read from the OVHcloud commercial catalog. The list holds one entry per model and region: a model sold in several regions appears once per region, with the bandwidth of that region and the region in location. The regions already activated on the project and those the project can activate where a model is sold are both listed. location.regionActivated on each entry tells which regions must be activated on the project before use. location.availabilityZones lists the availability zones of the region, for example eu-west-par-a, eu-west-par-b and eu-west-par-c, and is empty for a single-AZ region. Models come smallest first, each sorted by region name. Use name as the model when creating a gateway.

Path parameters

projectId
required
string

Project ID

Query parameters

name
ExternalGatewayModelEnum

Optional model filter, for example S

Values2XL3XLLMSXL
region
string

Optional region filter, case-insensitive. Keeps the entries of this region only. A region that does not exist is rejected. One the project can neither use nor activate returns an empty list.

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Model[]successful operation
bandwidth
read-only
integer

Bandwidth in Mbit/s

location
read-only
Location

Region where the model is sold to the project, whether that region is already activated on the project (regionActivated), and the availability zones of that region (availabilityZones), empty for a single-AZ region

name
read-only
ExternalGatewayModelEnum

Model name, to use as the model when creating a gateway

Values2XL3XLLMSXL

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/gateway/model \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "bandwidth": 0,    "location": {      "availabilityZones": [        "string"      ],      "region": "string",      "regionActivated": true    },    "name": "2XL"  }]