Skip to navigation

Get an issue

Requires the issues:read API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Path parameters

issueIdstringRequired

Issue UUID or label, e.g. VULN-000123.

Response

The issue.
idstringformat: "uuid"
labelstring or null
titlestring or null
descriptionstring or null
severityenum
Allowed values:
severityLevelinteger

critical = 4, high = 3, medium = 2, low = 1.

statusenum
Allowed values:
cwelist of strings
cvssobject or null
repositoryobject or null
locationstring or null
startLineinteger or null
endLineinteger or null
workspaceIdstringformat: "uuid"
pocobject or null
branchstring or null
applicationobject or null
endpointobject or null
introducedByobject or null
pentestIdstring or nullformat: "uuid"
urlstring
Console link to the issue.
createdAtdatetime
updatedAtdatetime
closedAtdatetime or null
closedDispositionenum or null

Structured close verdict. other appears only on findings closed before it was retired and cannot be written.

duplicateOfstring or nullformat: "uuid"
closedMethodstring or null
closedReasonstring or null
closedCommentsstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error