Authentication

๐Ÿ“˜

Optional

You do not need an API key to use this API; unauthenticated requests are supported. You can request a free API key here for unlimited requests and to receive an invite to our Slack community.

All API requests must be made over HTTPS.

Specify your API key in the Key header field:

GET https://alpha.api.sublimesecurity.com
Key: [your api key]
User-Agent: [your app name]

User-agent requirements

Each request to the API must be accompanied by a user agent request header. Typically this should be the name of the app consuming the service. A missing user agent may result in an HTTP 403 response. A valid request would look like:

GET https://alpha.api.sublimesecurity.com
User-Agent: [your app name]

The user agent should accurately describe the nature of the API consumer such that it can be clearly identified in the request. Not doing so may result in the request being blocked.