ListRegions Method

Description

Retrieves the list of regions.

HTTP Request

GET https://api.skeddly.com/api/Regions

Query Parameters

The following query parameters are accepted. One and only one of cloudProviderId, cloudProviderSubTypeId, or credentialId must be specified.

cloudProviderId

Comma-separated list of cloud-providers.

Valid Values: amazon.

Required: Conditional

cloudProviderSubTypeId

Comma-separated list of cloud-provider sub-types.

Valid Values:

• amazon-standard

• amazon-govcloud-us

• amazon-china.

Required: Conditional

credentialId

ID of a credential. Regions returned will be compatible with the specified credential.

Required: Conditional

include

Comma-separated list of extra data to include.

Valid Values: availabilityZones.

Required: No

Returns

Array of Region objects.

Sample Request

HTTP

GET /api/Regions HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>

Bash

curl "https://api.skeddly.com/api/Regions" \
  -H "Authorization: AccessKey <api key>"

Sample Response

[
  {
    "availabilityZones": [
        "us-east-1a",
        "us-east-1b"
    ],
    "cloudProviderSubTypeId": "amazon-standard",
    "displayName": "N. Virginia",
    "regionName": "us-east-1"
  }
]