Introduction

StackPath provides a RESTful HTTP API for customers to programmatically interact with the StackPath platform. This API manages your account, Stacks, and all of the services on them. Use the StackPath API to integrate StackPath's platform into your business and applications.

📘

OpenAPI

For additional information, StackPath's OpenAPI specs can be found here.

Requirements

The items below are required before you can start using the StackPath API.

StackPath Account

StackPath's API is only available to our customers. Create an account to get started.

API Credentials

Your account must have API access in order to utilize it. API access is guarded around credentials that are used to authenticate your calls. To generate your API credentials, perform the following:

1. In the StackPath Control Portal, in the top, right corner, click your name.
2. In the drop-down menu, click API Management.
3. Click Generate Credentials.
4. In the Name field, enter a descriptive name, and then click Save.
5. A Client ID and Client Secret will display.

Please remember to keep this information in a safe place for future use. These credentials can be used to control any products within your account via the API. The client secret will not be available once you close out the initial pop-out window, so if you lose this information, you will need to regenerate your API credentials.

HTTP Client

Applications communicate with the StackPath API via HyperText Transfer Protocol (HTTP). As such, you need an HTTP client to make requests via the API. There are many clients out there, but use whichever makes most sense for your platform and application.

The code examples in these guides use the curl command-line client.