SupportSnyk LearnAPI referenceProduct updatesSign up for free

Projects

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

Note: For a list of Project types, see Project type responses from the API.

List all Projects for an Org with the given Org ID.

get

List all Projects for an Org.

Authorizations
Path parameters
org_idstring · uuidRequired

The ID of the org that the projects belong to.

Query parameters
target_idstring · uuid[]Optional

Return projects that belong to the provided targets

target_referencestringOptional

Return projects that match the provided target reference

target_filestringOptional

Return projects that match the provided target file

target_runtimestringOptional

Return projects that match the provided target runtime

meta_countstring · enumOptional

The collection count.

Possible values:
idsstring · uuid[]Optional

Return projects that match the provided IDs.

namesstring[]Optional

Return projects that match the provided names.

names_start_withstring[]Optional

Return projects with names starting with the specified prefix.

originsstring[]Optional

Return projects that match the provided origins.

typesstring[]Optional

Return projects that match the provided types.

meta.latest_issue_countsbooleanOptional

Include a summary count for the issues found in the most recent scan of this project

meta.latest_dependency_totalbooleanOptional

Include the total number of dependencies found in the most recent scan of this project

cli_monitored_beforestring · date-timeOptional

Filter projects uploaded and monitored before this date (encoded value)

Example: 2021-05-29T09:50:54.014Z
cli_monitored_afterstring · date-timeOptional

Filter projects uploaded and monitored after this date (encoded value)

Example: 2021-05-29T09:50:54.014Z
importing_user_public_idstring[]Optional

Return projects that match the provided importing user public ids.

tagsstring[]Optional

Return projects that match all the provided tags

Example: ["key1:value1","key2:value2"]
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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_afterstringOptional

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=
ending_beforestringOptional

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
get
GET /rest/orgs/{org_id}/projects HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "build_args": {
          "root_workspace": "text"
        },
        "business_criticality": [
          "medium"
        ],
        "created": "2021-05-29T09:50:54.014Z",
        "environment": [
          "external",
          "hosted"
        ],
        "lifecycle": [
          "production"
        ],
        "name": "snyk/goof",
        "origin": "github",
        "read_only": true,
        "settings": {
          "auto_dependency_upgrade": {
            "ignored_dependencies": [
              "typescript"
            ],
            "is_enabled": true,
            "is_major_upgrade_enabled": true,
            "limit": 10,
            "minimum_age": 365
          },
          "auto_remediation_prs": {
            "is_backlog_prs_enabled": true,
            "is_fresh_prs_enabled": true,
            "is_patch_remediation_enabled": true
          },
          "manual_remediation_prs": {
            "is_patch_remediation_enabled": true
          },
          "pull_request_assignment": {
            "assignees": [
              "my-github-username"
            ],
            "is_enabled": true,
            "type": "auto"
          },
          "pull_requests": {
            "fail_only_for_issues_with_fix": true,
            "policy": "all",
            "severity_threshold": "high"
          },
          "recurring_tests": {
            "frequency": "daily"
          }
        },
        "status": "active",
        "tags": [
          {
            "key": "tag-key",
            "value": "tag-value"
          }
        ],
        "target_file": "package.json",
        "target_reference": "main",
        "target_runtime": "text",
        "type": "maven"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "cli_monitored_at": "2021-05-29T09:50:54.014Z",
        "latest_dependency_total": {
          "total": 1,
          "updated_at": "2025-04-28T20:54:38.036Z"
        },
        "latest_issue_counts": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1,
          "updated_at": "2025-04-28T20:54:38.036Z"
        }
      },
      "relationships": {
        "importer": {
          "data": {
            "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
            "type": "resource"
          },
          "links": {
            "related": {
              "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
            }
          }
        },
        "organization": {
          "data": {
            "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
            "type": "resource"
          },
          "links": {
            "related": {
              "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
            }
          }
        },
        "owner": {
          "data": {
            "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
            "type": "resource"
          },
          "links": {
            "related": {
              "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
            }
          }
        },
        "target": {
          "data": {
            "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
            "type": "resource"
          },
          "links": {
            "related": {
              "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
            }
          }
        }
      },
      "type": "project"
    }
  ],
  "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"
  },
  "meta": {
    "count": 1
  }
}

Updates project by project ID.

patch

Updates one project of the organization by project ID.

Authorizations
Path parameters
org_idstring · uuidRequired

The ID of the Org the project belongs to.

project_idstring · uuidRequired

The ID of the project to patch.

Query parameters
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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
Responses
patch
PATCH /rest/orgs/{org_id}/projects/{project_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 350

{
  "data": {
    "attributes": {
      "business_criticality": [
        "medium"
      ],
      "environment": [
        "external",
        "hosted"
      ],
      "lifecycle": [
        "production"
      ],
      "tags": [
        {
          "key": "tag-key",
          "value": "tag-value"
        }
      ],
      "test_frequency": "daily"
    },
    "id": "331ede0a-de94-456f-b788-166caeca58bf",
    "relationships": {
      "owner": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "user"
        }
      }
    },
    "type": "project"
  }
}
{
  "data": {
    "attributes": {
      "build_args": {
        "root_workspace": "text"
      },
      "business_criticality": [
        "medium"
      ],
      "created": "2021-05-29T09:50:54.014Z",
      "environment": [
        "external",
        "hosted"
      ],
      "lifecycle": [
        "production"
      ],
      "name": "snyk/goof",
      "origin": "github",
      "read_only": true,
      "settings": {
        "auto_dependency_upgrade": {
          "ignored_dependencies": [
            "typescript"
          ],
          "is_enabled": true,
          "is_major_upgrade_enabled": true,
          "limit": 10,
          "minimum_age": 365
        },
        "auto_remediation_prs": {
          "is_backlog_prs_enabled": true,
          "is_fresh_prs_enabled": true,
          "is_patch_remediation_enabled": true
        },
        "manual_remediation_prs": {
          "is_patch_remediation_enabled": true
        },
        "pull_request_assignment": {
          "assignees": [
            "my-github-username"
          ],
          "is_enabled": true,
          "type": "auto"
        },
        "pull_requests": {
          "fail_only_for_issues_with_fix": true,
          "policy": "all",
          "severity_threshold": "high"
        },
        "recurring_tests": {
          "frequency": "daily"
        }
      },
      "status": "active",
      "tags": [
        {
          "key": "tag-key",
          "value": "tag-value"
        }
      ],
      "target_file": "package.json",
      "target_reference": "main",
      "target_runtime": "text",
      "type": "maven"
    },
    "id": "331ede0a-de94-456f-b788-166caeca58bf",
    "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"
    },
    "meta": {
      "cli_monitored_at": "2021-05-29T09:50:54.014Z"
    },
    "relationships": {
      "importer": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      },
      "organization": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      },
      "owner": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      },
      "target": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      }
    },
    "type": "project"
  },
  "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 project by project ID.

get

Get one project of the organization by project ID.

Authorizations
Path parameters
org_idstring · uuidRequired

The ID of the org to which the project belongs to.

project_idstring · uuidRequired

The ID of the project.

Query parameters
meta.latest_issue_countsbooleanOptional

Include a summary count for the issues found in the most recent scan of this project

meta.latest_dependency_totalbooleanOptional

Include the total number of dependencies found in the most recent scan of this project

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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
get
GET /rest/orgs/{org_id}/projects/{project_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "build_args": {
        "root_workspace": "text"
      },
      "business_criticality": [
        "medium"
      ],
      "created": "2021-05-29T09:50:54.014Z",
      "environment": [
        "external",
        "hosted"
      ],
      "lifecycle": [
        "production"
      ],
      "name": "snyk/goof",
      "origin": "github",
      "read_only": true,
      "settings": {
        "auto_dependency_upgrade": {
          "ignored_dependencies": [
            "typescript"
          ],
          "is_enabled": true,
          "is_major_upgrade_enabled": true,
          "limit": 10,
          "minimum_age": 365
        },
        "auto_remediation_prs": {
          "is_backlog_prs_enabled": true,
          "is_fresh_prs_enabled": true,
          "is_patch_remediation_enabled": true
        },
        "manual_remediation_prs": {
          "is_patch_remediation_enabled": true
        },
        "pull_request_assignment": {
          "assignees": [
            "my-github-username"
          ],
          "is_enabled": true,
          "type": "auto"
        },
        "pull_requests": {
          "fail_only_for_issues_with_fix": true,
          "policy": "all",
          "severity_threshold": "high"
        },
        "recurring_tests": {
          "frequency": "daily"
        }
      },
      "status": "active",
      "tags": [
        {
          "key": "tag-key",
          "value": "tag-value"
        }
      ],
      "target_file": "package.json",
      "target_reference": "main",
      "target_runtime": "text",
      "type": "maven"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "meta": {
      "cli_monitored_at": "2021-05-29T09:50:54.014Z",
      "latest_dependency_total": {
        "total": 1,
        "updated_at": "2025-04-28T20:54:38.036Z"
      },
      "latest_issue_counts": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1,
        "updated_at": "2025-04-28T20:54:38.036Z"
      }
    },
    "relationships": {
      "importer": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      },
      "organization": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      },
      "owner": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      },
      "target": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      }
    },
    "type": "project"
  },
  "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 project by project ID.

delete

Delete one project in the organization by project ID.

Authorizations
Path parameters
org_idstring · uuidRequired

The ID of the org to which the project belongs to.

project_idstring · uuidRequired

The ID of the project.

Query parameters
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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
delete
DELETE /rest/orgs/{org_id}/projects/{project_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousProjects (v1)NextPull Request Templates

Last updated

Was this helpful?