Support Snyk Learn API reference Product updates Sign up for free

Policies

This document uses the REST API. For more details, see the Authentication for API page.

Last updated 15 days ago

Was this helpful?

Create a new org-level policy

Create a new org-level policy.

Org level Policy APIs Access Notice: Access to our Org level Policy APIs is currently restricted via "snykCodeConsistentIgnores" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.

post

/orgs/{org_id}/policies

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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))?))$

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/policies?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"action":{"data":{"expires":"2024-03-16T00:00:00Z","ignore_type":"wont-fix"}},"conditions_group":{"logical_operator":"and","conditions":[{"value":"text","field":"snyk/asset/finding/v1","operator":"includes"}]},"name":"text","action_type":"ignore"},"type":"policy"}}'

201

400

401

403

404

500

{
  "data": {
    "attributes": {
      "action": {
        "data": {
          "expires": "2024-03-16T00:00:00Z",
          "ignore_type": "wont-fix"
        }
      },
      "conditions_group": {
        "logical_operator": "and",
        "conditions": [
          {
            "value": "text",
            "field": "snyk/asset/finding/v1",
            "operator": "includes"
          }
        ]
      },
      "created_at": "2024-03-16T00:00:00Z",
      "created_by": {
        "email": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "name": "text",
      "review": "pending",
      "updated_at": "2024-03-16T00:00:00Z",
      "action_type": "ignore"
    },
    "id": "f16c31b5-6129-4571-add8-d589da9be524",
    "type": "policy"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

A single policy is returned if it is successfully created.

Get org-level policies

Get all policies for the requested organisation.

get

/orgs/{org_id}/policies

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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))?))$

starting_afterstring

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestring

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger · int32 · min: 10 · max: 100 · default: 10

Number of results to return per page

Example: 10

reviewstring · enum[]

Policy rule review state e.g. approved

expires_beforestring · date-time

Select only policies with an expiry strictly before the given time.

Example: 2024-03-16T00:00:00Z

expires_afterstring · date-time

Select only policies with an expiry strictly past the given time.

Example: 2024-03-16T00:00:00Z

expires_neverboolean

Select only policies that never expire.

Example: true

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/policies?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

{
  "data": [
    {
      "attributes": {
        "action": {
          "data": {
            "expires": "2024-03-16T00:00:00Z",
            "ignore_type": "wont-fix"
          }
        },
        "conditions_group": {
          "logical_operator": "and",
          "conditions": [
            {
              "value": "text",
              "field": "snyk/asset/finding/v1",
              "operator": "includes"
            }
          ]
        },
        "created_at": "2024-03-16T00:00:00Z",
        "created_by": {
          "email": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "name": "text",
        "review": "pending",
        "updated_at": "2024-03-16T00:00:00Z",
        "action_type": "ignore"
      },
      "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"
  }
}

The policies for the requested organisation.

Update an org-level policy

Update the org-level policy.

patch

/orgs/{org_id}/policies/{policy_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

policy_idstring · uuidrequired

Policy ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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))?))$

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/policies/{policy_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"action":{"data":{"expires":"2024-03-16T00:00:00Z","ignore_type":"wont-fix"}},"conditions_group":{"logical_operator":"and","conditions":[{"value":"text","field":"snyk/asset/finding/v1","operator":"includes"}]},"review":"pending"},"id":"f16c31b5-6129-4571-add8-d589da9be524","type":"policy","meta":{"key1":"value1","key3":["array_value1","array_value2"],"key2":{"sub_key":"sub_value"}}}}'

200

400

401

403

404

409

{
  "data": {
    "attributes": {
      "action": {
        "data": {
          "expires": "2024-03-16T00:00:00Z",
          "ignore_type": "wont-fix"
        }
      },
      "conditions_group": {
        "logical_operator": "and",
        "conditions": [
          {
            "value": "text",
            "field": "snyk/asset/finding/v1",
            "operator": "includes"
          }
        ]
      },
      "created_at": "2024-03-16T00:00:00Z",
      "created_by": {
        "email": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "name": "text",
      "review": "pending",
      "updated_at": "2024-03-16T00:00:00Z",
      "action_type": "ignore"
    },
    "id": "f16c31b5-6129-4571-add8-d589da9be524",
    "type": "policy"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

A single policy is returned if it is successfully updated.

Get an org-level policy

Get a specific org-level policy based on its ID.

get

/orgs/{org_id}/policies/{policy_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

policy_idstring · uuidrequired

Policy ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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))?))$

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/policies/{policy_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

{
  "data": {
    "attributes": {
      "action": {
        "data": {
          "expires": "2024-03-16T00:00:00Z",
          "ignore_type": "wont-fix"
        }
      },
      "conditions_group": {
        "logical_operator": "and",
        "conditions": [
          {
            "value": "text",
            "field": "snyk/asset/finding/v1",
            "operator": "includes"
          }
        ]
      },
      "created_at": "2024-03-16T00:00:00Z",
      "created_by": {
        "email": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "name": "text",
      "review": "pending",
      "updated_at": "2024-03-16T00:00:00Z",
      "action_type": "ignore"
    },
    "id": "f16c31b5-6129-4571-add8-d589da9be524",
    "type": "policy"
  },
  "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"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

The requested policy.

Delete an org-level policy

Delete an existing org-level policy.

delete

/orgs/{org_id}/policies/{policy_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

policy_idstring · uuidrequired

Policy ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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))?))$

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/policies/{policy_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

500

No body

The operation completed successfully with no content