This page is in development and as such, its contents may be incorrect

Get all policies

Lists all the policies configured in the Aspire

Query String Parameters

Response

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle",
    ...
  },
  {
    "id": "AAABcIueWUc=",
    "type": "execution",
    ...
  }],
  "message": "optional response message"
}

Status

Get a single policy

Get information about a single policy configured in Aspire

Path Parameters

Response

{
  "policy": {
    "id": "AAABcID5GBc=",
    "type": "throttle",
    ...
 },

  "message": "optional response message"
}

Status

Add

policies

Adds one policy or more policies to Aspire

Request Body Parameters

Other parameters passed in the request body will depend on the type of policy being created

Examples

Add a single policy

POST /aspire_api/policies
{
  "type": "Throttle",
  "description": "Europe Net Appliance throttle"
  ...
}

Add multiple policies

POST /aspire_api/policies
[{
  "type": "Throttle",
  "description": "Europe Net Appliance throttle"
  ...
},
{
  "type": "Route",
  "description": "German server"
  ...
}]

Response

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance"
    ...
   }],
  "message": "optional response message"
}

Status

Update

policies

Update a policy in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null

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 API above

Examples

Update a single policy

PUT /aspire_api/policies/AAABcID5GBc%3D
{
  "id": "AAABcID5GBc=",
  "type": "throttle"
  "description": "Europe Net Appliance"
  ...
}

Update multiple policies

PUT /aspire_api/policies
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance"
    ...
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "German server"
    ...
  }
}

Response

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance"
    ...
   }],
  "message": "optional response message"
}

Status

Delete

policies

Delete one or more policies from Aspire.

Panel
borderColor black bgColor #fafafb
DELETE /aspire_api/policypolicies/:id DELETE /aspire_api/policypolicies

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the policy(s) to delete

Examples

Delete a single policy

Code Block
language js
{ "id": "AAABcID5GBc=" }DELETE /aspire_api/policies/AAABcID5GBc%3D

Delete multiple seeds

Code Block
language js
[{ "id": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=" }]

Delete multiple policies (alternative form)

Code Block
language js
{ "id": ["AAABcID5GBc=", "AAABcIueWUc="] }DELETE /aspire_api/policies?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D

Response

Code Block
language js
{ "message": "optional response message" }

Status

Response code	Description
200	Success
404	Not found - a given seed identifier was not found
406	Not acceptable - there was an issue validating the input