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 a single policyGet information about a single policy configured in Aspire
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add policiesAdds one or more policies to Aspire
Request Body Parameters
Other parameters passed in the request body will depend on the type of policy being created: Throttle type:
Route type:
Examples Add a single policy
Add multiple policies
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update policiesUpdate a policy in Aspire.
Path and Request Body Parameters
Other parameters passed in the request body will depend on the type of policy being created - see Add a Policy above Examples Update a single policy
Update multiple policies
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete policiesDelete one or more policies from Aspire.
Path and Request Body Query String Parameters
Examples Delete a single policy
Delete multiple seedspolicies
Response
Status
|