Get all regions and zones for a provider

Get all regions and zones for a provider

GET 
undefined/functions/v1/cloud-options/:provider/regions-zones

Get all regions and zones for a provider

Request

Path Parameters

provider stringrequired

Possible values: [GCP, AWS, Azure]

The provider to get instance types for

Responses

200

Success

application/json

Schema

Schema

successboolean
Default value: true
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 200
statusTextstring
Default value: Success
messagestring
Default value: regions-zones fetched successfully
localizationstring
Default value: someone-method:success
data object
North America object[]
Array [
regionstring
Default value: us-central1
locationstring
Default value: Council Bluffs, Iowa, North America
zonesstring[]
]
Europe object[]
Array [
regionstring
Default value: us-central1
locationstring
Default value: Council Bluffs, Iowa, North America
zonesstring[]
]
Asia-Pacific object[]
Array [
regionstring
Default value: us-central1
locationstring
Default value: Council Bluffs, Iowa, North America
zonesstring[]
]
Middle East object[]
Array [
regionstring
Default value: us-central1
locationstring
Default value: Council Bluffs, Iowa, North America
zonesstring[]
]
Africa object[]
Array [
regionstring
Default value: us-central1
locationstring
Default value: Council Bluffs, Iowa, North America
zonesstring[]
]
Middle East & Africa object[]
Array [
regionstring
Default value: us-central1
locationstring
Default value: Council Bluffs, Iowa, North America
zonesstring[]
]

Example (auto)

{
  "success": true,
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 200,
  "statusText": "Success",
  "message": "regions-zones fetched successfully",
  "localization": "someone-method:success",
  "data": {
    "North America": [
      {
        "region": "us-central1",
        "location": "Council Bluffs, Iowa, North America",
        "zones": [
          "string"
        ]
      }
    ],
    "Europe": [
      {
        "region": "us-central1",
        "location": "Council Bluffs, Iowa, North America",
        "zones": [
          "string"
        ]
      }
    ],
    "Asia-Pacific": [
      {
        "region": "us-central1",
        "location": "Council Bluffs, Iowa, North America",
        "zones": [
          "string"
        ]
      }
    ],
    "Middle East": [
      {
        "region": "us-central1",
        "location": "Council Bluffs, Iowa, North America",
        "zones": [
          "string"
        ]
      }
    ],
    "Africa": [
      {
        "region": "us-central1",
        "location": "Council Bluffs, Iowa, North America",
        "zones": [
          "string"
        ]
      }
    ],
    "Middle East & Africa": [
      {
        "region": "us-central1",
        "location": "Council Bluffs, Iowa, North America",
        "zones": [
          "string"
        ]
      }
    ]
  }
}

400

Bad Request

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 400
statusTextstring
Default value: Bad Request
messagestring
Default value: Message Error
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 400,
  "statusText": "Bad Request",
  "message": "Message Error",
  "localization": "someone-method:error"
}

401

Unauthorized

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 401
statusTextstring
Default value: Unauthorized
messagestring
Default value: Message Unauthorized
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 401,
  "statusText": "Unauthorized",
  "message": "Message Unauthorized",
  "localization": "someone-method:error"
}

403

Forbidden

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 403
statusTextstring
Default value: Forbidden
messagestring
Default value: Message Forbidden
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 403,
  "statusText": "Forbidden",
  "message": "Message Forbidden",
  "localization": "someone-method:error"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "undefined/functions/v1/cloud-options/:provider/regions-zones");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

undefined/functions/v1

Auth

apiKeyAuth

Parameters

provider — pathrequired

---GCPAWSAzure

ResponseClear

Click the Send API Request button above and see the response here!