Deploy API Documentation

Welcome

Deploy offers an API to allow you to view your deployments and create new ones. In addition to the API, there's also a ruby gem available to make integrating with Deploy even easier.

Authenticating and Accessing the API

Users are provided with an API key which can be found from the 'My Profile' page. It's a 40 character string which must be used with your username in order to authenticate. All API requests should be sent with HTTP Basic authentication with your username (email address) & API key.

Requests should also send an Accept: application/json and Content-type: application/json header. All requests to the API should be in JSON and all responses received will be returned as JSON.

Requests should be made to http(s)://yourdomain.deployhq.com/