The StackPath API was designed to help you manage your Stacks, CDN sites, and more with RESTful endpoints that accept JSON as input and returns JSON as output. In this "Getting Started" section, you will go through the necessary steps to make your first StackPath API request.


The StackPath RESTful API is secured for customers and as such requires a few steps before use.

Register an account

To start, register an account with StackPath to properly authenticate your future requests to the API.

Accessing your Stack

In most cases, the API will require the use of a unique identifier of your Stack. For those instances, use the Stack slug found on your Stack Management page in your StackPath control portal.


Stack ID and Stack slug

The stack_slug and stack_id used in the documentation can be used interchangeably.

Configuring an initial Stack is part of the registration process and it guides you through a basic configuration. If, for some reason, you don't have an initial Stack, create one on the Stack Management page in your StackPath control portal.

Using an HTTP client

The StackPath API requires an HTTP client with the necessary authentication credentials as part of the OAuth 2.0 flow. For details on generating those credentials, see Authenticating the StackPath APIs. Then, continue getting started by making your first API request.

Welcome to the StackPath API!