API

Deploy features a robust and feature-rich REST API. You can explore the API using the API browser here.

You can navigate to the API browser from anywhere in Deploy:

Widescreen Mobile

• Click on the Your Username button in the bottom-left of the side navigation bar to show a nav menu

• Click on the Your Username button in the top-right of the header
  • You may need to click on the hamberger button to display your username first

• Click on the API Browser option

The API browser is a useful tool for exploring, sampling, and reviewing the structure of data returned from the API.

The API browser linked above uses your web browser's (Firefox, Chrome, Edge, etc) logged-in session cookie to authenticate who you are and set your permissions.

In order to use the API from a custom application, you will need to authenticate using an API key.

See the next page to learn how to create an API key.