Support Snyk Learn API reference Product updates Sign up for free

Apps

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

PreviousReference NextAudit Logs

Last updated 6 months ago

Was this helpful?

Get a list of apps that can act on your behalf.

get

/self/apps

Authorizations

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=

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/self/apps?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

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

Revoke an app

Revoke access for an app by app id

delete

/self/apps/{app_id}

Authorizations

Path parameters

app_idstring · uuidrequired

App ID

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

204

400

401

403

404

409

500

No body

The app has been revoked

Get a list of active OAuth sessions for the app.

get

/self/apps/{app_id}/sessions

Authorizations

Path parameters

app_idstring · uuidrequired

App ID

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=

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/self/apps/{app_id}/sessions?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

{
  "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"
  },
  "data": [
    {
      "attributes": {
        "created_at": "2025-02-20T18:15:37.819Z"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ]
}

A list of active OAuth sessions for the app.

Revoke an active user app session.

delete

/self/apps/{app_id}/sessions/{session_id}

Authorizations

Path parameters

app_idstring · uuidrequired

App ID

session_idstring · uuidrequired

Session ID

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/self/apps/{app_id}/sessions/{session_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

409

500

No body

The user app sessions has been revoked.

Get a list of apps installed for an user.

get

/self/apps/installs

Authorizations

Query parameters

expandstring · enum[]

Expand relationships.

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/self/apps/installs?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

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

Revoke access for an app by install ID.

delete

/self/apps/installs/{install_id}

Authorizations

Path parameters

install_idstring · uuidrequired

Install ID

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/self/apps/installs/{install_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

409

500

No body

The app install has been revoked.

Create a new app for an organization.

Deprecated

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

post

/orgs/{org_id}/apps

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

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

Body

access_token_ttl_secondsnumber · min: 3600 · max: 86400

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 · enum

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

Options: tenant, user

namestring · min: 1required

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

Example: My App

redirect_urisstring · uri[]required

List of allowed redirect URIs to call back after authentication.

Example: ["https://example.com/callback"]

scopesstring · min: 1[]required

The scopes this app is allowed to request during authorization.

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"access_token_ttl_seconds":3600,"context":"tenant","name":"My App","redirect_uris":["https://example.com/callback"],"scopes":[null]}'

201

400

401

403

404

409

500

{
  "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"
  }
}

Created Snyk App successfully

Get a list of apps created by an organization.

Deprecated

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

get

/orgs/{org_id}/apps

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

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=

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

200

400

401

403

404

409

500

{
  "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"
  },
  "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"
    }
  ]
}

A list of apps created by the specified organization

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

Deprecated

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

patch

/orgs/{org_id}/apps/{client_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

client_idstring · uuidrequired

Client ID

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

Body

access_token_ttl_secondsnumber · min: 3600 · max: 86400

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: 1

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

Example: My App

redirect_urisstring · uri[]

List of allowed redirect URIs to call back after authentication.

Example: ["https://example.com/callback"]

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps/{client_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"access_token_ttl_seconds":3600,"name":"My App","redirect_uris":["https://example.com/callback"]}'

200

400

401

403

404

409

500

{
  "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"
  }
}

The update app.

Get an app by client id

Deprecated

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

get

/orgs/{org_id}/apps/{client_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

client_idstring · uuidrequired

Client ID

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

200

400

401

403

404

409

500

{
  "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"
  }
}

The requested app

Delete an app

Deprecated

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

delete

/orgs/{org_id}/apps/{client_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

client_idstring · uuidrequired

Client ID

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

204

400

401

403

404

409

500

No body

The app has been deleted

Manage client secrets for an app.

Deprecated

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

post

/orgs/{org_id}/apps/{client_id}/secrets

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

client_idstring · uuidrequired

Client ID

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

Body

secretstring

Secret to delete when using delete mode

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

Options: replace, create, delete

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps/{client_id}/secrets?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"mode":"replace"}'

200

400

401

403

404

409

500

{
  "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"
  }
}

Secrets have been updated.

Install a Snyk Apps to this organization.

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

post

/orgs/{org_id}/apps/installs

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

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

Body

dataobjectrequired

relationshipsobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps/installs?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"app_install"},"relationships":{"app":{"data":{"id":"123e4567-e89b-12d3-a456-426614174000","type":"app"}}}}'

201

400

401

403

404

409

500

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

The newly created app install.

Get a list of apps installed for an organization.

get

/orgs/{org_id}/apps/installs

Authorizations

Path parameters

org_idstring · uuidrequired

Organization ID

Query parameters

expandstring · enum[]

Expand relationships.

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

200

400

401

403

404

409

500

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

Revoke app authorization for an Snyk Organization with install ID.

delete

/orgs/{org_id}/apps/installs/{install_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

install_idstring · uuidrequired

Install ID

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

204

400

401

403

404

409

500

No body

The app install has been revoked.

Manage client secret for non-interactive Snyk App installations.

post

/orgs/{org_id}/apps/installs/{install_id}/secrets

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

install_idstring · uuidrequired

Install ID

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

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps/installs/{install_id}/secrets?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"app","attributes":{"mode":"replace"}}}'

200

400

401

403

404

409

500

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "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"
    },
    "relationships": {
      "app": {
        "data": {
          "attributes": {
            "client_id": "123e4567-e89b-12d3-a456-426614174000",
            "context": "tenant",
            "name": "My App",
            "scopes": [
              "text"
            ]
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "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"
          }
        }
      }
    },
    "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"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Secret has been updated.

Create a new Snyk App for an organization.

post

/orgs/{org_id}/apps/creations

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

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

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps/creations?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"app","attributes":{"access_token_ttl_seconds":3600,"context":"tenant","name":"My App","redirect_uris":["https://example.com/callback"],"scopes":[null]}}}'

201

400

401

403

404

409

500

{
  "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"
  }
}

Created Snyk App successfully.

Get a list of apps created by an organization.

get

/orgs/{org_id}/apps/creations

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

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=

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

200

400

401

403

404

409

500

{
  "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"
  },
  "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"
    }
  ]
}

A list of apps created by the specified organization

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

Update app creation attributes with App ID.

patch

/orgs/{org_id}/apps/creations/{app_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

app_idstring · uuidrequired

App ID

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

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps/creations/{app_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"app","attributes":{"access_token_ttl_seconds":3600,"name":"My App","redirect_uris":["https://example.com/callback"]}}}'

200

400

401

403

404

409

500

{
  "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"
  }
}

The update app.

Get a Snyk App by its App ID.

get

/orgs/{org_id}/apps/creations/{app_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

app_idstring · uuidrequired

App ID

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

200

400

401

403

404

409

500

{
  "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"
  }
}

The requested app

Delete an app by its App ID.

delete

/orgs/{org_id}/apps/creations/{app_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

app_idstring · uuidrequired

App ID

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

204

400

401

403

404

409

500

No body

The app has been deleted

Manage client secret for the Snyk App.

post

/orgs/{org_id}/apps/creations/{app_id}/secrets

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

app_idstring · uuidrequired

App ID

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

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/apps/creations/{app_id}/secrets?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"app","attributes":{"mode":"replace"}}}'

200

400

401

403

404

409

500

{
  "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"
  }
}

Secret has been updated.

Get a list of app bots authorized to an organization.

Deprecated

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

get

/orgs/{org_id}/app_bots

Authorizations

Path parameters

org_idstring · uuidrequired

Organization ID

Query parameters

expandstring · enum[]

Expand relationships.

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

200

400

401

403

404

409

500

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

Revoke app bot authorization

Deprecated

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

delete

/orgs/{org_id}/app_bots/{bot_id}

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

204

400

401

403

404

409

500

No body

The app bot has been deauthorized

Install a Snyk Apps to this group.

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

post

/groups/{group_id}/apps/installs

Authorizations

Path parameters

group_idstring · uuidrequired

Group ID

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

Body

dataobjectrequired

relationshipsobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/groups/{group_id}/apps/installs?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"app_install"},"relationships":{"app":{"data":{"id":"123e4567-e89b-12d3-a456-426614174000","type":"app"}}}}'

201

400

401

403

404

409

500

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

The newly created app install.

Get a list of apps installed for a group.

get

/groups/{group_id}/apps/installs

Authorizations

Path parameters

group_idstring · uuidrequired

Group ID

Query parameters

expandstring · enum[]

Expand relationships.

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/groups/{group_id}/apps/installs?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

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

Revoke app authorization for an Snyk Group with install ID.

delete

/groups/{group_id}/apps/installs/{install_id}

Authorizations

Path parameters

group_idstring · uuidrequired

Group ID

install_idstring · uuidrequired

Install ID

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/groups/{group_id}/apps/installs/{install_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

409

500

No body

The app install has been de-authorized.

Manage client secret for non-interactive Snyk App installations.

post

/groups/{group_id}/apps/installs/{install_id}/secrets

Authorizations

Path parameters

group_idstring · uuidrequired

Group ID

install_idstring · uuidrequired

Install ID

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

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/groups/{group_id}/apps/installs/{install_id}/secrets?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"app","attributes":{"mode":"replace"}}}'

200

400

401

403

404

409

500

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "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"
    },
    "relationships": {
      "app": {
        "data": {
          "attributes": {
            "client_id": "123e4567-e89b-12d3-a456-426614174000",
            "context": "tenant",
            "name": "My App",
            "scopes": [
              "text"
            ]
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "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"
          }
        }
      }
    },
    "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"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Secret has been updated.