Operations 28
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/groups/{group_id}/apps/installs
List Snyk Apps installed for a group · Get a list of Snyk Apps installed for a Group
#
Ask an LLM
“Which Snyk Apps are installed at the group level?”
“Can I see every app install on my Snyk group, with the app details expanded?”
Tell an agent
List the Snyk Apps installed for group {group_id}.
Show the first {limit} app installs on group {group_id}.
POST
/groups/{group_id}/apps/installs
Install a Snyk App for a group · Install a Snyk App for a Group
#
Ask an LLM
“How do I install a client-credentials Snyk App across a whole group?”
“Can a Snyk App be installed at the group level instead of per organization?”
Tell an agent
Install the Snyk App on group {group_id}.
Add a group-level install of our unattended Snyk App to group {group_id}.
DELETE
/groups/{group_id}/apps/installs/{install_id}
Revoke a Snyk App install from a group · Revoke app authorization for a Snyk group with install ID
#
Ask an LLM
“How do I uninstall a Snyk App from a group so it loses access?”
“Can I revoke a group's app authorization using the install ID?”
Tell an agent destructive · confirm first
Revoke app install {install_id} from group {group_id}.
Remove the group-level Snyk App installation {install_id} in group {group_id}.
POST
/groups/{group_id}/apps/installs/{install_id}/secrets
Manage the client secret of a group app install · Manage client secret for non-interactive Snyk App installations
#
Ask an LLM
“How do I rotate the client secret for a non-interactive app installed on my group?”
“Can I replace the secret of a group-level Snyk App installation?”
Tell an agent
Rotate the client secret for group install {install_id} in group {group_id}.
Manage the secret on group {group_id}'s app installation {install_id}.
GET
/orgs/{org_id}/app_bots
List app bots authorized to an org (deprecated) · Get a list of app bots authorized to an organization
#
Ask an LLM
“Which app bots are authorized on my Snyk organization?”
“Is there still a legacy app bots listing for an org?”
Tell an agent
List the app bots authorized to org {org_id} using the deprecated app_bots endpoint.
Show the legacy app bots on organization {org_id}.
DELETE
/orgs/{org_id}/app_bots/{bot_id}
Revoke an app bot's authorization (deprecated) · Revoke app bot authorization
#
Ask an LLM
“How do I revoke an app bot from my organization?”
“Can I still remove a legacy app bot by its bot ID?”
Tell an agent destructive · confirm first
Revoke app bot {bot_id} in org {org_id}.
Remove the legacy app bot {bot_id} from organization {org_id}.
GET
/orgs/{org_id}/apps
List apps created by an org (deprecated endpoint) · Get a list of Snyk Apps created by an Organization
#
Ask an LLM
“Is there an older endpoint that lists the apps my org created?”
“What does the deprecated org apps listing return compared with app creations?”
Tell an agent
List the apps org {org_id} created using the deprecated apps endpoint.
Call the legacy app listing for organization {org_id}.
POST
/orgs/{org_id}/apps
Create an app for an org (deprecated endpoint) · Create a new app for an organization
#
Ask an LLM
“Can I still create an app with name, redirect URIs and scopes through the old apps endpoint?”
“What fields does the deprecated create-app call take?”
Tell an agent
Create an app named {name} in org {org_id} with redirect URIs {redirect_uris} and scopes {scopes} via the legacy endpoint.
Via the legacy endpoint, register {name} in org {org_id} with token TTL {access_token_ttl_seconds}s, redirects {redirect_uris}, scopes {scopes}.
GET
/orgs/{org_id}/apps/creations
List Snyk Apps created by an organization · Get a list of Snyk Apps created by an Organization
#
Ask an LLM
“Which Snyk Apps has my organization built?”
“Can I page through the app creations owned by an org?”
Tell an agent
List the Snyk App creations in org {org_id}.
Show {limit} apps my organization {org_id} created.
POST
/orgs/{org_id}/apps/creations
Create a new Snyk App for an organization · Create a new Snyk App for an organization
#
Ask an LLM
“How do I register a new Snyk App under my organization?”
“Can I create an OAuth app owned by a Snyk org?”
Tell an agent
Create a new Snyk App in org {org_id}.
Register an app creation for organization {org_id}.
DELETE
/orgs/{org_id}/apps/creations/{app_id}
Delete a Snyk App by its app ID · Delete a Snyk App by app ID
#
Ask an LLM
“How do I permanently delete a Snyk App my org created?”
“Can I remove an app creation using its app ID?”
Tell an agent destructive · confirm first
Delete Snyk App {app_id} from org {org_id}.
Remove the app creation {app_id} owned by organization {org_id}.
GET
/orgs/{org_id}/apps/creations/{app_id}
Get a Snyk App by its app ID · Get a Snyk App by app ID
#
Ask an LLM
“Where can I see the details of one Snyk App my org created?”
“Can I look up a created app's settings by app ID?”
Tell an agent
Get Snyk App {app_id} from org {org_id}.
Show the app creation {app_id} in organization {org_id}.
PATCH
/orgs/{org_id}/apps/creations/{app_id}
Update a Snyk App's name, redirects or token TTL · Update app creation attributes such as name, redirect URIs, and access token…
#
Ask an LLM
“How do I change the redirect URIs of a Snyk App I created?”
“Can I shorten the access token time to live on an app creation?”
Tell an agent
Update Snyk App {app_id} in org {org_id}.
Rename app creation {app_id} in organization {org_id} and adjust its redirect URIs.
POST
/orgs/{org_id}/apps/creations/{app_id}/secrets
Manage the client secret of a Snyk App · Manage client secret for a Snyk App
#
Ask an LLM
“How do I rotate the client secret of a Snyk App my org created?”
“Can I regenerate an app creation's secret by app ID?”
Tell an agent
Rotate the client secret for Snyk App {app_id} in org {org_id}.
Manage secrets on app creation {app_id} belonging to organization {org_id}.
GET
/orgs/{org_id}/apps/installs
List Snyk Apps installed for an organization · Get a list of Snyk Apps installed for an Organization
#
Ask an LLM
“Which Snyk Apps are installed on my organization?”
“Can I list org app installs with the app details expanded?”
Tell an agent
List the app installs on org {org_id}.
Show which third-party apps are installed in organization {org_id}.
POST
/orgs/{org_id}/apps/installs
Install a Snyk App for an organization · Install a Snyk App for an Organization
#
Ask an LLM
“How do I install a client-credentials Snyk App into a single organization?”
“Can an unattended Snyk App be installed on just one org?”
Tell an agent
Install the Snyk App on org {org_id}.
Add an org-level installation of our non-interactive app to organization {org_id}.
DELETE
/orgs/{org_id}/apps/installs/{install_id}
Revoke a Snyk App install from an organization · Revoke app authorization for a Snyk organization with install ID
#
Ask an LLM
“How do I uninstall a Snyk App from one organization?”
“Can I revoke an org's app authorization with the install ID?”
Tell an agent destructive · confirm first
Revoke app install {install_id} from org {org_id}.
Uninstall org-level installation {install_id} in organization {org_id}.
POST
/orgs/{org_id}/apps/installs/{install_id}/secrets
Manage the client secret of an org app install · Manage client secret for non-interactive Snyk App installations
#
Ask an LLM
“How do I rotate the secret for a non-interactive app installed on my org?”
“Can I replace the client secret of an organization-level app installation?”
Tell an agent
Rotate the client secret for org install {install_id} in org {org_id}.
Manage the secret on organization {org_id}'s app installation {install_id}.
Ask an LLM
“How do I delete an app when I only have its client ID?”
“Can the older client-id endpoint still delete an app?”
Tell an agent destructive · confirm first
Delete the app with client ID {client_id} from org {org_id}.
Remove app {client_id} in organization {org_id} via the legacy client-id endpoint.
GET
/orgs/{org_id}/apps/{client_id}
Get an app by client ID (deprecated) · Get an app by client id
#
Ask an LLM
“Can I look up an app by its OAuth client ID?”
“What does the legacy get-app-by-client-id call return?”
Tell an agent
Get the app with client ID {client_id} in org {org_id}.
Fetch app {client_id} from organization {org_id} using the deprecated client-id endpoint.
PATCH
/orgs/{org_id}/apps/{client_id}
Update an app by client ID (deprecated) · Update app attributes that are name, redirect URIs, and access token time to…
#
Ask an LLM
“Can I rename an app or change its redirect URIs using its client ID?”
“What can the deprecated update-app-by-client-id call change?”
Tell an agent
Rename the app with client ID {client_id} in org {org_id} to {name}.
Set redirect URIs {redirect_uris} and a {access_token_ttl_seconds}-second token TTL on client {client_id} in org {org_id}.
POST
/orgs/{org_id}/apps/{client_id}/secrets
Manage client secrets for an app (deprecated) · Manage client secrets for an app
#
Ask an LLM
“How do I replace or create a client secret for an app identified by client ID?”
“Which secret modes does the legacy client-id secrets endpoint accept?”
Tell an agent
Run secret mode {mode} on the app with client ID {client_id} in org {org_id}.
Use mode {mode} to manage secret {secret} for client {client_id} in organization {org_id}.
GET
/self/apps
List Snyk Apps that can act on your behalf · Get a list of Snyk Apps that can act on your behalf
#
Ask an LLM
“Which Snyk Apps have I authorized to act as me?”
“What apps currently have access to my Snyk account?”
Tell an agent
List the apps that can act on my behalf.
Show the first {limit} apps I've authorized on my account.
GET
/self/apps/installs
List Snyk App installs for the current user · Get a list of Snyk Apps installed for a user
#
Ask an LLM
“Which Snyk App installations belong to my user account?”
“Can I see my personal app installs with app details expanded?”
Tell an agent
List my personal Snyk App installs.
Show my user-level app installations with the app expanded using {expand}.
DELETE
/self/apps/installs/{install_id}
Revoke one of your app installs by install ID · Revoke a Snyk App by install ID
#
Ask an LLM
“How do I revoke a Snyk App I installed for myself, by its install ID?”
“Can I remove my own app installation without touching org installs?”
Tell an agent destructive · confirm first
Revoke my app install {install_id}.
Remove personal installation {install_id} from my account.
Ask an LLM
“How do I stop a Snyk App from acting on my behalf?”
“Can I revoke an app's access to my account using its app ID?”
Tell an agent destructive · confirm first
Revoke app {app_id}'s access to my account.
Deauthorize the app with ID {app_id} for me.
GET
/self/apps/{app_id}/sessions
List your active OAuth sessions for an app · Get a list of active OAuth sessions by app ID
#
Ask an LLM
“Which OAuth sessions does a Snyk App currently have open for me?”
“Can I see how many active sessions an app holds on my account?”
Tell an agent
List my active sessions for app {app_id}.
Show open OAuth sessions app {app_id} has with me.
DELETE
/self/apps/{app_id}/sessions/{session_id}
Revoke one active session of a Snyk App · Revoke the Snyk App session of an active user
#
Ask an LLM
“How do I end a single OAuth session an app has with me?”
“Can I kill one app session while keeping the app authorized?”
Tell an agent destructive · confirm first
Revoke session {session_id} of app {app_id}.
End app {app_id}'s OAuth session {session_id} on my account.
Documentation
Documentation
https://apidocs.snyk.io/?version=2024-10-15
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Orgs
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Projects
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Targets
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Integrations
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Audit-Logs
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/SBOM
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Container-Images
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Custom-Base-Images
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Webhooks
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues-Export
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-app-install-with-client-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-app-install-data-with-secret-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-app-post-request-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-paginated-links-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-app-install-data-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-app-bot-schema.json