v1

latestOpenAPI 3.0.02026-07-1799139348.0 KB

Get a policy by ID

get/v1/workspaces/{workspaceId}/policies/{policyId}

Path parameters

workspaceIdstring required

ID of the workspace

policyIdstring required

ID of the policy

Response

OK response

createdAtstring required
descriptionstring
enabledboolean required
idstring required
metadataobject required

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

namestring required
priorityinteger required
selectorstring required

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

workspaceIdstring required

Example response

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