Snyk Cloud API
The Cloud API from Snyk — 6 operation(s) for cloud.
Operations 9
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
/orgs/{org_id}/cloud/environments
List cloud environments for an organization · List Environments (Early Access)
#
Ask an LLM
“Which cloud environments has my Snyk org connected?”
“Can I filter cloud environments by kind, status or name?”
Tell an agent
List cloud environments in org {org_id}.
Show {kind} environments in org {org_id} with status {status}.
POST
/orgs/{org_id}/cloud/environments
Connect a new cloud environment and scan it · Create New Environment (Early Access)
#
Ask an LLM
“How do I connect a cloud account to Snyk as a new environment?”
“Does adding a cloud environment kick off a scan straight away?”
Tell an agent
Create a new cloud environment in org {org_id}.
Onboard my cloud account as an environment in org {org_id} and scan it.
DELETE
/orgs/{org_id}/cloud/environments/{environment_id}
Delete a cloud environment · Delete Environment (Early Access)
#
Ask an LLM
“How do I disconnect a cloud environment from Snyk?”
“Can I remove an environment I no longer want scanned?”
Tell an agent destructive · confirm first
Delete cloud environment {environment_id} from org {org_id}.
Remove environment {environment_id} in organization {org_id}.
PATCH
/orgs/{org_id}/cloud/environments/{environment_id}
Update a cloud environment · Update Environment (Early Access)
#
Ask an LLM
“How do I edit the settings of a connected cloud environment?”
“Can I rename an existing environment?”
Tell an agent
Update cloud environment {environment_id} in org {org_id}.
Change the settings of environment {environment_id} for organization {org_id}.
POST
/orgs/{org_id}/cloud/permissions
Generate the IaC template granting Snyk cloud access · Generate Cloud Provider Permissions (Early Access)
#
Ask an LLM
“What permissions does Snyk need in my cloud account, and can it give me a template?”
“How do I get the IAC template that lets Snyk read my cloud resources?”
Tell an agent
Generate the cloud provider permissions template for org {org_id}.
Produce the access template Snyk needs before I connect a cloud account to org {org_id}.
GET
/orgs/{org_id}/cloud/resources
List cloud resources Snyk has discovered · List Resources (Early Access)
#
Ask an LLM
“What cloud resources has Snyk found in my environments?”
“Can I filter resources by type, location or platform?”
Tell an agent
List cloud resources in org {org_id}.
Show {resource_type} resources in environment {environment_id} for org {org_id}.
Ask an LLM
“Which cloud scans have run for my organization?”
“Can I see the history of environment scans?”
Tell an agent
List cloud scans in org {org_id}.
Show the last {limit} cloud scans for org {org_id}.
POST
/orgs/{org_id}/cloud/scans
Trigger a new scan of a cloud environment · Create Scan (Early Access)
#
Ask an LLM
“How do I rescan a cloud environment on demand?”
“Can I trigger a cloud scan without waiting for the schedule?”
Tell an agent
Start a new cloud scan in org {org_id}.
Trigger a scan of my environment now for organization {org_id}.
Ask an LLM
“What's the status of a particular cloud scan?”
“Can I look up one scan's details by scan ID?”
Tell an agent
Get cloud scan {scan_id} in org {org_id}.
Check the status of scan {scan_id} for organization {org_id}.
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-resource-attributes-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-scan-attributes-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-environment-attributes-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-resource-relationships-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-paginated-links-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-scan-relationships-schema.json