CLcloudsmith
workspaces

POST /workspaces/{workspace}/policies/

Changed on

Create a policy.

Request

  • Base URL
    https://api.cloudsmith.io/v2
  • Auth
    • API key in header X-Api-Key
    • or HTTP basic

Path parameters

workspacestring required

The name of the Workspace.

Request body

created_atstring date-time required

The date and time the policy was created.

descriptionstring nullable

The description of the Policy.

namestring required

The name of the Policy.

regostring required

The rego code which constitutes the Policy logic.

enabledboolean

If true, the policy is enabled.

is_terminalboolean

If true and the policy matches, no further policies are evaluated.

read_onlyboolean required

Whether this policy is read-only (only specific variables can be updated).

slug_permstring required

The Policy identifier.

updated_atstring date-time required

The date and time the policy was updated.

versioninteger required

The version of the rego code.

precedenceinteger

The order in which this policy is evaluated relative to other policies.

Response

created_atstring date-time required

The date and time the policy was created.

descriptionstring nullable

The description of the Policy.

namestring required

The name of the Policy.

regostring required

The rego code which constitutes the Policy logic.

enabledboolean

If true, the policy is enabled.

is_terminalboolean

If true and the policy matches, no further policies are evaluated.

read_onlyboolean required

Whether this policy is read-only (only specific variables can be updated).

slug_permstring required

The Policy identifier.

updated_atstring date-time required

The date and time the policy was updated.

versioninteger required

The version of the rego code.

precedenceinteger

The order in which this policy is evaluated relative to other policies.

Changes