Projects

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

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

List all Projects for an Org.

get

/orgs/{org_id}/projects

Authorizations

Path parameters

org_idstring · uuidrequired

The ID of the org that the projects belong to.

Query parameters

target_idstring · uuid[]

Return projects that belong to the provided targets

target_referencestring

Return projects that match the provided target reference

target_filestring

Return projects that match the provided target file

target_runtimestring

Return projects that match the provided target runtime

meta_countstring · enum

The collection count.

Options: only

idsstring · uuid[]

Return projects that match the provided IDs.

namesstring[]

Return projects that match the provided names.

names_start_withstring[]

Return projects with names starting with the specified prefix.

originsstring[]

Return projects that match the provided origins.

typesstring[]

Return projects that match the provided types.

expandstring · enum[]

Expand relationships.

meta.latest_issue_countsboolean

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

meta.latest_dependency_totalboolean

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

cli_monitored_beforestring · date-time

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

Example: 2021-05-29T09:50:54.014Z

cli_monitored_afterstring · date-time

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

Example: 2021-05-29T09:50:54.014Z

importing_user_public_idstring[]

Return projects that match the provided importing user public ids.

tagsstring[]

Return projects that match all the provided tags

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

business_criticalitystring · enum[]

Return projects that match all the provided business_criticality value

environmentstring · enum[]

Return projects that match all the provided environment values

lifecyclestring · enum[]

Return projects that match all the provided lifecycle values

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

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

500

{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "count": 1
  },
  "data": [
    {
      "attributes": {
        "created": "2021-05-29T09:50:54.014Z",
        "name": "snyk/goof",
        "origin": "github",
        "read_only": true,
        "settings": {
          "auto_dependency_upgrade": {
            "is_enabled": true,
            "is_major_upgrade_enabled": true,
            "limit": 10,
            "minimum_age": 365,
            "ignored_dependencies": [
              "typescript"
            ]
          },
          "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": {
            "is_enabled": true,
            "type": "auto",
            "assignees": [
              "my-github-username"
            ]
          },
          "pull_requests": {
            "fail_only_for_issues_with_fix": true,
            "policy": "all",
            "severity_threshold": "high"
          },
          "recurring_tests": {
            "frequency": "daily"
          }
        },
        "target_file": "package.json",
        "target_reference": "main",
        "target_runtime": "text",
        "type": "maven",
        "status": "active",
        "build_args": {
          "root_workspace": "text"
        },
        "business_criticality": [
          "medium"
        ],
        "environment": [
          "external",
          "hosted"
        ],
        "lifecycle": [
          "production"
        ],
        "tags": [
          {
            "key": "tag-key",
            "value": "tag-value"
          }
        ]
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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",
      "meta": {
        "cli_monitored_at": "2021-05-29T09:50:54.014Z",
        "latest_dependency_total": {
          "total": 1,
          "updated_at": "2025-02-20T19:14:42.264Z"
        },
        "latest_issue_counts": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1,
          "updated_at": "2025-02-20T19:14:42.264Z"
        }
      }
    }
  ],
  "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"
  }
}

A list of projects is returned for the targeted org

Updates project by project ID.

Updates one project of the organization by project ID.

patch

/orgs/{org_id}/projects/{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-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))?))$

expandstring · enum[]

Expand relationships.

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/projects/{project_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"id":"331ede0a-de94-456f-b788-166caeca58bf","type":"project","attributes":{"test_frequency":"daily","business_criticality":["medium"],"environment":["external","hosted"],"lifecycle":["production"],"tags":[{"key":"tag-key","value":"tag-value"}]},"relationships":{"owner":{"data":{"id":"331ede0a-de94-456f-b788-166caeca58bf","type":"user"}}}}}'

200

400

401

403

404

500

{
  "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"
  },
  "data": {
    "attributes": {
      "created": "2021-05-29T09:50:54.014Z",
      "name": "snyk/goof",
      "origin": "github",
      "read_only": true,
      "settings": {
        "auto_dependency_upgrade": {
          "is_enabled": true,
          "is_major_upgrade_enabled": true,
          "limit": 10,
          "minimum_age": 365,
          "ignored_dependencies": [
            "typescript"
          ]
        },
        "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": {
          "is_enabled": true,
          "type": "auto",
          "assignees": [
            "my-github-username"
          ]
        },
        "pull_requests": {
          "fail_only_for_issues_with_fix": true,
          "policy": "all",
          "severity_threshold": "high"
        },
        "recurring_tests": {
          "frequency": "daily"
        }
      },
      "target_file": "package.json",
      "target_reference": "main",
      "target_runtime": "text",
      "type": "maven",
      "status": "active",
      "build_args": {
        "root_workspace": "text"
      },
      "business_criticality": [
        "medium"
      ],
      "environment": [
        "external",
        "hosted"
      ],
      "lifecycle": [
        "production"
      ],
      "tags": [
        {
          "key": "tag-key",
          "value": "tag-value"
        }
      ]
    },
    "id": "331ede0a-de94-456f-b788-166caeca58bf",
    "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",
    "meta": {
      "cli_monitored_at": "2021-05-29T09:50:54.014Z"
    },
    "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"
    }
  }
}

A project is updated for the targeted org

Get project by project ID.

Get one project of the organization by project ID.

get

/orgs/{org_id}/projects/{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

expandstring · enum[]

Expand relationships.

meta.latest_issue_countsboolean

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

meta.latest_dependency_totalboolean

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

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

200

400

401

403

404

500

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "attributes": {
      "created": "2021-05-29T09:50:54.014Z",
      "name": "snyk/goof",
      "origin": "github",
      "read_only": true,
      "settings": {
        "auto_dependency_upgrade": {
          "is_enabled": true,
          "is_major_upgrade_enabled": true,
          "limit": 10,
          "minimum_age": 365,
          "ignored_dependencies": [
            "typescript"
          ]
        },
        "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": {
          "is_enabled": true,
          "type": "auto",
          "assignees": [
            "my-github-username"
          ]
        },
        "pull_requests": {
          "fail_only_for_issues_with_fix": true,
          "policy": "all",
          "severity_threshold": "high"
        },
        "recurring_tests": {
          "frequency": "daily"
        }
      },
      "target_file": "package.json",
      "target_reference": "main",
      "target_runtime": "text",
      "type": "maven",
      "status": "active",
      "build_args": {
        "root_workspace": "text"
      },
      "business_criticality": [
        "medium"
      ],
      "environment": [
        "external",
        "hosted"
      ],
      "lifecycle": [
        "production"
      ],
      "tags": [
        {
          "key": "tag-key",
          "value": "tag-value"
        }
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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",
    "meta": {
      "cli_monitored_at": "2021-05-29T09:50:54.014Z",
      "latest_dependency_total": {
        "total": 1,
        "updated_at": "2025-02-20T19:14:42.264Z"
      },
      "latest_issue_counts": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1,
        "updated_at": "2025-02-20T19:14:42.264Z"
      }
    }
  },
  "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"
  }
}

A project is returned for the targeted org

Delete project by project ID.

Delete one project in the organization by project ID.

delete

/orgs/{org_id}/projects/{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-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}/projects/{project_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

500

No body

The project has been deleted

PreviousProjects (v1)NextPull Request Templates

Last updated 6 months ago

Was this helpful?