Policies
Snyk API reference for the Policies endpoints, including request parameters and response schemas
Create a new org-level policy.
Org level Policy APIs Access Notice: Org level Policy APIs are only available for use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores see this documentation.
Required permissions
Create Ignores (org.project.ignore.create)
API key value must be prefixed with "Token ".
Org ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$A single policy is returned if it is successfully created.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /rest/orgs/{org_id}/policies?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 414
{
"data": {
"attributes": {
"action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"name": "text",
"source": "api"
},
"meta": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"type": "policy"
}
}{
"data": {
"attributes": {
"action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"actor_source": "snyk_user",
"email": "text",
"external_id": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"origin": "bitbucket_cloud"
},
"name": "text",
"review": "pending",
"updated_at": "2024-03-16T00:00:00Z"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://example.com/api/this_resource"
}
}Get all policies for the requested organisation.
Org level Policy APIs Access Notice: Org level Policy APIs are only available for use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores see this documentation.
Required permissions
View Ignores (org.project.ignore.read)
API key value must be prefixed with "Token ".
Org ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Number of results to return per page
10Example: 10Search keyword for searching fields ignored_by.name, ignored_by.email, ignore_type in policy_rules
The column name to sort on
Sorting direction ASC/DESC
Select only policies with an expiry strictly before the given time.
2024-03-16T00:00:00ZSelect only policies with an expiry strictly past the given time.
2024-03-16T00:00:00ZSelect only policies that never expire.
trueThe policies for the requested organisation.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/orgs/{org_id}/policies?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"actor_source": "snyk_user",
"email": "text",
"external_id": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"origin": "bitbucket_cloud"
},
"name": "text",
"review": "pending",
"updated_at": "2024-03-16T00:00:00Z"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Update the org-level policy.
Org level Policy APIs Access Notice: Org level Policy APIs are only available for use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores see this documentation.
Required permissions
Edit Ignores (org.project.ignore.edit)
API key value must be prefixed with "Token ".
Org ID
Policy ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$A single policy is returned if it is successfully updated.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
PATCH /rest/orgs/{org_id}/policies/{policy_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 439
{
"data": {
"attributes": {
"action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"name": "text",
"review": "pending"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"meta": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"type": "policy"
}
}{
"data": {
"attributes": {
"action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"actor_source": "snyk_user",
"email": "text",
"external_id": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"origin": "bitbucket_cloud"
},
"name": "text",
"review": "pending",
"updated_at": "2024-03-16T00:00:00Z"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://example.com/api/this_resource"
}
}Get a specific org-level policy based on its ID.
Org level Policy APIs Access Notice: Org level Policy APIs are only available for use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores see this documentation.
Required permissions
View Ignores (org.project.ignore.read)
API key value must be prefixed with "Token ".
Org ID
Policy ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$The requested policy.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
GET /rest/orgs/{org_id}/policies/{policy_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"attributes": {
"action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"actor_source": "snyk_user",
"email": "text",
"external_id": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"origin": "bitbucket_cloud"
},
"name": "text",
"review": "pending",
"updated_at": "2024-03-16T00:00:00Z"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}Delete an existing org-level policy.
Org level Policy APIs Access Notice: Org level Policy APIs are only available for use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores see this documentation.
Required permissions
Remove Ignores (org.project.ignore.delete)
API key value must be prefixed with "Token ".
Org ID
Policy ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$The operation completed successfully with no content
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
DELETE /rest/orgs/{org_id}/policies/{policy_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Retrieve the event history for the given policy.
Org level Policy APIs Access Notice: Access to our Org level Policy APIs is currently restricted via "snykCodeConsistentIgnores" and "ignoreApprovalWorkflow" feature flags and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
Required permissions
View Ignores (org.project.ignore.read)
API key value must be prefixed with "Token ".
Org ID
Policy ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Number of results to return per page
10Example: 10The requested policy.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
GET /rest/orgs/{org_id}/policies/{policy_id}/events?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"changes": {
"new_action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"new_conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"new_name": "text",
"new_review": "pending",
"old_action": {
"data": {
"expires": "2024-03-16T00:00:00Z",
"ignore_type": "wont-fix",
"reason": "text"
}
},
"old_conditions_group": {
"conditions": [
{
"field": "snyk/asset/finding/v1",
"operator": "includes",
"value": "text"
}
],
"logical_operator": "and"
},
"old_name": "text",
"old_review": "pending"
},
"comment": "text",
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"actor_source": "snyk_user",
"email": "text",
"external_id": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"origin": "bitbucket_cloud"
},
"type": "approve"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy_event"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Create one new group level policy.
Group level Policy APIs Access Notice: Access to our Group level Policy APIs is currently restricted via "use-group-policy-apis" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
Required permissions
Create Policies (group.policy.create)
API key value must be prefixed with "Token ".
Group ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$A single policy is returned if it is successfully created.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /rest/groups/{group_id}/policies?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 270
{
"data": {
"attributes": {
"action": {
"data": {
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "exploit-maturity",
"operator": "includes",
"value": [
"mature"
]
}
],
"logical_operator": "and"
},
"name": "text"
},
"type": "policy"
}
}{
"data": {
"attributes": {
"action": {
"data": {
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "exploit-maturity",
"operator": "includes",
"value": [
"mature"
]
}
],
"logical_operator": "and"
},
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"email": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"name": "text",
"updated_at": "2024-03-16T00:00:00Z"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}Get all policies for the requested group
Group level Policy APIs Access Notice: Access to our Group level Policy APIs is currently restricted via "use-group-policy-apis" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
Required permissions
View Policies (group.policy.read)
API key value must be prefixed with "Token ".
Group ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Number of results to return per page
10Example: 10The group policies for the requested group
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/groups/{group_id}/policies?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"action": {
"data": {
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "exploit-maturity",
"operator": "includes",
"value": [
"mature"
]
}
],
"logical_operator": "and"
},
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"email": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"name": "text",
"updated_at": "2024-03-16T00:00:00Z"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Update the group-level policy.
Group level Policy APIs Access Notice: Access to our Group level Policy APIs is currently restricted via "use-group-policy-apis" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
Required permissions
Edit Policies (group.policy.edit)
API key value must be prefixed with "Token ".
Group ID
Policy ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$A single group policy is returned if it is successfully updated.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
PATCH /rest/groups/{group_id}/policies/{policy_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 314
{
"data": {
"attributes": {
"action": {
"data": {
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "exploit-maturity",
"operator": "includes",
"value": [
"mature"
]
}
],
"logical_operator": "and"
},
"name": "text"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
}
}{
"data": {
"attributes": {
"action": {
"data": {
"ignore_type": "wont-fix",
"reason": "text"
}
},
"action_type": "ignore",
"conditions_group": {
"conditions": [
{
"field": "exploit-maturity",
"operator": "includes",
"value": [
"mature"
]
}
],
"logical_operator": "and"
},
"created_at": "2024-03-16T00:00:00Z",
"created_by": {
"email": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"name": "text",
"updated_at": "2024-03-16T00:00:00Z"
},
"id": "f16c31b5-6129-4571-add8-d589da9be524",
"type": "policy"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://example.com/api/this_resource"
}
}Delete an existing group-level policy.
Group level Policy APIs Access Notice: Access to our Group level Policy APIs is currently restricted via "use-group-policy-apis" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
Required permissions
Delete Policies (group.policy.delete)
API key value must be prefixed with "Token ".
Group ID
Policy ID
Requested API version
2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$The operation completed successfully with no content
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
DELETE /rest/groups/{group_id}/policies/{policy_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?