Show search and navigation.

 

Frequently Asked Questions: REST API

General

ClosedWhat information do I need to submit a REST API request?

The majority of endpoints require the following information:

Item Description

Authorization

Most requests require authorization. Authorization information, which is contained within a token, is defined by the Authorization request header.

Learn more.

Account Number

api.edgecast.com Only

Most requests require a customer account number. This account number, which may be found in the upper-right hand corner of the MCC, indicates the customer account on which the request will be performed.

ClosedWhat programming languages may I use with the REST API?

Any programming language that supports GET, POST, PUT, and DELETE requests over HTTPS is allowed.

ClosedDo you have any examples on how to use specific programming languages with the REST API?

No. Our documentation only provides examples of properly formatted HTTPS requests.

Search the web (e.g., HTTPS request using PHP) to find out how to submit a HTTPS request using the desired programming language. Look for an example that explains how to define request headers and a request body.

Authorization

ClosedHow do I pass authorization information when submitting a request?

Authenticate and authorize your requests by passing the Authorization header with the following value:

  • api.edgecast.com

    TOK: REST API Token

  • API Gateway (api.vdms.io)

    Bearer OAuth 2.0 Token

Learn more.

ClosedHow do I generate a token?

User authentication requires passing a unique value (i.e., token). The type of token that may be used to authenticate your requests varies according to whether the service is hosted on our API gateway.

  • api.edgecast.com

    Requests to api.edgecast.com leverage a REST API token. Generate this token by performing the following steps:

    1. Navigate to the View Profile page.

    2. Click Edit.

    3. Click Generate New Primary from the Web Service REST API Token section. When prompted, click OK to confirm this action.

      If the Web Service REST API Token section doesn't exist, please contact your MCC administrator to request access to our REST API service. Upon approval, you will be allowed to generate and view tokens.

    4. From your preferred email client, open the verification email and then follow the verification link. The current primary token will be set as a backup token.

      Both primary and backup tokens provide the same level of access to the REST API.

    5. Update existing applications to use the new token value.
    6. Delete the backup token.

  • API Gateway (api.vdms.io)

    Requests to our API gateway require a temporary token generated from your OAuth 2.0 credentials. Generate this token by submitting a POST request to IDS.

    Learn more.

ClosedWhy can't I find my REST API token?

api.edgecast.com

Your MCC administrator determines which users are allowed to use the REST API. The REST API token will only be displayed to authorized users.

Your MCC administrator may have configured the REST API to only be accessed through a user account with limited privileges. This type of setup requires the MCC administrator to manually provide a REST API token to authorized users.

API Gateway (api.vdms.io)

Tokens are not provided. Rather, they must be generated and they are only valid for 5 minutes.

Learn more.

ClosedAre request headers (e.g., Authorization) case-sensitive?

No.

ClosedAdministrator: Where do I define REST API privileges?

api.edgecast.com

All user privileges, including those pertaining to the REST API, may be defined when modifying a user account from within the MCC.

Learn more.

API Gateway (api.vdms.io)

Each request to generate a token defines a scope. This scope determines the set of privileges that will be granted to the token.

Response

ClosedDoes a 200 OK response mean that the requested action took place?

A 200 OK response indicates that a properly formatted request was submitted and processed by the REST API. Typically, this means that the requested action was successfully performed. An exception to this rule takes place for requests that pass an invalid object ID (e.g., edge CNAME or publishing point). A 200 OK response will be provided for these types of requests even though the requested action was not performed.

ClosedWhy doesn't a 200 OK response contain a response body?

Typically, a 200 OK response will only include a response body under the following circumstances:

  • GET request
  • POST request

An empty response body will typically be returned under the following circumstances:

  • PUT request
    • Some PUT requests will return a response body (e.g., purging content and updating zones).
  • DELETE request
  • A GET request that points to an invalid object ID (e.g., edge CNAME or publishing point).
ClosedWhat does a non-2xx response mean?

A non-2xx response (e.g., 400 Bad Request) means that the requested action was not performed. The reason why the requested action did not take place is indicated by the HTTP response method (e.g., 400 Bad Request). An additional explanation may also be provided in the response body.

Learn more.

More Information