PSC API Keys are used to authenticate API access. Users can view API Key settings within the PSC Console under Settings > API Keys.
API keys include two parts:
Authentication is passed to the CB Defense API via the
X-Auth-Token HTTP header. To generate the appropriate header, concatenate the API Secret Key with the API ID with a forward slash in between. For example, if the API Secret Key is
ABCD and the API ID is
1234, the corresponding
X-Auth-Token HTTP header will be:
All API requests must be authenticated by using an API Secret Key and a API ID. Unauthenticated requests return an HTTP 401 error.
Older versions of this document had “Connector” related terminology. This has now been updated to “API Key”.
This allows a org administrator to define a API Key and get access to the API Secret Key and API ID that will be required to authenticate the API request. In addition, administrators can restrict use of this API key to a specific set of IP addresses for security reasons.
Currently there are three types of API keys available in the API Keys page. Each key type provides different access levels to API routes:
APIkey type: provides access to all APIs except for the Notifications API and the Live Response API
SIEMkey type: provides access to the Notifications API
Live Responsekey type: provides access to all APIs available to (1) above plus the Live Response API
Attempting to access an API not allowed by a given key type will result in an HTTP 401 Unauthorized error.
Rate limiting is done on a per API key basis. Rate limiting interval is 5 minutes: 25 API calls every 5 minutes.
When your request exceeds the rate limit for a given API key, the CB Defense API will return an HTTP 429 “Too Many Requests” response code.
If you expect a lot of use, consider caching the results in your application. This should reduce the possibility of being rate limited.
Rate limiting is currently not enforced. However, we do monitor excessive usage and can result in temporary enforcement of rate limiting.
If you or your application abuse the rate limits, the API key and or Organization might be blacklisted. Once an API key or Organization is blacklisted, you will be unable to get a response from CB Defense API.