Support Snyk Learn API reference Product updates Sign up for free

Collection

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

PreviousAudit Logs NextContainerImage

Last updated 6 months ago

Was this helpful?

Create a collection

post

/orgs/{org_id}/collections

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}/collections?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"resource","attributes":{"name":"text"}}}'

201

400

401

403

404

409

500

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "attributes": {
      "is_generated": true,
      "name": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "user"
        }
      },
      "org": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "org"
        }
      }
    },
    "type": "resource"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Returned collection

Get collections

Return a list of organization's collections with issues counts and projects count.

get

/orgs/{org_id}/collections

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

sortstring · enum

Return collections sorted by the specified attributes

Options: name, projectsCount, issues

directionstring · enum · default: DESC

Return collections sorted in the specified direction

Options: ASC, DESC

namestring · max: 255

Return collections which names include the provided string

is_generatedboolean

Return collections where is_generated matches the provided boolean

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

500

{
  "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"
  },
  "data": [
    {
      "attributes": {
        "is_generated": true,
        "name": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "issues_critical_count": 10,
        "issues_high_count": 10,
        "issues_low_count": 10,
        "issues_medium_count": 10,
        "projects_count": 7
      },
      "relationships": {
        "created_by_user": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "user"
          }
        },
        "org": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "org"
          }
        }
      },
      "type": "resource"
    }
  ]
}

Returns a list of collections

Edit a collection

patch

/orgs/{org_id}/collections/{collection_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

collection_idstring · uuidrequired

Unique identifier for a collection

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}/collections/{collection_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"resource","attributes":{"name":"text"}}}'

200

400

401

403

404

409

500

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "attributes": {
      "is_generated": true,
      "name": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "user"
        }
      },
      "org": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "org"
        }
      }
    },
    "type": "resource"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Returned collection

Get a collection

get

/orgs/{org_id}/collections/{collection_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

collection_idstring · uuidrequired

Unique identifier for a collection

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}/collections/{collection_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "attributes": {
      "is_generated": true,
      "name": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "user"
        }
      },
      "org": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "org"
        }
      }
    },
    "type": "resource"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Returned collection

Delete a collection

delete

/orgs/{org_id}/collections/{collection_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

collection_idstring · uuidrequired

Unique identifier for a collection

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}/collections/{collection_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

409

500

No body

Collection was deleted successfully

Add projects to a collection

Add projects to a collection by specifying an array of project ids

post

/orgs/{org_id}/collections/{collection_id}/relationships/projects

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

collection_idstring · uuidrequired

Unique identifier for a collection

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

dataobject[]required

IDs of items to add to a collection

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":[{"id":"123e4567-e89b-12d3-a456-426614174000","type":"project"}]}'

204

400

401

403

404

409

500

No body

successfully adding projects to a collection

Get projects from the specified collection

Return a list of organization's projects that are from the specified collection.

get

/orgs/{org_id}/collections/{collection_id}/relationships/projects

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

collection_idstring · uuidrequired

Unique identifier for a collection

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

sortstring · enum

Return projects sorted by the specified attributes

Options: imported, last_tested_at, issues

directionstring · enum · default: DESC

Return projects sorted in the specified direction

Options: ASC, DESC

target_idstring · uuid[]

Return projects that belong to the provided targets

showstring · enum[]

Return projects that are with or without issues

integrationstring · enum[]

Return projects that match the provided integration types

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

500

{
  "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"
  },
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "imported": "2021-05-29T09:50:54.014Z",
        "issues_critical_count": 10,
        "issues_high_count": 10,
        "issues_low_count": 10,
        "issues_medium_count": 10,
        "last_tested_at": "2021-05-29T09:50:54.014Z"
      },
      "type": "resource",
      "relationships": {
        "target": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "target"
          }
        }
      }
    }
  ]
}

Returns a list of projects from the specified collection

Remove projects from a collection

Remove projects from a collection by specifying an array of project ids

delete

/orgs/{org_id}/collections/{collection_id}/relationships/projects

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

collection_idstring · uuidrequired

Unique identifier for a collection

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

dataobject[]required

IDs of items to remove from a collection

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":[{"id":"123e4567-e89b-12d3-a456-426614174000","type":"project"}]}'

204

400

401

403

404

409

500

No body

successfully removing projects from a collection