SupportSnyk LearnAPI referenceProduct updatesSign up for free

Targets

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

Get targets by org ID

get

Get a list of an organization's targets.

Required permissions

  • View Projects (org.project.read)
Authorizations
Path parameters
org_idstring · uuidRequired

The id of the org to return a list of targets

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))?))$
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=
countbooleanOptional

Calculate total amount of filtered results

limitinteger · int32 · min: 1 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
is_privatebooleanOptional

Return targets that match the provided value of is_private

exclude_emptybooleanOptional

Return only the targets that has projects

Default: true
urlstringOptional

Return targets that match the provided remote_url.

display_namestringOptional

Return targets with display names starting with the provided string

created_gtestring · date-timeOptional

Return only targets which have been created at or after the specified date.

Example: 2022-01-01T16:00:00Z
Responses
200
A list of targets is returned for the targeted org
application/vnd.api+json
get
GET /rest/orgs/{org_id}/targets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "created_at": "2022-09-01T00:00:00Z",
        "display_name": "snyk-fixtures/goof",
        "is_private": false,
        "url": "http://github.com/snyk/local-goof"
      },
      "id": "55a348e2-c3ad-4bbc-b40e-9b232d1f4121",
      "relationships": {
        "integration": {
          "data": {
            "attributes": {
              "integration_type": "gitlab"
            },
            "id": "7667dae6-602c-45d9-baa9-79e1a640f199",
            "type": "integration"
          }
        },
        "organization": {
          "data": {
            "id": "e661d4ef-5ad5-4cef-ad16-5157cefa83f5",
            "type": "organization"
          }
        }
      },
      "type": "target"
    }
  ],
  "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": 3
  }
}

Get target by target ID

get

Get a specified target for an organization.

Required permissions

  • View Projects (org.project.read)
Authorizations
Path parameters
org_idstring · uuidRequired

The id of the org to return the target from

target_idstring · uuidRequired

The id of the target to return

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
200
A single target is returned if it is found in the specified org
application/vnd.api+json
get
GET /rest/orgs/{org_id}/targets/{target_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "created_at": "2022-09-01T00:00:00Z",
      "display_name": "snyk-fixtures/goof",
      "is_private": false,
      "url": "http://github.com/snyk/local-goof"
    },
    "id": "55a348e2-c3ad-4bbc-b40e-9b232d1f4121",
    "relationships": {
      "integration": {
        "data": {
          "attributes": {
            "integration_type": "gitlab"
          },
          "id": "7667dae6-602c-45d9-baa9-79e1a640f199",
          "type": "integration"
        }
      },
      "organization": {
        "data": {
          "id": "e661d4ef-5ad5-4cef-ad16-5157cefa83f5",
          "type": "organization"
        }
      }
    },
    "type": "target"
  },
  "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 target by target ID

delete

Delete the specified target.

Required permissions

  • Remove Projects (org.project.delete)
Authorizations
Path parameters
org_idstring · uuidRequired

The id of the org to delete

target_idstring · uuidRequired

The id of the target to delete

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
204
The target is deleted with all projects, if it is found in the specified org.
delete
DELETE /rest/orgs/{org_id}/targets/{target_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousSnapshots (v1)NextTest (v1)

Last updated

Was this helpful?