POST /aspire_api/policies
[{
  "type": "filesystemthrottle",
  "description": "Europe Net Appliance throttle",
  "period": "minute"
  ...
}

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "filesystemthrottle"
    "description": "Europe Net Appliance throttle",
    "period": "minute",
    ..."value": "100"
   },
   {
    "id": "AAABcID5GBd=",
    "type": "AAABcIueWUc=route"
    "description": "All servers",
    "routeTo": "US"
   },
	{
    "id": "AAABcID5GBe=",
    "type": "deleteIncremental",
  	"description": "Days before delete",
  	"deletesPolicy": "AFTER_DAYS",
  	"value": "1"
   },
	{
    "id": "AAABcID5GBf=",
    "type": "sharepointdeleteIncremental",
    "description": "SP Online"Iterations before delete",
    "deletesPolicy": "AFTER_INCREMENTALS",
    ..."value": "2"
  }] },
	{
    "id": "AAABcID5GBg=",
    "description": "default immediate policy",
  	"messagedeletesPolicy": "IMMEDIATE"optional response message"
}

,
  	"deleteCheckAfterErrors": "ALWAYS"
   }
]
}

Update policy(

ies)

Update one or more policys 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 nullpolicies in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Request Body Parameters

Other parameters passed in the request body will depend on the type of policy being created - see Add policy(s) above

Examples

x - at least one field must be present

ExampleUpdate a single policy

PUT /aspire_api/policies
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "typedescription": "filesystemEurope Net Appliance",
    "descriptionperiod": "Europe Net Applianceminute",
    "value": "100"
  ...
}

Update multiple policies

[{
},
  "AAABcID5GBd=": {
    "id": "AAABcID5GBcAAABcID5GBd=",
    "typedescription": "filesystemGerman server",
    "descriptionrouteTo": "Europe Net ApplianceUS"
  ...
},
"AAABcID5GBe=": {
    "id": "AAABcIueWUcAAABcID5GBe=",
    "typedescription": "sharepointdefault immediate policy",
    "descriptiondeleteCheckAfterErrors": "SP OnlineNEVER"
  ...
}]

Response

{
  "policy},
"AAABcID5GBf=": [{
    "id": "AAABcID5GBcAAABcID5GBf=",
    "typedescription": "filesystemIterations before delete",
    "descriptionvalue": "3"Europe Net Appliance"
    ...
   },
   {
 }

Response

{"policy":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="},{"updated":true,"id":"AAABcID5GBe="},{"updated":true,"id":"AAABcID5GBf="}]}

Status: 200, 404, 406

{
  "update" : {
    "description" : "DESCRIPTION"
    "

period" : "

PERIOD"

    "

value" : "

VALUE"
    "

routeTo" : "

ROUTE_TO"
    

"deleteCheckAfterErrors" : "NEVER"
  

}
}

{
  "message": "

update result response message"
}

: 200, 406

Delete policy(

ies)

Delete one or more policies from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Query String, Path Parameters and Request Body ParametersQuery parameters

Examples

Delete a single policy

Body Parameter

Examples

DELETE /aspire/_api/policies/AAABcID5GBc

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

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

Delete multiple seedsResponse

[{
  "idmessage": "AAABcID5GBc=delete result response message"
},

Status: 200, 404, 406

{
  "

message": "

delete result response message"
}

   "policy": [
        {
          "id": "<policy_id>",
          "type": "deleteIncremental",
          "description": "pD",
          "deletesPolicy": "IMMEDIATE",
          "deleteCheckAfterErrors": "ALWAYS"
        },
        ...
      ]
    }
  }
}