Files

Get Details of a File by ID

This API returns details about a given codebase file (identified by its fileId). If the isRemote flag is true, details for the remote file are retrieved. Otherwise, details for the file on the Scan Server file are retrieved.

To obtain the fileId for a given codebase file, use the Get ID of File or Folder API (/projects/{projectId}/files).

Request

path Parameters

fileId

required

integer <int32>

ID of the File

Example: 1

query Parameters

isRemote

boolean

Default: false

If true, fetch results of corresponding remote file.

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/files/{fileId}

Mark File Reviewed/Unreviewed

This API marks a given codebase file (identified by its &&fileId**) as reviewed or unreviewed. If a corresponding remote file exists, you can choose to have it also marked with the same status.

To obtain the fileId for a given codebase file, use the Get ID of File or Folder API (/projects/{projectId}/files).

Request

path Parameters

fileId

required

integer <int32>

ID of the File

Example: 1

query Parameters

isRemote	boolean Default: false If true, fetch results of corresponding remote file.
markAsReviewed	boolean Default: false If true, mark file as reviewed.

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/files/{fileId}/review

➔ Next to Folder