Snyk Tests API is one of 51 APIs that Snyk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Tests. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
3 operations
across 3 paths,
and defines 79 schemas.
It is described by OpenAPI 3.2.0, at version REST.
Requests are made against a single base URL, https://api.snyk.io/rest.
The identity and technical contract details declared by the specification.
UploadResource
object
Resource referring to an Upload Revision created through the File Upload API (currently in Closed Beta). Revisions contain collections of files uploaded by cli…
8 properties
4 required
io.snyk.api.common.ErrorDocument
object
2 properties
2 required
ContainerScanConfiguration
object
Scan configuration parameters for the Container scanner.
io.snyk.api.common.JsonApi
object
1 property
1 required
BaseResourceCreateItem
object
BaseResources contain a single instance of testable content.
2 properties
2 required
PolicyRefSet
object
A set of local and/or managed policies.
2 properties
1 required
ScmRepoLocator
object
ScmRepoLocator locates a test subject by SCM repository coordinates.
3 properties
2 required
TestResourceCreateItem
TestResources contain single instances of testable content to be provided to Snyk scanners.
TestConfiguration
object
Test configuration.
10 properties
DiffResource
object
DiffResources contain two versions of the same content to compare against each other. The Base and Compare fields contain Resources representing an "existing"…
3 properties
3 required
LocalPolicy
object
Locally configured policy options for determining outcome of this specific test.
6 properties
1 required
TestRequestBody
object
TestRequestBody represents the request body used when creating an Test.
1 property
1 required
LocalPathLocator
object
LocalPathLocator locates a test subject by local file paths, relative to the working copy top-level directory of the source code.
2 properties
2 required
TestAttributesCreate
object
TestAttributes represents the attributes of a Test resource.
6 properties
TestSubjectCreate
The subject of a test, which identifies the asset/project and content references necessary to conduct a security test.
DiffResourceCreateItem
object
DiffResources contain two versions of the same content to compare against each other. The Base and Compare fields contain Resources representing an "existing"…
3 properties
3 required
SecretsScanConfiguration
object
Scan configuration parameters for the Secrets scanner.
io.snyk.api.common.LinkProperty
io.snyk.api.v1testdepgraph.request.NodeRef
object
1 property
1 required
ScmResource
object
Resource representing a repository of source files located in a Source Code Management tool (e.g. GitHub). ScmResources provide Snyk with the requisite informa…
6 properties
3 required
SbomSubject
object
Deprecated Provide a BundleResource with SBOM Bundle ID and include SCA Scan Configuration instead. SBOM tests can also be initiated using an UploadResource if…
3 properties
3 required
io.snyk.api.common.LinkObject
object
2 properties
1 required
OtherLocator
object
OtherLocator represents any locator that this version of the API is not capable of expressing.
1 property
1 required
DepGraphSubject
object
Deprecated Provide an InlineResource with the DepGraph contents and the SCA Scan Configuration instead. Test subject representing a Snyk dependency graph (a le…
2 properties
2 required
SastScanConfiguration
object
Scan configuration parameters for the SAST scanner.
InlineResourceCreateItem
object
Resource comprised of file contents included directly in a request body. Currently supported scans utilizing InlineResources are: - SCA (Open Source): (1) Inli…
4 properties
3 required
IacScanConfiguration
object
Scan configuration parameters for the IAC scanner.
io.snyk.api.common.ErrorLink
object
A link that leads to further details about this particular occurrance of the problem.
1 property
io.snyk.api.common.Meta
object
Free-form object that may contain non-standard information.
LocalIgnore
object
6 properties
1 required
io.snyk.api.common.LinkString
string
TestExecutionStates
string
TestDataCreate
object
TestData represents a Test resource object.
2 properties
2 required
InlineContent
object
Content formats accepted inline for testing.
Severity
string
Indicate the severity of a finding discovered by a Test.
TestState
object
Test execution state information.
3 properties
1 required
TestOutcome
object
Outcome of a test; pass or fail.
3 properties
1 required
io.snyk.api.v1testdepgraph.request.Graph
object
2 properties
2 required
TestSubject
The subject of a test, which identifies the asset/project and content references necessary to conduct a security test.
InlineResource
object
Resource comprised of file contents included directly in a request body. Currently supported scans utilizing InlineResources are: - SCA (Open Source): (1) Inli…
3 properties
2 required
FindingSummary
object
Summary of findings found by the Test.
2 properties
1 required
DepGraphRef
object
4 properties
4 required
io.snyk.api.v1testdepgraph.request.Node
object
3 properties
3 required
io.snyk.api.v1testdepgraph.request.PackageInfo
object
2 properties
2 required
TestComponent
object
TestComponent represents a Test Component.
4 properties
2 required
ContainerRepoResource
object
Resource representing a container repository. Container Repos identify a specific container image in a container registry. These images can be scanned using th…
4 properties
3 required
SnykReferenceResource
object
SnykReferenceResources contain references to source code, containers, SBOMs, and other testable content that has already been provided to Snyk to create a Proj…
4 properties
3 required
SbomReachabilitySubject
object
Deprecated Provide a BundleResource with SBOM Bundle ID, a BundleResource with Source Bundle ID, and include SCA Scan Configuration instead. SBOM Reachability…
4 properties
4 required
DepGraphSubjectCreate
object
Deprecated Provide an InlineResource with the DepGraph contents and the SCA Scan Configuration instead. Test subject representing a Snyk dependency graph (a le…
3 properties
3 required
ScanConfiguration
object
A map of scanner types to their specific set of configuration parameters. The presence of a scanner's configuration in the provided ScanConfiguration is used t…
5 properties
TimeoutSpec
object
Specification for a test timeout policy. If the test does not complete within the seconds specified, the test will instantly complete with the given outcome.
2 properties
2 required
ScmContext
object
Additional SCM information about a resource. Provides context about where the content came from; the resource itself is the testable item. ScmResource does not…
3 properties
ProjectNameLocator
object
ProjectNameLocator locates a Snyk Project by its name.
3 properties
2 required
BundleResource
object
Resource representing Bundles of files created through the Deepcode Bundle API. Bundles contain collections of files uploaded by clients to Snyk for testing. B…
8 properties
4 required
TestOutcomeReason
string
Reasons for the outcome.
io.snyk.api.v1testdepgraph.request.PackageManager
object
1 property
1 required
GitUrlCoordinatesSubject
object
Deprecated Provide an ScmResource and include the SAST Scan Configuration instead. Test subject representing a source tree located in a Git repository that has…
4 properties
4 required
FindingType
string
Type of Finding which was discovered.
ScaScanConfiguration
object
Scan configuration parameters for the SCA scanner.
BaseResource
object
BaseResources contain a single instance of testable content.
2 properties
2 required
TestResource
TestResources contain single instances of testable content to be provided to Snyk scanners.
DependencyCountFact
object
DependencyCountFact represents a dependency count fact.
2 properties
2 required
BaseResourceVariantCreateItem
ReachabilityFilter
string
Represent various reachability filters available for findings.
DeepcodeBundleSubject
object
Deprecated Provide a BundleResource and include the SAST Scan Configuration instead. Test subject representing source code uploaded to Snyk using DeepCode bund…
3 properties
3 required
PassFail
string
Indicate whether a Test passes or fails.
OtherSubject
object
OtherSubject represents any subject that this version of the API is not capable of expressing.
1 property
1 required
TestFact
object
TestFact represents a test fact union.
TestData
object
TestData represents a Test resource object.
4 properties
3 required
DepGraphContent
object
Dep Graph file contents, of the same format as Dep Graphs provided to /v1/test-dep-graph endpoint.
2 properties
2 required
ProjectEntityLocator
object
ProjectEntityLocator locates a Snyk Project by its public ID.
2 properties
2 required
TestAttributes
object
TestAttributes represents the attributes of a Test resource.
13 properties
2 required
SdlcStage
string
SDLC stage where the test was initiated.
io.snyk.api.v1testdepgraph.request.Package
object
2 properties
2 required
io.snyk.api.common.Error
object
8 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Snyk publishes across the network.
