RIPS API

Version: 2.17.3

RIPS is a static code analysis tool to automatically detect taint-style vulnerabilities in PHP applications.

Default request content-types: application/json
Default response content-types: application/json
Schemes: https, http

Summary

Path Operation Description
/activities GET
/activities/{activityId} GET
/application/{applicationId}/customs/{customId}/clone POST
/applications DELETE
GET
POST
/applications/acls/own GET
/applications/scans/all GET
/applications/scans/issues/comments/all GET
/applications/scans/issues/origins/types GET
/applications/scans/issues/origins/types/{typeId} GET
/applications/scans/issues/reviews/types GET
/applications/scans/issues/reviews/types/{typeId} GET
/applications/scans/issues/types GET
/applications/scans/issues/types/{typeId} GET
/applications/scans/stats GET
/applications/uploads/all GET
/applications/{applicationId} DELETE
GET
PATCH
/applications/{applicationId}/acls DELETE
GET
POST
/applications/{applicationId}/acls/{aclId} DELETE
GET
PATCH
/applications/{applicationId}/customs DELETE
GET
POST
/applications/{applicationId}/customs/globals GET
/applications/{applicationId}/customs/{customId} DELETE
GET
PATCH
/applications/{applicationId}/customs/{customId}/controllers DELETE
GET
POST
/applications/{applicationId}/customs/{customId}/controllers/{controllerId} DELETE
GET
PATCH
/applications/{applicationId}/customs/{customId}/ignores DELETE
GET
POST
/applications/{applicationId}/customs/{customId}/ignores/{ignoreId} DELETE
GET
PATCH
/applications/{applicationId}/customs/{customId}/sanitisers DELETE
GET
POST
/applications/{applicationId}/customs/{customId}/sanitisers/{sanitiserId} DELETE
GET
PATCH
/applications/{applicationId}/customs/{customId}/settings GET
PUT
/applications/{applicationId}/customs/{customId}/sinks DELETE
GET
POST
/applications/{applicationId}/customs/{customId}/sinks/{sinkId} DELETE
GET
PATCH
/applications/{applicationId}/customs/{customId}/sources DELETE
GET
POST
/applications/{applicationId}/customs/{customId}/sources/{sourceId} DELETE
GET
PATCH
/applications/{applicationId}/customs/{customId}/validators DELETE
GET
POST
/applications/{applicationId}/customs/{customId}/validators/{validatorId} DELETE
GET
PATCH
/applications/{applicationId}/scans DELETE
GET
POST
/applications/{applicationId}/scans/stats GET
/applications/{applicationId}/scans/{scanId} DELETE
GET
PATCH
/applications/{applicationId}/scans/{scanId}/classes GET
/applications/{applicationId}/scans/{scanId}/classes/batches POST
/applications/{applicationId}/scans/{scanId}/classes/{classId} GET
/applications/{applicationId}/scans/{scanId}/comparison GET
/applications/{applicationId}/scans/{scanId}/comparison/details GET
/applications/{applicationId}/scans/{scanId}/concats GET
/applications/{applicationId}/scans/{scanId}/concats/{concatId} GET
/applications/{applicationId}/scans/{scanId}/entrypoints GET
/applications/{applicationId}/scans/{scanId}/entrypoints/{entrypointId} GET
/applications/{applicationId}/scans/{scanId}/exports/csvs GET
/applications/{applicationId}/scans/{scanId}/exports/jiracsvs GET
/applications/{applicationId}/scans/{scanId}/exports/pdfs GET
/applications/{applicationId}/scans/{scanId}/files DELETE
GET
/applications/{applicationId}/scans/{scanId}/files/{fileId} GET
/applications/{applicationId}/scans/{scanId}/functions GET
/applications/{applicationId}/scans/{scanId}/functions/batches POST
/applications/{applicationId}/scans/{scanId}/functions/{functionId} GET
/applications/{applicationId}/scans/{scanId}/issues GET
POST
/applications/{applicationId}/scans/{scanId}/issues/reviews/batches POST
/applications/{applicationId}/scans/{scanId}/issues/stats GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId} GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/comments DELETE
GET
POST
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/comments/{commentId} DELETE
GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/markups GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/markups/{markupId} GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/reviews GET
POST
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/reviews/{reviewId} GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/summaries GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/summaries/{summaryId} GET
/applications/{applicationId}/scans/{scanId}/libraries DELETE
GET
POST
/applications/{applicationId}/scans/{scanId}/libraries/{libraryId} DELETE
GET
PATCH
/applications/{applicationId}/scans/{scanId}/processes GET
POST
/applications/{applicationId}/scans/{scanId}/processes/{processId} GET
PATCH
/applications/{applicationId}/scans/{scanId}/sinks GET
/applications/{applicationId}/scans/{scanId}/sinks/{sinkId} GET
/applications/{applicationId}/scans/{scanId}/sources GET
/applications/{applicationId}/scans/{scanId}/sources/{sourceId} GET
/applications/{applicationId}/uploads DELETE
GET
POST
/applications/{applicationId}/uploads/{uploadId} DELETE
GET
/licenses GET
POST
/licenses/{licenseId} GET
/logs DELETE
GET
POST
/logs/{logId} GET
/oauth/v2/clients GET
POST
/oauth/v2/clients/{clientId} DELETE
GET
PUT
/oauth/v2/global/clients GET
/organisations DELETE
GET
POST
/organisations/{organisationId} DELETE
GET
PATCH
/quotas DELETE
GET
POST
/quotas/{quotaId} DELETE
GET
PATCH
/quotas/{quotaId}/acls DELETE
GET
POST
/quotas/{quotaId}/acls/{aclId} DELETE
GET
PATCH
/settings DELETE
GET
/settings/{key} DELETE
GET
PUT
/sources GET
/status GET
/teams DELETE
GET
POST
/teams/{teamId} DELETE
GET
PATCH
/users DELETE
GET
POST
/users/invite/ui POST
/users/reset/ui POST
/users/{userId} DELETE
GET
PATCH
/users/{userId}/activate/{token} POST
/users/{userId}/confirm/{token} POST
/users/{userId}/reset/{token} POST

Security

username

Type: apiKey
Name:

X-API-Username

In:

header

password

Type: apiKey
Name:

X-API-Password

In:

header

oauth2

Type: oauth2
Flow:

password

TokenUrl:

/oauth/v2/auth/tokens

Scopes:

Paths

GET /activities

Get all activities

Available Filters

Column Restrictions
id
type
context
application
createdBy
createdAt
organisation - Requires ROLE_ADMIN
organisationName - Requires ROLE_ADMIN
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /activities/{activityId}

Get a specific activity

activityId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

POST /application/{applicationId}/customs/{customId}/clone

Clone a existing custom profile

Uses default content-types: application/json

applicationId

Set to 0 to create application independent profile.

path integer
customId

The id of the custom profile that should be cloned.

path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications

Delete all applications with permissions for current user

Available Filters

Column Restrictions
id
name
currentScan
chargedQuota
createdBy
creation
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications

Get all applications with permissions for current user

Available Filters

Column Restrictions
id
name
currentScan
chargedQuota
createdBy
creation
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications

Add a new application

Uses default content-types: application/json

application: Post.Sub.Application

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/acls/own

Get all acls for current user

Available Filters

Column Restrictions
id
ownerUser
ownerTeam
createdBy
view
delete
create
edit
scan
manage
immutable
application
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/scans/all

Get all scans with permissions for the current user

Available Filters

Column Restrictions
id
version
upload
phase
percent
loc
codeStored
uploadRemoved
createdBy
custom
parent
start
finish
analysisDepth
application
path - Not available in cloud unless ROLE_WORKER
applicationName - Requires ROLE_ADMIN
organisation - Requires ROLE_ADMIN
organisationName - Requires ROLE_ADMIN
createdByUsername - Requires ROLE_ADMIN
comment
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/scans/issues/comments/all

Get all comments with permissions for the current user

Available Filters

Column Restrictions
id
comment
submission
createdBy
issue
source
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/scans/issues/origins/types

Get all origin types

Available Filters

Column Restrictions
id
tag
name
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

GET /applications/scans/issues/origins/types/{typeId}

Get a specific origin type

typeId path integer

Uses default content-types: application/json

200 OK

Successful

404 Not Found

Not found

GET /applications/scans/issues/reviews/types

Get all review types

Available Filters

Column Restrictions
id
tag
name
negative
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

GET /applications/scans/issues/reviews/types/{typeId}

Get a specific review type

typeId path integer

Uses default content-types: application/json

200 OK

Successful

404 Not Found

Not found

GET /applications/scans/issues/types

Get all issue types

Available Filters

Column Restrictions
id
tag
description
name
color
markup
severity
effort
secondOrder
cwe
owasp
sans
pcidss
asvs
enabled
category
parent
inactive
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

GET /applications/scans/issues/types/{typeId}

Get a specific issue type

typeId path integer

Uses default content-types: application/json

200 OK

Successful

404 Not Found

Not found

GET /applications/scans/stats

Get statistics about all applications with permissions for current user

Available Filters

Column Restrictions
id
version
upload
phase
percent
loc
codeStored
uploadRemoved
createdBy
custom
parent
start
finish
analysisDepth
application
path - Not available in cloud
comment
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/uploads/all

Get all uploads with permissions for current user

Available Filters

Column Restrictions
id
submission
name
extension
size
file
createdBy
createdByUsername
organisation - Admins only
organisationName - Admins only
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}

Delete a specific application

applicationId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}

Get a specific application

applicationId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}

Update an existing application

Uses default content-types: application/json

application: Patch.Sub.Application
applicationId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/acls

Delete all acls with permissions for current user

Available Filters

Column Restrictions
id
ownerUser
ownerTeam
createdBy
view
delete
create
edit
scan
manage
immutable
application
applicationId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/{applicationId}/acls

Get all acls with permissions for current user

Available Filters

Column Restrictions
id
ownerUser
ownerTeam
createdBy
view
delete
create
edit
scan
manage
immutable
application
applicationId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

POST /applications/{applicationId}/acls

Add a new acl

Uses default content-types: application/json

applicationId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/acls/{aclId}

Delete a specific acl

applicationId path integer
aclId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/acls/{aclId}

Get a specific acl

applicationId path integer
aclId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/acls/{aclId}

Update an existing acl

Uses default content-types: application/json

applicationId path integer
aclId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/customs

Delete all custom profiles for the current application

Available Filters

Column Restrictions
id
name
global - Deprecated
default
applicationId

Set to 0 to delete application independent profiles.

path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/{applicationId}/customs

Get all custom profiles for the current application

Available Filters

Column Restrictions
id
name
global - Deprecated
default
applicationId

Set to 0 to get application independent profiles.

path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications/{applicationId}/customs

Add a new custom profile

Uses default content-types: application/json

applicationId

Set to 0 to create application independent profile.

path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/{applicationId}/customs/globals

Get all custom profiles for the current application and all global profiles

Available Filters

Column Restrictions
id
name
global - Deprecated
default
application
applicationId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password

DELETE /applications/{applicationId}/customs/{customId}

Delete a specific custom profile

applicationId

Set to 0 to delete application independent profiles.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}

Get a specific custom profile

applicationId

Set to 0 to get application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/customs/{customId}

Update an existing custom profile

Uses default content-types: application/json

applicationId

Set to 0 to update application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/controllers

Delete all controllers for the current custom profile

Available Filters

Column Restrictions
id
class
method
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/controllers

Get all controllers for the current custom profile

Available Filters

Column Restrictions
id
class
method
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications/{applicationId}/customs/{customId}/controllers

Add a new controller

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/controllers/{controllerId}

Delete a specific controller

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
controllerId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/controllers/{controllerId}

Get a specific controller

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
controllerId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/customs/{customId}/controllers/{controllerId}

Update an existing controller

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
controllerId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/ignores

Delete all ignores for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
folder
fullPath
codeQualityFolder
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/ignores

Get all ignores for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
folder
fullPath
codeQualityFolder
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications/{applicationId}/customs/{customId}/ignores

Add a new ignore

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/ignores/{ignoreId}

Delete a specific ignore

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
ignoreId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/ignores/{ignoreId}

Get a specific ignore

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
ignoreId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/customs/{customId}/ignores/{ignoreId}

Update an existing ignore

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
ignoreId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/sanitisers

Delete all sanitisers for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
parameter
characters
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/sanitisers

Get all sanitisers for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
parameter
characters
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications/{applicationId}/customs/{customId}/sanitisers

Add a new sanitiser

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/sanitisers/{sanitiserId}

Delete a specific sanitiser

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sanitiserId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/sanitisers/{sanitiserId}

Get a specific sanitiser

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sanitiserId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/customs/{customId}/sanitisers/{sanitiserId}

Update an existing sanitiser

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sanitiserId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/settings

Get settings

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PUT /applications/{applicationId}/customs/{customId}/settings

Add or update settings

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/sinks

Delete all sinks for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/sinks

Get all sinks for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications/{applicationId}/customs/{customId}/sinks

Add a new sink

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/sinks/{sinkId}

Delete a specific sink

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sinkId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/sinks/{sinkId}

Get a specific sink

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sinkId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/customs/{customId}/sinks/{sinkId}

Update an existing sink

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sinkId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/sources

Delete all sources for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/sources

Get all sources for the current custom profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications/{applicationId}/customs/{customId}/sources

Add a new source

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/sources/{sourceId}

Delete a specific source

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sourceId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/sources/{sourceId}

Get a specific source

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sourceId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/customs/{customId}/sources/{sourceId}

Update an existing source

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
sourceId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/validators

Delete all validators for the current custom profile

Available Filters

Column Restrictions
id
class
method
parameter
characters
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/validators

Get all validators for the current custom profile

Available Filters

Column Restrictions
id
class
method
parameter
characters
applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

username
password
oauth2

POST /applications/{applicationId}/customs/{customId}/validators

Add a new validator

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/customs/{customId}/validators/{validatorId}

Delete a specific validator

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
validatorId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/customs/{customId}/validators/{validatorId}

Get a specific validator

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
validatorId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/customs/{customId}/validators/{validatorId}

Update an existing validator

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
customId path integer
validatorId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

DELETE /applications/{applicationId}/scans

Delete all scans of one application

Available Filters

Column Restrictions
id
version
upload
phase
percent
loc
codeStored
uploadRemoved
createdBy
custom
parent
start
finish
analysisDepth
application
path - Not available in cloud
comment
applicationId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/{applicationId}/scans

Get all scans of one application

Available Filters

Column Restrictions
id
version
upload
phase
percent
loc
codeStored
uploadRemoved
createdBy
custom
parent
start
finish
analysisDepth
application
path - Not available in cloud
comment
applicationId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

POST /applications/{applicationId}/scans

Add a new scan to application

Uses default content-types: application/json

applicationId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/{applicationId}/scans/stats

Get stats about all scans of one application

Available Filters

Column Restrictions
id
version
upload
phase
percent
loc
codeStored
uploadRemoved
createdBy
custom
parent
start
finish
analysisDepth
application
path - Not available in cloud
comment
applicationId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

DELETE /applications/{applicationId}/scans/{scanId}

Delete a specific scan

applicationId path integer
scanId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}

Get a specific scan

applicationId path integer
scanId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

PATCH /applications/{applicationId}/scans/{scanId}

Update an existing scan

Uses default content-types: application/json

scan: Patch.Sub.Application.Scan
tags: string[]
string
applicationId path integer
scanId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/classes

Get all classes of one scan

Available Filters

Column Restrictions
id
startLine
endLine
name
file
applicationId path integer
scanId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

POST /applications/{applicationId}/scans/{scanId}/classes/batches

Add a new class

Uses default content-types: application/json

applicationId path integer
scanId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/classes/{classId}

Get a specific class

applicationId path integer
scanId path integer
classId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/comparison

Get stats about old, new and fixed issues compared to parent scan

applicationId path integer
scanId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

No parent scan found

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/comparison/details

Gets old, new and fixed issues compared to parent scan

applicationId path integer
scanId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

No parent scan found

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password

GET /applications/{applicationId}/scans/{scanId}/concats

Get all concats of one scan

Available Filters

Column Restrictions
id
line
file
function
class
applicationId path integer
scanId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/concats/{concatId}

Get a specific concat

applicationId path integer
scanId path integer
concatId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/entrypoints

Get all entrypoints of one scan

Available Filters

Column Restrictions
id
line
file
function
class
applicationId path integer
scanId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/entrypoints/{entrypointId}

Get a specific entrypoint

applicationId path integer
scanId path integer
entrypointId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

username
password
oauth2

GET /applications/{applicationId}/scans/{scanId}/exports/csvs

Get scan information as csv

Available Filters

Column Restrictions
id
origin
originName
depth
lastReview
lastReviewType
reviewed
negativelyReviewed
concat
entrypoint
scan
parent
cve
sink
sinkName
sinkFilePath
source
sourceName
sourceParameter
type
typeSeverity
typeName
typeCategory
applicationId path integer
scanId path integer
filter

A JSON-encoded filter object (see 'Available Filters').

query string