openapi: 3.0.3 info: title: Snyk AccessRequests Issues API version: REST servers: - description: Snyk REST API url: https://api.snyk.io/rest security: - APIToken: [] - BearerAuth: [] tags: - name: Issues paths: /groups/{group_id}/issues: get: description: 'Get a list of a group''s issues. #### Required permissions - `View Issues (group.issues.read)`' operationId: listGroupIssues parameters: - $ref: '#/components/parameters/Version' - $ref: '#/components/parameters/StartingAfter' - $ref: '#/components/parameters/EndingBefore' - $ref: '#/components/parameters/Limit' - description: Group ID in: path name: group_id required: true schema: example: 4a18d42f-0706-4ad0-b127-24078731fbed format: uuid type: string - $ref: '#/components/parameters/ScanItemId' - $ref: '#/components/parameters/ScanItemType' - $ref: '#/components/parameters/Type' - description: A filter to select issues updated before this date. in: query name: updated_before schema: format: date-time type: string - description: A filter to select issues updated after this date. in: query name: updated_after schema: format: date-time type: string - description: A filter to select issues created before this date. in: query name: created_before schema: format: date-time type: string - description: A filter to select issues created after this date. in: query name: created_after schema: format: date-time type: string - $ref: '#/components/parameters/EffectiveSeverityLevel' - $ref: '#/components/parameters/Status' - $ref: '#/components/parameters/Ignored' responses: '200': $ref: '#/components/responses/ListIssues200' '401': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '403': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '404': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Not Found: The resource being operated on could not be found.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '500': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Internal Server Error: An error was encountered while attempting to process the request.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string summary: Get issues by group ID tags: - Issues x-snyk-api-lifecycle: released x-snyk-api-releases: - 2023-03-10~experimental - 2023-09-29~beta - '2024-01-23' x-snyk-api-resource: issues x-snyk-api-stability: ga x-snyk-api-version: '2024-01-23' x-stability-level: stable /groups/{group_id}/issues/{issue_id}: get: description: 'Get an issue #### Required permissions - `View Issues (group.issues.read)`' operationId: getGroupIssueByIssueID parameters: - $ref: '#/components/parameters/Version' - description: Group ID in: path name: group_id required: true schema: example: 4a18d42f-0706-4ad0-b127-24078731fbed format: uuid type: string - $ref: '#/components/parameters/PathIssueId20240123' responses: '200': $ref: '#/components/responses/GetIssue20020240123' '400': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Bad Request: A parameter provided as a part of the request was invalid.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '401': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '403': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '404': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Not Found: The resource being operated on could not be found.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '409': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Conflict: The requested operation conflicts with the current state of the resource in some way.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '500': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Internal Server Error: An error was encountered while attempting to process the request.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string summary: Get an issue tags: - Issues x-snyk-api-lifecycle: released x-snyk-api-releases: - '2024-01-23' x-snyk-api-resource: issues x-snyk-api-stability: ga x-snyk-api-version: '2024-01-23' x-stability-level: stable /orgs/{org_id}/issues: get: description: 'Get a list of an organization''s issues. #### Required permissions - `View Organization (org.read)` - `View Projects (org.project.read)` - `View Project history (org.project.snapshot.read)`' operationId: listOrgIssues parameters: - $ref: '#/components/parameters/Version' - $ref: '#/components/parameters/StartingAfter' - $ref: '#/components/parameters/EndingBefore' - $ref: '#/components/parameters/Limit' - description: Org ID in: path name: org_id required: true schema: example: 4a18d42f-0706-4ad0-b127-24078731fbed format: uuid type: string - $ref: '#/components/parameters/ScanItemId' - $ref: '#/components/parameters/ScanItemType' - $ref: '#/components/parameters/Type' - description: A filter to select issues updated before this date. in: query name: updated_before schema: format: date-time type: string - description: A filter to select issues updated after this date. in: query name: updated_after schema: format: date-time type: string - description: A filter to select issues created before this date. in: query name: created_before schema: format: date-time type: string - description: A filter to select issues created after this date. in: query name: created_after schema: format: date-time type: string - $ref: '#/components/parameters/EffectiveSeverityLevel' - $ref: '#/components/parameters/Status' - $ref: '#/components/parameters/Ignored' responses: '200': $ref: '#/components/responses/ListIssues200' '401': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '403': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '404': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Not Found: The resource being operated on could not be found.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '500': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Internal Server Error: An error was encountered while attempting to process the request.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string summary: Get issues by org ID tags: - Issues x-snyk-api-lifecycle: released x-snyk-api-releases: - 2023-03-10~experimental - 2023-09-29~beta - '2024-01-23' x-snyk-api-resource: issues x-snyk-api-stability: ga x-snyk-api-version: '2024-01-23' x-stability-level: stable /orgs/{org_id}/issues/{issue_id}: get: description: 'Get an issue #### Required permissions - `View Organization (org.read)` - `View Projects (org.project.read)` - `View Project history (org.project.snapshot.read)`' operationId: getOrgIssueByIssueID parameters: - $ref: '#/components/parameters/Version' - description: Org ID in: path name: org_id required: true schema: example: 4a18d42f-0706-4ad0-b127-24078731fbed format: uuid type: string - $ref: '#/components/parameters/PathIssueId20240123' responses: '200': $ref: '#/components/responses/GetIssue20020240123' '400': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Bad Request: A parameter provided as a part of the request was invalid.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '401': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '403': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Unauthorized: the request requires an authentication token or a token with more permissions.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '404': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Not Found: The resource being operated on could not be found.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '409': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Conflict: The requested operation conflicts with the current state of the resource in some way.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string '500': content: application/vnd.api+json: schema: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object description: 'Internal Server Error: An error was encountered while attempting to process the request.' headers: deprecation: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string snyk-request-id: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string snyk-version-lifecycle-stage: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string snyk-version-requested: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string snyk-version-served: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string sunset: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string summary: Get an issue tags: - Issues x-snyk-api-lifecycle: released x-snyk-api-releases: - '2024-01-23' x-snyk-api-resource: issues x-snyk-api-stability: ga x-snyk-api-version: '2024-01-23' x-stability-level: stable /orgs/{org_id}/packages/issues: post: description: 'This endpoint is currently restricted and is not available to all customers. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned; transitive vulnerabilities (from dependencies) are not included as they can vary depending on the context. #### Required permissions - `View Organization (org.read)`' operationId: listIssuesForManyPurls parameters: - $ref: '#/components/parameters/Version' - description: Unique identifier for an organization in: path name: org_id required: true schema: format: uuid type: string requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/BulkPackageUrlsRequestBody' required: true responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/IssuesWithPurlsResponse' description: Returns an array of issues with the purl identifier of the package that caused them headers: deprecation: $ref: '#/components/headers/DeprecationHeader' location: $ref: '#/components/headers/Location' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' summary: List issues for a given set of packages (Currently not available to all customers) tags: - Issues x-snyk-api-lifecycle: released x-snyk-api-releases: - 2023-01-04~experimental - 2023-03-29~beta - '2023-04-17' - '2023-08-21' - '2024-06-26' - '2025-11-05' x-snyk-api-resource: issues x-snyk-api-stability: ga x-snyk-api-version: '2025-11-05' x-stability-level: stable /orgs/{org_id}/packages/{purl}/issues: get: description: 'Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context. For Maven packages, you can optionally include a checksum qualifier in the PURL to request checksum validation. The response will include metadata indicating whether the provided checksum matches Snyk''s records. Vulnerabilities are always returned regardless of checksum match status; the validation metadata allows clients to interpret results appropriately. #### Required permissions - `View Organization (org.read)`' operationId: getIssuesPerPurl parameters: - $ref: '#/components/parameters/Version' - $ref: '#/components/parameters/PackageUrl' - description: Unique identifier for an organization in: path name: org_id required: true schema: format: uuid type: string - description: Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0. in: query name: offset schema: minimum: 0 type: integer - description: Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000. in: query name: limit schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/vnd.api+json: schema: $ref: '#/components/schemas/IssuesResponse' description: Returns an array of issues headers: deprecation: $ref: '#/components/headers/DeprecationHeader' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' summary: List issues for a package tags: - Issues x-snyk-api-lifecycle: released x-snyk-api-releases: - 2022-06-29~beta - '2022-09-15' - '2024-06-26' - '2025-11-05' x-snyk-api-resource: issues x-snyk-api-stability: ga x-snyk-api-version: '2025-11-05' x-stability-level: stable components: responses: GetIssue20020240123: content: application/vnd.api+json: schema: properties: data: $ref: '#/components/schemas/Issue' jsonapi: $ref: '#/components/schemas/JsonApi' links: $ref: '#/components/schemas/PaginatedLinks' required: - jsonapi - data description: Returns an instance of an issue headers: deprecation: $ref: '#/components/headers/DeprecationHeader__0' location: description: 'A header providing a URL for the location of a resource ' example: https://example.com/resource/4 schema: format: uri type: string snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader__0' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader__0' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader__0' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader__0' sunset: $ref: '#/components/headers/SunsetHeader__0' '400': content: application/vnd.api+json: schema: $ref: '#/components/schemas/ErrorDocument' description: 'Bad Request: A parameter provided as a part of the request was invalid.' headers: deprecation: $ref: '#/components/headers/DeprecationHeader' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' '500': content: application/vnd.api+json: schema: $ref: '#/components/schemas/ErrorDocument' description: 'Internal Server Error: An error was encountered while attempting to process the request.' headers: deprecation: $ref: '#/components/headers/DeprecationHeader' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' '404': content: application/vnd.api+json: schema: $ref: '#/components/schemas/ErrorDocument' description: 'Not Found: The resource being operated on could not be found.' headers: deprecation: $ref: '#/components/headers/DeprecationHeader' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' '403': content: application/vnd.api+json: schema: $ref: '#/components/schemas/ErrorDocument' description: 'Forbidden: the request requires an authentication token with more or different permissions.' headers: deprecation: $ref: '#/components/headers/DeprecationHeader' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' '409': content: application/vnd.api+json: schema: $ref: '#/components/schemas/ErrorDocument' description: 'Conflict: The requested operation conflicts with the current state of the resource in some way.' headers: deprecation: $ref: '#/components/headers/DeprecationHeader' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' ListIssues200: content: application/vnd.api+json: examples: Cloud: $ref: '#/components/examples/CloudListIssuesResponse' Code: $ref: '#/components/examples/CodeListIssuesResponse20240123' IaC: $ref: '#/components/examples/IaCListIssuesResponse20240123' OpenSource: $ref: '#/components/examples/OpenSourceListIssuesResponse20240123' schema: properties: data: items: $ref: '#/components/schemas/Issue' type: array jsonapi: $ref: '#/components/schemas/JsonApi' links: $ref: '#/components/schemas/PaginatedLinks' required: - jsonapi - data description: Returns a collection of issues. headers: deprecation: $ref: '#/components/headers/DeprecationHeader__0' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader__0' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader__0' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader__0' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader__0' sunset: $ref: '#/components/headers/SunsetHeader__0' '401': content: application/vnd.api+json: schema: $ref: '#/components/schemas/ErrorDocument' description: 'Unauthorized: the request requires an authentication token.' headers: deprecation: $ref: '#/components/headers/DeprecationHeader' snyk-request-id: $ref: '#/components/headers/RequestIdResponseHeader' snyk-version-lifecycle-stage: $ref: '#/components/headers/VersionStageResponseHeader' snyk-version-requested: $ref: '#/components/headers/VersionRequestedResponseHeader' snyk-version-served: $ref: '#/components/headers/VersionServedResponseHeader' sunset: $ref: '#/components/headers/SunsetHeader' headers: SunsetHeader__0: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string VersionStageResponseHeader__0: description: 'The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string VersionStageResponseHeader: description: 'A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ' schema: enum: - wip - experimental - beta - ga - deprecated - sunset example: ga type: string RequestIdResponseHeader: description: 'A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string SunsetHeader: description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD' example: '2021-08-02' schema: format: date type: string RequestIdResponseHeader__0: description: 'A unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID. ' example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef schema: format: uuid type: string DeprecationHeader: description: 'A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string VersionRequestedResponseHeader: description: A header containing the version of the endpoint requested by the caller. example: '2026-03-25' schema: $ref: '#/components/schemas/QueryVersion' VersionServedResponseHeader: description: A header containing the version of the endpoint that was served by the API. example: '2026-03-25' schema: $ref: '#/components/schemas/ActualVersion' VersionServedResponseHeader__0: description: The version of the endpoint that was served by the API. example: '2021-06-04' schema: description: Resolved API version pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string Location: schema: type: string DeprecationHeader__0: description: 'The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ' example: '2021-07-01T00:00:00Z' schema: format: date-time type: string VersionRequestedResponseHeader__0: description: The version of the endpoint requested by the caller. example: '2021-06-04' schema: description: Requested API version pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string parameters: Ignored: description: Whether an issue is ignored or not. in: query name: ignored schema: type: boolean style: form PathIssueId20240123: description: Issue ID in: path name: issue_id required: true schema: example: 4a18d42f-0706-4ad0-b127-24078731fbed format: uuid type: string Limit: description: Number of results to return per page example: 10 in: query name: limit schema: default: 10 format: int32 maximum: 100 minimum: 10 multipleOf: 10 type: integer Type: description: An issue type to filter issues. in: query name: type schema: $ref: '#/components/schemas/TypeDef' style: form EndingBefore: description: Return the page of results immediately before this cursor example: v1.eyJpZCI6IjExMDAifQo= in: query name: ending_before schema: type: string StartingAfter: description: Return the page of results immediately after this cursor example: v1.eyJpZCI6IjEwMDAifQo= in: query name: starting_after schema: type: string ScanItemType: description: A scan item types to filter issues through their scan item relationship. in: query name: scan_item.type schema: $ref: '#/components/schemas/ScanItemType' style: form ScanItemId: description: A scan item id to filter issues through their scan item relationship. in: query name: scan_item.id schema: example: 4a18d42f-0706-4ad0-b127-24078731fbee format: uuid type: string style: form Status: description: An issue's status explode: false in: query name: status schema: items: enum: - open - resolved type: string type: array style: form Version: description: The requested version of the endpoint to process the request example: '2026-03-25' in: query name: version required: true schema: $ref: '#/components/schemas/QueryVersion' PackageUrl: description: 'A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required. Maven packages support an optional checksum qualifier to request checksum validation. When provided, the response will include checksum validation metadata indicating whether the package and checksum match records in Snyk''s database. Checksum format: `algorithm:hex_value` (lowercase), for example `sha1:ad9503c3e994a4f611a4892f2e67ac82df727086`. Only one checksum is supported per request. Supported algorithms: md5, sha1, sha256, sha512.' example: pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0?checksum=sha1:ad9503c3e994a4f611a4892f2e67ac82df727086 in: path name: purl required: true schema: type: string EffectiveSeverityLevel: description: One or more effective severity levels to filter issues. explode: false in: query name: effective_severity_level schema: items: enum: - info - low - medium - high - critical type: string type: array style: form schemas: ClassTypeDef: enum: - rule-category - compliance - weakness example: compliance type: string QueryVersion: description: Requested API version example: '2026-03-25' pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$ type: string ScanItemType: enum: - project - environment example: project type: string ExploitDetails: description: Details about the exploits properties: maturity_levels: description: List of maturity levels items: $ref: '#/components/schemas/MaturityLevel' type: array sources: description: Sources for determining exploit maturity level, e.g., CISA, ExploitDB, Snyk. items: type: string type: array type: object OSConditionRiskFactor: properties: included_in_score: default: false type: boolean links: $ref: '#/components/schemas/RiskFactorLinks' name: type: string updated_at: format: date-time type: string value: type: boolean required: - name - updated_at - value type: object ResourcePathRepresentation: description: An object that contains an opaque identifying string. properties: resource_path: $ref: '#/components/schemas/ResourcePath' required: - resource_path type: object IssuesWithPurlsResponse: additionalProperties: false properties: data: items: $ref: '#/components/schemas/CommonIssueModelVThree' type: array jsonapi: $ref: '#/components/schemas/JsonApi' links: $ref: '#/components/schemas/PaginatedLinks' meta: $ref: '#/components/schemas/PurlIssuesMeta' type: object Coordinate: properties: remedies: items: $ref: '#/components/schemas/Remedy3' type: array representations: description: The affected versions of this vulnerability. items: anyOf: - $ref: '#/components/schemas/ResourcePathRepresentation' - $ref: '#/components/schemas/PackageRepresentation' type: array required: - representations type: object CVSSSource: additionalProperties: false properties: level: example: medium minLength: 1 type: string modification_time: description: The time this CVSS data was last updated format: date-time type: string score: example: 4.2 format: float type: number source: example: snyk minLength: 1 type: string vector: example: CVSS:4.0/AV:N/AC:H/AT:N/PR:L/UI:A/VC:N/VI:N/VA:N/SC:H/SI:L/SA:L/E:A minLength: 1 type: string version: example: '4.0' minLength: 1 type: string required: - level - source - score - vector - version - modification_time type: object Problem: additionalProperties: false example: id: SNYK-DEBIAN8-CURL-358558 source: snyk type: rule properties: disclosed_at: description: When this problem was disclosed to the public. format: date-time type: string discovered_at: description: When this problem was first discovered. format: date-time type: string id: maxLength: 1024 minLength: 1 type: string source: example: CVE maxLength: 64 minLength: 1 type: string type: $ref: '#/components/schemas/ProblemTypeDef' updated_at: description: When this problem was last updated. format: date-time type: string url: description: An optional URL for this problem. format: uri maxLength: 4096 minLength: 1 type: string required: - id - type - source type: object CommonIssueModelVThree: properties: attributes: properties: coordinates: items: $ref: '#/components/schemas/Coordinate' type: array created_at: example: '2022-06-16T13:51:13Z' format: date-time type: string description: description: A description of the issue in Markdown format example: '## Overview\n\n\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.' type: string effective_severity_level: 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. enum: - info - low - medium - high - critical type: string problems: items: $ref: '#/components/schemas/Problem3' type: array severities: description: An array of dictionaries containing all known data related to the vulnerability items: $ref: '#/components/schemas/Severity3' type: array slots: $ref: '#/components/schemas/Slots' title: description: A human-readable title for this issue. example: XML External Entity (XXE) Injection type: string type: description: The issue type example: package_vulnerability type: string updated_at: description: When the vulnerability information was last modified. example: '2022-06-16T14:00:24.315507Z' format: date-time type: string type: object id: description: The Snyk ID of the vulnerability. example: SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754 type: string type: description: The type of the REST resource. Always ‘issue’. example: issue type: string type: object Issue: additionalProperties: false description: A Snyk Issue. properties: attributes: $ref: '#/components/schemas/IssueAttributes' id: example: 73832c6c-19ff-4a92-850c-2e1ff2800c16 format: uuid type: string relationships: $ref: '#/components/schemas/IssueRelationships' type: $ref: '#/components/schemas/IssueType' required: - id - type - attributes - relationships type: object Severity3: properties: level: description: Level of severity calculated via vector example: medium type: string score: description: The CVSS score calculated from the vector, representing the severity of the vulnerability on a scale from 0 to 10. example: 5.3 nullable: true type: number source: description: The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application. example: Snyk type: string type: description: Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector. example: primary type: string vector: description: CVSS vector string detailing the metrics of a vulnerability. example: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:L nullable: true type: string version: description: CVSS version being described. example: '4.0' type: string type: object PaginatedLinks: additionalProperties: false example: first: https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K last: https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K next: https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K properties: first: $ref: '#/components/schemas/LinkProperty' last: $ref: '#/components/schemas/LinkProperty' next: $ref: '#/components/schemas/LinkProperty' prev: $ref: '#/components/schemas/LinkProperty' self: $ref: '#/components/schemas/LinkProperty' type: object RiskFactorLinks: properties: evidence: $ref: '#/components/schemas/LinkProperty' type: object IgnoreType: enum: - ignore example: ignore type: string OrganizationType: enum: - organization example: organization type: string ActualVersion: description: Resolved API version example: '2026-03-25' pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$ type: string IssuesResponse: additionalProperties: false properties: data: items: $ref: '#/components/schemas/CommonIssueModelVThree' type: array jsonapi: $ref: '#/components/schemas/JsonApi' links: $ref: '#/components/schemas/PaginatedLinks' meta: $ref: '#/components/schemas/IssuesMeta' type: object ResourcePath: example: ',5.4.0),[6.0.0.pr1,6.4.0)' maxLength: 2024 minLength: 1 type: string Error: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string links: additionalProperties: false description: A link that leads to further details about this particular occurrance of the problem. example: about: https://example.com/about_this_error properties: about: example: https://example.com/api/resource oneOf: - description: A string containing the link’s URL. example: https://example.com/api/resource type: string - additionalProperties: false example: href: https://example.com/api/resource properties: href: description: A string containing the link’s URL. example: https://example.com/api/resource type: string meta: additionalProperties: true description: Free-form object that may contain non-standard information. example: key1: value1 key2: sub_key: sub_value key3: - array_value1 - array_value2 type: object required: - href type: object type: object meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object PackageMeta__0: properties: name: description: The package’s name example: spring-core type: string namespace: description: A name prefix, such as a maven group id or docker image owner example: org.springframework type: string type: description: The package type or protocol example: maven type: string url: description: The purl of the package example: pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0 type: string version: description: The version of the package example: 1.0.0 type: string type: object ErrorDocument: additionalProperties: false example: errors: - detail: Permission denied for this resource status: '403' jsonapi: version: '1.0' properties: errors: example: - detail: Permission denied for this resource status: '403' items: additionalProperties: false example: detail: Not Found status: '404' properties: code: description: An application-specific error code, expressed as a string value. example: entity-not-found type: string detail: description: A human-readable explanation specific to this occurrence of the problem. example: 'The request was missing these required fields: ...' type: string id: description: A unique identifier for this particular occurrence of the problem. example: f16c31b5-6129-4571-add8-d589da9be524 format: uuid type: string links: additionalProperties: false description: A link that leads to further details about this particular occurrance of the problem. example: about: https://example.com/about_this_error properties: about: example: https://example.com/api/resource oneOf: - description: A string containing the link’s URL. example: https://example.com/api/resource type: string - additionalProperties: false example: href: https://example.com/api/resource properties: href: description: A string containing the link’s URL. example: https://example.com/api/resource type: string meta: additionalProperties: true description: Free-form object that may contain non-standard information. example: key1: value1 key2: sub_key: sub_value key3: - array_value1 - array_value2 type: object required: - href type: object type: object meta: additionalProperties: true example: key: value type: object source: additionalProperties: false example: pointer: /data/attributes properties: parameter: description: A string indicating which URI query parameter caused the error. example: param1 type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document. example: /data/attributes type: string type: object status: description: The HTTP status code applicable to this problem, expressed as a string value. example: '400' pattern: ^[45]\d\d$ type: string title: 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. example: Bad request type: string required: - status - detail type: object minItems: 1 type: array jsonapi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object required: - jsonapi - errors type: object RiskScore: description: Risk prioritization score based on an analysis model example: model: v1 value: 700 properties: model: description: Risk scoring model used to calculate the score value type: string updated_at: format: date-time type: string value: description: Risk score value, which may be used for overall prioritization maximum: 1000 minimum: 0 type: integer required: - value - model type: object MaturityLevel: description: Details about the maturity level properties: format: description: The standard by which the “maturity” value is shown. example: CVSSv4 type: string level: description: 'Exploit maturity of the vulnerability. For CVSSv3: Proof of Concept, Functional, High. For CVSSv4: Unreported, Proof of Concept, Attacked.' example: Attacked type: string type: description: Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector. example: primary type: string type: object BulkPackageUrlsRequestBody: properties: data: properties: attributes: properties: purls: description: An array of Package URLs (purl). Supported purl types are apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required. items: type: string type: array required: - purls type: object type: $ref: '#/components/schemas/Types' required: - attributes type: object required: - data type: object Class: additionalProperties: false example: id: CWE-190 source: CWE type: weakness properties: id: maxLength: 1024 minLength: 1 type: string source: example: CWE maxLength: 64 minLength: 1 type: string type: $ref: '#/components/schemas/ClassTypeDef' url: description: An optional URL for this class. format: uri maxLength: 4096 minLength: 1 type: string required: - id - type - source type: object Remedy3: properties: description: description: A markdown-formatted optional description of this remedy. example: Upgrade the package version to 5.4.0,6.4.0 to fix this vulnerability type: string details: properties: upgrade_package: description: A minimum version to upgrade to in order to remedy the issue. example: 5.4.0,6.4.0 type: string type: object type: description: The type of the remedy. Always ‘indeterminate’. example: indeterminate type: string type: object PublicFacingRiskFactor: properties: included_in_score: default: false type: boolean links: $ref: '#/components/schemas/RiskFactorLinks' name: type: string updated_at: format: date-time type: string value: type: boolean required: - name - updated_at - value type: object PackageMeta: properties: name: description: The package’s name example: woodstox-core type: string namespace: description: A name prefix, such as a maven group id or docker image owner example: com.fasterxml.woodstox type: string type: description: The package type or protocol example: maven type: string url: description: The purl of the package example: pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0 type: string version: description: The version of the package example: 5.0.0 type: string type: object IssueType: enum: - issue example: issue type: string Problem3: properties: disclosed_at: description: When this problem was disclosed to the public. format: date-time type: string discovered_at: description: When this problem was first discovered. format: date-time type: string id: example: CWE-61 maxLength: 1024 minLength: 1 type: string source: example: CVE maxLength: 64 minLength: 1 type: string updated_at: description: When this problem was last updated. format: date-time type: string url: description: An optional URL for this problem. format: uri maxLength: 4096 minLength: 1 type: string required: - id - source type: object IssueRelationships: additionalProperties: false description: issue relationships example: ignore: data: id: a3952187-0d8e-45d8-9aa2-036642857b5d type: ignore organization: data: id: a3952187-0d8e-45d8-9aa2-036642857b5b type: organization scan_item: data: id: a3952187-0d8e-45d8-9aa2-036642857b5c type: project test_executions: data: - id: 0086e1bc-7c27-4f2e-9a99-5fe793ba4bef type: test-workflow-execution properties: ignore: description: An optional reference to an ignore rule that marks this issue as ignored. properties: data: properties: id: example: 5a19d42f-31bc-4ad0-b127-b79a3270db08 type: string type: $ref: '#/components/schemas/IgnoreType' required: - type - id type: object required: - data type: object organization: properties: data: properties: id: example: 5a19d42f-31bc-4ad0-b127-b79a3270db08 format: uuid type: string type: $ref: '#/components/schemas/OrganizationType' required: - type - id type: object required: - data type: object scan_item: properties: data: properties: id: example: 5a19d42f-31bc-4ad0-b127-b79a3270db08 format: uuid type: string type: $ref: '#/components/schemas/ScanItemType' required: - type - id type: object required: - data type: object test_executions: description: 'The "test execution" that identified this Issues. This ID represents a grouping of issues, that were identified by some analysis run, to produce Issues. ' properties: data: description: List of metadata associated with the test executions that identified this issue items: properties: id: example: 3344947d-a5c3-4e20-928b-385a5d8792a3 type: string type: $ref: '#/components/schemas/TestExecutionType' required: - type - id type: object maxItems: 25 type: array required: - data type: object required: - organization - scan_item type: object ChecksumValidationMeta: description: Metadata about checksum validation when a checksum qualifier is provided in the PURL properties: description: description: Human-readable explanation of the validation result example: Package and checksum both match type: string details: properties: checksum: description: Whether the checksum matched (null if no checksum validation was requested) example: true nullable: true type: boolean name_version: description: Whether the package name and version were found example: true type: boolean required: - name_version - checksum type: object input: properties: checksum: description: The checksum value provided (null if none) example: sha1:abc123 nullable: true type: string purl: description: The original PURL provided example: pkg:maven/com.example/my-package@1.0.0?checksum=sha1:abc123 type: string required: - purl - checksum type: object type: description: 'The type of match found: - `full`: Both package ID and checksum match - `partial`: Only one of package ID or checksum matches - `none`: Neither package ID nor checksum found' enum: - none - partial - full example: full type: string required: - type - details - description - input type: object IssuesMeta: properties: match: $ref: '#/components/schemas/ChecksumValidationMeta' package: $ref: '#/components/schemas/PackageMeta__0' type: object Risk: additionalProperties: false description: Risk prioritization information for an issue example: factors: - name: deployed updated_at: '2023-09-07T13:36:37Z' value: true score: model: v4 value: 700 properties: factors: description: Risk factors identified for an issue items: $ref: '#/components/schemas/RiskFactor' type: array score: $ref: '#/components/schemas/RiskScore' required: - factors type: object Slots: properties: disclosure_time: description: The time at which this vulnerability was disclosed. example: '2022-06-16T13:51:13Z' format: date-time type: string exploit_details: $ref: '#/components/schemas/ExploitDetails' publication_time: description: The time at which this vulnerability was published. example: '2022-06-16T14:00:24.315507Z' type: string references: items: properties: title: description: Descriptor for an external reference to the issue type: string url: description: URL for an external reference to the issue type: string type: object type: array type: object DeployedRiskFactor: properties: included_in_score: default: false type: boolean links: $ref: '#/components/schemas/RiskFactorLinks' name: type: string updated_at: format: date-time type: string value: type: boolean required: - name - updated_at - value type: object PackageRepresentation: properties: package: $ref: '#/components/schemas/PackageMeta' type: object IssueAttributes: additionalProperties: false description: issue attributes properties: classes: description: A list of details for weakness data, policy, etc that are the class of this issue's source. items: $ref: '#/components/schemas/Class' maxItems: 50 minItems: 1 type: array coordinates: description: 'Where the issue originated, specific to issue type. Details on what code, package, etc introduced the issue. An issue may be caused by more than one coordinate. ' items: properties: created_at: description: The time when this coordinate was created. format: date-time type: string is_fixable_manually: description: Indicates whether a issue can be fixed manually by the user. This typically involves making changes directly to the code or configuration to address the issue. type: boolean is_fixable_snyk: description: Indicates whether Snyk can automatically provide a fix for the issue. Snyk might offer solutions like patches or upgrades that can be applied directly through its platform. type: boolean is_fixable_upstream: description: Indicates whether a fix is available from the upstream source, such as the original package maintainers. It means that the issue can be resolved by updating to a version where the maintainers have already addressed the vulnerability. type: boolean is_patchable: description: Indicates whether the issue can be fixed by applying a patch. Patches are specific code changes that address vulnerabilities without requiring a full upgrade of the package. type: boolean is_pinnable: description: Indicates whether the issue can be fixed by pinning the dependency to a specific version. Pinning involves locking the dependency to a version that is known to be secure. type: boolean is_upgradeable: description: Indicates whether the issue can be resolved by upgrading the package to a newer version. Upgrading typically involves moving to a version where the vulnerability has been fixed. type: boolean last_introduced_at: description: The time when this coordinate was last introduced. format: date-time type: string last_resolved_at: description: The time when this coordinate was last resolved. format: date-time type: string last_resolved_details: description: Optional details about the last resolution of this coordinate. type: string reachability: description: '- function and package are both presented in e.g. reporting as "Reachable", meaning that a direct or indirect path was found from the application to the vulnerable code. - no-info is presented as "No path found", meaning that there was no path found from the application to the vulnerable code. - not-applicable is presented as "Not applicable" and it means that reachability information isn''t applicable to the issue. E.g we do not provide reachability info for Snyk container issues. ' enum: - function - package - no-info - not-applicable type: string remedies: items: additionalProperties: false properties: correlation_id: description: 'An optional identifier for correlating remedies between coordinates or across issues. They are scoped to a single Project and test run. Remedies with the same correlation_id must have the same contents. ' maxLength: 256 minLength: 1 type: string description: description: A markdown-formatted optional description of this remedy. Links are not permitted. maxLength: 4096 minLength: 1 type: string meta: additionalProperties: false properties: data: additionalProperties: true description: Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized. type: object schema_version: description: 'A schema version identifier the metadata object validates against. Note: this information is only relevant in the domain of the API consumer: the issues system always considers metadata just as an arbitrary object. ' maxLength: 256 minLength: 1 type: string required: - data - schema_version type: object type: enum: - indeterminate - manual - automated - rule_result_message - terraform - cloudformation - cli - kubernetes - arm type: string required: - type type: object maxItems: 5 minItems: 1 type: array representations: description: 'A list of precise locations that surface an issue. A coordinate may have multiple representations. ' items: oneOf: - description: An object that contains an opaque identifying string. properties: resourcePath: maxLength: 2024 minLength: 1 type: string required: - resourcePath type: object - description: An object that contains a list of opaque identifying strings. properties: dependency: properties: package_name: description: The package name the issue was found in maxLength: 2048 minLength: 1 type: string package_version: description: The package version the issue was found in maxLength: 2048 minLength: 1 type: string required: - package_name - package_version type: object required: - dependency type: object - description: A resource location to some service, like a cloud resource. Only available for issue type 'cloud' and 'iac'. properties: cloud_resource: properties: environment: properties: id: description: Internal ID for an environment. format: uuid type: string name: maxLength: 256 minLength: 1 type: string native_id: description: An optional native identifier for this environment. For example, a cloud account id. maxLength: 2048 minLength: 1 type: string type: enum: - aws - azure - azure_ad - google - scm - cli - tfc type: string required: - id - type - name type: object resource: properties: iac_mappings_count: description: Amount of IaC resources this resource maps to. format: int64 minimum: 0 type: integer id: description: Internal ID for a resource. format: uuid type: string input_type: enum: - cloud_scan - arm - k8s - tf - tf_hcl - tf_plan - tf_state - cfn type: string location: maxLength: 256 minLength: 1 type: string name: minLength: 1 type: string native_id: description: An optional native identifier for this resource. For example, a cloud resource id. maxLength: 2048 minLength: 1 type: string platform: maxLength: 256 minLength: 1 type: string resource_type: maxLength: 256 minLength: 1 type: string tags: additionalProperties: maxLength: 256 type: string type: object type: enum: - cloud - iac type: string required: - input_type type: object required: - environment type: object required: - cloud_resource type: object - description: A location within a file. properties: sourceLocation: properties: commit_id: description: The git commit ID containing this issue. type: string file: description: 'A path to the file containing this issue, relative to the root of the project target, formatted using POSIX separators. ' maximum: 2048 minimum: 1 type: string region: properties: end: properties: column: minimum: 0 type: integer line: minimum: 0 type: integer required: - line - column type: object start: properties: column: minimum: 0 type: integer line: minimum: 0 type: integer required: - line - column type: object required: - start - end type: object required: - file type: object required: - sourceLocation type: object minItems: 1 type: array state: description: The state of this coordinate. enum: - open - resolved type: string updated_at: description: The time when this coordinate was last updated. format: date-time type: string type: object minItems: 1 type: array created_at: description: The creation time of this issue. format: date-time type: string description: description: A markdown-formatted optional description of this issue. Links are not permitted. example: 'Affected versions of this package are vulnerable to Prototype Pollution. The utilities function allow modification of the `Object` prototype. If an attacker can control part of the structure passed to this function, they could add or modify an existing property. ' maxLength: 4096 minLength: 1 type: string effective_severity_level: description: 'The computed effective severity of this issue. This is either the highest level from all included severities, or an overridden value set via group level policy. ' enum: - info - low - medium - high - critical type: string exploit_details: additionalProperties: false properties: maturity_levels: items: additionalProperties: false properties: format: example: CVSS_v4 minLength: 1 type: string level: example: attacked minLength: 1 type: string required: - format - level type: object type: array sources: example: - CISA items: type: string type: array required: - sources - maturity_levels type: object ignored: description: A flag indicating if the issue is being ignored. Derived from the issue's ignore, which provides more details. type: boolean key: description: An opaque key used for uniquely identifying this issue across test runs, within a project. example: 24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1 maxLength: 2048 type: string key_asset: description: SAST identifier that allows the identification of Snyk Code issues with a unique ID per repository. example: 1662bb2e-4c43-4f2c-83e1-ee5e0e009999 maxLength: 37 type: string problems: description: A list of details for vulnerability data, policy, etc that are the source of this issue. items: $ref: '#/components/schemas/Problem' minItems: 1 type: array resolution: $ref: '#/components/schemas/Resolution' risk: $ref: '#/components/schemas/Risk' severities: items: $ref: '#/components/schemas/CVSSSource' type: array status: description: The issue's status. Derived from the issue's resolution, which provides more details. enum: - open - resolved type: string title: description: A human-readable title for this issue. example: Insecure hash function used maxLength: 2048 minLength: 1 type: string tool: description: An opaque identifier for corelating across test runs. example: snyk://npm-deps maxLength: 1024 minLength: 1 type: string type: $ref: '#/components/schemas/TypeDef' updated_at: description: The time when this issue was last modified. format: date-time type: string required: - key - title - type - effective_severity_level - created_at - updated_at - status - ignored type: object PurlIssuesMeta: properties: errors: items: $ref: '#/components/schemas/Error' type: array packages: additionalProperties: properties: match: $ref: '#/components/schemas/ChecksumValidationMeta' package: $ref: '#/components/schemas/PackageMeta__0' required: - package type: object description: 'Package metadata and checksum validation results, keyed by PURL. Keys must be valid Package URLs (e.g., "pkg:maven/com.example/foo@1.0.0"). ' type: object type: object LoadedPackageRiskFactor: properties: included_in_score: default: false type: boolean links: $ref: '#/components/schemas/RiskFactorLinks' name: type: string updated_at: format: date-time type: string value: type: boolean required: - name - updated_at - value type: object ProblemTypeDef: enum: - rule - vulnerability type: string LinkProperty: example: https://example.com/api/resource oneOf: - description: A string containing the link’s URL. example: https://example.com/api/resource type: string - additionalProperties: false example: href: https://example.com/api/resource properties: href: description: A string containing the link’s URL. example: https://example.com/api/resource type: string meta: additionalProperties: true description: Free-form object that may contain non-standard information. example: key1: value1 key2: sub_key: sub_value key3: - array_value1 - array_value2 type: object required: - href type: object JsonApi: additionalProperties: false example: version: '1.0' properties: version: description: Version of the JSON API specification this server supports. example: '1.0' pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ type: string required: - version type: object Resolution: additionalProperties: false description: 'An optional field recording when and via what means an issue was resolved, if it was resolved. Resolved issues are retained for XX days. ' properties: details: description: Optional details about the resolution. Used by Snyk Cloud so far. type: string resolved_at: description: The time when this issue was resolved. format: date-time type: string type: $ref: '#/components/schemas/ResolutionTypeDef' required: - type - resolved_at type: object TypeDef: description: The type of an issue. enum: - package_vulnerability - license - cloud - code - custom - config example: cloud type: string RiskFactor: discriminator: mapping: deployed: '#/components/schemas/DeployedRiskFactor' loaded_package: '#/components/schemas/LoadedPackageRiskFactor' os_condition: '#/components/schemas/OSConditionRiskFactor' public_facing: '#/components/schemas/PublicFacingRiskFactor' propertyName: name oneOf: - $ref: '#/components/schemas/DeployedRiskFactor' - $ref: '#/components/schemas/OSConditionRiskFactor' - $ref: '#/components/schemas/PublicFacingRiskFactor' - $ref: '#/components/schemas/LoadedPackageRiskFactor' Types: example: resource pattern: ^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$ type: string ResolutionTypeDef: enum: - disappeared - fixed type: string TestExecutionType: enum: - test-workflow-execution - custom-execution type: string examples: CloudListIssuesResponse: summary: An example of a list issue response for a Cloud issue. value: data: - attributes: classes: - id: data source: snyk-cloud type: rule-category - id: CIS-AWS_v1.3.0_2.1.2 source: CIS-AWS_v1.3.0 type: compliance - id: CIS-AWS_v1.4.0_2.1.2 source: CIS-AWS_v1.4.0 type: compliance - id: HIPAA_§164.306(a) source: HIPAA_v2013 type: compliance - id: HIPAA_§164.312(a)(2)(iv) source: HIPAA_v2013 type: compliance - id: HIPAA_v2013_164.312(e)(2)(ii) source: HIPAA_v2013 type: compliance coordinates: - remedies: - description: '1. Go to the AWS console 2. Navigate to the S3 service page 3. ...' type: manual - description: '1. Find the corresponding AWS::S3::Bucket resource 2. ...' type: cloudformation - description: '1. Find the corresponding aws_s3_bucket resource 2. ...' type: terraform - description: Buckets should not ... type: rule_result_message representations: - cloud_resource: environment: id: b50f2832-a901-565e-9e06-e4e59e8582b6 name: Staging native_id: '721018433921' type: aws resource: id: b50f2832-a901-565e-9e06-e4e59e8582b7 input_type: cloud_scan location: us-east-1 name: policy-test-remediation native_id: arn:aws:s3:::policy-test-remediation platform: aws resource_type: aws_s3_bucket tags: Stage: Prod type: cloud created_at: '2022-09-27T20:09:05Z' description: To protect data in transit, an S3 bucket policy should deny all HTTP requests to its objects and allow only HTTPS requests. HTTPS uses Transport Layer Security (TLS) to encrypt data, which preserves integrity and prevents tampering. effective_severity_level: medium ignored: false key: b50f2832-a901-565e-9e06-e4e59e8582b6 problems: - id: SNYK-CC-00181 source: snyk-cloud type: rule resolution: details: rule_passed resolved_at: '2022-09-28T20:09:05Z' type: fixed status: resolved title: S3 bucket policies should only allow requests that use HTTPS tool: snyk://cloud type: cloud updated_at: '2022-09-28T20:09:05Z' id: d8db944b-d25a-477d-9c26-a63befad8ada relationships: organization: data: id: 81e93f62-135f-48bc-84d0-47f16822313f type: organization scan_item: data: id: 24c8e771-ab3b-4e85-ac4f-f73950ba4acf type: environment type: issue jsonapi: version: '1.0' OpenSourceListIssuesResponse20240123: summary: An example of a list issue response for an Open Source issue. value: data: - attributes: created_at: '2022-09-27T20:09:05Z' effective_severity_level: medium ignored: false key: npm:hoek:20180212:hoek:2.16.3 status: resolved title: Hoek - Prototype Pollution type: package_vulnerability updated_at: '2022-09-27T20:09:05Z' id: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2 relationships: organization: data: id: a3952187-0d8e-45d8-9aa2-036642857b5b type: organization scan_item: data: id: a3952187-0d8e-45d8-9aa2-036642857b5c type: project type: issue jsonapi: version: '1.0' IaCListIssuesResponse20240123: summary: An example of a list issue response for an Infrastructure as Code issue. value: data: - attributes: created_at: '2022-09-27T20:09:05Z' effective_severity_level: low ignored: false key: ff35a5c4d1cb4a1fd29c38b70f8ab89d1efea9d75aabf3a202d94f4776714b6191e2747cded23ba6cd7a47017a505a5d2c0823b69106ee2be0c11a18aa44b8a4 status: resolved title: Container is running with writable root filesystem type: cloud updated_at: '2022-09-27T20:09:05Z' id: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2 relationships: organization: data: id: a3952187-0d8e-45d8-9aa2-036642857b5b type: organization scan_item: data: id: a3952187-0d8e-45d8-9aa2-036642857b5c type: project type: issue jsonapi: version: '1.0' CodeListIssuesResponse20240123: summary: An example of a list issue response for a Code issue. value: data: - attributes: created_at: '2022-09-27T20:09:05Z' effective_severity_level: low ignored: false key: 24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1 status: resolved title: Insecure hash function used type: code updated_at: '2022-09-27T20:09:05Z' id: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2 relationships: organization: data: id: a3952187-0d8e-45d8-9aa2-036642857b5b type: organization scan_item: data: id: a3952187-0d8e-45d8-9aa2-036642857b5c type: project type: issue jsonapi: version: '1.0' securitySchemes: APIToken: description: API key value must be prefixed with \"Token \". in: header name: Authorization type: apiKey BearerAuth: scheme: bearer type: http x-snyk-api-version: '2024-10-15'