Create or update policy

Create or update a Policy in an organization.

PUT /policies/{org}

Create or update policy

cURL

curl --request PUT \
  --url https://app.kosli.com/api/v2/policies/{org} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'payload={
  "name": "<string>",
  "description": "",
  "type": "env",
  "comment": ""
}' \
  --form 'policy_file=<string>'

200

{
  "name": "<string>",
  "description": "<string>",
  "created_by": "<string>",
  "created_at": 123,
  "last_modified_at": 123,
  "archived": false,
  "versions": [],
  "events": [],
  "consuming_envs": []
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org · string · required

Body

multipart/form-data

payload · PolicyPutInput · object · required

Policy metadata in JSON format

Show child attributes

Example:

{
  "comment": "Initial version",
  "description": "Production environment policy",
  "name": "production-policy",
  "type": "env"
}

policy_file · string | null

The YAML policy file to upload (max size: 10MB)

Response

200

application/json

Update Success

Response model for a policy

This represents the response structure when retrieving, creating or updating a policy.

name · string · required

description · string · required

created_by · string · required

created_at · number | null

last_modified_at · number | null

archived · boolean · default: false

versions · VersionedPolicy · object[]

Show child attributes

events · PolicyEvent · object[]

Show child attributes

consuming_envs · string[]