Create a policy

Changed on Jun 3, 2026

post/v1/workspaces/{workspaceId}/policies

Request

Base URL
http://localhost:3001/api
URL
http://localhost:3001/api/v1/workspaces/{workspaceId}/policies
Auth
- API key in header X-API-Key
- or HTTP bearer

Path parameters

workspaceIdstring required

ID of the workspace

Request body

descriptionstring

enabledboolean

metadataobject

Arbitrary metadata for the policy (record<string, string>)

namestring required

priorityinteger

selectorstring

CEL expression for matching release targets. Use "true" to match all targets.

Example request

{
  "rules": [
    {
      "verification": {
        "metrics": [
          {
            "failureCondition": "result.statusCode == 500",
            "intervalSeconds": 30,
            "provider": {
              "url": "http://{{ .resource.name }}.{{ .environment.name }}/health"
            },
            "successCondition": "result.statusCode == 200"
          }
        ]
      }
    }
  ]
}

Response

Accepted response

createdAtstring required

descriptionstring

enabledboolean required

idstring required

metadataobject required

Arbitrary metadata for the policy (record<string, string>)

namestring required

priorityinteger required

selectorstring required