SupportSnyk LearnAPI referenceProduct updatesSign up for free

Apps

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

Get a list of apps that can act on your behalf

get

Get a list of apps that can act on your behalf

Authorizations
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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of apps install that can act on your behalf
application/vnd.api+json
get
GET /rest/self/apps HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {
        "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
        "context": "tenant",
        "name": "My App",
        "scopes": [
          "text"
        ]
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      },
      "type": "text"
    }
  ],
  "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"
  }
}

Revoke an app

delete

Revoke access for an app by app id

Authorizations
Path parameters
app_idstring · uuidRequired

App ID

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 app has been revoked
delete
DELETE /rest/self/apps/{app_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a list of active OAuth sessions for the app

get

Get a list of active OAuth sessions for the app

Authorizations
Path parameters
app_idstring · uuidRequired

App ID

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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of active OAuth sessions for the app.
application/vnd.api+json
get
GET /rest/self/apps/{app_id}/sessions HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {
        "created_at": "2025-07-04T20:04:45.014Z"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "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"
  }
}

Revoke an active user app session

delete

Revoke an active user app session

Authorizations
Path parameters
app_idstring · uuidRequired

App ID

session_idstring · uuidRequired

Session ID

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 user app sessions has been revoked.
delete
DELETE /rest/self/apps/{app_id}/sessions/{session_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a list of apps installed for an user

get

Get a list of apps installed for an user

Authorizations
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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of apps installed for the specified organization.
application/vnd.api+json
get
GET /rest/self/apps/installs HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {
        "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
        "installed_at": "2024-04-30T16:07:46.230044Z"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      },
      "relationships": {
        "app": {
          "data": {
            "attributes": {
              "client_id": "123e4567-e89b-12d3-a456-426614174000",
              "context": "tenant",
              "name": "My App",
              "scopes": [
                "text"
              ]
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "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"
            },
            "type": "text"
          }
        }
      },
      "type": "text"
    }
  ],
  "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"
  }
}

Revoke access for an app by install ID

delete

Revoke access for an app by install ID

Authorizations
Path parameters
install_idstring · uuidRequired

Install ID

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 app install has been revoked.
delete
DELETE /rest/self/apps/installs/{install_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
Deprecated

Create a new app for an organization.

post

Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

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
access_token_ttl_secondsnumber · min: 3600 · max: 86400Optional

The access token time to live for your app, in seconds. It only affects the newly generated access tokens, existing access token will continue to have their previous time to live as expiration.

Example: 3600
contextstring · enumOptional

Allow installing the app to a org/group or to a user, default tenant.

Possible values:
namestring · min: 1Required

New name of the app to display to users during authorization flow.

Example: My App
redirect_urisstring · uri[] · min: 1Required

List of allowed redirect URIs to call back after authentication.

Example: ["https://example.com/callback"]
scopesstring[] · min: 1Required

The scopes this app is allowed to request during authorization.

Responses
201
Created Snyk App successfully
application/vnd.api+json
post
POST /rest/orgs/{org_id}/apps HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 135

{
  "access_token_ttl_seconds": 3600,
  "context": "tenant",
  "name": "My App",
  "redirect_uris": [
    "https://example.com/callback"
  ],
  "scopes": [
    "text"
  ]
}
{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "client_secret": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}
Deprecated

Get a list of apps created by an organization.

get

Get a list of apps created by an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of apps created by the specified organization
application/vnd.api+json
get
GET /rest/orgs/{org_id}/apps HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {
        "access_token_ttl_seconds": 3600,
        "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
        "context": "tenant",
        "grant_type": "authorization_code",
        "is_confidential": true,
        "is_public": false,
        "name": "My App",
        "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
        "redirect_uris": [
          "https://example.com/callback"
        ],
        "scopes": [
          "text"
        ]
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "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"
  }
}
Deprecated

Update app attributes that are name, redirect URIs, and access token time to live

patch

Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

client_idstring · uuidRequired

Client ID

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
access_token_ttl_secondsnumber · min: 3600 · max: 86400Optional

The access token time to live for your app, in seconds. It only affects the newly generated access tokens, existing access token will continue to have their previous time to live as expiration.

Example: 3600
namestring · min: 1Optional

New name of the app to display to users during authorization flow.

Example: My App
redirect_urisstring · uri[] · min: 1Optional

List of allowed redirect URIs to call back after authentication.

Example: ["https://example.com/callback"]
Responses
200
The update app.
application/vnd.api+json
patch
PATCH /rest/orgs/{org_id}/apps/{client_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 98

{
  "access_token_ttl_seconds": 3600,
  "name": "My App",
  "redirect_uris": [
    "https://example.com/callback"
  ]
}
{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}
Deprecated

Get an app by client id

get

Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

client_idstring · uuidRequired

Client ID

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
The requested app
application/vnd.api+json
get
GET /rest/orgs/{org_id}/apps/{client_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}
Deprecated

Delete an app

delete

Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

client_idstring · uuidRequired

Client ID

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 app has been deleted
delete
DELETE /rest/orgs/{org_id}/apps/{client_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
Deprecated

Manage client secrets for an app.

post

Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead.

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

client_idstring · uuidRequired

Client ID

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
modestring · enumRequired

Operation to perform:

  • replace - Replace existing secrets with a new generated secret
  • create - Add a new secret, preserving existing secrets
  • delete - Remove an existing secret by value
Possible values:
secretstringOptional

Secret to delete when using delete mode

Responses
200
Secrets have been updated.
application/vnd.api+json
post
POST /rest/orgs/{org_id}/apps/{client_id}/secrets HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 34

{
  "mode": "replace",
  "secret": "text"
}
{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "client_secret": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Install a Snyk Apps to this organization

post

Install a Snyk App to this organization, the Snyk App must use unattended authentication e.g. client credentials

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

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
201
The newly created app install.
application/vnd.api+json
post
POST /rest/orgs/{org_id}/apps/installs HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 123

{
  "data": {
    "type": "app_install"
  },
  "relationships": {
    "app": {
      "data": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "app"
      }
    }
  }
}
{
  "data": {
    "attributes": {
      "client_id": "123e4567-e89b-12d3-a456-426614174000",
      "client_secret": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "relationships": {
      "app": {
        "data": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text"
        }
      }
    },
    "type": "text"
  },
  "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"
  }
}

Get a list of apps installed for an organization

get

Get a list of apps installed for an organization

Authorizations
Path parameters
org_idstring · uuidRequired

Organization ID

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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of apps installed for the specified organization.
application/vnd.api+json
get
GET /rest/orgs/{org_id}/apps/installs HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {
        "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
        "installed_at": "2024-04-30T16:07:46.230044Z"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      },
      "relationships": {
        "app": {
          "data": {
            "attributes": {
              "client_id": "123e4567-e89b-12d3-a456-426614174000",
              "context": "tenant",
              "name": "My App",
              "scopes": [
                "text"
              ]
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "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"
            },
            "type": "text"
          }
        }
      },
      "type": "text"
    }
  ],
  "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"
  }
}

Revoke app authorization for a Snyk organization with install ID

delete

Revoke app authorization for a Snyk organization with install ID

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

install_idstring · uuidRequired

Install ID

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 app install has been revoked.
delete
DELETE /rest/orgs/{org_id}/apps/installs/{install_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Manage client secret for non-interactive Snyk App installations

post

Manage client secret for non-interactive Snyk App installations

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

install_idstring · uuidRequired

Install ID

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
200
Secret has been updated.
application/vnd.api+json
post
POST /rest/orgs/{org_id}/apps/installs/{install_id}/secrets HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 71

{
  "data": {
    "attributes": {
      "mode": "replace",
      "secret": "text"
    },
    "type": "app"
  }
}
{
  "data": {
    "attributes": {
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "client_secret": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
      "installed_at": "2024-04-30T16:07:46.230044Z"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "relationships": {
      "app": {
        "data": {
          "attributes": {
            "client_id": "123e4567-e89b-12d3-a456-426614174000",
            "context": "tenant",
            "name": "My App",
            "scopes": [
              "text"
            ]
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "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"
          },
          "type": "text"
        }
      }
    },
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Create a new Snyk App for an organization

post

Create a new Snyk App for an organization

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

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
201
Created Snyk App successfully.
application/vnd.api+json
post
POST /rest/orgs/{org_id}/apps/creations HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 172

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "context": "tenant",
      "name": "My App",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "type": "app"
  }
}
{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "client_secret": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get a list of apps created by an organization

get

Get a list of apps created by an organization

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of apps created by the specified organization
application/vnd.api+json
get
GET /rest/orgs/{org_id}/apps/creations HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {
        "access_token_ttl_seconds": 3600,
        "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
        "context": "tenant",
        "grant_type": "authorization_code",
        "is_confidential": true,
        "is_public": false,
        "name": "My App",
        "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
        "redirect_uris": [
          "https://example.com/callback"
        ],
        "scopes": [
          "text"
        ]
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "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"
  }
}

Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID

patch

Update app creation attributes with App ID

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

app_idstring · uuidRequired

App ID

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
200
The update app.
application/vnd.api+json
patch
PATCH /rest/orgs/{org_id}/apps/creations/{app_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 135

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "name": "My App",
      "redirect_uris": [
        "https://example.com/callback"
      ]
    },
    "type": "app"
  }
}
{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get a Snyk App by its App ID

get

Get a Snyk App by its App ID

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

app_idstring · uuidRequired

App ID

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
The requested app
application/vnd.api+json
get
GET /rest/orgs/{org_id}/apps/creations/{app_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Delete an app by its App ID

delete

Delete an app by its App ID

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

app_idstring · uuidRequired

App ID

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 app has been deleted
delete
DELETE /rest/orgs/{org_id}/apps/creations/{app_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Manage client secret for the Snyk App

post

Manage client secret for the Snyk App

Authorizations
Path parameters
org_idstring · uuidRequired

Org ID

app_idstring · uuidRequired

App ID

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
200
Secret has been updated.
application/vnd.api+json
post
POST /rest/orgs/{org_id}/apps/creations/{app_id}/secrets HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 71

{
  "data": {
    "attributes": {
      "mode": "replace",
      "secret": "text"
    },
    "type": "app"
  }
}
{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 3600,
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "client_secret": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
      "context": "tenant",
      "grant_type": "authorization_code",
      "is_confidential": true,
      "is_public": false,
      "name": "My App",
      "org_public_id": "123e4567-e89b-12d3-a456-426614174000",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": [
        "text"
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}
Deprecated

Get a list of app bots authorized to an organization.

get

Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.

Authorizations
Path parameters
org_idstring · uuidRequired

Organization ID

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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of app bots authorized to the specified organization
application/vnd.api+json
get
GET /rest/orgs/{org_id}/app_bots HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {},
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      },
      "relationships": {
        "app": {
          "data": {
            "attributes": {
              "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
              "context": "tenant",
              "name": "My App",
              "scopes": [
                "text"
              ]
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "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"
            },
            "type": "text"
          }
        }
      },
      "type": "text"
    }
  ],
  "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"
  }
}
Deprecated

Revoke app bot authorization

delete

Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.

Authorizations
Path parameters
bot_idstring · uuidRequired

The ID of the app bot

org_idstring · uuidRequired

Organization ID

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 app bot has been deauthorized
delete
DELETE /rest/orgs/{org_id}/app_bots/{bot_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Install a Snyk Apps to this group

post

Install a Snyk App to this group, the Snyk App must use unattended authentication e.g. client credentials

Authorizations
Path parameters
group_idstring · uuidRequired

Group ID

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
201
The newly created app install.
application/vnd.api+json
post
POST /rest/groups/{group_id}/apps/installs HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 123

{
  "data": {
    "type": "app_install"
  },
  "relationships": {
    "app": {
      "data": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "app"
      }
    }
  }
}
{
  "data": {
    "attributes": {
      "client_id": "123e4567-e89b-12d3-a456-426614174000",
      "client_secret": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "relationships": {
      "app": {
        "data": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text"
        }
      }
    },
    "type": "text"
  },
  "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"
  }
}

Get a list of apps installed for a group

get

Get a list of apps installed for a group

Authorizations
Path parameters
group_idstring · uuidRequired

Group ID

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=
limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200
A list of apps installed for the specified group.
application/vnd.api+json
get
GET /rest/groups/{group_id}/apps/installs HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "attributes": {
        "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
        "installed_at": "2024-04-30T16:07:46.230044Z"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      },
      "relationships": {
        "app": {
          "data": {
            "attributes": {
              "client_id": "123e4567-e89b-12d3-a456-426614174000",
              "context": "tenant",
              "name": "My App",
              "scopes": [
                "text"
              ]
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "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"
            },
            "type": "text"
          }
        }
      },
      "type": "text"
    }
  ],
  "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"
  }
}

Revoke app authorization for a Snyk group with install ID

delete

Revoke app authorization for a Snyk group with install ID

Authorizations
Path parameters
group_idstring · uuidRequired

Group ID

install_idstring · uuidRequired

Install ID

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 app install has been de-authorized.
delete
DELETE /rest/groups/{group_id}/apps/installs/{install_id} HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Manage client secret for non-interactive Snyk App installations

post

Manage client secret for non-interactive Snyk App installations

Authorizations
Path parameters
group_idstring · uuidRequired

Group ID

install_idstring · uuidRequired

Install ID

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
200
Secret has been updated.
application/vnd.api+json
post
POST /rest/groups/{group_id}/apps/installs/{install_id}/secrets HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 71

{
  "data": {
    "attributes": {
      "mode": "replace",
      "secret": "text"
    },
    "type": "app"
  }
}
{
  "data": {
    "attributes": {
      "client_id": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
      "client_secret": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
      "installed_at": "2024-04-30T16:07:46.230044Z"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "relationships": {
      "app": {
        "data": {
          "attributes": {
            "client_id": "123e4567-e89b-12d3-a456-426614174000",
            "context": "tenant",
            "name": "My App",
            "scopes": [
              "text"
            ]
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "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"
          },
          "type": "text"
        }
      }
    },
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}
PreviousReferenceNextAudit Logs

Last updated

Was this helpful?

Revision created

Add comment to emphasize required filters hidden in GitBook collapsed field