Support Snyk Learn API reference Product updates Sign up for free

Targets

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

PreviousSnapshots (v1)NextTest (v1)

Last updated 6 months ago

Was this helpful?

Get targets by org ID

Get a list of an organization's targets.

get

/orgs/{org_id}/targets

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-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=

countboolean

Calculate total amount of filtered results

limitinteger · int32 · min: 1 · max: 100 · default: 10

Number of results to return per page

Example: 10

is_privateboolean

Return targets that match the provided value of is_private

exclude_emptyboolean · default: true

Return only the targets that has projects

urlstring

Return targets that match the provided remote_url.

source_typesstring · enum[]

Return targets that match the provided source_types

display_namestring

Return targets with display names starting with the provided string

created_gtestring · date-time

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

Example: 2022-01-01T16:00:00Z

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

500

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

Get target by target ID

Get a specified target for an organization.

get

/orgs/{org_id}/targets/{target_id}

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

200

400

401

404

500

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

A single target is returned if it is found in the specified org

Delete target by target ID

Delete the specified target.

delete

/orgs/{org_id}/targets/{target_id}

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

204

400

401

404

500

No body

The target is deleted with all projects, if it is found in the specified org.