Skip to content

Apply policy to a project

POST
/api/v1/projects/{projectId}/policies/{policyId}
curl --request POST \
--url https://localhost:10001/api/v1/projects/1/policies/1 \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example" }'

Link a policy to a specific project instance and return the created project policy

projectId
required
integer

Project ID

policyId
required
integer

Policy ID

Request body with policy name

Media type application/json
object
name
string
Example generated
{
"name": "example"
}

Created project policy

Media type application/json
object
appliedAt
string
appliedBy
string
archivedAt
string
archivedBy
string
cid
string
createdAt
string
id
integer
isArchived
boolean
isReapplied
boolean
name
string
policyId
integer
projectId
integer
slug
string
status
string
subjectCid
string
updatedAt
string
Example generated
{
"appliedAt": "example",
"appliedBy": "example",
"archivedAt": "example",
"archivedBy": "example",
"cid": "example",
"createdAt": "example",
"id": 1,
"isArchived": true,
"isReapplied": true,
"name": "example",
"policyId": 1,
"projectId": 1,
"slug": "example",
"status": "example",
"subjectCid": "example",
"updatedAt": "example"
}

Bad request - Invalid project ID, policy ID, or request body

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Project or policy not found

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Policy already applied to project

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Internal server error

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}