Collection

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

Create a collection

POSThttps://api.snyk.io/rest/orgs/{org_id}/collections

Path parameters

org_id*string (uuid)

Org ID

Query parameters

Body

data*object

Response

Returned collection

Headers

Body

dataobject

collection resource object

jsonapiJsonApi (object)

linksSelfLink (object)

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "resource",
        "attributes": {
          "name": "text"
        }
      }
    }),
});
const data = await response.json();

Response

{
  "data": {
    "attributes": {
      "is_generated": false,
      "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"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get collections

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

GEThttps://api.snyk.io/rest/orgs/{org_id}/collections

Path parameters

org_id*string (uuid)

Org ID

Query parameters

Response

Returns a list of collections

Headers

Body

dataarray of CollectionResponse (object)

jsonapiJsonApi (object)

linksPaginatedLinks (object)

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "attributes": {
        "is_generated": false,
        "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"
    }
  ],
  "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"
  }
}

Edit a collection

PATCHhttps://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}

Path parameters

org_id*string (uuid)

Org ID

collection_id*string (uuid)

Unique identifier for a collection

Query parameters

Body

data*object

Response

Returned collection

Headers

Body

dataobject

collection resource object

jsonapiJsonApi (object)

linksSelfLink (object)

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "resource",
        "attributes": {
          "name": "text"
        }
      }
    }),
});
const data = await response.json();

Response

{
  "data": {
    "attributes": {
      "is_generated": false,
      "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"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get a collection

GEThttps://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}

Path parameters

org_id*string (uuid)

Org ID

collection_id*string (uuid)

Unique identifier for a collection

Query parameters

Response

Returned collection

Headers

Body

dataobject

collection resource object

jsonapiJsonApi (object)

linksSelfLink (object)

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "attributes": {
      "is_generated": false,
      "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"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Delete a collection

DELETEhttps://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}

Path parameters

org_id*string (uuid)

Org ID

collection_id*string (uuid)

Unique identifier for a collection

Query parameters

Response

Collection was deleted successfully

Headers

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Add projects to a collection

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

POSThttps://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects

Path parameters

org_id*string (uuid)

Org ID

collection_id*string (uuid)

Unique identifier for a collection

Query parameters

Body

data*array of object

IDs of items to add to a collection

Response

successfully adding projects to a collection

Headers

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "project"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Get projects from the specified collection

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

GEThttps://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects

Path parameters

org_id*string (uuid)

Org ID

collection_id*string (uuid)

Unique identifier for a collection

Query parameters

Response

Returns a list of projects from the specified collection

Headers

Body

dataarray of ProjectOfCollection (object)

jsonapiJsonApi (object)

linksPaginatedLinks (object)

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
      },
      "relationships": {
        "target": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "target"
          }
        }
      },
      "type": "resource"
    }
  ],
  "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"
  }
}

Remove projects from a collection

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

DELETEhttps://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects

Path parameters

org_id*string (uuid)

Org ID

collection_id*string (uuid)

Unique identifier for a collection

Query parameters

Body

data*array of object

IDs of items to remove from a collection

Response

successfully removing projects from a collection

Headers

Request

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/collections/{collection_id}/relationships/projects?version=text', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "project"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

PreviousAudit Logs NextContainerImage

Last updated 4 months ago