# Public Cloud › Network › Gateway › Service references API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Public Cloud product's sections: https://developers.eu.ovhcloud.com/reference/public-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 1 operation of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/public-cloud/network/gateway/service-references/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/public-cloud/network/gateway/service-references.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/public-cloud/network/gateway/service-references.json?format=openapi3

## Operations

- `GET /publicCloud/project/{projectId}/reference/gateway/model` — List gateway models

## List gateway models

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

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/network/gateway/service-references/#getGatewayModels

**Status:** Stable production version  
**IAM actions:** `publicCloudProject:apiovh:reference/gateway/model/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `name` | query | publicCloud.gateway.ExternalGatewayModelEnum |  | Optional model filter, for example S — one of `2XL`, `3XL`, `L`, `M`, `S`, `XL` |
| `projectId` | path | string | yes | Project ID |
| `region` | query | 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. |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.reference.gateway.Model[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `bandwidth` | integer | read-only | Bandwidth in Mbit/s |
| `location` | publicCloud.reference.Location | read-only | 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 |
| `location.availabilityZones` | string[] | read-only | Availability zones of the region, for example eu-west-par-a, eu-west-par-b and eu-west-par-c. Empty for a single-AZ region. |
| `location.region` | string | read-only | Region name, for example GRA11 |
| `location.regionActivated` | boolean | read-only | Whether the region is already activated on the project. When false, the region must be activated on the project before use. |
| `name` | publicCloud.gateway.ExternalGatewayModelEnum | read-only | Model name, to use as the model when creating a gateway — one of `2XL`, `3XL`, `L`, `M`, `S`, `XL` |

```json
[
  {
    "bandwidth": 0,
    "location": {
      "availabilityZones": [
        "string"
      ],
      "region": "string",
      "regionActivated": true
    },
    "name": "2XL"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/gateway/model" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/reference/gateway/model")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/reference/gateway/model");

print_r($result);
?>
```