Snyk Tests API
The Tests API from Snyk — 3 operation(s) for tests.
Operations 3
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}/test_jobs/{job_id}
Check the progress of a test job · Get a test job. (Early Access)
#
Ask an LLM
“Is the Snyk test I started through the API still running?”
“How do I find out when an asynchronous test job has produced a test?”
Tell an agent
Check test job {job_id} in org {org_id}.
Poll the in-progress test job {job_id} for organization {org_id}.
POST
/orgs/{org_id}/tests
Start a new open source or code test · Create a new test. (Early Access)
#
Ask an LLM
“Can I run an open source or code analysis test through the API?”
“What do I need to provide to start a new Snyk test?”
Tell an agent
Start a new test in org {org_id}.
Run an SCA test on these items for organization {org_id} with request ID {snyk_request_id}.
Ask an LLM
“What was the outcome of a finished Snyk test?”
“Does the test result include findings, or just a summary?”
Tell an agent
Get test {test_id} in org {org_id}.
Show the result summary of completed test {test_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-test-data-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-test-request-body-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-io-snyk-api-common-json-api-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-io-snyk-api-common-link-property-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-io-snyk-api-common-meta-schema.json