Request and Response - Structure and Elements

This section provides an overview of the basic structure and elements of a request/response to our REST API services.

Learn about:

HTTP method
Request URL
Common request and response headers
Request body syntax

HTTP Method

HTTP method is a critical component of a request to our REST API service as it determines the type of action being requested.

HTTP Method	Description
DELETE	Deletes the referenced object (e.g., edge CNAME or customer origin).
GET	Retrieves information about the referenced object.
POST	Creates a new object.
PUT	Updates the properties associated with an existing object.

Our REST API service may return a 405 Method Not Allowed response for requests submitted with an unsupported HTTP method.

Request URL

The format for a REST API request varies according to whether you are submitting requests to api.edgecast.com or our API gateway (api.vdms.io).

api.edgecast.com

The URL for a request to a REST API service follows the basic pattern defined below:

https://api.edgecast.com/v2/serviceIdentifies the REST API web service (e.g., mcc, reporting, and realtimestats) designed to manage requests for a specific set of resources. Each of our services has a dedicated purpose. For example, our mcc service allows general CDN configuration and tasks, while our realtimestats service only provides real-time statistics on CDN usage.//?

Sample request:

https://api.edgecast.com/v2/mcc/customers/0001/edge/purge

Sample request with parameters:

https://api.edgecast.com/v2/reporting/customers/0001/bytestransferred?begindate=2022-01-01&enddate=2022-02-01

API Gateway

Requests to services that leverage our API gateway follow this basic pattern:

https://api.vdms.io///?

Sample request:

https://api.vdms.io/rules-engine/v1.1/policies

Request Headers

Request headers provide information about your request to a REST API service. This information allows our server to authenticate your request and provides information that allows it to receive and translate the request body.

The use of a Byte Order Mark (BOM) in a request to the REST API is not supported. Some user agents are configured to automatically include a BOM. Please either configure the user agent to exclude the BOM or use a different user agent.

Request header values are case-insensitive.

Request Header	Description
Authorization	Authorization varies according to whether you are submitting requests to api.edgecast.com or our API gateway (api.vdms.io). api.edgecast.com Set this header to your REST API token using the following format: TOK: Token Sample value: TOK:12345678-1234-1234-1234-1234567890ab API Gateway (api.vdms.io) Set this header to your access token using the following format: Bearer Access Token Sample value: Bearer A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01z...A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01zOTIzQjI1MTYzRjU4MU1wQ0I3MUNBRDk3QjAzNkUwQjgiLCJ01XAiOiJKV1QiLCJ4NXQiOiJGMDc4bzVJN0pSWV9XQm9Ndcc5dGw3QTI0TGcifQ.1yJuYmYiOj11NjUzMDgwNzgsImV4cCI6MTU2NTMwODM3OCwiaXNzIjoiacR0ccM6Ly9pZC52ZG1zLmlvIiwiYXVkIjpbImc0dcBzOi8vaWQudmRtcy5pby9yZXNvdXJjZXMiLCJlYy5ydWxlcyJdLCJjbGllbnRfaWQiOiIxNTccOWZmZi04MTQzLTRmOW1tOWY1Yi1jNDgzZWVkNzclM2QiLCJzY29wZSI6WyJlYy5ydWxlcyJdfQ.XQ4TvzDrwLo4bO71cb1TbgYxmtcgTzC46Do0A9F3inAqw1qcr_Nr9IgRDxJDqR4Udc9QR86LVTQC2-ogGWP3pI12GtDtiUQdKYs5fpcuMf2Kbqau6kuU1M5BJm_GOcBNCCAJnU7SrDprVbPlwanGqk3yjcyo9nto8KWCRTwq2t31UQ1Ci31FZSr4vaMZJqk1vBW6NS3-yGowGCZbSIQBKpSgcc75coPtSjF1Qi6M4yORDyMC8c3KKlIp2b-6mpfDFXINIFV-XvnNuQ9v-lcc43_VWuDA_cQO8wmS4VzS1Ac1tpg1Pp4Bcdtjt12yKAXvi0X19R1BDmpxmO17cRRKYQ
Accept	This header should indicate the format in which the response will be returned. The recommended value for this request header is: application/json
Content-Type	This header should indicate the format of the request body. The recommended value for this request header is: application/json You may omit this header when an endpoint does not have request parameters.
Host	This header, which is set by the user agent, indicates the host name corresponding to the requested endpoint. api.edgecast.com api.edgecast.com API Gateway (api.vdms.io) api.vdms.io
Content-Length	This header, which is set by the user agent, indicates the number of bytes contained in the request body.

Request Body

PUT and POST requests typically require request body parameters that describe the action that will take place. These request body parameters are case-sensitive.

Response Headers

Response headers provide information about the response to your request to the REST API service. A brief description is provided for the response headers that are returned by most endpoints. Standard HTTP response headers are typically returned along with these common response headers.

Response Header	Description
Cache-Control	Indicates the cache-control policy for the response body.
Content-Length	Indicates the number of bytes in the response body.
Content-Type	Indicates the format of the response body. This header will report one of the following values: JSON: application/json; charset=utf-8 XML: application/xml
Ec-Response-Id	api.edgecast.com Only Indicates the system-defined ID assigned to the response.
I_am	This header is reserved for internal use.
X-Frame-Options	api.edgecast.com Only Indicates that the page may only be displayed in a frame on the same origin as the parent page.
Date	Identifies the date and time (UTC) at which your request was processed.

In addition to the above headers, the response for Real-Time Log Delivery endpoints will also include the following response header:

Response Header	Description
Pragma	Indicates the cache-control policy for the response body. The Cache-Control header takes precedence over this header.

Response Header

Description

Indicates the cache-control policy for the response body.

The Cache-Control header takes precedence over this header.

In addition to the above headers, the response for requests to our API gateway may also include the following headers:

The above headers are reserved for future use.