API docs by Redocly

SolidPoint Backend (v1.0.0)

Download OpenAPI specification:

User

Users_createUser

Create user.

Request Body schema: application/json
required
tenantID
integer <uint32> (TenantID)

Tenant ID.

email
required
string

User email.

password
required
string

User password.

role
required
string
Enum: "unknown" "readOnly" "analyst" "user" "admin" "superAdmin"

User role. May be omitted in response.

name
string

User name.

companyName
string

User company name.

occupation
string

User occupation.

object

User settings - arbitrary JSON object (up to 32KB).

Responses

Request samples

Content type
application/json
{
  • "tenantID": 0,
  • "email": "string",
  • "password": "string",
  • "role": "unknown",
  • "name": "string",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "authType": "string"
}

Users_getUsers

Get users.

This request can be specified with query parameters:

  • role: user role;
  • tenant: user tenant (tenant name or tenant id).
query Parameters
role
string (UserRole)
Enum: "unknown" "readOnly" "analyst" "user" "admin" "superAdmin"
integer or string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users_activateUsers

Activate users.

This request can be specified by tenantID parameter in body. If tenant is not specified, all users in all tenants will be activated.

Request Body schema: application/json
required
role
string
Enum: "unknown" "readOnly" "analyst" "user" "admin" "superAdmin"

User role. May be omitted in response.

tenantID
integer <uint32> (TenantID)

Tenant ID.

emailLanguage
string
Default: "en"
Enum: "en" "ru"

Email language that will be used after activation. Email is used for user notifications.

Responses

Request samples

Content type
application/json
{
  • "role": "unknown",
  • "tenantID": 0,
  • "emailLanguage": "en"
}

Response samples

Content type
application/json
[
  • {
    }
]

Users_updateUserCommon

Update common user data.

Request Body schema: application/json
required
email
string

User email.

name
string

User name.

companyName
string

User company name.

occupation
string

User occupation.

object

User settings - arbitrary JSON object (up to 32KB).

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "authType": "string"
}

Users_getCurrentUser

Get current user.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "tokens": [
    ]
}

Users_updateUserPassword

Update current user password.

Request Body schema: application/json
required
newPassword
required
string

New user password.

oldPassword
required
string

Old user password.

Responses

Request samples

Content type
application/json
{
  • "newPassword": "string",
  • "oldPassword": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "authType": "string"
}

Wizards_wizardEmailExists

Check if email exists. For super administrators only.

Request Body schema: application/json
required
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "wizard": true,
  • "details": { }
}

Users_activateUserByEmail

Activate user by email.

path Parameters
email
required
string
Request Body schema: application/json
required
role
string
Enum: "unknown" "readOnly" "analyst" "user" "admin" "superAdmin"

User role. May be omitted in response.

tenantID
integer <uint32> (TenantID)

Tenant ID.

emailLanguage
string
Default: "en"
Enum: "en" "ru"

Email language that will be used after activation. Email is used for user notifications.

Responses

Request samples

Content type
application/json
{
  • "role": "unknown",
  • "tenantID": 0,
  • "emailLanguage": "en"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "authType": "string"
}

Users_updateUserFull

Update full user data.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
tenantID
integer <uint32> (TenantID)

Tenant ID.

email
string

User email.

password
string

User password.

role
string
Enum: "unknown" "readOnly" "analyst" "user" "admin" "superAdmin"

User role. May be omitted in response.

name
string

User name.

companyName
string

User company name.

occupation
string

User occupation.

object

User settings - arbitrary JSON object (up to 32KB).

Responses

Request samples

Content type
application/json
{
  • "tenantID": 0,
  • "email": "string",
  • "password": "string",
  • "role": "unknown",
  • "name": "string",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "authType": "string"
}

Users_getUser

Get user.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "authType": "string"
}

Users_deleteUser

Delete user.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Users_activateUser

Activate user.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
role
string
Enum: "unknown" "readOnly" "analyst" "user" "admin" "superAdmin"

User role. May be omitted in response.

tenantID
integer <uint32> (TenantID)

Tenant ID.

emailLanguage
string
Default: "en"
Enum: "en" "ru"

Email language that will be used after activation. Email is used for user notifications.

Responses

Request samples

Content type
application/json
{
  • "role": "unknown",
  • "tenantID": 0,
  • "emailLanguage": "en"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "email": "string",
  • "name": "string",
  • "role": "unknown",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "authType": "string"
}

Token

Tokens_createToken

Create manual token.

Request Body schema: application/json
required
name
required
string

Token name.

lifetime
required
integer <int32>

Token lifetime. May be omitted in response.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lifetime": 0
}

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "token": {
    }
}

Tokens_revokeToken

Revoke manual token.

path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "token": {
    }
}

Authentication

Authentication_newAuthentication

Create new authentication.

Available authentications:

  • Standard (by default);
  • LDAP.
Request Body schema: application/json
required
tenantID
integer <uint32> (TenantID)

Tenant ID.

type
required
string
Enum: "Unknown" "Standard" "LDAP"

Authentication type.

Available types:

  • Standard (by default);
  • LDAP.
disabled
boolean

Whether authentication is disabled.

parameters
object

Authentication parameters. Vary by authentication type.

Responses

Request samples

Content type
application/json
{
  • "tenantID": 0,
  • "type": "Unknown",
  • "disabled": true,
  • "parameters": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "Unknown",
  • "disabled": true,
  • "parameters": { },
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Authentication_getAuthentications

Get authentications.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

LDAP_verifyLDAPConnection

Verify connection to LDAP server.

path Parameters
label
required
string

Responses

Response samples

Content type
application/json
{
  • "verification": true
}

LDAP_verifyUserCredentials

Verify user credentials on LDAP server.

path Parameters
label
required
string
Request Body schema: application/json
required
login
required
string

User login. Matches user's email if authentication is Standard. May be omitted in response.

password
required
string

User password.

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "verification": true
}

LDAP_verifyUserExistence

Verify user existence on LDAP server.

path Parameters
label
required
string
Request Body schema: application/json
required
login
required
string

User login. Matches user's email if authentication is Standard. May be omitted in response.

password
required
string

User password.

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "verification": true
}

Authentication_login

User login.

Standard authentication is used by default.

Request Body schema: application/json
required
email
required
string

User email.

password
required
string

User password.

object

Authentication data.

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "token": {
    }
}

Authentication_logout

User logout.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Authentication_register

User registration.

Request Body schema: application/json
required
tenantID
integer <uint32> (TenantID)

Tenant ID.

email
required
string

User email.

password
required
string

User password.

role
required
string
Enum: "unknown" "readOnly" "analyst" "user" "admin" "superAdmin"

User role. May be omitted in response.

name
string

User name.

companyName
string

User company name.

occupation
string

User occupation.

object

User settings - arbitrary JSON object (up to 32KB).

Responses

Request samples

Content type
application/json
{
  • "tenantID": 0,
  • "email": "string",
  • "password": "string",
  • "role": "unknown",
  • "name": "string",
  • "companyName": "string",
  • "occupation": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Wizards_validateEmail

Validate user email.

Request Body schema: application/json
required
email
required
string

User email.

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "wizard": true,
  • "details": { }
}

Authentication_updateAuthentication

Update authentication.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
disabled
boolean

Whether authentication is disabled.

parameters
object

Authentication parameters. Vary by authentication type.

Responses

Request samples

Content type
application/json
{
  • "disabled": true,
  • "parameters": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "Unknown",
  • "disabled": true,
  • "parameters": { },
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Authentication_getAuthentication

Get authentication.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "Unknown",
  • "disabled": true,
  • "parameters": { },
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Authentication_deleteAuthentication

Delete authentication.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scan

Scans_startScans

Make new scan requests.

This request should use urls, targetIDs, scanIDs or raw parameter in body parameters (one of).

Request Body schema: application/json
required
urls
Array of strings

URLs of new or previously specified targets.

targetIDs
Array of integers <uint32> [ items <uint32 > ]

IDs of existing targets.

scanIDs
Array of integers <uint32> [ items <uint32 > ]

IDs of existing scans.

Array of objects

Raw scan requests. In priority.

scanType
string
Default: "full"
Enum: "unknown" "full" "discovery" "fuzzing" "custom"

Scan type.

customModules
Array of strings

Custom modules to be used in scan.

The scanType parameter is custom by default.

withDetails
boolean

Whether to use scans' resources and deps (details) to start scans.

Scans should be discovery only.

This parameter may be used with targetIDs or scanIDs (in priority).

If targetIDs parameter is used, last targets discovery scans will be used.

withDirbuster
boolean
Default: false

Whether dirbuster is enabled.

The static-crawler module is required for this setting.

Array of objects (CreateReport)

Reports to be generated upon scan completion.

Stub records are created immediately at scan start. Generation runs automatically when the scan status becomes done and there are no other processing non-deferred scans.

Responses

Request samples

Content type
application/json
{
  • "urls": [
    ],
  • "targetIDs": [
    ],
  • "scanIDs": [
    ],
  • "raw": [
    ],
  • "scanType": "full",
  • "customModules": [
    ],
  • "withDetails": true,
  • "withDirbuster": false,
  • "deferredReports": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Scans_getScans

Get scans.

jobs, resources, deps, appAuth, spec and wafHarExtractor parameters will be omitted in response.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scans_manageScans

Manage scans:

  • Pause scans (in priority).
  • Resume scans.
  • Cancel scans (in priority).
  • Delete scans.
Request Body schema: application/json
required
pause
Array of integers <uint32> [ items <uint32 > ]

IDs of scans to pause.

resume
Array of integers <uint32> [ items <uint32 > ]

IDs of scans to resume.

cancel
Array of integers <uint32> [ items <uint32 > ]

IDs of scans to cancel.

delete
Array of integers <uint32> [ items <uint32 > ]

IDs of scans to delete.

Responses

Request samples

Content type
application/json
{
  • "pause": [
    ],
  • "resume": [
    ],
  • "cancel": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scans_countScans

Count scans.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Scans_countScanDetails

Count scan details.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Scans_countScansIssues

Count scans' issues.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Scans_getScanModules

Get available modules for scans.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scans_replaceScansTenant

Replace tenant for specified scans.

jobs, resources, deps, appAuth, spec and wafHarExtractor parameters will be omitted in response.

Request Body schema: application/json
required
scanIDs
Array of integers <uint32> [ items <uint32 > ]

Scan IDs.

tenantID
integer <uint32>

Tenant IDs.

Responses

Request samples

Content type
application/json
{
  • "scanIDs": [
    ],
  • "tenantID": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Scans_createReports

Create new scan reports.

Request Body schema: application/json
required
required
Array of objects (CreateReport)

Responses

Request samples

Content type
application/json
{
  • "reports": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Scans_getAllSoftwareVersions

Get software versions from scans.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scans_countSoftwareVersions

Count software versions from scans.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Scans_getScanTypes

Get available scan types.

Responses

Response samples

Content type
application/json
[
  • "unknown"
]

Scans_getScan

Get scan.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "string",
  • "decodedUrl": "string",
  • "isUrlValid": true,
  • "constraintsSatisfied": true,
  • "type": "unknown",
  • "syncStatus": "pending",
  • "actionStatus": "unknown",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "scanGroupID": 0,
  • "scanEndpointID": 0,
  • "targetID": 0,
  • "appAuthID": 0,
  • "specID": 0,
  • "wafHarExtractorID": 0,
  • "tenantID": 0,
  • "scanDetails": {
    },
  • "scanReports": [
    ],
  • "appAuth": {
    },
  • "spec": {
    },
  • "wafHarExtractor": {
    }
}

Scans_deleteScan

Delete scan.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scans_cancelScan

Cancel scan.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scans_getScanIssues

Get scan's issues.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scans_countScanIssues

Count scan's issues.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Scans_getScanIssue

Get scan's issue.

id - unique id of scan. issueID - unique id of scan issue.

path Parameters
id
required
integer <uint32>
issueID
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "scanID": 0,
  • "issueID": "string",
  • "type": "unknown",
  • "analyzer": "string",
  • "url": "string",
  • "details": { },
  • "fqdn": "string",
  • "ipAddress": "string",
  • "port": 0,
  • "os": "string",
  • "service": "string",
  • "software": "string",
  • "category": "string",
  • "patches": { },
  • "payload": { },
  • "dataflows": { },
  • "issue": {
    }
}

Scans_getScanJobsLogsModules

Get logs for jobs of scans.

path Parameters
id
required
integer <uint32>
jobID
required
integer <uint64>
query Parameters
type
string (ScanDetailsJobLogType)
Enum: "unknown" "standard" "http" "authChecker"

Job's log type can be used to filter the logs.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scans_pauseScan

Pause scan.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scans_getScanReports

Get scan's reports.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scans_deleteScanReport

Delete scan's report.

path Parameters
id
required
integer <uint32>
reportID
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scans_getScanReportFile

Get scan's report file.

path Parameters
id
required
integer <uint32>
reportID
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scans_resumeScan

Resume / Unpause scan.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Scans_getScanSoftwareVersions

Get software versions detected during scan.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scans_getScanStatus

Get scan's status.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "syncStatus": "pending",
  • "actionStatus": "unknown",
  • "status": "UNKNOWN"
}

Scan group

ScanGroups_getScanGroups

Get scan groups.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ScanGroups_countScanGroups

Count scan groups.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

ScanGroups_updateScanGroup

Update scan group.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
name
string

Scan group name. May be omitted in response.

description
string

Scan group description. May be omitted in response.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

ScanGroups_getScanGroup

Get scan group.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "scans": [
    ]
}

Target

Targets_createTarget

Create target.

Request Body schema: application/json
required
tenantID
integer <uint32> (TenantID)

Tenant ID.

name
string

Target name. May be omitted in response.

url
required
string

Target URL.

description
string

Target description. May be omitted in response.

object

Target update time. May be omitted in response

object

Target url restriction list. May be omitted in response

object

Target authentication checking configuration.

object

Target regexp authentication refresher configuration.

object

Target browser authentication refresher configuration.

object (CreateAppAuthData)
object (CreateWAFHarExtractorData)
object (CreateSpecData)

Responses

Request samples

Content type
application/json
{
  • "tenantID": 0,
  • "name": "string",
  • "url": "string",
  • "description": "string",
  • "rpsLimit": {
    },
  • "urlRestrictionList": {
    },
  • "authCheckingConfig": {
    },
  • "regexpAuthRefresherConfig": {
    },
  • "browserAuthRefresherConfig": {
    },
  • "appAuth": {
    },
  • "wafHarExtractor": {
    },
  • "specification": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "actionStatus": "unknown",
  • "name": "string",
  • "url": "string",
  • "decodedUrl": "string",
  • "isUrlValid": true,
  • "constraintsSatisfied": true,
  • "description": "string",
  • "additionalData": {
    },
  • "scansCount": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "appAuthID": 0,
  • "specID": 0,
  • "wafHarExtractorID": 0,
  • "scans": [
    ],
  • "appAuth": {
    },
  • "spec": {
    },
  • "wafHarExtractor": {
    }
}

Targets_getTargets

Get targets.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Targets_manageTargets

Manage targets:

  • Delete targets.
Request Body schema: application/json
required
delete
Array of integers <uint32> [ items <uint32 > ]

Responses

Request samples

Content type
application/json
{
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Targets_countTargets

Count targets.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Targets_getTargetFilesInfo

Get information about target files:

  • Application authentication files.
  • Specification files.
  • Waf har extractor files.

Files information:

  • Extensions.
  • Sizes.

Responses

Response samples

Content type
application/json
{
  • "tlsClientCertificate": {
    },
  • "specification": {
    },
  • "wafHarExtractor": {
    },
  • "browserAuthRefresherConfig": {
    }
}

Targets_getTargetsHostnameConstraints

Get information about current hostname constraints for targets.

Responses

Response samples

Content type
application/json
{
  • "hostnameConstraints": [
    ]
}

Targets_getSeverityChart

Get severity chart.

resolution query parameter is default to day. timezone query parameter specifies timezone, UTC is default. from - to parameters are default to one month from current date.

Timezones examples for timezone query parameter:

  • UTC (default).
  • UTC+3.
  • UTC-8.
  • UTC+14:30.
  • UTC-13:30.
  • etc.

Time/date format for from and to query parameters:

  • 2006-01-02 (date only).
  • 2006-01-02T15:04:05Z07:00 (RFC3339).

Time/date query parameters examples: 2024-10-28, 2024-10-28T16:56:49.753295+03:00 (time zone can be specified).

query Parameters
resolution
string (SeverityTrendResolution)
Enum: "15 minutes" "30 minutes" "1 hour" "3 hours" "6 hours" "12 hours" "1 day" "3 days" "1 week" "2 weeks"
timezone
string
Default: "UTC"
from
string <date-time>
to
string <date-time>
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "unknown": 0,
  • "info": 0,
  • "low": 0,
  • "mediu": 0,
  • "high": 0,
  • "critical": 0
}

Targets_getSeverityTrend

Get severity trend.

resolution query parameter is default to day. timezone query parameter specifies timezone, UTC is default. from - to parameters are default to one month from current date.

Maximum points for severity trend: (to - from) / resolution = 100. If points > 100 the error will be returned. No maximum points restriction for users with role superAdmin.

Timezones examples for timezone query parameter:

  • UTC (default).
  • UTC+3.
  • UTC-8.
  • UTC+14:30.
  • UTC-13:30.
  • etc.

Time/date format for from and to query parameters:

  • 2006-01-02 (date only).
  • 2006-01-02T15:04:05Z07:00 (RFC3339).

Time/date query parameters examples: 2024-10-28, 2024-10-28T16:56:49.753295+03:00 (time zone can be specified).

query Parameters
resolution
string (SeverityTrendResolution)
Enum: "15 minutes" "30 minutes" "1 hour" "3 hours" "6 hours" "12 hours" "1 day" "3 days" "1 week" "2 weeks"
timezone
string
Default: "UTC"
from
string <date-time>
to
string <date-time>
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "trend": {
    },
  • "targetID": 0,
  • "resolution": "15 minutes",
  • "timezone": "string",
  • "timeRange": {
    }
}

Wizards_wizardTargetExist

Check if target exist.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Request Body schema: application/json
required
id
required
integer <uint32>

Target ID. May be omitted in response.

url
required
string

Target URL.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "wizard": true,
  • "details": { }
}

Wizards_wizardTargetSatisfyConstraints

Check if target's URL satisfy tenant constraints.

Request Body schema: application/json
required
url
required
string

Target URL.

Responses

Request samples

Content type
application/json
{
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "wizard": true,
  • "details": { }
}

Wizards_wizardTargetValidAppAuthURI

Check if application authentication URI is valid for target URL.

Request Body schema: application/json
required
url
required
string

Target URL.

required
object (AppAuthUri)

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "appAuthURI": {
    }
}

Response samples

Content type
application/json
{
  • "wizard": true,
  • "details": { }
}

Wizards_wizardTargetVerifyUrl

Check if target's URL is valid.

Request Body schema: application/json
required
url
required
string

Target URL.

Responses

Request samples

Content type
application/json
{
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "wizard": true,
  • "details": { }
}

Wizards_wizardTargetValidUrlRestrictionList

Check if target's URL restriction list is valid.

Request Body schema: application/json
required
urlRestrictionList
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "urlRestrictionList": [
    ]
}

Response samples

Content type
application/json
{
  • "wizard": true,
  • "details": { }
}

Targets_updateTarget

Update target.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
name
string

Target name. May be omitted in response.

description
string

Target description. May be omitted in response.

object

Target update time. May be omitted in response

object

Target url restriction list. May be omitted in response

rewriteAuthCheckingConfig
boolean

Whether to rewrite authentication checking configuration with new data or not. Empty authentication checking criteria works as clear data.

object

Target authentication checking configuration.

rewriteRegexpAuthRefresherConfig
boolean

Whether to rewrite regexp authentication refresher configuration with new data or not. Empty regexp authentication refresher configuration works as clear data.

object

Target regexp authentication refresher configuration.

rewriteBrowserAuthRefresherConfig
boolean

Whether to rewrite browser authentication refresher configuration with new data or not. Empty browser authentication refresher configuration works as clear data.

object

Target browser authentication refresher configuration.

rewriteAppAuth
boolean

Whether to rewrite application authentication with new data or not. Empty application authentication works as clear data.

object (CreateAppAuthData)
rewriteSpec
boolean

Whether to rewrite specification with new data or not. Empty specification works as clear data.

object (CreateSpecDataUpdate)
rewriteWAFHarExtractor
boolean

Whether to rewrite waf har extractor with new data or not. Empty waf har extractor works as clear data.

object (CreateWAFHarExtractorDataUpdate)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "rpsLimit": {
    },
  • "urlRestrictionList": {
    },
  • "rewriteAuthCheckingConfig": true,
  • "authCheckingConfig": {
    },
  • "rewriteRegexpAuthRefresherConfig": true,
  • "regexpAuthRefresherConfig": {
    },
  • "rewriteBrowserAuthRefresherConfig": true,
  • "browserAuthRefresherConfig": {
    },
  • "rewriteAppAuth": true,
  • "appAuth": {
    },
  • "rewriteSpec": true,
  • "specification": {
    },
  • "rewriteWAFHarExtractor": true,
  • "wafHarExtractor": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "actionStatus": "unknown",
  • "name": "string",
  • "url": "string",
  • "decodedUrl": "string",
  • "isUrlValid": true,
  • "constraintsSatisfied": true,
  • "description": "string",
  • "additionalData": {
    },
  • "scansCount": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "appAuthID": 0,
  • "specID": 0,
  • "wafHarExtractorID": 0,
  • "scans": [
    ],
  • "appAuth": {
    },
  • "spec": {
    },
  • "wafHarExtractor": {
    }
}

Targets_getTarget

Get target.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "actionStatus": "unknown",
  • "name": "string",
  • "url": "string",
  • "decodedUrl": "string",
  • "isUrlValid": true,
  • "constraintsSatisfied": true,
  • "description": "string",
  • "additionalData": {
    },
  • "scansCount": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenantID": 0,
  • "appAuthID": 0,
  • "specID": 0,
  • "wafHarExtractorID": 0,
  • "scans": [
    ],
  • "appAuth": {
    },
  • "spec": {
    },
  • "wafHarExtractor": {
    }
}

Targets_deleteTarget

Delete target.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Targets_getTargetIssues

Get issues of target.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Targets_updateIssueStatus

Update target's issue status.

path Parameters
id
required
integer <uint32>
issueID
required
string
Request Body schema: application/json
required
status
required
string (IssueStatus)
Enum: "unknown" "actual" "falsePositive" "confirmed" "fixed" "regression"

Responses

Request samples

Content type
application/json
{
  • "status": "unknown"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

Targets_getTargetSeverityChart

Get target severity chart.

resolution query parameter is default to day. timezone query parameter specifies timezone, UTC is default. from - to parameters are default to one month from current date.

Timezones examples for timezone query parameter:

  • UTC (default).
  • UTC+3.
  • UTC-8.
  • UTC+14:30.
  • UTC-13:30.
  • etc.

Time/date format for from and to query parameters:

  • 2006-01-02 (date only).
  • 2006-01-02T15:04:05Z07:00 (RFC3339).

Time/date query parameters examples: 2024-10-28, 2024-10-28T16:56:49.753295+03:00 (time zone can be specified).

path Parameters
id
required
integer <uint32>
query Parameters
resolution
string (SeverityTrendResolution)
Enum: "15 minutes" "30 minutes" "1 hour" "3 hours" "6 hours" "12 hours" "1 day" "3 days" "1 week" "2 weeks"
timezone
string
Default: "UTC"
from
string <date-time>
to
string <date-time>
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "unknown": 0,
  • "info": 0,
  • "low": 0,
  • "mediu": 0,
  • "high": 0,
  • "critical": 0
}

Targets_getTargetSeverityTrend

Get target severity trend.

resolution query parameter is default to day. timezone query parameter specifies timezone, UTC is default. from - to parameters are default to one month from current date.

Maximum points for severity trend: (to - from) / resolution = 100. If points > 100 the error will be returned. No maximum points restriction for users with role superAdmin.

Timezones examples for timezone query parameter:

  • UTC (default).
  • UTC+3.
  • UTC-8.
  • UTC+14:30.
  • UTC-13:30.
  • etc.

Time/date format for from and to query parameters:

  • 2006-01-02 (date only).
  • 2006-01-02T15:04:05Z07:00 (RFC3339).

Time/date query parameters examples: 2024-10-28, 2024-10-28T16:56:49.753295+03:00 (time zone can be specified).

path Parameters
id
required
integer <uint32>
query Parameters
resolution
string (SeverityTrendResolution)
Enum: "15 minutes" "30 minutes" "1 hour" "3 hours" "6 hours" "12 hours" "1 day" "3 days" "1 week" "2 weeks"
timezone
string
Default: "UTC"
from
string <date-time>
to
string <date-time>
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "trend": {
    },
  • "targetID": 0,
  • "resolution": "15 minutes",
  • "timezone": "string",
  • "timeRange": {
    }
}

Targets_getTargetSoftwareVersions

Get target software versions.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Targets_countTargetSoftwareVersions

Count target software versions.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Target group

TargetGroups_createTargetGroup

Create target group.

Request Body schema: application/json
required
tenantID
integer <uint32> (TenantID)

Tenant ID.

name
string

Target group name. May be omitted in response.

description
string

Target group description. May be omitted in response.

targetIDs
Array of integers <uint32> [ items <uint32 > ]

Target IDs.

Responses

Request samples

Content type
application/json
{
  • "tenantID": 0,
  • "name": "string",
  • "description": "string",
  • "targetIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "targets": [
    ]
}

TargetGroups_getTargetGroups

Get target groups.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TargetGroups_countTargetGroups

Count target groups.

query Parameters
within_tenant
boolean (WithinTenant)

All requests are (by default) performed within the tenant, except for super administrators. The within_tenant query parameter is responsible for managing whether requests are performed within or beyond the tenant for super administrators.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

TargetGroups_updateTargetGroup

Update target group.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
name
string

Target group name. May be omitted in response.

description
string

Target group description. May be omitted in response.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

TargetGroups_getTargetGroup

Get target group.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "targets": [
    ]
}

TargetGroups_deleteTargetGroup

Delete target group.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

TargetGroups_rewriteTargetGroupTargets

Rewrite target group tarets.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
targetIDs
required
Array of integers <uint32> [ items <uint32 > ]

Target IDs.

Responses

Request samples

Content type
application/json
{
  • "targetIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "targets": [
    ]
}

TargetGroups_manageTargetGroupTargets

Manage target group tarets:

  • Add targets to target group (in priority).
  • Delete targets from target group.
path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
add
Array of integers <uint32> [ items <uint32 > ]

IDs of targets to add.

delete
Array of integers <uint32> [ items <uint32 > ]

IDs of targets to delete.

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tenantID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "targets": [
    ]
}

Scanner

ScanEndpoints_createScanEndpoint

Create scanner.

Request Body schema: application/json
required
name
required
string

Scanner name.

address
required
string

Scanner address.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "schemaVersion": 0,
  • "disabled": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenants": [
    ]
}

ScanEndpoints_getScanEndpoints

Get scanners.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ScanEndpoints_updateScanEndpoint

Update scanner.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
name
string

Scanner name.

disabled
boolean

Whether scanner is disabled.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "schemaVersion": 0,
  • "disabled": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

ScanEndpoints_getScanEndpoint

Get scanner.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "schemaVersion": 0,
  • "disabled": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tenants": [
    ]
}

ScanEndpoints_disableScanEndpoint

Disable scanner.

This endpoint is to disable scanner with scan synchronisation service (service as a dependency). If scanner is busy, 400 HTTP status code will be sent with corresponding error.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorDetails": { }
}

ScanEndpoints_getScanEndpointModules

Get scanner modules.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Audit log

AuditLogNameSpace_getAuditLog

Get audit log.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AuditLogNameSpace_getAuditLogByReqID

Get audit log of specific request.

path Parameters
reqID
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AuditLogNameSpace_getAuditLogByUserID

Get audit log of specific user.

path Parameters
userID
required
integer <uint32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AuditLogNameSpace_getAuditLogByID

Get audit log record.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "reqID": "string",
  • "reqAction": "string",
  • "userData": { },
  • "applicationLog": true,
  • "tableName": "string",
  • "operation": "string",
  • "oldData": { },
  • "newData": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "user": {
    }
}

Tenant

Tenants_createTenant

Create tenant.

Request Body schema: application/json
required
name
required
string (TenantName)

Tenant name.

hostnameConstraints
Array of strings

Tenant hostname constraints. Shell pattern constraints.

object (CreateWAFHarExtractorData)
scanEndpointIDs
Array of integers <uint32> [ items <uint32 > ]

Tenant scan endpoint IDs to add.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractor": {
    },
  • "scanEndpointIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractorID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "wafHarExtractor": {
    },
  • "users": [
    ],
  • "targets": [
    ],
  • "targetGroups": [
    ],
  • "scanGroups": [
    ],
  • "scanEndpoints": [
    ]
}

Tenants_getTenants

Get tenants.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tenants_getDefaultTenant

Get the default tenant.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractorID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "wafHarExtractor": {
    },
  • "users": [
    ],
  • "targets": [
    ],
  • "targetGroups": [
    ],
  • "scanGroups": [
    ],
  • "scanEndpoints": [
    ]
}

Tenants_updateTenant

Update tenant.

path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
name
string (TenantName)

Tenant name.

rewriteWAFHarExtractor
boolean

Whether to rewrite waf har extractor with new data or not. Empty waf har extractor works as clear data.

object (CreateWAFHarExtractorDataUpdate)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rewriteWAFHarExtractor": true,
  • "wafHarExtractor": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractorID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Tenants_getTenantByID

Get tenant by id.

path Parameters
id
required
integer <uint32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractorID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "wafHarExtractor": {
    },
  • "users": [
    ],
  • "targets": [
    ],
  • "targetGroups": [
    ],
  • "scanGroups": [
    ],
  • "scanEndpoints": [
    ]
}

Tenants_manageHostnameConstraints

Manage tenant hostname constraints:

  • Add tenant hostname constraints (in priority).
  • Delete tenant hostname constraints.
path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
add
Array of strings

Hostname constraints to add to tenant.

delete
Array of strings

Hostname constraints to delete from tenant.

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractorID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Tenants_manageScanEndpoints

Manage tenant scan endpoints:

  • Add tenant scan endpoints (in priority).
  • Delete tenant scan endpoints.
path Parameters
id
required
integer <uint32>
Request Body schema: application/json
required
add
Array of integers <uint32> [ items <uint32 > ]

Scan endpoint IDs. Scan endpoints to add to tenant.

delete
Array of integers <uint32> [ items <uint32 > ]

Scan endpoint IDs. Scan endpoints to delete from tenant.

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractorID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "scanEndpoints": [
    ]
}

Tenants_getTenantByName

Get tenant by name.

path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "hostnameConstraints": [
    ],
  • "wafHarExtractorID": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "wafHarExtractor": {
    },
  • "users": [
    ],
  • "targets": [
    ],
  • "targetGroups": [
    ],
  • "scanGroups": [
    ],
  • "scanEndpoints": [
    ]
}

About

AboutNameSpace_getAbout

Get application info.

Responses

Response samples

Content type
application/json
{
  • "version": "string"
}