The policies API provides functionality that allows a administrator to add, delete or update policies
Table of Contents |
---|
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all policiesLists all the policies configured in the Aspire
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all policies, filteredLists policies configured in the Aspire, filtered by a specified criteria
Query String Parameters
Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single policyGets information about a single policy configured in Aspire
Query String Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add policiesAdds policies to Aspire
Body Parameters
Other parameters passed in the request body will depend on the type of policy being created: Throttle type:
Route type:
Example
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update policiesUpdate policies in Aspire.
Body Parameters
Other parameters passed in the request body will depend on the type of policy being created - see Add a Policy above Example
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple policies, filteredDelete multiple policies from Aspire, filtered by a specified criteria
Body Parameters
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete policyDelete a single policy from Aspire.
Query String Parameters
Example
Delete multiple policies Response
Status
|
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials filter:
|