| Table of Contents |
|---|
Making Requests
Wherever possible, we suggest using the Accept-Encoding: gzip header.
All API requests must use HTTP Basic Auth.
Generating Client ID and API Key
Log in to your AMP for Endpoints Console.
Go to Accounts > Business Settings.
Click Configure API Credentials under Features to generate the Client ID and secure API Key.
...
| Code Block |
|---|
{
"version":"v0.1.0",
"data":{},
"errors":[{
"error_code":401,
"description":"Unauthorized",
"details":["Unknown API key or Client ID"]
}]
}
|
Rate Limits
API Clients are allowed to make a limited number of requests every hour. Each API response will include HTTP headers detailing the status of their rate limit. If the limit is overrun, then an HTTP 429 Error will be returned.
X-Rate-Limit-Limit- Total allowed requests in the current period.X-Rate-Limit-Remaining- Requests left.X-Rate-Limit-Reset- Number of seconds before the limit is reset.
Request Errors
If you make a request that contains an unexpected parameter or invalid request entity, then a 400 Bad Request will be sent back, and the error will describe which fields were problematic.
JSON Envelope format
All data returned by the API will be in the following format:
...
| Code Block |
|---|
{
"version": "0.1.0",
"metadata":{},
"data":{},
"errors": []
}
|
Metadata section
Links
Links describing the returned resource. In the case of a result set, any pagination links will be here.
Results
In most cases, the API will be returning you a list of results in the data section. The results object gives you information as to how many results were returned.
...
| Code Block |
|---|
{
"offset": 500
}
|
Links
A links object describes locations where one can retrieve more information about the information described, either the whole document, or elements inside of it.
Example of a paginated set of links
| Code Block |
|---|
"links": {
"self": "http://api.sourcefire.com/v0/example?offset=10",
"next": "http://api.sourcefire.com/v0/example?offset=20",
"last": "http://api.sourcefire.com/v0/example?offset=0"
}
|
Error
Errors may be the direct response of the API such as a bad request or a server error.
...
| Code Block |
|---|
{
"error_code": 400,
"description": "Bad Request",
"details": []
} |
UI Provisioning-
Device Configuration: Cisco AMP for Endpoints API