Quick reference information is provided for:
A request consists of:
All REST API requests must comply with the following requirements:
| Requirement | Description |
|---|---|
|
Protocol |
HTTPS |
|
Hostname |
api.edgecast.com api.edgecast.com
API Gateway (api.vdms.io) api.vdms.io
|
|
Variables |
Make sure to replace italicized URL segments with the proper data (e.g., customer account number). |
Additionally, make sure to specify the correct HTTP method as it determines how the request will be interpreted.
| HTTP Method | Description |
|---|---|
|
DELETE |
Deletes the referenced object (e.g., edge CNAME |
|
GET |
Retrieves information about the referenced object. |
|
POST |
Creates a new object. |
|
PUT |
Updates the properties associated with an existing object. |
Make sure to include the following headers when submitting a request to our REST API service.
Request header names and values are case-insensitive.
| Header Name | Description |
|---|---|
|
Authorization |
Identifies the requester and provides authorization to perform the requested action. api.edgecast.com Set this header to your REST API token using the following format: TOK: Token
Sample value: Authorization: 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: |
|
Accept |
Identifies the format for the response body (i.e., JSON or XML). Syntax (JSON): Accept: Application/json
Syntax (XML): Accept: Application/xml
|
|
Content-Type |
Identifies the format for the request body (i.e., JSON or XML). This request header is unnecessary for GET requests. Syntax (JSON): Content-Type: Application/json
Syntax (XML): Content-Type: Application/xml
|
|
Host |
Indicates the host to which the request is being posted. api.edgecast.com Host: api.edgecast.com
API Gateway (api.vdms.io) Host: api.vdms.io
|
Key information:
Quick reference information is provided for:
A 200 OK HTTP status code indicates that the requested endpoint was successfully processed by our servers.
The proper response for a successful request can be an empty response body. An empty response body is returned when:
The response from our Web Services REST API service should include the following headers.
| Header Name | Description |
|---|---|
|
Cache-Control |
Indicates that the cache-control for the response body is "private." |
|
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:
|
|
Date |
Identifies the date and time (UTC) at which the request was processed. |
Key information:
Use the HTTP status code to determine why a request was denied.
Checklist
Verify that the request references
Verify that
Verify that the Authorization header references a valid token.
Verify the request body's format matches the Content-Type header value.
Verify all characters in the request URL are URL encoded.
Verify that the request includes all required request body parameters.
Validate all request body parameters.
Verify that each request body parameter included in the request is set to a valid and properly formatted value.
Verify that required request body parameters are not set to a blank value.
Only requests to our API gateway may return this response.
Checklist
Verify that the Authorization header references a valid token.
Verify that the token defined within the Authorization header was generated with a scope that authorizes the requested action.
Checklist
Verify that the Authorization header references a valid token using the following syntax:
Verify that the specified token does not include additional characters (e.g, quotes).
Verify that the request references a valid customer account number.
Verify that your user account has sufficient privileges to perform the requested action. Specifically, your user account must be granted the HTTP methodRefers to the type of action being requested. Our REST API supports the use of the following methods: GET, POST, PUT, and DELETE. being requested and sufficient user privileges to perform the equivalent action within the MCC.
Perform a case-comparison between the request URL and the endpoint defined in the documentation.
Checklist
Compare the request URL to the endpoint defined in the documentation.
Checklist
Verify that the specified HTTP methodRefers to the type of action being requested. Our REST API supports the use of the following methods: GET, POST, PUT, and DELETE. is allowed for the requested endpoint.
Checklist
Verify that resource being created doesn't already exist.
Checklist
Verify that the request URL is properly formatted.