RIPS API

Version: 3.2.4

RIPS is a static code analysis tool to automatically detect taint-style vulnerabilities in PHP and Java 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}/profiles/{profileId}/clone POST
/applications DELETE
GET
POST
/applications/acls/own GET
/applications/profiles/all GET
/applications/scans/all GET
/applications/scans/issues/origins/types GET
/applications/scans/issues/origins/types/{typeId} GET
/applications/scans/issues/patches/types GET
/applications/scans/issues/patches/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/patches GET
/applications/scans/issues/types/patches/{patchId} GET
/applications/scans/issues/types/{typeId} GET
/applications/scans/pitfalls/types GET
/applications/scans/pitfalls/types/{typeId} GET
/applications/scans/properties/types GET
/applications/scans/properties/{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}/profiles DELETE
GET
POST
/applications/{applicationId}/profiles/globals GET
/applications/{applicationId}/profiles/{profileId} DELETE
GET
PATCH
/applications/{applicationId}/profiles/{profileId}/controllers DELETE
GET
POST
/applications/{applicationId}/profiles/{profileId}/controllers/{controllerId} DELETE
GET
PATCH
/applications/{applicationId}/profiles/{profileId}/ignoredcodes DELETE
GET
POST
/applications/{applicationId}/profiles/{profileId}/ignoredcodes/{codeId} DELETE
GET
PATCH
/applications/{applicationId}/profiles/{profileId}/ignoredlocations DELETE
GET
POST
/applications/{applicationId}/profiles/{profileId}/ignoredlocations/{locationId} DELETE
GET
PATCH
/applications/{applicationId}/profiles/{profileId}/sanitizers DELETE
GET
POST
/applications/{applicationId}/profiles/{profileId}/sanitizers/{sanitizerId} DELETE
GET
PATCH
/applications/{applicationId}/profiles/{profileId}/settings GET
PUT
/applications/{applicationId}/profiles/{profileId}/sinks DELETE
GET
POST
/applications/{applicationId}/profiles/{profileId}/sinks/{sinkId} DELETE
GET
PATCH
/applications/{applicationId}/profiles/{profileId}/sources DELETE
GET
POST
/applications/{applicationId}/profiles/{profileId}/sources/{sourceId} DELETE
GET
PATCH
/applications/{applicationId}/profiles/{profileId}/validators DELETE
GET
POST
/applications/{applicationId}/profiles/{profileId}/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/pdfs GET
/applications/{applicationId}/scans/{scanId}/exports/pdfs/queues POST
/applications/{applicationId}/scans/{scanId}/exports/pdfs/queues/{queueId} GET
/applications/{applicationId}/scans/{scanId}/exports/pdfs/queues/{queueId}/downloads GET
/applications/{applicationId}/scans/{scanId}/filebrowser 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}/contexts GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/contexts/{contextId} GET
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/patches GET
POST
/applications/{applicationId}/scans/{scanId}/issues/{issueId}/patches/{patchId} 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}/pitfalls GET
/applications/{applicationId}/scans/{scanId}/pitfalls/{pitfallId} GET
/applications/{applicationId}/scans/{scanId}/processes DELETE
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
/callbacks DELETE
GET
POST
/callbacks/{callbackId} DELETE
GET
PATCH
/languages GET
/languages/{languageId} 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
/organizations DELETE
GET
POST
/organizations/{organizationId} 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
/systems/health GET
/systems/ldap GET
PUT
/systems/ldap/sync POST
/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

email

Type: apiKey
Name:

X-API-Email

In:

header

password

Type: apiKey
Name:

X-API-Password

In:

header

oauth2

Type: oauth2
Flow:

password

TokenUrl:

https://api-3.ripstech.com/oauth/v2/auth/tokens

Scopes:

Paths

GET /activities

Get all activities

Available Filters

Column Restrictions
id
type
context
application
applicationName
createdBy
createdByEmail
createdAt
organization - Requires ROLE_ADMIN
organizationName - Requires ROLE_ADMIN
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
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

email
password
oauth2

POST /application/{applicationId}/profiles/{profileId}/clone

Clone an existing profile

Uses default content-types: application/json

applicationId

Set to 0 to create application independent profile.

path integer
profileId

The id of the 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

email
password
oauth2

DELETE /applications

Delete all applications with permissions for current user

Available Filters

Column Restrictions
id
name
currentScan
chargedQuota
createdBy
createdAt
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications

Get all applications with permissions for current user

Available Filters

Column Restrictions
id
name
currentScan
chargedQuota
createdBy
createdAt
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
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

email
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
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/profiles/all

Get all profiles

Available Filters

Column Restrictions
id
name
default
application
language
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
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
profile
parent
startedAt
finishedAt
analysisDepth
application
path - Not available in cloud unless ROLE_WORKER
applicationName
organization - Requires ROLE_ADMIN
organizationName - Requires ROLE_ADMIN
createdByEmail - Requires ROLE_ADMIN
comment
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
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
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

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/patches/types

Get all patch 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/patches/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/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
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

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
markup
severity
effort
secondOrder
cwe
owasp2010
owasp2013
owasp2017
sans
pcidss
asvs301
asvs401
category
parent
inactive
language
languageName
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

GET /applications/scans/issues/types/patches

Get all issue type patches

Available Filters

Column Restrictions
id
language
type
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/patches/{patchId}

Get a specific issue type patch

patchId path integer

Uses default content-types: application/json

200 OK

Successful

404 Not Found

Not found

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/pitfalls/types

Get all pitfall 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/pitfalls/types/{typeId}

Get a specific pitfall type

typeId path integer

Uses default content-types: application/json

200 OK

Successful

404 Not Found

Not found

GET /applications/scans/properties/types

Get all property types

Available Filters

Column Restrictions
id
tag
name
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

GET /applications/scans/properties/{typeId}

Get a specific property 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
profile
parent
startedAt
finishedAt
analysisDepth
application
applicationName
path - Not available in cloud
comment
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/uploads/all

Get all uploads with permissions for current user

Available Filters

Column Restrictions
id
createdAt
name
extension
size
file
createdBy
createdByEmail
organization - Admins only
organizationName - Admins only
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

email
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

email
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

email
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

email
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
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

email
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
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

email
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

email
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

email
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

email
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

email
password
oauth2

DELETE /applications/{applicationId}/profiles

Delete all profiles for the current application

Available Filters

Column Restrictions
id
name
default
language
applicationId

Set to 0 to delete application independent profiles.

path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/{applicationId}/profiles

Get all profiles for the current application

Available Filters

Column Restrictions
id
name
default
language
applicationId

Set to 0 to get application independent profiles.

path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

POST /applications/{applicationId}/profiles

Add a new 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

email
password
oauth2

GET /applications/{applicationId}/profiles/globals

Get all profiles for the current application and all global profiles

Available Filters

Column Restrictions
id
name
default
application
language
applicationId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password

DELETE /applications/{applicationId}/profiles/{profileId}

Delete a specific profile

applicationId

Set to 0 to delete application independent profiles.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}

Get a specific profile

applicationId

Set to 0 to get application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PATCH /applications/{applicationId}/profiles/{profileId}

Update an existing profile

Uses default content-types: application/json

applicationId

Set to 0 to update application independent profile.

path integer
profileId 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

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/controllers

Delete all controllers for the current profile

Available Filters

Column Restrictions
id
class
method
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/controllers

Get all controllers for the current profile

Available Filters

Column Restrictions
id
class
method
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

POST /applications/{applicationId}/profiles/{profileId}/controllers

Add a new controller

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/controllers/{controllerId}

Delete a specific controller

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
controllerId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/controllers/{controllerId}

Get a specific controller

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
controllerId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PATCH /applications/{applicationId}/profiles/{profileId}/controllers/{controllerId}

Update an existing controller

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId 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

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/ignoredcodes

Delete all ignored codes for the current profile

Available Filters

Column Restrictions
id
class
method
type
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/ignoredcodes

Get all ignored codes for the current profile

Available Filters

Column Restrictions
id
class
method
type
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

POST /applications/{applicationId}/profiles/{profileId}/ignoredcodes

Add a new ignored code

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/ignoredcodes/{codeId}

Delete a specific ignored code

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
codeId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/ignoredcodes/{codeId}

Get a specific ignored code

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
codeId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PATCH /applications/{applicationId}/profiles/{profileId}/ignoredcodes/{codeId}

Update an existing ignored code

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
codeId 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

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/ignoredlocations

Delete all ignored locations for the current profile

Available Filters

Column Restrictions
id
path
match
exclude
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/ignoredlocations

Get all ignored locations for the current profile

Available Filters

Column Restrictions
id
path
match
exclude
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

POST /applications/{applicationId}/profiles/{profileId}/ignoredlocations

Add a new ignored location

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/ignoredlocations/{locationId}

Delete a specific ignored location

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
locationId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/ignoredlocations/{locationId}

Get a specific ignored location

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
locationId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PATCH /applications/{applicationId}/profiles/{profileId}/ignoredlocations/{locationId}

Update an existing ignored location

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
locationId 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

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/sanitizers

Delete all sanitizers for the current profile

Available Filters

Column Restrictions
id
class
method
property
parameter
characters
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/sanitizers

Get all sanitizers for the current profile

Available Filters

Column Restrictions
id
class
method
property
parameter
characters
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

POST /applications/{applicationId}/profiles/{profileId}/sanitizers

Add a new sanitizer

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/sanitizers/{sanitizerId}

Delete a specific sanitizer

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
sanitizerId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/sanitizers/{sanitizerId}

Get a specific sanitizer

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
sanitizerId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PATCH /applications/{applicationId}/profiles/{profileId}/sanitizers/{sanitizerId}

Update an existing sanitizer

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
sanitizerId 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

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/settings

Get settings

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PUT /applications/{applicationId}/profiles/{profileId}/settings

Add or update settings

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/sinks

Delete all sinks for the current profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
typeName
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/sinks

Get all sinks for the current profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
typeName
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

POST /applications/{applicationId}/profiles/{profileId}/sinks

Add a new sink

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/sinks/{sinkId}

Delete a specific sink

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
sinkId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/sinks/{sinkId}

Get a specific sink

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
sinkId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PATCH /applications/{applicationId}/profiles/{profileId}/sinks/{sinkId}

Update an existing sink

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId 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

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/sources

Delete all sources for the current profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/sources

Get all sources for the current profile

Available Filters

Column Restrictions
id
class
method
property
parameter
type
applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
filter

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

query string
orderBy

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

query string
select

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

query string
limit

Limits the number of elements in the collection.

query integer , { x ∈ ℤ | 0 ≤ x ≤ 500 } 500
offset

Changes the offset in the collection.

query integer , { x ∈ ℤ | x ≥ 0 }

Uses default content-types: application/json

200 OK

Successful

email
password
oauth2

POST /applications/{applicationId}/profiles/{profileId}/sources

Add a new source

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer

Uses default content-types: application/json

200 OK

Successful

400 Bad Request

Invalid input

403 Forbidden

Missing permissions

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/sources/{sourceId}

Delete a specific source

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
sourceId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

GET /applications/{applicationId}/profiles/{profileId}/sources/{sourceId}

Get a specific source

applicationId

Set to 0 to use application independent profile.

path integer
profileId path integer
sourceId path integer

Uses default content-types: application/json

200 OK

Successful

403 Forbidden

Missing permissions

404 Not Found

Not found

email
password
oauth2

PATCH /applications/{applicationId}/profiles/{profileId}/sources/{sourceId}

Update an existing source

Uses default content-types: application/json

applicationId

Set to 0 to use application independent profile.

path integer
profileId 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

email
password
oauth2

DELETE /applications/{applicationId}/profiles/{profileId}/validators

Delete all validators for the current profile

Available Filters

Column Restrictions
id
class
method
parameter
characters