Get AWS Regions

Retrieves a list of AWS regions to which log data may be delivered.

Request

Retrieve AWS regions via one of the following requests:

  • api.edgecast.com

    HTTP Method Request URI

    GET

    https://api.edgecast.com/v2/mcc/rtld/aws-regions

  • API Gateway (api.vdms.io)

    HTTP Method Request URI

    GET

    https://api.vdms.io/rtld/v1/aws-regions

    You may use either of the above endpoints. However, the API gateway endpoint requires oAuth 2.0 credentials.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response elements:

Name Data Type Description

@id

String

api.edgecast.com

Returns /v2/mcc/rtld/aws-regions.

API Gateway (api.vdms.io)

Returns /aws-regions.

@type

String

Returns Collection.

items

Array of Objects

Contains the AWS regions to which log data may be delivered.

code

String

items array

Identifies an AWS region by its code name. Reference this code name when defining or retrieving a RTLD configuration.

name

String

items array

Identifies an AWS region by its name.

total_items

Integer

Indicates the total number of AWS regions that were included in the response.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

Sample Request and Response (JSON)

A sample JSON request is shown below.

GET https://api.edgecast.com/v2/mcc/rtld/aws-regions HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Content-Type: application/json

Host: api.edgecast.com

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: no-cache

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 1060

{
	"@id": "/v2/mcc/rtld/aws-regions",
	"@type": "Collection",
	"items": [{
			"code": "ap-south-1",
			"name": "Asia Pacific (Mumbai)"
		}, {
			"code": "ap-northeast-2",
			"name": "Asia Pacific (Seoul)"
		}, {
			"code": "ap-southeast-1",
			"name": "Asia Pacific (Singapore)"
		}, {
			"code": "ap-southeast-2",
			"name": "Asia Pacific (Sydney)"
		}, {
			"code": "ap-northeast-1",
			"name": "Asia Pacific (Tokyo)"
		}, {
			"code": "ca-central-1",
			"name": "Canada (Central)"
		}, {
			"code": "eu-central-1",
			"name": "EU (Frankfurt)"
		}, {
			"code": "eu-west-1",
			"name": "EU (Ireland)"
		}, {
			"code": "eu-west-2",
			"name": "EU (London)"
		}, {
			"code": "sa-east-1",
			"name": "South America (São Paulo)"
		}, {
			"code": "us-east-1",
			"name": "US East (N. Virginia)"
		}, {
			"code": "us-east-2",
			"name": "US East (Ohio)"
		}, {
			"code": "us-west-1",
			"name": "US West (N. California)"
		}, {
			"code": "us-west-2",
			"name": "US West (Oregon)"
		}
	],
	"total_items": 14
}