The policies API provides functionality that allows a administrator to add, delete or update policies

Table of Contents

Section

Get all policies

Lists all the policies configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/policies

Query String Parameters

Name	Type	Required	Description
type	string	Optional	Filter returned seeds to only those with the given type
description	string	Optional	Filter returned seeds to only those whose description matches the given expression

Response

Code Block

language	js

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle",
    ..."timeUnit": "m",
	"numberOfDocuments": "100"
  },
  {
    "id": "AAABcIueWUc=",
    "type": "executionroute",
     ..."tags": ["US","UK","DEU"]
  }]
}

Status

Response code	Description
200	Success

Section

Get a single policy

Get information about a single policy configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/policies/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the policy to return

Response

Code Block

language	js

{
  "policy": {
    "id": "AAABcID5GBc=",
    "type": "throttle",
    ... "timeUnit": "m",
	"numberOfDocuments": "100"
 }
}

Status

Response code	Description
200	Success

Section

Add policies

Adds one or more policies to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies

Request Body Parameters

Name	Type	Required	Description
type	string	Required	The type of policy to add
description	string	Optional	An optional description of the seed

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

Throttle type:

Name	Type	Required	Description
timeUnit	string	Required	Time unit of the throttling policy
numberOfDocuments	int	Required	Number of documents per time unit for the throttling policy

Route type:

Name	Type	Required	Description
tags	string	Required	Tags for the routing policy

Examples

Add a single policy

Code Block

language	js

POST /aspire/_api/policies
{
  "type": "Throttle",
  "description": "Europe Net Appliance throttle",
   ..."timeUnit": "m",
  "numberOfDocuments": "100"
}

Add multiple policies

Code Block

language	js

POST /aspire_api/policies
[{
  "type": "Throttle",
  "description": "Europe Net Appliance throttle",
  "timeUnit": "s",
  ..."numberOfDocuments": "10"
},
{
  "type": "Route",
  "description": "German server",
  ..."tags": ["US","UK","DEU"]
}]

Response

Code Block

language	js

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance",
    "timeUnit": "s",
     ..."numberOfDocuments": "10"
   }]
}

Status

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Section

Update policies

Update a policy in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/policies/:id

PUT /aspire_api/policies

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the policy to update
type	string	Optional	The type of policy
description	string	Optional	An optional description of the seed

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

Code Block

language	js

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

Update multiple policies

Code Block

language	js

PUT /aspire_api/policies
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance",
	"timeUnit": "s",
   ... "numberOfDocuments": "10"
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "German server",
    ... "tags": ["DEU"]
  }
}

Response

Code Block

language	js

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance",
	"timeUnit": "s",
    ..."numberOfDocuments": "10"
   }]
}

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

Section

Delete policies

Delete one or more policies from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/policies/:id

DELETE /aspire_api/policies

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

DELETE /aspire_api/policies/AAABcID5GBc%3D

Delete multiple seeds

Code Block

language	js

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

Page tree

Versions Compared

Old Version 11

New Version 12

Key

Get all policies

Get a single policy

Add policies

Update policies

Delete policies

Page tree

Page History

Versions Compared

Old Version 11

New Version 12

Key

Get all policies

Get a single policy

Add policies

Update policies

Delete policies