Skip to content

Authentication

Authentication requires a single api key, encoded to the Authorization header.

Example:

Authorization: Token {{ CloudPress API Token }}

IP Restriction

You may restrict access by IP to a particular API Key in the CloudPress API Key Manager. Note that when you attempt to connect from a non-authorized IP, you will receive the same response as if you supplied an invalid API Key.

By default there is no IP restriction in place.

Setting Account Scope

Some API endpoints require an Account Scope. To specify which account you would like to be working under, include the header X-Auth-Account.

Example:

X-Auth-Account: {{ CloudPress Account ID }}

About Endpoint

CloudPress offers an 'about' endpoint that provides information about who you are logged in as, as well as, information about available resources.

GET /api/about

Returned Params
  • version: String | Api Version Information
  • logged_in_as: String | Your user ID
  • account_scoped: String | If you authenticated with an account, this is your ID.
  • locations: Array
    • id: String
    • name: String
  • products: Array
    • id: String
    • name: String
    • description: String