Warning

title	Page in development

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

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

Pagination query string parameters

Section

Get all policies, filtered

Lists policies configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies/getAll

Pagination query string parameters

Common filter

Response

Code Block

language	js

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle",
	"description": "Europe Net Appliance throttle",
    "timeUnitperiod": "mminute",
	"timeUnitRate": "1",
	"numberOfDocuments"value": "100"
  },
  {
    "id": "AAABcIueWUc=",
    "type": "route",
	"description": "All servers",
    "tagsrouteTo": ["US","UK","DEU"]
  }]
}

Status

Response code Description

200 Success

Section

Get all policies, filtered

Lists policies configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies/getAll

Pagination query string parameters

Common filter

: 200

: 200, 404

Section

Get single policy

Gets 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

Query String Parameters

Name

	Type	Required	Description
expand	string	Optional	List of fields to expand, * will expand everything

Response

Code Block

language	js

{
  "policy": {
    "id": "AAABcID5GBc=",
    "type": "throttle",
	"description": "Europe Net Appliance throttle",
    "timeUnitperiod": "mminute",
	"timeUnitRate": "1",
	"numberOfDocumentsvalue": "100"
 }
}

Status

Response code Description

200 Success

Not acceptable - there was an issue validating the input

See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors

Status: 201, 406

Section

Add

policies

policy(ies)

Adds policies to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies

Body Parameters

Name

Type

Required

Description

type

string

Required

The type of policy to add

"throttle"
"route"

description

string

Required

An optional description of the policy

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

Throttle type:

Name	Type	Required	Description
timeUnitperiod	string	Required	Time unit of the throttling policy - second, minute, hour, day
valuetimeUnitRate	int	Required	The rate at which each time unit is throttled	numberOfDocuments	int	Required	Number of documents per time unit for the throttling policy

Route type:

Name	Type	Required	Description
tagsrouteTo	array of stringsstring	Required	Tags for the routing policyTODO

Example

Code Block

language	js

POST /aspire_api/policies
[{
  "type": "throttle",
  "description": "Europe Net Appliance throttle",
  "timeUnitperiod": "sminute",
  "timeUnitRatevalue": "10",
  "numberOfDocuments": "10"100"
},
{
  "type": "route",
  "description": "German servers",
  "tagsrouteTo": ["US","UK","DEU"]
}]

Response

Code Block

language	js

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance throttle",
    "timeUnitperiod": "sminute",
    "timeUnitRatevalue": "10",
    "numberOfDocuments": "10"100"
   },
   {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "All servers",
    "tagsrouteTo": ["US","UK","DEU"]
   }]
}

Status

Response code Description

201 Created

406

Section

Update

policies

policy(ies)

Update policies in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/policies/:id

PUT /aspire_api/policies

Note
The existing document will be replaced by the new one provided in the body

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
...

+ fields from "Add" section...Other parameters passed in the request body will depend on the type of policy being created - see Add a Policy above

Example

Code Block

language	js

PUT /aspire_api/policies
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance",
	"timeUnit": "s",
    "timeUnitRateperiod": "1minute",
    "numberOfDocumentsvalue": "10100"
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "German server",
    "tagsrouteTo": ["DEUUS"]
  }
}

Response

Code Block

language	js

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance",
	"timeUnit": "s",
	"timeUnitRate    "period": "1minute",
    "numberOfDocumentsvalue": "10100"
   },
   {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "German server",
    "tagsrouteTo": ["DEUUS"]
  }]
}

See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors

Status: 200, 404, 406

Not acceptable - there was an issue validating the input

Section

Update policies, filtered

Update policies configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies/updateAll

Common filter

Update body parameter

Response

Code Block

Description

language

200 Success

404 Not found - a given seed identifier was not found

406

js

{
  "message": "update result response message"
}

Status: 200, 406

Filters retrieved policies. Check the filter definition here

Common filter

Response

Section

Delete multiple policies, filtered

Delete multiple policies from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies/deleteAll

Body Parameters

Name Type Required Description

filter JSON Required

Code Block

language	js

{
  "message": "optional response message"
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

Response codeDescription200Success404Not found - a given credential identifier was not found406Not acceptable - there was an issue validating the input

Status: 200

Not acceptable - there was an issue validating the input

: 200, 404, 406

Section

Delete policy(ies)

Delete a single policy one or more policies from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/policies/:id

DELETE /aspire/_api/policies

POST /aspire/_api/policies/delete

Path Parameters and Query parameters

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

Body Parameter

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

ExamplesExample

Code Block

language	js

DELETE /aspire/_api/policies/AAABcID5GBc

DELETE /aspire/_api/policies/AAABcID5GBc%3D

Delete multiple policies

?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/policies/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js

{
  "message": "optionaldelete result response message"
}

Status

Response code Description

200 Success

404 Not found - a given seed identifier was not found

406

Page tree

Versions Compared

Old Version 26

New Version 27

Key

Get all policies

Get all policies, filtered

Get all policies, filtered

Get single policy

Add

policy(ies)

Update

policy(ies)

Update policies, filtered

Delete multiple policies, filtered

Delete policy(ies)

Page tree

Page History

Versions Compared

Old Version 26

New Version 27

Key

Get all policies

Get all policies, filtered

Get all policies, filtered

Get single policy

Add

policy(ies)

Update

policy(ies)

Update policies, filtered

Delete multiple policies, filtered

Delete policy(ies)