🔒 Authenticate

All our endpoints are protected by an API key, witch can be obtained by contacting our support team.

The secret key have 73 characters.

To access any of the API endpoints, you must provide a valid API key in all your requests. The API key should be included in the authentication header of each request. Additionally, you must include the email associated with the API key in the 'octa-agent-email' field to assist in identifying the requests, as demonstrated below:

curl --location 'http://apiurl.com/auth/check' \ 
--header 'x-api-key: {api-key}' \
--header 'octa-agent-email: {agent-email}' \

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.