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

List 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

Query String and Path Parameters

Response

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

  "message": "optional response message"
}

Status

Add a policy

Adds one policy 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

{
  "type": "Throttle"
  "description": "Europe Net Appliance throttle"
  ...
}

Response

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

Status

Update a policy

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

Request Body Parameters

Other parameters passed in the request body will depend on the type of policy being created - see Policy API above

Examples

Update a single policy

{
  "id": "AAABcID5GBc=",
  "type": "throttle"
  "description": "Europe Net Appliance"
  ...
}

Response

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

Status

Delete policy(s)

Delete one or more policies from Aspire.

Query String, Path and Request Body Parameters

Examples

Delete a single policy

{
  "id": "AAABcID5GBc="
}

Delete multiple seeds

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Delete multiple policies (alternative form)

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

{
  "message": "optional response message"
}

Status