v1

latestOpenAPI 3.0.0Apache 2.02026-07-17504188.8 KB

Policy

Update a policy.

put/v1/{tenantId}/policies/{policyId}

Request body

Idstring

The policy ID, generated by server

TenantIdstring

The tenant UUID in a multi-tenancy environment.

Namestring

Policy Name.

Descriptionstring

Description of policy.

Example request

{
  "Id": "5bd6f273b0bdf90001dc91c3",
  "TenantId": "94b280022d0c4401bcf3b0ea85870519",
  "Name": "policy001",
  "Description": "Migration Policy",
  "Schedule": {
    "Type": "cron"
  }
}

Response

successful operation

Example response

{
  "policy": {
    "Id": "5bd6f273b0bdf90001dc91c3",
    "TenantId": "94b280022d0c4401bcf3b0ea85870519",
    "Name": "policy001",
    "Description": "Migration Policy",
    "Schedule": {
      "Type": "cron"
    }
  }
}