Versions Compared

Old Version 30

changes.mady.by.user Petr Podsednik

Saved on

compared with

New Version 31

changes.mady.by.user Petr Podsednik

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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
borderColorblack
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
borderColorblack
bgColor#fafafb

POST /aspire/_api/policies/getAll

Pagination query string parameters

Common filter

Response

Code Block
languagejs
{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle",
	"description": "Europe Net Appliance throttle",
    "period": "minute",
	"value": "100"
  },
  {
    "id": "AAABcIueWUc=",
    "type": "route",
	"description": "All servers",
    "routeTo": "US"
  }]
}

Status: 200


Section

Get single policy

Gets information about a single policy configured in Aspire

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/policies/:id


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the policy to return


Response

Code Block
languagejs
{
  "policy": {
    "id": "AAABcID5GBc=",
    "type": "throttle",
	"description": "Europe Net Appliance throttle",
    "period": "minute",
	"value": "100"
 }
}

Status: 200, 404



Section

Add policy(ies)

Adds policies to Aspire

Panel
borderColorblack
bgColor#fafafb
POST /aspire/_api/policies


Body Parameters

NameTypeRequiredDescription
typestringRequired

The type of policy to add

  • "throttle"
  • "route"
descriptionstringRequiredAn optional description of the policy


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


Throttle type:

NameTypeRequiredDescription
periodstringRequiredTime unit of the throttling policy - second, minute, hour, day
valueintRequiredNumber of documents per time unit for the throttling policy


Route type:

NameTypeRequiredDescription
routeTostringRequiredTODO


Example

Code Block
languagejs
POST /aspire_api/policies
[{
  "type": "throttle",
  "description": "Europe Net Appliance throttle",
  "period": "minute",
  "value": "100"
},
{
  "type": "route",
  "description": "German servers",
  "routeTo": "US"
}]


Response

Code Block
languagejs
{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance throttle",
    "period": "minute",
    "value": "100"
   },
   {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "All servers",
    "routeTo": "US"
   }]
}

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

Update policy(ies)

Update policies in Aspire.

Panel
borderColorblack
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

NameTypeRequiredDescription
idstringRequiredThe identifier of the policy to update
...


+ fields from "Add" section...

Example

Code Block
languagejs
PUT /aspire_api/policies
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance",
    "period": "minute",
    "value": "100"
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "German server",
    "routeTo": "US"
  }
}


Response

Code Block
languagejs
{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance",
    "period": "minute",
    "value": "100"
   },
   {
    "id": "AAABcID5GBd=",
    "type": "route"
    "description": "German server",
    "routeTo": "US"
  }]
}

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


Section

Update policies, filtered

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

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/policies/updateAll

Common filter

Update body parameter


Response

Code Block
languagejs
{
  "message": "update result response message"
}

Status: 200, 406


Section

Delete multiple policies, filtered

Delete multiple policies from Aspire, filtered by a specified criteria

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/policies/deleteAll

Common filter


Response

Code Block
languagejs
{
  "message": "optionaldelete result response message"
}

Status: 200


Section

Delete policy(ies)

Delete one or more policies from Aspire.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/policies/:id

DELETE /aspire/_api/policies

POST /aspire/_api/policies/delete


Path Parameters and Query parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the policy(s) to delete


Body Parameter

NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the policy(s) to delete


Examples

Code Block
languagejs
DELETE /aspire/_api/policies/AAABcID5GBc

DELETE /aspire/_api/policies?id=AAABcID5GBc&id=AAABcID5GBd

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


Response

Code Block
languagejs
{
  "message": "delete result response message"
}

Status: 200, 404, 406