policy

Update an existing Agent Policy

put/policies/agent/{id}

Headers

Authorizationstring jwt required

User's access token.

Request body

namestring

A unique name label

descriptionstring

User description of this Policy

tagsobject

User defined key/values for organization and searching

Example request

{
  "name": "my-policy",
  "tags": {
    "region": "eu",
    "node_type": "dns"
  }
}

Response

Policy object

idstring uuid required

Unique identifier (UUID)

namestring

A unique name label

descriptionstring

User description of this Policy

tagsobject

User defined key/values for organization and searching

backendstring

The policy backend to use. Cannot change once created.

ts_createdstring date-time

Timestamp of creation

versioninteger

A monotonically increasing counter starting at 0 on creation and increasing with each policy update.

policyobject

Agent backend specific policy data.

Example response

{
  "name": "my-policy",
  "tags": {
    "region": "eu",
    "node_type": "dns"
  },
  "backend": "pktvisor"
}

Changes