Show search and navigation.

 

Web Services REST API Access

Applies To:
HTTP LargeThis platform has been optimized to cache and deliver static content (e.g., HTML, CSS, JavaScript, ISO, multimedia, and software downloads, etc.) over HTTP or HTTPS.
HTTP SmallLegacy. If you are currently serving traffic over this platform, then you may continue to do so. However, we recommend that you serve your traffic over our more robust HTTP Large platform.
ADNThe Application Delivery Network platform has been optimized to deliver dynamic content (e.g., login credentials, account information, etc.) over HTTP or HTTPS. Typically, user-specific and database-driven content are served over this platform.

View information on how to administer your own Web Services REST API token.

Our REST API endpoints are organized by service, such as mcc, reporting, and realtimestats. These services allow you to automate core CDN tasks, such as:

The ability to automate tasks through our endpoints requires the use of a Web Service REST API token. A unique Web Service REST API token is assigned to a user when one or more HTTP methods have been granted. The available types of HTTP methods are described below.

HTTP Method Description

GET

Retrieves report data and information about your CDN configuration.

POST

Creates a CDN configuration (e.g., customer origins or edge CNAMEs).

PUT

Use this HTTP method to:

  • Perform actions (e.g., purge and load content)
  • Define CDN settings (e.g., cache settings)
  • Update a CDN configuration (e.g., customer origins or edge CNAMEs)

DELETE

Deletes a CDN configuration (e.g., customer origins or edge CNAMEs).

A HTTP method must be specified when calling an endpoint. This method determines the type of action that will take place.

A request to our REST API will only be honored when the user associated with the token has been granted sufficient permissions. Specifically, the user must be granted both the HTTP method (i.e., GET, PUT, POST, or DELETE) being requested and sufficient privileges to perform the action within the MCC.

A request submitted with a token with insufficient permissions will return a 403 Forbidden.

To define a user's level of access to the REST API

  1. Navigate to the Users page.
  2. Click on the desired user.
  3. Click Permissions.

  4. Under the API Access section, determine the scope of a user's API access by marking or clearing the checkboxes that appear next to each HTTP method.

    Grant a Web Services REST API token by assigning at least one HTTP method to the desired user. Likewise, revoke a Web Services REST API token by clearing all HTTP methods from that user.

  5. Under the User Access Modules section, grant the privileges that correspond to the set of actions that will be automated.
  6. Click Save.
More Information