AuditLogSearch
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"created",
"event"
],
"properties": {
"event": {
"type": "string",
"example": "api.access"
},
"org_id": {
"type": "string",
"format": "uuid",
"example": "0d3728ec-eebf-484d-9907-ba238019f10b"
},
"content": {
"type": "object"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2021-07-01T00:00:00Z"
},
"group_id": {
"type": "string",
"format": "uuid",
"example": "0d3728ec-eebf-484d-9907-ba238019f10b"
},
"project_id": {
"type": "string",
"format": "uuid",
"example": "0d3728ec-eebf-484d-9907-ba238019f10b"
}
}
}
}
}
}
AuditLogsSearchGroupAuditLogsResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AuditLogSearch"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AuditLogsSearchOrganizationAuditLogsResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AuditLogSearch"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AutoDependencyUpgradeSettings
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"example": 10,
"maximum": 10,
"minimum": 1,
"description": "Limit of dependency upgrade PRs which can be opened simultaneously. When the limit is reached, no new upgrade PRs are created. If specified, must be between 1 and 10."
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Automatically raise pull requests to update out-of-date dependencies."
},
"minimum_age": {
"type": "number",
"example": 365,
"description": "Minimum dependency maturity period in days. If specified, must be between 1 and 365."
},
"is_inherited": {
"type": "boolean",
"example": true,
"description": "Apply the auto dependency integration settings of the Organization to this project."
},
"ignored_dependencies": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"typescript"
],
"description": "Dependencies which should NOT be included in an automatic upgrade operation."
},
"is_major_upgrade_enabled": {
"type": "boolean",
"example": true,
"description": "Include major version in dependency upgrade recommendation."
}
},
"description": "Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Project's integration."
}
AutoRemediationPRsSettings
{
"type": "object",
"properties": {
"is_fresh_prs_enabled": {
"type": "boolean",
"example": true,
"description": "Automatically create pull requests on scheduled tests for new vulnerabilities."
},
"is_backlog_prs_enabled": {
"type": "boolean",
"example": true,
"description": "Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities."
},
"is_patch_remediation_enabled": {
"type": "boolean",
"example": true,
"description": "Include vulnerability patches in automatic pull requests."
}
},
"description": "Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration."
}
BulkPackageUrlsRequestBody
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"type": "object",
"required": [
"purls"
],
"properties": {
"purls": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of Package URLs (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required."
}
}
}
}
}
}
}
Class
{
"type": "object",
"example": {
"id": "CWE-190",
"type": "weakness",
"source": "CWE"
},
"required": [
"id",
"type",
"source"
],
"properties": {
"id": {
"type": "string",
"maxLength": 1024,
"minLength": 1
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096,
"minLength": 1,
"description": "An optional URL for this class."
},
"type": {
"$ref": "#/components/schemas/ClassTypeDef"
},
"source": {
"type": "string",
"example": "CWE",
"maxLength": 64,
"minLength": 1
}
}
}
ClassTypeDef
{
"enum": [
"rule-category",
"compliance",
"weakness"
],
"type": "string",
"example": "compliance"
}
ClientId
{
"type": "string",
"format": "uuid",
"example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
"description": "The oauth2 client id for the app."
}
ClientSecret
{
"type": "string",
"example": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
"minLength": 1,
"description": "The oauth2 client secret for the app. This is the only time this secret will be returned, store it securely and don’t lose it."
}
CloudResource
{
"type": "object",
"required": [
"environment"
],
"properties": {
"resource": {
"$ref": "#/components/schemas/Resource"
},
"environment": {
"$ref": "#/components/schemas/Environment"
}
}
}
CollectionAttributes
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/components/schemas/name"
},
"is_generated": {
"type": "boolean"
}
}
}
CollectionCreateNewResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
},
"description": "collection resource object"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionEditCollectionResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
},
"description": "collection resource object"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionGetByIdResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
},
"description": "collection resource object"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionGetListResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionResponse"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionMeta
{
"type": "object",
"required": [
"projects_count",
"issues_critical_count",
"issues_high_count",
"issues_medium_count",
"issues_low_count"
],
"properties": {
"projects_count": {
"type": "number",
"example": 7,
"description": "The amount of projects belonging to this collection"
},
"issues_low_count": {
"type": "number",
"example": 10,
"description": "The sum of low severity issues of the collection's projects"
},
"issues_high_count": {
"type": "number",
"example": 10,
"description": "The sum of high severity issues of the collection's projects"
},
"issues_medium_count": {
"type": "number",
"example": 10,
"description": "The sum of medium severity issues of the collection's projects"
},
"issues_critical_count": {
"type": "number",
"example": 10,
"description": "The sum of critical severity issues of the collection's projects"
}
}
}
CollectionRelationships
{
"type": "object",
"required": [
"org",
"created_by_user"
],
"properties": {
"org": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "331ede0a-de94-456f-b788-166caeca58bf",
"description": "ID of the org that this collection belongs to"
},
"type": {
"enum": [
"org"
],
"type": "string"
}
}
}
}
},
"created_by_user": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "331ede0a-de94-456f-b788-166caeca58bf",
"nullable": true,
"description": "ID of the user that created the collection. Null for auto-collections."
},
"type": {
"enum": [
"user"
],
"type": "string"
}
}
}
}
}
}
}
CollectionResponse
{
"type": "object",
"required": [
"id",
"type",
"meta",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"meta": {
"$ref": "#/components/schemas/CollectionMeta"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
}
}
CommonIssueModel
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754",
"description": "The Snyk ID of the vulnerability."
},
"type": {
"type": "string",
"example": "issue",
"description": "The type of the REST resource. Always ‘issue’."
},
"attributes": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754",
"description": "The Snyk vulnerability ID."
},
"type": {
"type": "string",
"example": "package_vulnerability",
"description": "The issue type"
},
"slots": {
"$ref": "#/components/schemas/Slots"
},
"title": {
"type": "string",
"example": "XML External Entity (XXE) Injection",
"description": "A human-readable title for this issue."
},
"problems": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"source"
],
"properties": {
"id": {
"type": "string",
"example": "CWE-61",
"maxLength": 1024,
"minLength": 1
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096,
"minLength": 1,
"description": "An optional URL for this problem."
},
"source": {
"type": "string",
"example": "CVE",
"maxLength": 64,
"minLength": 1
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was last updated."
},
"disclosed_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was disclosed to the public."
},
"discovered_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was first discovered."
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T13:51:13Z"
},
"severities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Severity"
},
"description": "The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’."
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T14:00:24.315507Z",
"description": "When the vulnerability information was last modified."
},
"coordinates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"remedies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "indeterminate",
"description": "The type of the remedy. Always ‘indeterminate’."
},
"details": {
"type": "object",
"properties": {
"upgrade_package": {
"type": "string",
"example": "5.4.0,6.4.0",
"description": "A minimum version to upgrade to in order to remedy the issue."
}
}
},
"description": {
"type": "string",
"example": "Upgrade the package version to 5.4.0,6.4.0 to fix this vulnerability",
"description": "A markdown-formatted optional description of this remedy."
}
}
}
},
"representation": {
"type": "array",
"items": {
"type": "string",
"example": "5.3.0"
},
"description": "The affected versions of this vulnerability."
}
}
}
},
"description": {
"type": "string",
"example": "## Overview\\n\\n\\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.",
"description": "A description of the issue in Markdown format"
},
"effective_severity_level": {
"enum": [
"info",
"low",
"medium",
"high",
"critical"
],
"type": "string",
"description": "The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies."
}
}
}
}
}
CommonIssueModelVTwo
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754",
"description": "The Snyk ID of the vulnerability."
},
"type": {
"type": "string",
"example": "issue",
"description": "The type of the REST resource. Always ‘issue’."
},
"attributes": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "package_vulnerability",
"description": "The issue type"
},
"slots": {
"$ref": "#/components/schemas/Slots"
},
"title": {
"type": "string",
"example": "XML External Entity (XXE) Injection",
"description": "A human-readable title for this issue."
},
"problems": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"source"
],
"properties": {
"id": {
"type": "string",
"example": "CWE-61",
"maxLength": 1024,
"minLength": 1
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096,
"minLength": 1,
"description": "An optional URL for this problem."
},
"source": {
"type": "string",
"example": "CVE",
"maxLength": 64,
"minLength": 1
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was last updated."
},
"disclosed_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was disclosed to the public."
},
"discovered_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was first discovered."
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T13:51:13Z"
},
"severities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Severity"
},
"description": "The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’."
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T14:00:24.315507Z",
"description": "When the vulnerability information was last modified."
},
"coordinates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoordinateVTwo"
}
},
"description": {
"type": "string",
"example": "## Overview\\n\\n\\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.",
"description": "A description of the issue in Markdown format"
},
"effective_severity_level": {
"enum": [
"info",
"low",
"medium",
"high",
"critical"
],
"type": "string",
"description": "The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies."
}
}
}
}
}
ContainerBuildArgs
{
"type": "object",
"required": [
"platform"
],
"properties": {
"platform": {
"type": "string"
}
}
}
ContainerImageGetInstanceResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Image"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ContainerImageListImageTargetRefsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageTargetRef"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ContainerImageListInstancesOfContainerImageResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
Context
{
"enum": [
"tenant",
"user"
],
"type": "string",
"description": "Allow installing the app to a org/group or to a user, default tenant."
}
Coordinate
{
"type": "object",
"properties": {
"remedies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Remedy"
},
"maxItems": 5,
"minItems": 1
},
"is_pinnable": {
"type": "boolean"
},
"is_patchable": {
"type": "boolean"
},
"reachability": {
"type": "string"
},
"is_upgradeable": {
"type": "boolean"
},
"is_fixable_snyk": {
"type": "boolean"
},
"representations": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"resourcePath"
],
"properties": {
"resourcePath": {
"type": "string",
"maxLength": 2024,
"minLength": 1
}
},
"description": "An object that contains an opaque identifying string."
},
{
"type": "object",
"required": [
"dependency"
],
"properties": {
"dependency": {
"$ref": "#/components/schemas/Dependency"
}
},
"description": "An object that contains a list of opaque identifying strings."
},
{
"type": "object",
"required": [
"cloud_resource"
],
"properties": {
"cloud_resource": {
"$ref": "#/components/schemas/CloudResource"
}
},
"description": "A resource location to some service, like a cloud resource."
},
{
"type": "object",
"required": [
"sourceLocation"
],
"properties": {
"sourceLocation": {
"$ref": "#/components/schemas/SourceLocation"
}
},
"description": "A location within a file."
}
]
},
"maxItems": 5,
"minItems": 1,
"description": "A list of precise locations that surface an issue. A coordinate may have multiple representations.\n"
},
"is_fixable_manually": {
"type": "boolean"
},
"is_fixable_upstream": {
"type": "boolean"
}
}
}
CoordinateVTwo
{
"type": "object",
"required": [
"representations"
],
"properties": {
"remedies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "indeterminate",
"description": "The type of the remedy. Always ‘indeterminate’."
},
"details": {
"type": "object",
"properties": {
"upgrade_package": {
"type": "string",
"example": "5.4.0,6.4.0",
"description": "A minimum version to upgrade to in order to remedy the issue."
}
}
},
"description": {
"type": "string",
"example": "Upgrade the package version to 5.4.0,6.4.0 to fix this vulnerability",
"description": "A markdown-formatted optional description of this remedy."
}
}
}
},
"representations": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourcePathRepresentation"
},
{
"$ref": "#/components/schemas/PackageRepresentation"
}
]
},
"description": "The affected versions of this vulnerability."
}
}
}
CreateCollectionRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/components/schemas/name"
}
}
}
}
}
}
}
CustomBaseImageAttributes
{
"type": "object",
"required": [
"project_id",
"include_in_recommendations"
],
"properties": {
"project_id": {
"type": "string",
"format": "uuid",
"example": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
"description": "The ID of the container project that the custom base image is based off of.\nThe attributes of this custom base image are taken from the latest snapshot at the time of creation.\nThis means that no changes should be made to the original project after the creation of the custom base image,\nas new snapshots created from any changes will NOT be picked up.\n"
},
"versioning_schema": {
"$ref": "#/components/schemas/VersioningSchema"
},
"include_in_recommendations": {
"type": "boolean",
"example": true,
"description": "Whether this image should be recommended as a base image upgrade. \nIf set to true, this image could be shown as a base image upgrade to other projects.\nIf set to false this image will never be recommended as an upgrade.\n"
}
}
}
CustomBaseImageCollectionResponse
{
"type": "object",
"required": [
"data",
"jsonapi"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/CustomBaseImageSnapshot"
}
}
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CustomBaseImagePatchRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the custom base image that should be updated. (Same one used in the URI)"
},
"type": {
"type": "string",
"example": "custom_base_image",
"description": "This should always be \"custom_base_image\""
},
"attributes": {
"type": "object",
"properties": {
"versioning_schema": {
"$ref": "#/components/schemas/VersioningSchema"
},
"include_in_recommendations": {
"type": "boolean",
"example": true
}
},
"minProperties": 1
}
}
}
}
}
CustomBaseImagePostRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"example": "custom_base_image",
"description": "This should always be \"custom_base_image\""
},
"attributes": {
"$ref": "#/components/schemas/CustomBaseImageAttributes"
}
}
}
}
}
CustomBaseImageResource
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "2cab3939-d112-4ef0-836d-e09c87cbe69b"
},
"type": {
"type": "string",
"example": "custom_base_image"
},
"attributes": {
"$ref": "#/components/schemas/CustomBaseImageAttributes"
}
}
}
CustomBaseImageResponse
{
"type": "object",
"required": [
"data",
"jsonapi"
],
"properties": {
"data": {
"$ref": "#/components/schemas/CustomBaseImageResource"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CustomBaseImageSnapshot
{
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"org_id": {
"type": "string",
"format": "uuid"
},
"group_id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"repository": {
"type": "string"
},
"include_in_recommendations": {
"type": "boolean"
}
}
}
CycloneDxComponent
{
"xml": {
"name": "component"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "acme-lib"
},
"purl": {
"type": "string",
"example": "pkg:golang/golang.org/x/text@v0.3.7"
},
"type": {
"xml": {
"attribute": true
},
"type": "string",
"example": "library"
},
"bom-ref": {
"xml": {
"attribute": true
},
"type": "string",
"example": "common-util@3.0.0"
},
"version": {
"type": "string",
"example": "1.0.0"
}
}
}
CycloneDxDependency
{
"xml": {
"name": "dependency"
},
"type": "object",
"properties": {
"ref": {
"xml": {
"attribute": true
},
"type": "string",
"example": "common-util@3.0.0"
},
"dependsOn": {
"xml": {
"name": "dependency"
},
"type": "array",
"items": {
"type": "string"
},
"example": [
"web-framework@1.0.0",
"persistence@3.1.0"
]
}
}
}
CycloneDxDocument
{
"type": "object",
"required": [
"bomFormat",
"specVersion",
"version",
"metadata",
"dependencies"
],
"properties": {
"version": {
"type": "integer",
"example": 1
},
"metadata": {
"$ref": "#/components/schemas/CycloneDxMetadata"
},
"bomFormat": {
"enum": [
"CycloneDX"
],
"type": "string",
"example": "CycloneDX"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxComponent"
},
"description": "A list of included software components"
},
"specVersion": {
"type": "string",
"example": "1.4"
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxDependency"
}
}
}
}
CycloneDxMetadata
{
"type": "object",
"properties": {
"tools": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxTool"
}
},
"component": {
"$ref": "#/components/schemas/CycloneDxComponent"
},
"timestamp": {
"type": "string",
"example": "2021-02-09T20:40:32Z"
},
"properties": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxProperty"
}
}
}
}
CycloneDxProperty
{
"xml": {
"name": "property"
},
"type": "object",
"properties": {
"name": {
"xml": {
"attribute": true
},
"type": "string",
"example": "snyk:org_id"
},
"value": {
"type": "string",
"example": "f1bb66d1-a94e-4574-aea1-9697d794e04d"
}
}
}
CycloneDxTool
{
"xml": {
"name": "tool"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Snyk Open Source"
},
"vendor": {
"type": "string",
"example": "Snyk"
}
}
}
CycloneDxXmlDocument
{
"xml": {
"name": "bom"
},
"type": "object",
"required": [
"metadata",
"components",
"dependencies"
],
"properties": {
"metadata": {
"$ref": "#/components/schemas/CycloneDxMetadata"
},
"components": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxComponent"
},
"description": "A list of included software components"
},
"dependencies": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxDependency"
}
}
}
}
DeleteProjectsFromCollectionRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"enum": [
"project"
],
"type": "string",
"description": "Type of the item id"
}
}
},
"maxItems": 100,
"description": "IDs of items to remove from a collection"
}
}
}
Dependency
{
"type": "object",
"required": [
"package_name",
"package_version"
],
"properties": {
"package_name": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "The package name the issue was found in"
},
"package_version": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "The package version the issue was found in"
}
}
}
DeployedRiskFactor
{
"type": "object",
"required": [
"name",
"updated_at",
"value"
],
"properties": {
"name": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/RiskFactorLinks"
},
"value": {
"type": "boolean"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"included_in_score": {
"type": "boolean",
"default": false
}
}
}
Environment
{
"type": "object",
"required": [
"id",
"type",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Internal ID for an environment."
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"type": {
"$ref": "#/components/schemas/EnvironmentTypeDef"
},
"native_id": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "An optional native identifier for this environment. For example, a cloud account id."
}
}
}
EnvironmentTypeDef
{
"enum": [
"aws",
"azure",
"azure_ad",
"google",
"scm",
"cli",
"tfc"
],
"type": "string"
}
Error
{
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"links": {
"$ref": "#/components/schemas/ErrorLink"
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
}
ErrorDocument
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}