Download OpenAPI specification:Download
Probely is a Web Vulnerability Scanning suite for Agile Teams. It provides continuous scanning of your Web Applications and lets you efficiently manage the lifecycle of the vulnerabilities found, in a sleek and intuitive web interface API.
In this quick example we will start a scan for a target from a list and get the final scan results.
To run the requests, replace <PROBELY_AUTH_TOKEN>
with your authentication token.
Read more about how to obtain the authentication token in the Authentication section.
We will start with a request to get the list of targets of the account.
curl https://api.probely.com/targets/ -X GET -H "Content-Type: application/json" -H "Authorization: JWT <PROBELY_AUTH_TOKEN>"
The response returns a JSON with the list of targets in your account.
{
"count": 32,
"page_total": 4,
"page": 1,
"length": 10,
"results": [
{
"id": "3jWDZrNpfhSK",
"site": {
"id": "44rhjEiKbqHP",
"name": "My Website",
"desc": "",
"url": "https://www.example.com/",
...
},
...
},
...
]
}
With a list of targets, we will start a scan for the first target (with the identifier 3jWDZrNpfhSK
).
curl https://api.probely.com/targets/3jWDZrNpfhSK/scan_now/ -X POST -H "Content-Type: application/json" -H "Authorization: JWT <PROBELY_AUTH_TOKEN>"
The response returns a JSON with information about the scan, such as the scan identifier, the scan status, and the creation date.
{
"id": "37borpHTaGDe",
"target": {
"id": "3jWDZrNpfhSK",
...
},
"status": "queued",
...
"created": "2023-11-15T15:14:20.650073Z",
...
}
Now, we will poll Probely with the following request to get the scan information and check whether the scan is complete.
We will use the scan identifier (37borpHTaGDe
) and target identifier (3jWDZrNpfhSK
) from the previous steps.
curl https://api.probely.com/targets/3jWDZrNpfhSK/scans/37borpHTaGDe/ -X GET -H "Content-Type: application/json" -H "Authorization: JWT <PROBELY_AUTH_TOKEN>"
When the scan is complete, the response returns a JSON with the scan status as completed
, together with the date and time of completion and the final number of vulnerabilities found (low, medium, and high).
{
"id": "37borpHTaGDe",
"target": {
"id": "3jWDZrNpfhSK",
...
},
"status": "completed",
"started": "2023-11-15T15:14:22.971155Z",
"completed": "2023-11-15T15:57:52.888459Z",
"scan_profile": "api_normal",
"lows": 1,
"mediums": 2,
"highs": 24,
...
}
In this last step, we polled Probely to get the scan information and check whether it was complete.
An alternative to this is to subscribe to Probely events and get notified about changes in your account.
Learn more about the available events and how to subscribe to them in Events.
A valid authentication token is required to make requests to the Probely API.
To obtain the authenticationtoken, generate an API Key in the Probely app and save it in a secure place.
Treat the authentication token as a password since it allows access to information in your account and possible manipulation (depending on the role associated with the API Key).
To pass the authentication token in requests, add it to the authorization header using the following format:
Authorization: JWT <PROBELY_AUTH_TOKEN>
TL;DR: you run scans on targets, and findings are created for any issue that is found. However, there are a few more concepts that must be explained in order to get a complete picture of how Probely works. We will spend the next few sections detailing the most important concepts.
A target defines the scope of a scan, what will and won't be included in the scan plan. This is done by filling a target's site and assets.
The entry point for the web application (and authentication) is setup in the target's site.
In modern web applications, you are probably loading resources from multiple domains. A single page app, for example, will usually load the page from one domain and make AJAX requests to another. This is what assets are for: they specify what domains our scanner should follow and create requests for.
A URL is probably not the only thing you will need to setup when scanning your application.
For example:
These parameters are all configured in the target's site.
We need to ensure that only allowed web applications are scanned. Therefore, we must verify that you have control of any site you wish to include. This can be done by:
This is what you're here for. After configuring your target, you will want to run scans against it. You can either start a one off scan, or schedule one for later - recurring or not.
During the scan, we will crawl the site and run several modules to check for security issues, which we call findings. You can check the findings even before a scan ends. If everything goes well, the scan will complete and that is it.
With some findings, our automated processes may have difficulties determining if it is a false positive or a legitimate issue. In these instances, a scan will be marked as under review, and we will further analyze the finding before making a decision. We will only show findings that, for some degree of confidence, are true positives. A finding that we are not sure of will never be displayed.
As much as we try to prevent it, a scan (or a sub-module) can malfunction.
If this happens, a scan is marked as:
During a scan, we try to determine what frameworks you are using and add this information to the site and asset objects discussed previously.
The last core concept is the finding, this is a security issue that we have found during our scans. If the same issue is found in a new scan it will not open a new finding but update the previous.
A finding will have a lot of information about the issue. Namely, where it was found, URL, insertion point (e.g. cookie), parameter, and method. Evidence we gathered, and the full request and response that we used. Sugestions of how to go about fixing it. A full description of the vulnerability is also present in the definition property. We also assign a severity and calculate the CVSS score for each.
Besides all this, there are also actions that you can perform on a finding. You can assign it to one user, leave comments for your team or add labels, and reduce or increase the severity.
If you don't plan on fixing the finding and accept the risk, or you think we reported a false positive, you can mark the finding to reflect that.
Scan profiles allow you perform different kinds of scans that differ in their duration, type and number of requests performed and vulnerabilities tested for:
There are several scan profiles:
id | Name |
---|---|
lightning | Security Posture |
safe | Safe |
normal | Normal |
full | Full |
api_normal | API Normal |
api_full | API Full |
Security Posture scans usually run in under a minute and check for SSL/TLS, HTTP headers, and cookies attribute-related vulnerabilities.
The safe profile tests for all the vulnerabilities we support, but with a limited set of payloads, to reduce the possible impact on the target application. The scanner will not make POST, PUT or DELETE requests, however, our crawler will still make requests with these methods if there are actions that trigger them.
The Normal profile tests for all the vulnerabilities we support, with a larger set of payloads than the one used in the safe profile, for some tests. It also has no restrictions about which methods it uses.
The Full profile includes all the tests from the normal profile, plus an even larger set of payloads.
Specifically for API targets, there are also the API Normal/API Full that correspond to profiles normal/full for web targets.
API users are a special kind of user in a Probely account. They represent applications interacting with Probely through the API in machine-to-machine scenarios, such as standalone applications integrating with Probely.
Depending on the roles assigned, API users can have access to different features of Probely to perform their tasks. Read more on How do Roles and Permissions Work
The endpoints under API Users provide the following functionality:
Some relevant information when using API Users:
Further functionality related to API Users is provided in the following tags:
account | boolean |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
role | Array of strings A unique Base58 value identifying this object. |
target | Array of strings |
team | Array of strings |
user | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
]
}
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
{- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
id required | string = 12 characters |
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
{- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
id | string = 12 characters |
object (ObjectId) | |
object (ObjectId) | |
object (DPOScopeRequest) |
{- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
Add roles to multiple API users in one operation.
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
[- {
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
]
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
Add/update/delete multiple API user roles in one operation.
Array of objects (UserRoleCreateRequest) | |
Array of objects (UserRoleUpdateRequest) | |
Array of objects (UserRoleDestroyRequest) |
{- "create": [
- {
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
], - "update": [
- {
- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
], - "delete": [
- {
- "id": "stringstring"
}
]
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
Update multiple API user roles in one operation.
id required | string = 12 characters |
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
[- {
- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
]
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
account | boolean |
active | boolean |
exclude_target | Array of strings |
exclude_team | Array of strings |
label | Array of strings A unique Base58 value identifying this object. |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between user labels.
|
length | integer Number of results to return per page. |
mfa_enabled | boolean |
no_access | boolean |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
role | Array of strings or null A unique Base58 value identifying this object. |
search | string A search term. |
target | Array of strings |
team | Array of strings |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
], - "is_apiuser": true,
- "key": "string"
}
]
}
name required | string <= 60 characters Name of the user. |
title | string Enum: "ceo" "cto" "cso" "seceng" "dev" "devop" "manager" "other" "" Job title:
|
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
required | Array of objects (UserLabel) |
Array of objects (SimpleUserRoleRequest) | |
mfa_enabled | boolean If true, the user has MFA (Multi-Factor Authentication) enabled at login. |
{- "name": "string",
- "title": "ceo",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
], - "mfa_enabled": true
}
{- "id": "string",
- "name": "string",
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
], - "is_apiuser": true,
- "key": "string"
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
], - "is_apiuser": true,
- "key": "string"
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 60 characters Name of the user. |
title | string Enum: "ceo" "cto" "cso" "seceng" "dev" "devop" "manager" "other" "" Job title:
|
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
required | Array of objects (UserLabel) |
mfa_enabled | boolean If true, the user has MFA (Multi-Factor Authentication) enabled at login. |
{- "name": "string",
- "title": "ceo",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "mfa_enabled": true
}
{- "id": "string",
- "name": "string",
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
], - "is_apiuser": true,
- "key": "string"
}
id required | string A unique Base58 value identifying this object. |
name | string <= 60 characters Name of the user. |
title | string Enum: "ceo" "cto" "cso" "seceng" "dev" "devop" "manager" "other" "" Job title:
|
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
Array of objects (UserLabel) | |
mfa_enabled | boolean If true, the user has MFA (Multi-Factor Authentication) enabled at login. |
{- "name": "string",
- "title": "ceo",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "mfa_enabled": true
}
{- "id": "string",
- "name": "string",
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
], - "is_apiuser": true,
- "key": "string"
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
], - "is_apiuser": true,
- "key": "string"
}
user_id required | string |
enabled | boolean |
exclude_team | Array of strings Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | Array of strings Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
role | Array of strings |
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | Array of strings Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | Array of strings |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "user_roles": "string",
- "changed": "2019-08-24T14:15:22Z",
}
]
}
name required | string <= 60 characters Name of the user. |
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
required | Array of objects (UserLabel) |
Array of objects (SimpleUserRole) Roles of the user. |
{- "name": "string",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "user_roles": [
- {
- "role": { },
- "scope": {
- "property1": null,
- "property2": null
}
}
]
}
{- "id": "string",
- "name": "string",
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
], - "is_apiuser": true,
- "key": "string"
}
To scan targets with Probely you need to have an account and subscribe to one of the available pricing plans.
Once created, you can manage your account regarding the subscribed plan, payment and billing information, invoices, targets with unlimited scans, and credits for scanning targets.
Within your account, explore the features provided by Probely, such as:
See the Related Tags section for further details.
The endpoints under Account provide the following functionality:
Further functionality related to Account is provided in the following tags:
Details about the accounts subscription (subscribed plan, billing cycle, etc..).
{- "status": "active",
- "plan": {
- "id": "enterprise-base-eur",
- "name": "Enterprise Plan",
- "family": "enterprise",
- "description": "",
- "is_trial": true,
- "charge_model": "flat_fee",
- "period": 1,
- "period_unit": "year",
- "allowed_scan_profiles": [
- "lightning",
- "safe",
- "normal",
- "full"
], - "allowed_credits_packs": [ ]
}, - "plan_target_quantity": 5,
- "pool_size": 10,
- "auto_collection": true,
- "next_billing_at": "2019-08-24T14:15:22Z",
- "trial_end": "2019-08-24T14:15:22Z",
- "balance": 0,
- "balance_currency_code": "eur",
- "has_used_trial": true,
- "heroku": false,
- "plan_amount": 56000,
- "next_billing_amount": 56000,
- "available_slots": 5
}
{- "first_name": "Pedro",
- "last_name": "Miguel",
- "company": "Probely",
- "address": "Fake street 19",
- "city": "Lisbon",
- "country": "Portugal",
- "zip": "1200-123",
- "vat_number": "123456789"
}
first_name | string Default: "" First name of billing contact. |
last_name | string Default: "" Last name of billing contact. |
company | string Default: "" Company name for billing purposes. |
string <email> Default: "" E-mail for billing purposes. | |
address | string Default: "" Company address for billing purposes. |
city | string Default: "" |
country | string Default: "" Company country for billing purposes. |
state | string Default: "" Company state for billing purposes. |
zip | string Default: "" Company zip code for billing purposes. |
vat_number | string Company VAT number for billing purposes. |
reg_number | string Company registration number for billing purposes. |
other | string Additional information that should be in invoices. |
{- "first_name": "Pedro",
- "last_name": "Miguel",
- "company": "Probely",
- "address": "Fake street 19",
- "city": "Lisbon",
- "country": "Portugal",
- "zip": "1200-123",
- "vat_number": "123456789"
}
{- "first_name": "Pedro",
- "last_name": "Miguel",
- "company": "Probely",
- "address": "Fake street 19",
- "city": "Lisbon",
- "country": "Portugal",
- "zip": "1200-123",
- "vat_number": "123456789"
}
first_name | string Default: "" First name of billing contact. |
last_name | string Default: "" Last name of billing contact. |
company | string Default: "" Company name for billing purposes. |
string <email> Default: "" E-mail for billing purposes. | |
address | string Default: "" Company address for billing purposes. |
city | string Default: "" |
country | string Default: "" Company country for billing purposes. |
state | string Default: "" Company state for billing purposes. |
zip | string Default: "" Company zip code for billing purposes. |
vat_number | string Company VAT number for billing purposes. |
reg_number | string Company registration number for billing purposes. |
other | string Additional information that should be in invoices. |
{- "first_name": "Pedro",
- "last_name": "Miguel",
- "company": "Probely",
- "address": "Fake street 19",
- "city": "Lisbon",
- "country": "Portugal",
- "zip": "1200-123",
- "vat_number": "123456789"
}
{- "first_name": "Pedro",
- "last_name": "Miguel",
- "company": "Probely",
- "address": "Fake street 19",
- "city": "Lisbon",
- "country": "Portugal",
- "zip": "1200-123",
- "vat_number": "123456789"
}
{- "promotional_credits": 4294967295,
- "purchased_credits": 4294967295,
- "outstanding_credits": 4294967295,
- "on_hold_promotional": 4294967295,
- "on_hold_purchased": 4294967295,
- "promotional_expiration_date": "2019-08-24",
- "purchased_expiration_date": "2019-08-24",
- "balance": 0
}
pack_id required | string <= 100 characters Identifier of the credits pack to purchase. |
coupon_ids | Array of strings[ items <= 100 characters ] Identifiers of the credits coupons to purchase. |
{- "pack_id": "string",
- "coupon_ids": [
- "string"
]
}
{- "id": "string",
- "sub_total": 0,
- "total": 0,
- "amount_due": 0,
- "amount_paid": 0,
- "currency_code": "string",
- "credits_applied": 0,
- "line_items": [
- {
- "quantity": 0,
- "description": "string",
- "unit_amount": 0,
- "tax_amount": 0,
- "discount_amount": 0,
- "amount": 0,
- "date_from": 0,
- "date_to": 0
}
], - "discounts": [
- {
- "description": "string",
- "amount": 0
}
], - "taxes": [
- {
- "tax_name": "string",
- "tax_rate": 0,
- "tax_amount": 0
}
]
}
{- "auto_top_up_on_expiration": true,
- "auto_top_up_on_insufficient": true,
- "auto_top_up_credits_pack": {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
}
auto_top_up_on_expiration | boolean If true, buy credits automatically on the expiration date of purchased credits. |
auto_top_up_on_insufficient | boolean If true, buy credits automatically when the account balance is insufficient to perfom scans. |
object or null |
{- "auto_top_up_on_expiration": true,
- "auto_top_up_on_insufficient": true,
- "auto_top_up_credits_pack": {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
}
{- "auto_top_up_on_expiration": true,
- "auto_top_up_on_insufficient": true,
- "auto_top_up_credits_pack": {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
}
auto_top_up_on_expiration | boolean If true, buy credits automatically on the expiration date of purchased credits. |
auto_top_up_on_insufficient | boolean If true, buy credits automatically when the account balance is insufficient to perfom scans. |
object or null |
{- "auto_top_up_on_expiration": true,
- "auto_top_up_on_insufficient": true,
- "auto_top_up_credits_pack": {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
}
{- "auto_top_up_on_expiration": true,
- "auto_top_up_on_insufficient": true,
- "auto_top_up_credits_pack": {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
}
length | integer Number of results to return per page. |
operation | Array of strings Items Enum: "earned" "expired" "purchased" "used"
|
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
scope__name | string |
search | string A search term. |
target__label | string |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "description": "string",
- "amount": 4294967295,
- "balance": -2147483648,
- "on_hold": -2147483648,
- "full_balance": "string",
- "scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}
}
]
}
Account entitlements give detailed information of what features are available and what limits the account is subject to.
{- "pool_size": 0,
- "allow_extra_users": true,
- "max_users": 0,
- "max_scan_freq": "string",
- "max_scan_number": 0,
- "max_credit_targets": 0,
- "allow_billing": true,
- "allow_create_and_destroy_targets": true,
- "max_ultd_targets": 0,
- "allow_scope_labels": true,
- "allowed_scope_types": [
- "string"
], - "spa_limit": 0,
- "scanning_agent_limit": 0,
- "verify_target_ownership": true,
- "allowed_builtin_scan_profiles": [
- "string"
], - "allow_custom_scan_profiles": true,
- "allow_bulk_scan": true,
- "allow_pause_and_resume_scan": true,
- "allow_partial_scan": true,
- "allow_scanning_2fa_targets": true,
- "allow_teams": true,
- "allow_bulk": true,
- "allow_dashboard": true,
- "allow_roles": true,
- "allow_scanning_agent": true,
- "allow_user_labels": true,
- "allow_custom_roles": true,
- "allow_sso": true,
- "allow_target_import_export": true,
- "allow_full_coverage_report": true,
- "allow_audit_log": true,
- "allow_azure_devops": true,
- "allow_jira_cloud": true,
- "allow_jira_server": true,
- "allow_slack": true,
- "allow_defectdojo": true,
- "allow_webhooks": true,
- "allow_shortcut": true,
- "allow_heroku_sso": true,
- "allowed_report_file_formats": [
- "string"
], - "allowed_report_types": [
- "string"
], - "allow_stored_reports": true,
- "allowed_stored_report_file_formats": [
- "string"
], - "allowed_stored_report_types": [
- "string"
], - "allow_buying_credits": true,
- "allow_credits": true,
- "allow_unlimited": true,
- "allow_ultd_change": true,
- "number_unused_slots": 0,
- "allowed_credits_packs": [
- {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
], - "credits_hourly_cost": 0,
- "credits_cap": 0,
- "credits_lightning_cost": 0,
- "credits_auth_cost": 0,
- "allowed_monthly_promotional_credits": 0,
- "number_available_ultd_targets_minus_team_quotas": 0,
- "allowed_builtin_roles": [
- "string"
], - "allow_target_roles": true
}
List past invoices.
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "reference": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "amount": 0,
- "currency_code": "string",
- "description": "string"
}
]
}
Details about the accounts subscription (subscribed plan, billing cycle, etc..).
{- "plan": {
- "id": "string",
- "name": "string",
- "family": "string",
- "description": "string",
- "is_trial": true,
- "charge_model": "per_unit",
- "price": 0,
- "currency_code": "USD",
- "period": -2147483648,
- "period_unit": "week",
- "allowed_builtin_scan_profiles": [
- "string"
], - "allowed_credits_packs": [
- {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
], - "discount": 0,
- "savings": 0,
- "tiers": {
- "property1": null,
- "property2": null
}
}, - "subscription_status": "future",
- "has_used_trial": true,
- "trial_end": "2019-08-24T14:15:22Z",
- "next_billing_at": "2019-08-24T14:15:22Z",
- "next_billing_amount": 4294967295,
- "plan_amount": 4294967295,
- "auto_collection": true,
- "number_free_ultd_targets": 4294967295,
- "max_ultd_targets": 0,
- "number_paid_ultd_targets": 4294967295,
- "number_used_ultd_targets": 4294967295,
- "number_available_ultd_targets": 4294967295,
- "number_available_ultd_targets_minus_team_quotas": 4294967295,
- "number_used_credit_targets": 0,
- "number_available_credit_targets": 0,
- "past_year_ultd_target_changes": 0,
- "max_yearly_ultd_target_changes": 0,
- "next_allowed_ultd_target_change": "2019-08-24T14:15:22Z",
- "channel": "self-service"
}
enabled | boolean |
exclude_team | Array of strings Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | Array of strings Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
ordering | string Which field to use when ordering the results. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | Array of strings Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | Array of strings |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean |
[- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "unlimited": true
}
]
enabled | boolean |
exclude_team | Array of strings Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | Array of strings Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
ordering | string Which field to use when ordering the results. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | Array of strings Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | Array of strings |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean |
id required | string |
unlimited | boolean If true, the target has unlimited scans. |
[- {
- "id": "string",
- "unlimited": true
}
]
[- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "unlimited": true
}
]
enabled | boolean |
exclude_team | Array of strings Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | Array of strings Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
ordering | string Which field to use when ordering the results. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | Array of strings Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | Array of strings |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean |
id required | string |
unlimited | boolean If true, the target has unlimited scans. |
[- {
- "id": "string",
- "unlimited": true
}
]
[- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "unlimited": true
}
]
enabled | boolean |
exclude_team | Array of strings Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | Array of strings Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
ordering | string Which field to use when ordering the results. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | Array of strings Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | Array of strings |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean |
[- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "unlimited": true
}
]
length | integer Number of results to return per page. |
page | integer A page number within the paginated result set. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
]
}
id required | string A unique value identifying this addon. |
{- "id": "string",
- "name": "string",
- "price": -2147483648,
- "currency_code": "USD",
- "pack_amount": 4294967295,
- "discount": 0,
- "savings": 0
}
length | integer Number of results to return per page. |
page | integer A page number within the paginated result set. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "enterprise-base-eur",
- "name": "Enterprise Plan",
- "family": "enterprise",
- "description": "",
- "is_trial": true,
- "charge_model": "flat_fee",
- "period": 1,
- "period_unit": "year",
- "allowed_scan_profiles": [
- "lightning",
- "safe",
- "normal",
- "full"
], - "allowed_credits_packs": [ ]
}
]
}
Other resources a scan required access to (e.g. the domain where an API is being served) should be added here. You can also configure custom headers and cookies for each asset.
target_id required | string Identifier of the target. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
skip_reachability_check | string Probely's default behavior is to make a request to your target or host to check that it's reachable. To change this default add this parameter. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "desc": "string",
- "stack": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true,
- "host": "string"
}
]
}
target_id required | string Identifier of the target. |
skip_reachability_check | string Probely's default behavior is to make a request to your target or host to check that it's reachable. To change this default add this parameter. |
name | string <= 255 characters Name of the target or extra host. |
desc | string or null Description of the target. |
required | object (Framework) |
Array of objects (NameValue) Custom headers to send. | |
Array of objects (NameValue) Custom cookies to send. | |
include | boolean If true, the extra host is in the scope of the scan. |
{- "name": "string",
- "desc": "string",
- "stack": { },
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
{- "id": "string",
- "name": "string",
- "desc": "string",
- "stack": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true,
- "host": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
skip_reachability_check | string Probely's default behavior is to make a request to your target or host to check that it's reachable. To change this default add this parameter. |
{- "id": "string",
- "name": "string",
- "desc": "string",
- "stack": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true,
- "host": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
skip_reachability_check | string Probely's default behavior is to make a request to your target or host to check that it's reachable. To change this default add this parameter. |
name | string <= 255 characters Name of the target or extra host. |
desc | string or null Description of the target. |
required | object (Framework) |
Array of objects (NameValue) Custom headers to send. | |
Array of objects (NameValue) Custom cookies to send. | |
include | boolean If true, the extra host is in the scope of the scan. |
{- "name": "string",
- "desc": "string",
- "stack": { },
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
{- "id": "string",
- "name": "string",
- "desc": "string",
- "stack": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true,
- "host": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
skip_reachability_check | string Probely's default behavior is to make a request to your target or host to check that it's reachable. To change this default add this parameter. |
name | string <= 255 characters Name of the target or extra host. |
desc | string or null Description of the target. |
Array of objects or null Technologies in target scans. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
Array of objects (NameValue) Custom headers to send. | |
Array of objects (NameValue) Custom cookies to send. | |
include | boolean If true, the extra host is in the scope of the scan. |
{- "name": "string",
- "desc": "string",
- "stack": [
- { }
], - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
{- "id": "string",
- "name": "string",
- "desc": "string",
- "stack": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true,
- "host": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
skip_reachability_check | string Probely's default behavior is to make a request to your target or host to check that it's reachable. To change this default add this parameter. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
Vulnerability scans may require extensive requests to targets, which can be perceived as malicious attacks and make scans fail.
To avoid that, Probely requires the verification of the domain of targets to prove the ownership, i.e., that requests from vulnerability scans are allowed.
The endpoints under Domains provide the following functionality:
Some relevant information when using Domains:
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
verified | boolean |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "hostname": "string",
- "id": "string",
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "verified": true,
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
]
}
hostname required | string^(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1... Domain name with an associated IP address or an IP address itself. |
basic_auth_username | string or null Username used for basic authentication. |
basic_auth_password | string or null Password used for basic authentication. |
port | integer or null [ 1 .. 65535 ] IP Port to send the requests to. |
{- "hostname": "string",
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
{- "hostname": "string",
- "id": "string",
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "verified": true,
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
id required | string A unique Base58 value identifying this object. |
{- "hostname": "string",
- "id": "string",
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "verified": true,
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
id required | string A unique Base58 value identifying this object. |
hostname required | string^(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1... Domain name with an associated IP address or an IP address itself. |
basic_auth_username | string or null Username used for basic authentication. |
basic_auth_password | string or null Password used for basic authentication. |
port | integer or null [ 1 .. 65535 ] IP Port to send the requests to. |
{- "hostname": "string",
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
{- "hostname": "string",
- "id": "string",
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "verified": true,
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
id required | string A unique Base58 value identifying this object. |
hostname | string^(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1... Domain name with an associated IP address or an IP address itself. |
basic_auth_username | string or null Username used for basic authentication. |
basic_auth_password | string or null Password used for basic authentication. |
port | integer or null [ 1 .. 65535 ] IP Port to send the requests to. |
{- "hostname": "string",
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
{- "hostname": "string",
- "id": "string",
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "verified": true,
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
id required | string A unique Base58 value identifying this object. |
type required | string Enum: "file" "dns_txt" "dns_cname" "meta_tag" "whitelist" "email" "waved"
|
{- "type": "file"
}
{- "hostname": "string",
- "id": "string",
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "verified": true,
- "basic_auth_username": "string",
- "basic_auth_password": "string",
- "port": 1
}
Probely saves records and sends notifications of important events related to an account. So, instead of polling Probely repeatedly to get information and figure out whether something happened, register Webhooks and get notified by Probely about events in real-time.
Probely sends notifications for the following events:
Account Events
Target Events
Event notifications sent to Webhooks depend on the type of events Webhooks are registered for:
Webhook Registration | Event Notifications |
---|---|
Account Events | The Webhook receives notifications from Probely about account events and target events for all targets of the account. |
Target Events | The Webhook receives notifications from Probely about target events for a specific target of the account. |
The endpoints under Events provide the following functionality:
Some relevant information when using Events:
Further functionality related to Events is provided in the following tags:
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
]
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
target_id required | string Identifier of the target. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
]
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
target_id required | string Identifier of the target. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
]
}
target_id required | string Identifier of the target. |
name required | string <= 255 characters Name of the webhook. |
url required | string <uri> |
check_cert | boolean If true, verify the HTTPS certificate of the webhook URL. Defaults to true. |
api_version | string Value: "v1" API version of the webhook.
|
{- "name": "string",
- "check_cert": true,
- "api_version": "v1"
}
{- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target.r of the target. |
name required | string <= 255 characters Name of the webhook. |
url required | string <uri> |
check_cert | boolean If true, verify the HTTPS certificate of the webhook URL. Defaults to true. |
api_version | string Value: "v1" API version of the webhook.
|
{- "name": "string",
- "check_cert": true,
- "api_version": "v1"
}
{- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
name | string <= 255 characters Name of the webhook. |
url | string <uri> |
check_cert | boolean If true, verify the HTTPS certificate of the webhook URL. Defaults to true. |
api_version | string Value: "v1" API version of the webhook.
|
{- "name": "string",
- "check_cert": true,
- "api_version": "v1"
}
{- "id": "string",
- "event_type": "user_created",
- "occurred_at": "2019-08-24T14:15:22Z",
- "object_type": "string",
- "content": "string",
- "webhooks": [
- {
- "id": "string",
- "api_version": "v1",
- "status": "scheduled",
- "next_try": "2019-08-24T14:15:22Z",
- "retries": -2147483648
}
]
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "check_cert": true,
- "api_version": "v1",
- "created": "2019-08-24T14:15:22Z",
- "changed": "2019-08-24T14:15:22Z",
}
]
}
name required | string <= 255 characters Name of the webhook. |
url required | string <uri> |
check_cert | boolean If true, verify the HTTPS certificate of the webhook URL. Defaults to true. |
api_version | string Value: "v1" API version of the webhook.
|
{- "name": "string",
- "check_cert": true,
- "api_version": "v1"
}
{- "id": "string",
- "name": "string",
- "check_cert": true,
- "api_version": "v1",
- "created": "2019-08-24T14:15:22Z",
- "changed": "2019-08-24T14:15:22Z",
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "check_cert": true,
- "api_version": "v1",
- "created": "2019-08-24T14:15:22Z",
- "changed": "2019-08-24T14:15:22Z",
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 255 characters Name of the webhook. |
url required | string <uri> |
check_cert | boolean If true, verify the HTTPS certificate of the webhook URL. Defaults to true. |
api_version | string Value: "v1" API version of the webhook.
|
{- "name": "string",
- "check_cert": true,
- "api_version": "v1"
}
{- "id": "string",
- "name": "string",
- "check_cert": true,
- "api_version": "v1",
- "created": "2019-08-24T14:15:22Z",
- "changed": "2019-08-24T14:15:22Z",
}
id required | string A unique Base58 value identifying this object. |
name | string <= 255 characters Name of the webhook. |
url | string <uri> |
check_cert | boolean If true, verify the HTTPS certificate of the webhook URL. Defaults to true. |
api_version | string Value: "v1" API version of the webhook.
|
{- "name": "string",
- "check_cert": true,
- "api_version": "v1"
}
{- "id": "string",
- "name": "string",
- "check_cert": true,
- "api_version": "v1",
- "created": "2019-08-24T14:15:22Z",
- "changed": "2019-08-24T14:15:22Z",
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
]
}
name required | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
name | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
Findings are security issues found during scans. We try hard to present valid findings only. We give as much information as possible to help you know exactly what to do, without having to resort to outside resources.
Findings come with all the data we gathered during the scan, a suggestion on how to fix it, and a description of the vulnerability.
assignee | Array of strings A unique Base58 value identifying this object. |
label | Array of strings A unique Base58 value identifying this object. |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between labels.
|
lastfound_max | string or null <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. |
lastfound_min | string or null <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. |
length | integer Number of results to return per page. |
new | boolean |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
scan | Array of strings A unique Base58 value identifying this object. |
search | string A search term. |
severity | Array of integers Items Enum: 10 20 30 Severity of the vulnerability finding:
|
state | Array of strings Items Enum: "accepted" "fixed" "invalid" "notfixed" "retesting" State of the vulnerability finding:
|
target | Array of strings A unique Base58 value identifying this object. |
target_label | Array of strings A unique Base58 value identifying this object. |
target_label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
team | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}
Query Findings by their compound Id.
id required | integer A unique integer value identifying this finding. |
{- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
id required | integer A unique integer value identifying this finding. |
scans | Array of strings Scans that originated the vulnerability finding. |
required | Array of objects (FindingLabel) |
required | object (SimpleVulnerabilityDefinition) |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
required | object (SimpleUser) |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new required | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "insertion_point": "cookie",
- "parameter": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
id required | integer A unique integer value identifying this finding. |
scans | Array of strings Scans that originated the vulnerability finding. |
Array of objects or null Labels of the vulnerability finding. | |
definition | string Definition of the vulnerability. |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
assignee | string or null User who is assigned to fix the vulnerability. |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": "string",
- "insertion_point": "cookie",
- "parameter": "string",
- "assignee": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
scans | Array of strings Scans that originated the vulnerability finding. |
required | Array of objects (FindingLabel) |
required | object (SimpleVulnerabilityDefinition) |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
required | object (SimpleUser) |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new required | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "insertion_point": "cookie",
- "parameter": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "ids": [
- "<finding id>"
]
}
scans | Array of strings Scans that originated the vulnerability finding. |
required | Array of objects (FindingLabel) |
required | object (SimpleVulnerabilityDefinition) |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
required | object (SimpleUser) |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new required | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "insertion_point": "cookie",
- "parameter": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "ids": [
- "<finding id>"
]
}
target_id required | string Identifier of the target. |
assignee | Array of strings A unique Base58 value identifying this object. |
label | Array of strings A unique Base58 value identifying this object. |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between labels.
|
lastfound_max | string or null <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. |
lastfound_min | string or null <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. |
length | integer Number of results to return per page. |
new | boolean |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
scan | Array of strings A unique Base58 value identifying this object. |
search | string A search term. |
severity | Array of integers Items Enum: 10 20 30 Severity of the vulnerability finding:
|
state | Array of strings Items Enum: "accepted" "fixed" "invalid" "notfixed" "retesting" State of the vulnerability finding:
|
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}
finding_id required | string Finding ID |
target_id required | string Identifier of the target. |
length | integer Number of results to return per page. |
message_type | Array of strings or null Items Enum: "accepted" "assign" "fixed" "found" "invalid" "note" "retest" "retest_failed" "update"
|
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "change": "string",
- "changed": "2019-08-24T14:15:22Z",
- "field": "string",
- "value": { },
- "old_value": { },
- "message": "string",
- "message_type": "found",
- "finding_history_type": "s"
}
]
}
id required | integer [ -2147483648 .. 2147483647 ] |
target_id required | string Identifier of the target. |
{- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
id required | integer [ -2147483648 .. 2147483647 ] |
target_id required | string Identifier of the target. |
scans | Array of strings Scans that originated the vulnerability finding. |
required | Array of objects (FindingLabel) |
required | object (SimpleVulnerabilityDefinition) |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
required | object (SimpleUser) |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new required | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "insertion_point": "cookie",
- "parameter": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
id required | integer [ -2147483648 .. 2147483647 ] |
target_id required | string Identifier of the target. |
scans | Array of strings Scans that originated the vulnerability finding. |
Array of objects or null Labels of the vulnerability finding. | |
definition | string Definition of the vulnerability. |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
assignee | string or null User who is assigned to fix the vulnerability. |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": "string",
- "insertion_point": "cookie",
- "parameter": "string",
- "assignee": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "id": 0,
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "scans": [
- "string"
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "fix": "string",
- "requests": [
- {
- "request": "string",
- "response": "string"
}
], - "evidence": "string",
- "extra": "string",
- "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "url": "string",
- "path": "string",
- "method": "get",
- "insertion_point": "cookie",
- "parameter": "string",
- "value": "string",
- "params": "string",
- "state": "notfixed",
- "severity": 10,
- "cvss_score": 0,
- "cvss_vector": "string",
- "last_found": "2019-08-24T14:15:22Z",
- "retesting": true,
- "new": true,
- "changed": "2019-08-24T14:15:22Z",
- "comment": "string"
}
id required | integer [ -2147483648 .. 2147483647 ] |
target_id required | string Identifier of the target. |
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
target_id required | string Identifier of the target. |
scans | Array of strings Scans that originated the vulnerability finding. |
required | Array of objects (FindingLabel) |
required | object (SimpleVulnerabilityDefinition) |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
required | object (SimpleUser) |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new required | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "insertion_point": "cookie",
- "parameter": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "ids": [
- "<finding id>"
]
}
target_id required | string Identifier of the target. |
scans | Array of strings Scans that originated the vulnerability finding. |
required | Array of objects (FindingLabel) |
required | object (SimpleVulnerabilityDefinition) |
insertion_point | string Enum: "cookie" "parameter" "arbitrary_url_param" "header" "url_folder" "url_filename" "json_parameter" "request_body" "multipart_parameter" "graphql_parameter" "non_standard_parameter" "" Insertion point of the parameter:
|
parameter | string <= 1024 characters Name of the inserted parameter. |
required | object (SimpleUser) |
state | string Enum: "notfixed" "invalid" "accepted" "fixed" State of the vulnerability finding:
|
severity | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Severity of the vulnerability finding:
|
last_found | string <date-time> Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" |
new required | boolean If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans. |
comment | string or null Comment on the object. |
{- "scans": [
- "string"
], - "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "definition": {
- "id": "string",
- "name": "string",
- "desc": "string"
}, - "insertion_point": "cookie",
- "parameter": "string",
- "state": "notfixed",
- "severity": 10,
- "last_found": "2019-08-24T14:15:22Z",
- "new": true,
- "comment": "string"
}
{- "ids": [
- "<finding id>"
]
}
target_id required | string Identifier of the target. |
enabled | boolean |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "url": "string",
- "enabled": true
}
]
}
target_id required | string Identifier of the target. |
url required | string <= 2048 characters URL to scan. The maximum length is 2048 characters. |
enabled | boolean |
{- "url": "string",
- "enabled": true
}
{- "id": "string",
- "url": "string",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "id": "string",
- "url": "string",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
url required | string <= 2048 characters URL to scan. The maximum length is 2048 characters. |
enabled | boolean |
{- "url": "string",
- "enabled": true
}
{- "id": "string",
- "url": "string",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
url | string <= 2048 characters URL to scan. The maximum length is 2048 characters. |
enabled | boolean |
{- "url": "string",
- "enabled": true
}
{- "id": "string",
- "url": "string",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
required | Array of objects (UniqueFinding) |
{- "ids": [
- {
- "target_id": "289nqnDwp1Wi",
- "finding_id": 1
}, - {
- "target_id": "2endVWWueTMp",
- "finding_id": 1
}
]
}
{- "token": "<token>"
}
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf",
- "enabled": true
}
]
}
name required | string <= 255 characters Name of the stored report. |
date_time | string or null <date-time> Date and time when the next report will be generated. |
recurrence | string Enum: "h" "d" "w" "m" "q" "" Report generation recurrence.
|
timezone | string <= 64 characters Timezone to use for saved report timestamp. |
on_day_of_week | boolean Schedule report to be generated on specific monthly day of week (for monthly/quarterly recurrence). |
scheduled_day_of_week | integer or null [ -2147483648 .. 2147483647 ] Enum: 1 2 3 4 5 6 7 null Day of week to generate report on - monday to sunday (with
|
week_index | string or null Enum: "first" "second" "third" "fourth" "last" "" null Which week of the month to generate report on (with
|
required | object (ReportFilters) |
report_type | string Default: "default" |
report_fileformat | string Default: "pdf" |
{- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf"
}
{- "id": "string",
- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 255 characters Name of the stored report. |
date_time | string or null <date-time> Date and time when the next report will be generated. |
recurrence | string Enum: "h" "d" "w" "m" "q" "" Report generation recurrence.
|
timezone | string <= 64 characters Timezone to use for saved report timestamp. |
on_day_of_week | boolean Schedule report to be generated on specific monthly day of week (for monthly/quarterly recurrence). |
scheduled_day_of_week | integer or null [ -2147483648 .. 2147483647 ] Enum: 1 2 3 4 5 6 7 null Day of week to generate report on - monday to sunday (with
|
week_index | string or null Enum: "first" "second" "third" "fourth" "last" "" null Which week of the month to generate report on (with
|
required | object (ReportFilters) |
report_type | string Default: "default" |
report_fileformat | string Default: "pdf" |
{- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf"
}
{- "id": "string",
- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
name | string <= 255 characters Name of the stored report. |
date_time | string or null <date-time> Date and time when the next report will be generated. |
recurrence | string Enum: "h" "d" "w" "m" "q" "" Report generation recurrence.
|
timezone | string <= 64 characters Timezone to use for saved report timestamp. |
on_day_of_week | boolean Schedule report to be generated on specific monthly day of week (for monthly/quarterly recurrence). |
scheduled_day_of_week | integer or null [ -2147483648 .. 2147483647 ] Enum: 1 2 3 4 5 6 7 null Day of week to generate report on - monday to sunday (with
|
week_index | string or null Enum: "first" "second" "third" "fourth" "last" "" null Which week of the month to generate report on (with
|
object (ReportFilters) | |
report_type | string Default: "default" |
report_fileformat | string Default: "pdf" |
{- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf"
}
{- "id": "string",
- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf",
- "enabled": true
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
name required | string <= 255 characters Name of the stored report. |
date_time | string or null <date-time> Date and time when the next report will be generated. |
recurrence | string Enum: "h" "d" "w" "m" "q" "" Report generation recurrence.
|
timezone | string <= 64 characters Timezone to use for saved report timestamp. |
on_day_of_week | boolean Schedule report to be generated on specific monthly day of week (for monthly/quarterly recurrence). |
scheduled_day_of_week | integer or null [ -2147483648 .. 2147483647 ] Enum: 1 2 3 4 5 6 7 null Day of week to generate report on - monday to sunday (with
|
week_index | string or null Enum: "first" "second" "third" "fourth" "last" "" null Which week of the month to generate report on (with
|
required | object (ReportFilters) |
report_type | string Default: "default" |
report_fileformat | string Default: "pdf" |
{- "name": "string",
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "filters": {
- "severity": {
- "property1": null,
- "property2": null
}, - "state": {
- "property1": null,
- "property2": null
}, - "assignee": {
- "property1": null,
- "property2": null
}, - "label": {
- "property1": null,
- "property2": null
}, - "new": true,
- "target_label": {
- "property1": null,
- "property2": null
}, - "target": {
- "property1": null,
- "property2": null
}, - "team": {
- "property1": null,
- "property2": null
}, - "search": "string"
}, - "report_type": "default",
- "report_fileformat": "pdf"
}
{- "results": [
- { }
]
}
target_id required | string Identifier of the target. |
required | Array of objects (UniqueFinding) |
{- "ids": [
- 1,
- 5,
- 23
]
}
{- "token": "<token>"
}
target_id required | string |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
id required | string |
target_id required | string |
report_type | string Enum: "default" "executive_summary" "hipaa" "iso27001" "owasp" "pci" |
{- "error": "Invalid JWT."
}
User roles and permissions define which actions are allowed.
The access to the main features of Probely is ruled by permissions. For instance, in order to add a target, the user needs to have the permission Create Target
.
You can group permissions using roles. For instance, the built-in role Developer
can view targets, change target settings, change findings, and start scans, but cannot add targets.
You can then map roles to users by creating user roles at different levels:
Account: To apply a role to all targets of the account, i.e., the role is set at an account level or global scope.
Target: If you want to grant a user access to a single target.
Team: If you want to grant a user access to a group of targets associated with a team.
You can also combine the different levels of roles. You can have a user that has, for instance, the role Developer
at an account level and a role Admin
on a specific target.
Depending on your subscribed plan, you will have access to different roles:
Lite: Admin
and Owner
roles only.
Pro: Built-in roles (Admin
, Auditor
, Billing
, Developer
, Owner
, SecOps
).
Enterprise: Built-in roles, and custom roles with different permission combinations.
Owner
is special role that can be assigned to a single user with additional anti account lockout measures.
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string"
}
]
}
object | |
custom | boolean |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}
]
}
name required | string <= 255 characters Role's name. |
Array of objects (HighLevelPermission) | |
description | string or null Short description. |
{- "name": "string",
- "permissions": [
- {
- "id": "string"
}
], - "description": "string"
}
{- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 255 characters Role's name. |
Array of objects (HighLevelPermission) | |
description | string or null Short description. |
{- "name": "string",
- "permissions": [
- {
- "id": "string"
}
], - "description": "string"
}
{- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}
id required | string A unique Base58 value identifying this object. |
name | string <= 255 characters Role's name. |
Array of objects (HighLevelPermission) | |
description | string or null Short description. |
{- "name": "string",
- "permissions": [
- {
- "id": "string"
}
], - "description": "string"
}
{- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
A scan profile is associated with a target and determines how Probely scans that target.
There is a set of built-in scan profiles provided by Probely that already address the most common types of scans. However, it is also possible to create custom scan profiles to adjust and fine-tune scans for specific needs.
The endpoints under Scan Profiles provide the following functionality:
Some relevant information when using Scan Profiles:
Further functionality related to Scan Profiles is provided in the following tags:
archived | boolean If true, the scan profile is no longer in use. |
builtin | boolean If true, it is a built-in scan profile, which cannot be changed. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
type | string Enum: "api" "web" Target type:
|
verified | boolean If true, the scan profile only allows targets with verified domains. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "can_scan_unverified": true,
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1,
- "builtin": true
}
]
}
id required | string Identifier of the custom scan profile. |
name | string <= 255 characters Name of the scan profile. |
description | string or null Description of the scan profile. |
archived | boolean If true, the scan profile is no longer in use. |
type required | string Enum: "web" "api" Target type:
|
speed | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Scan speed:
|
payloads | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Scan payloads:
|
required | Array of objects (SimpleVulnerabilityDefinition) Vulnerabilities for the scanner to verify. |
methods | string Enum: "all" "safe" "" Scan methods:
|
delay | integer or null [ 0 .. 5000 ] Time delay in milliseconds between requests for each scanning thread. |
(integer or null) or (string or null) The maximum time the scan is allowed to run. | |
dedup_enabled | boolean If true, the scan deduplicates pages with the same SimHash to scan only a few of them. |
auto_patterns_enabled | boolean If true, the scan detects URL patterns to identify similar pages to scan only a few of them. |
max_urls | integer [ 1 .. 50000 ] Maximum number of URLs the crawler can visit. |
{- "id": "string",
- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "can_scan_unverified": true,
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1,
- "builtin": true
}
id required | string Identifier of the scan profile. |
{- "id": "string",
- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "can_scan_unverified": true,
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1,
- "builtin": true
}
id required | string Identifier of the scan profile. |
name | string <= 255 characters Name of the scan profile. |
description | string or null Description of the scan profile. |
archived | boolean If true, the scan profile is no longer in use. |
type required | string Enum: "web" "api" Target type:
|
speed | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Scan speed:
|
payloads | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Scan payloads:
|
required | Array of objects (SimpleVulnerabilityDefinition) Vulnerabilities for the scanner to verify. |
methods | string Enum: "all" "safe" "" Scan methods:
|
delay | integer or null [ 0 .. 5000 ] Time delay in milliseconds between requests for each scanning thread. |
(integer or null) or (string or null) The maximum time the scan is allowed to run. | |
dedup_enabled | boolean If true, the scan deduplicates pages with the same SimHash to scan only a few of them. |
auto_patterns_enabled | boolean If true, the scan detects URL patterns to identify similar pages to scan only a few of them. |
max_urls | integer [ 1 .. 50000 ] Maximum number of URLs the crawler can visit. |
{- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "can_scan_unverified": true,
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1,
- "builtin": true
}
id required | string Identifier of the scan profile. |
name | string <= 255 characters Name of the scan profile. |
description | string or null Description of the scan profile. |
archived | boolean If true, the scan profile is no longer in use. |
type | string Enum: "web" "api" Target type:
|
speed | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Scan speed:
|
payloads | integer [ -2147483648 .. 2147483647 ] Enum: 10 20 30 Scan payloads:
|
Array of objects (SimpleVulnerabilityDefinition) Vulnerabilities for the scanner to verify. | |
methods | string Enum: "all" "safe" "" Scan methods:
|
delay | integer or null [ 0 .. 5000 ] Time delay in milliseconds between requests for each scanning thread. |
(integer or null) or (string or null) The maximum time the scan is allowed to run. | |
dedup_enabled | boolean If true, the scan deduplicates pages with the same SimHash to scan only a few of them. |
auto_patterns_enabled | boolean If true, the scan detects URL patterns to identify similar pages to scan only a few of them. |
max_urls | integer [ 1 .. 50000 ] Maximum number of URLs the crawler can visit. |
{- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "archived": true,
- "type": "web",
- "speed": 10,
- "payloads": 10,
- "vulnerabilities": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "methods": "all",
- "can_scan_unverified": true,
- "delay": 5000,
- "max_run_time": 0,
- "dedup_enabled": true,
- "auto_patterns_enabled": true,
- "max_urls": 1,
- "builtin": true
}
Scanning agents allow create secure tunnels into your infrastructure allowing scans to run against internal targets.
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
scopes_logical_operator | string Enum: "and" "or" Logical operator to apply between agent scopes.
|
search | string A search term. |
team | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
]
}
{ }
{- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
id required | string A unique value identifying this scanning agent. |
{- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
id required | string A unique value identifying this scanning agent. |
{ }
{- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
id required | string A unique value identifying this scanning agent. |
name | string <= 255 characters |
Array of objects or null or null |
{- "name": "string",
- "teams": [
- { }
]
}
{- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
id required | string A unique value identifying this scanning agent. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
Start and manage scans against the target. You can also produce reports and access the list of scanned endpoints.
completed__gt | string <date-time> |
completed__gte | string <date-time> |
completed__lt | string <date-time> |
completed__lte | string <date-time> |
label | Array of strings A unique Base58 value identifying this object. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
partial | boolean |
search | string A search term. |
started__gt | string <date-time> |
started__gte | string <date-time> |
started__lt | string <date-time> |
started__lte | string <date-time> |
started_max | string or null <date-time> Date and time of when the scan started. |
started_min | string or null <date-time> Date and time of when the scan started. |
status | Array of strings Items Enum: "canceled" "canceling" "completed" "completed_with_errors" "failed" "finishing_up" "paused" "pausing" "queued" "resuming" "started" "under_review" Status of the scan:
|
team | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
]
}
required | Array of objects (ScanIdSchema) |
{- "scans": [
- {
- "id": "string"
}
]
}
[- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
]
required | Array of objects (ScanIdSchema) |
{- "scans": [
- {
- "id": "string"
}
]
}
[- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
]
required | Array of objects (ScanIdSchema) |
object (ResumeOptions) |
{- "scans": [
- {
- "id": "string"
}
], - "overrides": {
- "ignore_blackout_period": true
}
}
[- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
]
required | Array of objects (ScanIdSchema) |
object (ScanOptions) |
{- "targets": [
- {
- "id": "string"
}
], - "overrides": {
- "ignore_blackout_period": true,
- "scan_profile": "lightning",
- "reduced_scopes": [
- {
- "url": "string",
- "enabled": true
}
]
}
}
[- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
]
target_id required | string Identifier of the target. |
length | integer Number of results to return per page. |
page | integer A page number within the paginated result set. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
]
}
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "stack": [
- { }
], - "has_sequence_navigation": true,
- "user_data": "string"
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "stack": [
- { }
], - "has_sequence_navigation": true,
- "user_data": "string"
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "stack": [
- { }
], - "has_sequence_navigation": true,
- "user_data": "string"
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
target_id required | string Identifier of the target. |
completed__gt | string <date-time> |
completed__gte | string <date-time> |
completed__lt | string <date-time> |
completed__lte | string <date-time> |
label | Array of strings A unique Base58 value identifying this object. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
partial | boolean |
search | string A search term. |
started__gt | string <date-time> |
started__gte | string <date-time> |
started__lt | string <date-time> |
started__lte | string <date-time> |
started_max | string or null <date-time> Date and time of when the scan started. |
started_min | string or null <date-time> Date and time of when the scan started. |
status | Array of strings Items Enum: "canceled" "canceling" "completed" "completed_with_errors" "failed" "finishing_up" "paused" "pausing" "queued" "resuming" "started" "under_review" Status of the scan:
|
team | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
]
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
request_method,url,status_code,result,reason,info
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
Array of objects or null Technologies found in the scan. The scanning engine uses them to fine-tune vulnerability tests and texts about how to fix the vulnerabilities. | |
has_sequence_navigation | boolean |
user_data | string Store scan metadata. |
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
target_id required | string Identifier of the target. |
{- "id": "MyThjkIs2Wca",
- "target": {
- "id": "MyThjkIs2Wca",
- "name": "",
- "site": {
- "id": "MyThjkIs2Wca",
- "name": "[PwC] Example Site",
- "desc": "",
- "host": "www.example.pt",
- "has_form_login": false,
- "form_login_check_pattern": "",
- "form_login": [
- {
- "name": "username",
- "value": "testuser1"
}, - {
- "name": "password",
- "value": "testuserpassword"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": true,
- "has_sequence_navigation": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "",
- "password": ""
}, - "headers": [ ],
- "cookies": [ ],
- "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2023-10-20T20:44:12.556924Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "",
- "has_otp": false,
- "otp_secret": "",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "",
- "otp_submit": "",
- "otp_login_sequence_totp_value": "",
- "otp_type": "totp",
- "otp_url": "",
- "stack": [
- {
- "id": "MyThjkIs2Wca",
- "name": "IIS",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Microsoft ASP.NET",
- "desc": ""
}, - {
- "id": "MyThjkIs2Wca",
- "name": "Windows Server",
- "desc": ""
}
], - "verified": false,
- "verification_token": "07080d0e-1234-ABCD-1234-fcbb57e2fe0c",
- "verification_date": null,
- "verification_method": "",
- "verification_last_error": "",
- "api_scan_settings": null
}, - "type": "single",
- "desc": "",
- "labels": [
- {
- "id": "MyThjkIs2Wca",
- "name": "PwC",
- "color": "",
- "changed_by": {
- "id": "MyThjkIs2Wca",
- "email": "",
- "name": "Example"
}, - "changed": "2022-06-02T09:31:29.238031Z"
}
], - "has_assets": false,
- "report_fileformat": "docx",
- "scanning_agent": null,
- "teams": [
- {
- "id": "MyThjkIs2Wca",
- "name": "Example Team"
}
], - "blackout_period": {
- "begin": "02:00:00",
- "cease": "03:00:00",
- "weekdays": [
- 1
], - "enabled": true,
- "timezone": "Africa/Lagos",
- "changed": "2023-10-30T18:11:32.548246Z",
}
}, - "status": "completed",
- "started": "2024-01-25T01:05:08.102608Z",
- "completed": "2024-01-25T01:07:34.570500Z",
- "scan_profile": {
- "id": "lightning",
- "name": "Lightning",
- "description": "Fast scan that checks vulnerabilities related to SSL/TLS, HTTP security headers, and cookies attributes.",
- "builtin": true
}, - "lows": 5,
- "mediums": 1,
- "highs": 0,
- "created": "2024-01-25T01:05:05.894103Z",
- "unlimited": true,
- "changed": "2024-01-25T01:07:45.896140Z",
- "stack": [ ],
- "crawler": {
- "state": "ended",
- "status": [
- 4,
- 4
], - "warning": [
- {
- "code": "login_failed",
- "message": "Cannot login, please review your login settings."
}, - {
- "code": "target_status",
- "message": "The target is responding with an HTTP 500 code. Please make sure that this is intended. If Probely's requests are being throttled, ignored, or rejected, this will result in poor scan results."
}
], - "error": [ ],
- "full_status": {
- "type": "feedback",
- "ts": 1706720605.0290248,
- "iid": "c144f028-9110-XXXX-1234-5d2b10161f43",
- "aid": "b3448314-41c8-XXXX-1234-fd1af2a9f1fb",
- "stage": "crawler",
- "module": "anansi",
- "subtype": "status",
- "data": {
- "type": "feedback",
- "allExtraHosts": [ ],
- "countTimeoutEndpoints": 0,
- "crawlingEndpoints": [ ],
- "countLoginFailed": 1,
- "lastLogin": [
- {
- "status": "failed",
- "timestamp": 1706720567048
}
], - "status": {
- "500": 4
}, - "outOfScopeHostsCount": { },
- "allHostnames": [
- "example.com"
], - "version": 2,
- "countNetworkErrorEndpoints": 0,
- "total": 4,
- "lastCrawledEndpoints": [
], - "doingLogin": false,
- "done": 4,
- "rejected": 0,
- "countLoginSuccess": 0,
- "statusByHost": {
- "example.com": {
- "500": 4
}
}
}
}
}, - "fingerprinter": {
- "state": "ended",
- "count": 1,
- "warning": [ ],
- "error": [ ]
}, - "scanner": {
- "state": "ended",
- "status": [
- 1,
- 1
], - "warning": [ ],
- "error": [ ],
- "full_status": {
- "type": "feedback",
- "aid": "494b2a40-5e8d-4d6c-808b-ac81194917d4",
- "subtype": "status",
- "stage": "scanner",
- "module": "zap",
- "data": {
- "done": 79,
- "total": 400,
- "scannerState": {
- "numberRequestBeingScanned": 2,
- "currentAverageRtt": 16.444445,
- "averageRtt": 16.444445,
- "nStatus3xx": "0",
- "nStatus4xx": "0",
- "nStatus5xx": "0",
- "nConnectionErrors": "0",
- "nTimeouts": "0",
- "nRequests": "9",
- "sampleOfRequestBeingScanned": [
- {
- "httpMethod": "GET",
}, - {
- "httpMethod": "GET",
}
]
}
}
}
}, - "has_sequence_navigation": false,
- "incremental": false,
- "reduced_scope": true,
- "crawl_sequences_only": false,
- "ignore_blackout_period": false,
- "user_data": null
}
label | Array of strings A unique Base58 value identifying this object. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
team | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
]
}
required | Array of objects (BulkScheduledScanScopeTargetSchema) |
required | object (ScheduledScan) Serializer for scheduled/recurrent scans |
{- "targets": [
- {
- "id": "string"
}
], - "scheduledscan": {
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning"
}
}
[- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
]
required | Array of objects (BulkScheduledScanScopeTargetSchema) |
required | object (ScheduledScan) Serializer for scheduled/recurrent scans |
{- "scheduledscans": [
- {
- "id": "string"
}
], - "scheduledscan": {
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning"
}
}
[- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
]
Array of objects (BulkScheduledScanScopeTargetSchema) | |
object (ScheduledScan) Serializer for scheduled/recurrent scans |
{- "scheduledscans": [
- {
- "id": "string"
}
], - "scheduledscan": {
- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning"
}
}
[- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
]
target_id required | string Identifier of the target. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
]
}
target_id required | string Identifier of the target. |
date_time required | string <date-time> Date and time of next scan scheduled. |
recurrence | string Enum: "h" "d" "w" "m" "q" "" Scheduled scan recurrence.
|
timezone | string <= 64 characters Timezone to use for scheduled scan timestamp. |
run_on_day_of_week | boolean Schedule scan to run on specific monthly day of week (for monthly/quarterly recurrence). |
scheduled_day_of_week | integer or null [ -2147483648 .. 2147483647 ] Enum: 1 2 3 4 5 6 7 null Day of week to run scan on - monday to sunday (for run on day of week option).
|
week_index | string or null Enum: "first" "second" "third" "fourth" "last" "" null Which week of the month to run scan on (with
|
partial_scan | boolean Future scans set as partial scans, use in conjunction with |
override_target_settings | boolean Override scan target's scan settings, use in conjunction with |
incremental | boolean Future scans set to incremental, use in conjunction with |
reduced_scope | boolean Future scans set as reduced scope, use in conjunction with |
scan_profile | string or null Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile to use. |
{- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning"
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
date_time required | string <date-time> Date and time of next scan scheduled. |
recurrence | string Enum: "h" "d" "w" "m" "q" "" Scheduled scan recurrence.
|
timezone | string <= 64 characters Timezone to use for scheduled scan timestamp. |
run_on_day_of_week | boolean Schedule scan to run on specific monthly day of week (for monthly/quarterly recurrence). |
scheduled_day_of_week | integer or null [ -2147483648 .. 2147483647 ] Enum: 1 2 3 4 5 6 7 null Day of week to run scan on - monday to sunday (for run on day of week option).
|
week_index | string or null Enum: "first" "second" "third" "fourth" "last" "" null Which week of the month to run scan on (with
|
partial_scan | boolean Future scans set as partial scans, use in conjunction with |
override_target_settings | boolean Override scan target's scan settings, use in conjunction with |
incremental | boolean Future scans set to incremental, use in conjunction with |
reduced_scope | boolean Future scans set as reduced scope, use in conjunction with |
scan_profile | string or null Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile to use. |
{- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning"
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
date_time | string <date-time> Date and time of next scan scheduled. |
recurrence | string Enum: "h" "d" "w" "m" "q" "" Scheduled scan recurrence.
|
timezone | string <= 64 characters Timezone to use for scheduled scan timestamp. |
run_on_day_of_week | boolean Schedule scan to run on specific monthly day of week (for monthly/quarterly recurrence). |
scheduled_day_of_week | integer or null [ -2147483648 .. 2147483647 ] Enum: 1 2 3 4 5 6 7 null Day of week to run scan on - monday to sunday (for run on day of week option).
|
week_index | string or null Enum: "first" "second" "third" "fourth" "last" "" null Which week of the month to run scan on (with
|
partial_scan | boolean Future scans set as partial scans, use in conjunction with |
override_target_settings | boolean Override scan target's scan settings, use in conjunction with |
incremental | boolean Future scans set to incremental, use in conjunction with |
reduced_scope | boolean Future scans set as reduced scope, use in conjunction with |
scan_profile | string or null Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile to use. |
{- "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning"
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
id required | string |
{- "webhook_url": "string",
- "notify_scan_started": true,
- "notify_scan_completed": true,
- "notify_high_findings": true,
- "notify_medium_findings": true,
- "notify_low_findings": true,
- "notify_finding_fixed": true,
- "notify_login_failed": false,
- "notify_retest_completed": true
}
id required | string |
webhook_url | string^https://hooks.slack.com/services/(?:.*)$ |
notify_scan_started | boolean |
notify_scan_completed | boolean |
notify_high_findings | boolean |
notify_medium_findings | boolean |
notify_low_findings | boolean |
notify_finding_fixed | boolean |
notify_login_failed | boolean Default: false |
notify_retest_completed | boolean |
{- "webhook_url": "string",
- "notify_scan_started": true,
- "notify_scan_completed": true,
- "notify_high_findings": true,
- "notify_medium_findings": true,
- "notify_low_findings": true,
- "notify_finding_fixed": true,
- "notify_login_failed": false,
- "notify_retest_completed": true
}
{- "webhook_url": "string",
- "notify_scan_started": true,
- "notify_scan_completed": true,
- "notify_high_findings": true,
- "notify_medium_findings": true,
- "notify_low_findings": true,
- "notify_finding_fixed": true,
- "notify_login_failed": false,
- "notify_retest_completed": true
}
id required | string |
webhook_url | string^https://hooks.slack.com/services/(?:.*)$ |
notify_scan_started | boolean |
notify_scan_completed | boolean |
notify_high_findings | boolean |
notify_medium_findings | boolean |
notify_low_findings | boolean |
notify_finding_fixed | boolean |
notify_login_failed | boolean Default: false |
notify_retest_completed | boolean |
{- "webhook_url": "string",
- "notify_scan_started": true,
- "notify_scan_completed": true,
- "notify_high_findings": true,
- "notify_medium_findings": true,
- "notify_low_findings": true,
- "notify_finding_fixed": true,
- "notify_login_failed": false,
- "notify_retest_completed": true
}
{- "webhook_url": "string",
- "notify_scan_started": true,
- "notify_scan_completed": true,
- "notify_high_findings": true,
- "notify_medium_findings": true,
- "notify_low_findings": true,
- "notify_finding_fixed": true,
- "notify_login_failed": false,
- "notify_retest_completed": true
}
assigned | boolean |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
team | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
]
}
name required | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
name | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
In Probely, a target defines the scope and behavior of a scan on a website, an application, or an API.
Each target has a URL that defines the scope of the scan and also the configuration of the scan behavior as, for example:
Learn more about targets in this article: Targets from A to Z.
The endpoints under Targets provide the following functionality:
Further functionality related to Targets is provided in the following tags:
enabled | boolean If true, filter results by enabled targets. If false, filter results by disabled targets. |
exclude_team | string Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | string Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | string Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | string Type of target to filter results. Possible values are "single" for a web application and "api" for an API. |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean If true, filter results by verified targets. If false, filter results by unverified targets. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}, - "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
]
}
skip_reachability_check | string Probely's default behavior is to make a request to your target or host to check that it's reachable. To change this default add this parameter. |
skip_redirect_check | string When adding a target or host Probely will check that redirects are still in the scan's scope and prevents adding otherwise. This parameter allows to skip this check, take care that redirect limit isn't more than 6. If you need to override this behavior you'll need to use the 'skip_reachability_check' parameter. |
required | object Core settings of the target. |
scan_profile | string Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile of the scan. |
type | string Type of target. |
unlimited | boolean If true, the target has unlimited scans. |
report_type | string Enum: "default" "executive_summary" "owasp" "pci" "iso27001" "hipaa" Type of scan report produced for the target:
|
report_fileformat | string Enum: "pdf" "docx" Report format for the target:
|
Array of objects or null Labels of the target. | |
object or null Scanning agent of the target. Learn more on how to scan internal applications with a scanning agent. | |
include_deduplicated_endpoints | boolean or null If true, scans include deduplicated endpoints. |
object Time window during which scans are temporarily interrupted. | |
fail_fast | boolean If true, scans fail on recoverable errors. |
incremental | boolean If true, on-demand scans can be incremental to narrow the coverage to new and updated URLs. |
reduced_scope | boolean If true, on-demand scans can have reduced scope to narrow the coverage to defined URLs. |
schedule_incremental | boolean If true, scheduled scans can be incremental to narrow the coverage to new and updated URLs. |
schedule_reduced_scope | boolean If true, scheduled scans can have reduced scope to narrow the coverage to defined URLs. |
crawl_sequences_only | boolean If true, on-demand scans can only crawl navigation sequences to narrow the coverage. |
schedule_crawl_sequences_only | boolean If true, scheduled scans can only crawl navigation sequences to narrow the coverage. |
{- "site": {
- "name": "string",
- "desc": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "stack": [
- { }
], - "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "scan_profile": "lightning",
- "type": "string",
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "scanning_agent": { },
- "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string"
}, - "fail_fast": true,
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}, - "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}, - "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
required | object Core settings of the target. |
scan_profile | string Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile of the scan. |
type | string Type of target. |
unlimited | boolean If true, the target has unlimited scans. |
report_type | string Enum: "default" "executive_summary" "owasp" "pci" "iso27001" "hipaa" Type of scan report produced for the target:
|
report_fileformat | string Enum: "pdf" "docx" Report format for the target:
|
Array of objects or null Labels of the target. | |
object or null Scanning agent of the target. Learn more on how to scan internal applications with a scanning agent. | |
include_deduplicated_endpoints | boolean or null If true, scans include deduplicated endpoints. |
object Time window during which scans are temporarily interrupted. | |
fail_fast | boolean If true, scans fail on recoverable errors. |
incremental | boolean If true, on-demand scans can be incremental to narrow the coverage to new and updated URLs. |
reduced_scope | boolean If true, on-demand scans can have reduced scope to narrow the coverage to defined URLs. |
schedule_incremental | boolean If true, scheduled scans can be incremental to narrow the coverage to new and updated URLs. |
schedule_reduced_scope | boolean If true, scheduled scans can have reduced scope to narrow the coverage to defined URLs. |
crawl_sequences_only | boolean If true, on-demand scans can only crawl navigation sequences to narrow the coverage. |
schedule_crawl_sequences_only | boolean If true, scheduled scans can only crawl navigation sequences to narrow the coverage. |
{- "site": {
- "name": "string",
- "desc": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "stack": [
- { }
], - "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "scan_profile": "lightning",
- "type": "string",
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "scanning_agent": { },
- "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string"
}, - "fail_fast": true,
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}, - "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
object Core settings of the target. | |
scan_profile | string Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile of the scan. |
type | string Type of target. |
unlimited | boolean If true, the target has unlimited scans. |
report_type | string Enum: "default" "executive_summary" "owasp" "pci" "iso27001" "hipaa" Type of scan report produced for the target:
|
report_fileformat | string Enum: "pdf" "docx" Report format for the target:
|
Array of objects or null Labels of the target. | |
object or null Scanning agent of the target. Learn more on how to scan internal applications with a scanning agent. | |
include_deduplicated_endpoints | boolean or null If true, scans include deduplicated endpoints. |
object Time window during which scans are temporarily interrupted. | |
fail_fast | boolean If true, scans fail on recoverable errors. |
incremental | boolean If true, on-demand scans can be incremental to narrow the coverage to new and updated URLs. |
reduced_scope | boolean If true, on-demand scans can have reduced scope to narrow the coverage to defined URLs. |
schedule_incremental | boolean If true, scheduled scans can be incremental to narrow the coverage to new and updated URLs. |
schedule_reduced_scope | boolean If true, scheduled scans can have reduced scope to narrow the coverage to defined URLs. |
crawl_sequences_only | boolean If true, on-demand scans can only crawl navigation sequences to narrow the coverage. |
schedule_crawl_sequences_only | boolean If true, scheduled scans can only crawl navigation sequences to narrow the coverage. |
{- "site": {
- "name": "string",
- "desc": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "stack": [
- { }
], - "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "scan_profile": "lightning",
- "type": "string",
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "scanning_agent": { },
- "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string"
}, - "fail_fast": true,
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}, - "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": "lightning",
- "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": "lightning",
- "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
media_type required | string Enum: "application/json" "application/x-www-form-urlencoded" Format of the payload:
|
api_login_url required | string <= 2048 characters URL to make the authentication request to the API. |
api_login_payload required | string <= 4096 characters Payload to send in the authentication request. |
api_login_token_field required | string <= 256 characters Field containing the authentication token in the response to the authentication request. |
token_prefix required | string <= 16 characters Prefix to add to the authentication token. |
token_parameter_name required | string <= 256 characters Parameter name to send the authentication token. |
token_parameter_location required | string Enum: "cookie" "header" Where to send the parameter name with the authentication token and the prefix:
|
{- "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
[- "[\"user.username\", \"user.email\"]"
]
Endpoint for interacting with Scopes (AKA Targets).
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": "lightning",
- "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": "lightning",
- "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": "lightning",
- "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
ignore_blackout_period | boolean If true, the scan ignores the blackout period defined in the target settings. |
scan_profile | string Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile to use. |
Array of objects (ReducedScope) Configuration to reduce the scope of the scan. |
{- "ignore_blackout_period": true,
- "scan_profile": "lightning",
- "reduced_scopes": [
- {
- "url": "string",
- "enabled": true
}
]
}
{- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "unlimited": true,
- "changed": "2019-08-24T14:15:22Z",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "target_options": {
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string"
}, - "has_assets": true,
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
}, - "has_sequence_navigation": true,
- "incremental": true,
- "reduced_scope": true,
- "crawl_sequences_only": true,
- "ignore_blackout_period": true,
- "user_data": "string"
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": "lightning",
- "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
id required | string A unique Base58 value identifying this object. |
file | string |
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}, - "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
target_id required | string Identifier of the target. |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "type": "text",
- "value": "string"
}
]
}
target_id required | string Identifier of the target. |
type | string Enum: "text" "url" "sel" Type of element for the logout detection:
|
value required | string <= 2048 characters The value of the element for the logout detection. |
{- "type": "text",
- "value": "string"
}
{- "id": "string",
- "type": "text",
- "value": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "id": "string",
- "type": "text",
- "value": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
type | string Enum: "text" "url" "sel" Type of element for the logout detection:
|
value required | string <= 2048 characters The value of the element for the logout detection. |
{- "type": "text",
- "value": "string"
}
{- "id": "string",
- "type": "text",
- "value": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
type | string Enum: "text" "url" "sel" Type of element for the logout detection:
|
value | string <= 2048 characters The value of the element for the logout detection. |
{- "type": "text",
- "value": "string"
}
{- "id": "string",
- "type": "text",
- "value": "string"
}
id required | string A unique Base58 value identifying this object. |
target_id required | string Identifier of the target. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
Disable multiple Targets in one operation.
ids required | Array of strings |
{- "ids": [
- "string"
]
}
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
Update multiple Targets in one operation.
required | object Core settings of the target. |
scan_profile | string Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile of the scan. |
type | string Type of target. |
unlimited | boolean If true, the target has unlimited scans. |
report_type | string Enum: "default" "executive_summary" "owasp" "pci" "iso27001" "hipaa" Type of scan report produced for the target:
|
report_fileformat | string Enum: "pdf" "docx" Report format for the target:
|
Array of objects or null Labels of the target. | |
object or null Scanning agent of the target. Learn more on how to scan internal applications with a scanning agent. | |
include_deduplicated_endpoints | boolean or null If true, scans include deduplicated endpoints. |
object Time window during which scans are temporarily interrupted. | |
fail_fast | boolean If true, scans fail on recoverable errors. |
incremental | boolean If true, on-demand scans can be incremental to narrow the coverage to new and updated URLs. |
reduced_scope | boolean If true, on-demand scans can have reduced scope to narrow the coverage to defined URLs. |
schedule_incremental | boolean If true, scheduled scans can be incremental to narrow the coverage to new and updated URLs. |
schedule_reduced_scope | boolean If true, scheduled scans can have reduced scope to narrow the coverage to defined URLs. |
crawl_sequences_only | boolean If true, on-demand scans can only crawl navigation sequences to narrow the coverage. |
schedule_crawl_sequences_only | boolean If true, scheduled scans can only crawl navigation sequences to narrow the coverage. |
{- "site": {
- "name": "string",
- "desc": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "stack": [
- { }
], - "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "scan_profile": "lightning",
- "type": "string",
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "scanning_agent": { },
- "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string"
}, - "fail_fast": true,
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
{- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "lows": 0,
- "mediums": 0,
- "highs": 0,
- "risk": 0,
- "last_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z"
}, - "running_scan": {
- "id": "string",
- "status": "canceled",
- "started": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "scan_profile": "lightning",
- "lows": 0,
- "mediums": 0,
- "highs": 0,
- "created": "2019-08-24T14:15:22Z",
- "crawler": {
- "state": "string",
- "status": [
- "string"
], - "warning": [
- {
- "code": "string",
- "message": "string"
}
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "iid": "031aa9ce-4e51-4ff6-a280-f056f56095c4",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "ts": "string",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "type": "string",
- "countTimeoutEndpoints": 0,
- "countLoginFailed": 0,
- "version": 0,
- "countNetworkErrorEndpoints": 0,
- "doingLogin": true,
- "done": 0,
- "rejected": 0,
- "total": 0,
- "allExtraHosts": [
- "string"
], - "crawlingEndpoints": [
- "string"
], - "lastLogin": [
- {
- "status": "string",
- "timestamp": 0
}
], - "status": {
- "property1": null,
- "property2": null
}, - "outOfScopeHostsCount": {
- "property1": null,
- "property2": null
}, - "allHostnames": {
- "property1": null,
- "property2": null
}, - "statusByHost": {
- "property1": null,
- "property2": null
}
}
}
}, - "fingerprinter": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
]
}, - "scanner": {
- "state": "string",
- "count": 0,
- "warning": [
- "string"
], - "error": [
- "string"
], - "full_status": {
- "type": "string",
- "aid": "1f672178-4f51-4c6c-8290-51f7acb1d193",
- "subtype": "string",
- "stage": "string",
- "module": "string",
- "data": {
- "done": 0,
- "total": 0,
- "scannerState": {
- "numberOfRequestBeingScanned": 0,
- "currentAverageRtt": 0,
- "averageRtt": 0,
- "nStatus3xx": "string",
- "nStatus4xx": "string",
- "nStatus5xx": "string",
- "nConnectionErrors": "string",
- "nTimeouts": "string",
- "nRequests": "string",
}
}
}
}, - "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
]
}, - "next_scan": {
- "id": "string",
- "target": {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "desc": "string",
- "host": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_sequence_navigation": true,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "changed": "2019-08-24T14:15:22Z",
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "otp_url": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "string",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}, - "date_time": "2019-08-24T14:15:22Z",
- "recurrence": "h",
- "changed": "2019-08-24T14:15:22Z",
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "timezone": "string",
- "run_on_day_of_week": true,
- "scheduled_day_of_week": 1,
- "week_index": "first",
- "partial_scan": true,
- "override_target_settings": true,
- "incremental": true,
- "reduced_scope": true,
- "scan_profile": "lightning",
- "unlimited": "string"
}, - "assets": [
- {
- "id": "string",
- "account": "string",
- "name": "string",
- "host": "string",
- "desc": "string",
- "stack": [
- {
- "id": "string",
- "name": "string",
- "desc": "string"
}
], - "verified": true,
- "verification_token": "bb1403cd-c02c-401d-a78a-6a9452aa09db",
- "verification_date": "2019-08-24T14:15:22Z",
- "verification_method": "file",
- "verification_last_error": "string",
- "changed": "2019-08-24T14:15:22Z",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "include": true
}
], - "scan_profile": {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}, - "type": "string",
- "enabled": true,
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "allowed_scan_profiles": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "builtin": "string"
}
], - "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "fail_fast": true,
- "changed": "2019-08-24T14:15:22Z",
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
The upload functionality allows the automatic creation of new targets from multiple file formats (.yaml
, .csv
, .json
).
And one can optionally add scheduled scan data when uploading target data.
The following are the required internal data structures.
The fields about scheduled scan data can be left empty if not necessary.
"name","url","scan_profile","scheduledscan_datetime","scheduledscan_recurrence","labels"
"My target","https://mytarget.url.com","Normal","2022-12-30T12:34:56.224739","m","['label1', 'label2']"
"My other target","https://www.mytargetsite2.com","Normal","","","['label3', 'label2']"
- name: My target
site:
name: My target site
desc: My target site description
url: https://mytarget.url.com
# optional site fields
form_login_url: https://mytarget.url.com/login
form_login_check_pattern: ""
form_login: []
headers: []
cookies: []
whitelist: []
scan_profile: normal
type: single
# optional target fields
report_type: default
# optional scheduled_scan data
scheduled_scan:
date_time: "2022-12-30T12:34:56.224739"
recurrence: "d"
timezome: "Europe/Madrid"
Data format with nested ScheduledScan
data:
[
{
"name": "My target",
"site": {
"name": "My target site",
"desc": "My target description",
"url": "https://mytarget.url.com",
# optional site fields
"form_login_url": "https://mytarget.url.com/login,
"form_login_check_pattern": "",
"form_login": [],
"headers": [],
"cookies": [],
"whitelist": []
},
"scan_profile": "Normal",
// optional scheduled_scan data
"scheduled_scan": {
"date_time": "2022-12-30T12:34:56.224739",
"recurrence": "d",
"timezone": "Europe/Madrid"
}
}
]
Data format with flat ScheduledScan
data:
[
{
"name": "My target",
"site": {
"name": "My target site",
"desc": "My target description",
"url": "https://mytarget.url.com"
# optional site fields
"form_login_url": "https://mytarget.url.com/login,
"form_login_check_pattern": "",
"form_login": [],
"headers": [],
"cookies": [],
"whitelist": []
},
"scan_profile": "Normal",
// optional scheduled_scan data
"scheduledscan_datetime": "2022-12-30T12:34:56.224739",
"scheduledscan_recurrence": "m"
},
]
required | object Core settings of the target. |
scan_profile | string Enum: "lightning" "normal" "safe" "full" "api_normal" "api_full" Scan profile of the scan. |
type | string Type of target. |
unlimited | boolean If true, the target has unlimited scans. |
report_type | string Enum: "default" "executive_summary" "owasp" "pci" "iso27001" "hipaa" Type of scan report produced for the target:
|
report_fileformat | string Enum: "pdf" "docx" Report format for the target:
|
Array of objects or null Labels of the target. | |
object or null Scanning agent of the target. Learn more on how to scan internal applications with a scanning agent. | |
include_deduplicated_endpoints | boolean or null If true, scans include deduplicated endpoints. |
object Time window during which scans are temporarily interrupted. | |
fail_fast | boolean If true, scans fail on recoverable errors. |
incremental | boolean If true, on-demand scans can be incremental to narrow the coverage to new and updated URLs. |
reduced_scope | boolean If true, on-demand scans can have reduced scope to narrow the coverage to defined URLs. |
schedule_incremental | boolean If true, scheduled scans can be incremental to narrow the coverage to new and updated URLs. |
schedule_reduced_scope | boolean If true, scheduled scans can have reduced scope to narrow the coverage to defined URLs. |
crawl_sequences_only | boolean If true, on-demand scans can only crawl navigation sequences to narrow the coverage. |
schedule_crawl_sequences_only | boolean If true, scheduled scans can only crawl navigation sequences to narrow the coverage. |
{- "site": {
- "name": "string",
- "desc": "string",
- "has_form_login": false,
- "form_login_check_pattern": "string",
- "form_login": [
- {
- "name": "string",
- "value": "string"
}
], - "logout_detection_enabled": false,
- "has_sequence_login": false,
- "has_basic_auth": false,
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "cookies": [
- {
- "name": "string",
- "value": "string"
}
], - "whitelist": [ ],
- "blacklist": [ ],
- "auth_enabled": false,
- "logout_condition": "any",
- "check_session_url": "string",
- "has_otp": true,
- "otp_secret": "string",
- "otp_algorithm": "SHA1",
- "otp_digits": 6,
- "otp_field": "string",
- "otp_submit": "string",
- "otp_login_sequence_totp_value": "string",
- "otp_type": "string",
- "stack": [
- { }
], - "api_scan_settings": {
- "api_schema_type": "openapi",
- "api_schema_url": "string",
- "api_schema_file": "string",
- "custom_api_parameters": [
- {
- "name": "string",
- "value": "string"
}
], - "media_type": "application/json",
- "api_login_url": "string",
- "api_login_payload": "string",
- "api_login_token_field": "string",
- "token_prefix": "string",
- "token_parameter_name": "string",
- "token_parameter_location": "cookie"
}
}, - "scan_profile": "lightning",
- "type": "string",
- "unlimited": true,
- "report_type": "default",
- "report_fileformat": "pdf",
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "scanning_agent": { },
- "include_deduplicated_endpoints": true,
- "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string"
}, - "fail_fast": true,
- "incremental": true,
- "reduced_scope": true,
- "schedule_incremental": true,
- "schedule_reduced_scope": true,
- "crawl_sequences_only": true,
- "schedule_crawl_sequences_only": true
}
{- "target_ids": [
- "<target id>"
], - "scan_ids": [
- "<target id>"
]
}
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "scope_type": "string",
- "url": "string",
- "target_data": {
- "property1": null,
- "property2": null
}, - "api_scan_settings": {
- "property1": null,
- "property2": null
}, - "login_sequence": {
- "property1": null,
- "property2": null
}
}
]
}
Group users, targets, and other elements in teams for specific features and a more efficient management. For example, users in a team can only run scans for targets of their team, not the targets of other teams.
Learn more about how to get started with Teams.
The endpoints under Teams provide the following functionality:
Some relevant information when using Teams:
Further functionality related to Teams is provided in the following tags:
id required | string A unique Base58 value identifying this object. |
required | Array of objects (ID) Teams to move the target to. |
{- "teams": [
- {
- "id": "string"
}
]
}
{- "id": "string",
- "name": "string"
}
required | Array of objects (ID) Teams to move the target to. |
ids required | Array of strings Identifiers of the targets to move, separated by commas. |
{- "teams": [
- {
- "id": "string"
}
], - "ids": [
- "string"
]
}
{- "id": "string",
- "name": "string"
}
can_create_target | boolean |
can_move | boolean |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
user | Array of strings |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "num_api_keys": 0,
- "num_users": 0,
- "num_targets": 0,
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}
], - "scanning_agents": [
- {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
], - "num_available_targets": 0
}
]
}
name required | string <= 255 characters Name of the team. |
quota | integer or null <int64> [ 0 .. 4294967295 ] Number of targets the team can create. |
reserve | boolean If true, the account has target slots reserved for the team to ensure the fulfillment of the team's quota. |
Array of objects Targets of the team. | |
Array of objects Scanning agents of the team. |
{- "name": "string",
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string"
}
], - "scanning_agents": [
- { }
]
}
{- "id": "string",
- "name": "string",
- "num_api_keys": 0,
- "num_users": 0,
- "num_targets": 0,
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}
], - "scanning_agents": [
- {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
], - "num_available_targets": 0
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "num_api_keys": 0,
- "num_users": 0,
- "num_targets": 0,
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}
], - "scanning_agents": [
- {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
], - "num_available_targets": 0
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 255 characters Name of the team. |
quota | integer or null <int64> [ 0 .. 4294967295 ] Number of targets the team can create. |
reserve | boolean If true, the account has target slots reserved for the team to ensure the fulfillment of the team's quota. |
Array of objects Targets of the team. | |
Array of objects Scanning agents of the team. |
{- "name": "string",
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string"
}
], - "scanning_agents": [
- { }
]
}
{- "id": "string",
- "name": "string",
- "num_api_keys": 0,
- "num_users": 0,
- "num_targets": 0,
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}
], - "scanning_agents": [
- {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
], - "num_available_targets": 0
}
id required | string A unique Base58 value identifying this object. |
name | string <= 255 characters Name of the team. |
quota | integer or null <int64> [ 0 .. 4294967295 ] Number of targets the team can create. |
reserve | boolean If true, the account has target slots reserved for the team to ensure the fulfillment of the team's quota. |
Array of objects Targets of the team. | |
Array of objects Scanning agents of the team. |
{- "name": "string",
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string"
}
], - "scanning_agents": [
- { }
]
}
{- "id": "string",
- "name": "string",
- "num_api_keys": 0,
- "num_users": 0,
- "num_targets": 0,
- "quota": 4294967295,
- "reserve": true,
- "targets": [
- {
- "id": "string",
- "name": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "type": "string",
- "desc": "string",
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "has_assets": true,
- "report_fileformat": "pdf",
- "scanning_agent": {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}, - "teams": [
- {
- "id": "string",
- "name": "string"
}
], - "blackout_period": {
- "begin": "14:15:22Z",
- "cease": "14:15:22Z",
- "weekdays": [
- 0
], - "enabled": true,
- "timezone": "string",
- "changed": "2019-08-24T14:15:22Z",
}
}
], - "scanning_agents": [
- {
- "id": "string",
- "name": "string",
- "installer_generated": true,
- "online": true,
- "fallback": true,
- "rx_bytes": 0,
- "tx_bytes": 0,
- "latest_handshake": 0
}
], - "num_available_targets": 0
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
During the scans we run fingerprinters against the target and record the result on the site and assets. You can access our list of frameworks/software here.
A user in a Probely account represents a human or a machine (API user) that interacts with Probely.
Depending on the roles and permissions assigned, users can have access to different features of Probely to perform their tasks.
The endpoints under User provide the following functionality:
Some relevant information when using User:
Further functionality related to User is provided in the following tags:
ordering | string Which field to use when ordering the results. |
search | string A search term. |
[- {
- "id": "string",
- "name": "string",
- "title": "ceo",
- "is_billing_admin": true,
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "is_apiuser": true,
- "intercom_user_id": "string",
- "is_sso": true,
- "is_owner": true,
- "mfa_enabled": true,
- "first_login": "2019-08-24T14:15:22Z"
}
]
password required | string New password. |
confpassword required | string Confirmation of the new password. |
current_password required | string Current password. |
{- "password": "string",
- "confpassword": "string",
- "current_password": "string"
}
{- "message": "Password Changed"
}
end_scan_emails | string Enum: "always" "started_by" "never" ""
|
{- "end_scan_emails": "always"
}
{- "end_scan_emails": "always"
}
end_scan_emails | string Enum: "always" "started_by" "never" ""
|
{- "end_scan_emails": "always"
}
{- "end_scan_emails": "always"
}
{- "account": [
- {
- "id": "string",
- "name": "string"
}
], - "targets": {
- "property1": [
- {
- "id": "string",
- "name": "string"
}
], - "property2": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "teams": {
- "property1": [
- {
- "id": "string",
- "name": "string"
}
], - "property2": [
- {
- "id": "string",
- "name": "string"
}
]
}
}
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
role | string |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
]
}
enabled | boolean |
exclude_team | Array of strings Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | Array of strings Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
role | Array of strings |
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | Array of strings Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | Array of strings |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "user_roles": "string",
- "changed": "2019-08-24T14:15:22Z",
}
]
}
Labels are a mechanism to apply short and useful information to users. For example, create a label called "Outsource" to apply to users working as outsourcers to filter them and facilitate user management.
When creating labels, validate whether Probely provides that information as, for example, teams, roles, and targets of the user.
The endpoints under User Labels provide the following functionality:
Further functionality related to User Labels is provided in the following tags:
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
search | string A search term. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
]
}
name required | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
name | string <= 255 characters Name of the label. |
color | string^[a-zA-Z0-9#_-]*$ Color of the label, in RGB hexadecimal format prefixed with "#". |
{- "name": "string",
- "color": "string"
}
{- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
User management provides functionality to create and manage users in a Probely account so they can interact with Probely apps and the API.
The endpoints under User Management provide the following functionality:
Further functionality related to User Management is provided in the following tags:
account | boolean |
active | boolean |
exclude_target | Array of strings |
exclude_team | Array of strings |
label | Array of strings A unique Base58 value identifying this object. |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between user labels.
|
length | integer Number of results to return per page. |
mfa_enabled | boolean |
no_access | boolean |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
role | Array of strings or null A unique Base58 value identifying this object. |
search | string A search term. |
target | Array of strings |
team | Array of strings |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "title": "ceo",
- "is_billing_admin": true,
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring",
- "name": "string"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring",
- "name": "string"
}, - "target": {
- "id": "stringstring",
- "name": "string"
}
}
}
], - "last_login": "2019-08-24T14:15:22Z",
- "is_apiuser": true,
- "mfa_enabled": true
}
]
}
name required | string <= 60 characters Name of the user. |
title | string Enum: "ceo" "cto" "cso" "seceng" "dev" "devop" "manager" "other" "" Job title:
|
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
required | Array of objects (UserLabel) |
Array of objects (SimpleUserRoleRequest) | |
mfa_enabled | boolean If true, the user has MFA (Multi-Factor Authentication) enabled at login. |
{- "name": "string",
- "title": "ceo",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
], - "mfa_enabled": true
}
{- "id": "string",
- "name": "string",
- "title": "ceo",
- "is_billing_admin": true,
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring",
- "name": "string"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring",
- "name": "string"
}, - "target": {
- "id": "stringstring",
- "name": "string"
}
}
}
], - "last_login": "2019-08-24T14:15:22Z",
- "is_apiuser": true,
- "mfa_enabled": true
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "title": "ceo",
- "is_billing_admin": true,
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring",
- "name": "string"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring",
- "name": "string"
}, - "target": {
- "id": "stringstring",
- "name": "string"
}
}
}
], - "last_login": "2019-08-24T14:15:22Z",
- "is_apiuser": true,
- "mfa_enabled": true
}
id required | string A unique Base58 value identifying this object. |
name required | string <= 60 characters Name of the user. |
title | string Enum: "ceo" "cto" "cso" "seceng" "dev" "devop" "manager" "other" "" Job title:
|
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
required | Array of objects (UserLabel) |
mfa_enabled | boolean If true, the user has MFA (Multi-Factor Authentication) enabled at login. |
{- "name": "string",
- "title": "ceo",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "mfa_enabled": true
}
{- "id": "string",
- "name": "string",
- "title": "ceo",
- "is_billing_admin": true,
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring",
- "name": "string"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring",
- "name": "string"
}, - "target": {
- "id": "stringstring",
- "name": "string"
}
}
}
], - "last_login": "2019-08-24T14:15:22Z",
- "is_apiuser": true,
- "mfa_enabled": true
}
id required | string A unique Base58 value identifying this object. |
name | string <= 60 characters Name of the user. |
title | string Enum: "ceo" "cto" "cso" "seceng" "dev" "devop" "manager" "other" "" Job title:
|
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
Array of objects (UserLabel) | |
mfa_enabled | boolean If true, the user has MFA (Multi-Factor Authentication) enabled at login. |
{- "name": "string",
- "title": "ceo",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "mfa_enabled": true
}
{- "id": "string",
- "name": "string",
- "title": "ceo",
- "is_billing_admin": true,
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring",
- "name": "string"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring",
- "name": "string"
}, - "target": {
- "id": "stringstring",
- "name": "string"
}
}
}
], - "last_login": "2019-08-24T14:15:22Z",
- "is_apiuser": true,
- "mfa_enabled": true
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
user_id required | string |
enabled | boolean |
exclude_team | Array of strings Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend". |
label | Array of strings Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA". |
label_logical_operator | string Enum: "and" "or" Logical operator to apply between target labels.
|
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
risk | Array of integers Items Enum: 0 10 20 30 Target risk to filter results:
|
role | Array of strings |
scan_profile | Array of strings or null Identifiers of the scan profiles to filter results, separated by commas. |
search | string A search term. |
team | Array of strings Names of the teams to filter results, as a query string. For example, "team=Frontend" or "team=Frontend&team=Backend". |
type | Array of strings |
unlimited | boolean If true, filter results by targets with unlimited scans. If false, filter results by targets that use credits. |
verified | boolean |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "site": {
- "id": "string",
- "name": "string",
- "url": "string",
- "changed": "2019-08-24T14:15:22Z",
}, - "user_roles": "string",
- "changed": "2019-08-24T14:15:22Z",
}
]
}
name required | string <= 60 characters Name of the user. |
title | string Enum: "ceo" "cto" "cso" "seceng" "dev" "devop" "manager" "other" "" Job title:
|
active | boolean Default: true If true, the user can authenticate to Probely to interact with apps and the API. |
Array of objects or null Labels of the user. | |
Array of objects (SimpleUserRole) Roles of the user. | |
mfa_enabled | boolean If true, the user has MFA (Multi-Factor Authentication) enabled at login. |
{- "name": "string",
- "title": "ceo",
- "active": true,
- "labels": [
- {
- "name": "string",
- "color": "string"
}
], - "user_roles": [
- {
- "role": { },
- "scope": {
- "property1": null,
- "property2": null
}
}
], - "mfa_enabled": true
}
{- "id": "string",
- "name": "string",
- "title": "ceo",
- "is_billing_admin": true,
- "changed": "2019-08-24T14:15:22Z",
- "active": true,
- "labels": [
- {
- "id": "string",
- "name": "string",
- "color": "string",
- "changed": "2019-08-24T14:15:22Z"
}
], - "user_roles": [
- {
- "role": {
- "id": "stringstring",
- "name": "string"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring",
- "name": "string"
}, - "target": {
- "id": "stringstring",
- "name": "string"
}
}
}
], - "last_login": "2019-08-24T14:15:22Z",
- "is_apiuser": true,
- "mfa_enabled": true
}
The access to Probely features is determined by permissions, which are grouped into roles to assign to users.
This way, depending on the roles and permissions assigned, users can have access to different features of Probely to perform their tasks.
A User Role represents an assignment of a role to a user.
The endpoints under User Roles provide the following functionality:
Some relevant information when using User Roles:
Further functionality related to User Roles is provided in the following tags:
account | boolean |
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
role | Array of strings A unique Base58 value identifying this object. |
target | Array of strings |
team | Array of strings |
user | Array of strings A unique Base58 value identifying this object. |
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
]
}
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
{- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
id required | string = 12 characters |
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
{- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
id | string = 12 characters |
object (ObjectId) | |
object (ObjectId) | |
object (DPOScopeRequest) |
{- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
id required | string A unique Base58 value identifying this object. |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
Add roles to multiple users in one operation.
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
[- {
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
]
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
add/update/delete multiple user roles in one operation.
Array of objects (UserRoleCreateRequest) | |
Array of objects (UserRoleUpdateRequest) | |
Array of objects (UserRoleDestroyRequest) |
{- "create": [
- {
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
], - "update": [
- {
- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
], - "delete": [
- {
- "id": "stringstring"
}
]
}
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
Update multiple user roles in one operation.
id required | string = 12 characters |
required | object (ObjectId) |
required | object (ObjectId) |
required | object (DPOScopeRequest) |
[- {
- "id": "stringstring",
- "user": {
- "id": "stringstring"
}, - "role": {
- "id": "stringstring"
}, - "scope": {
- "tier": "account",
- "team": {
- "id": "stringstring"
}, - "target": {
- "id": "stringstring"
}
}
}
]
{- "id": "string",
- "role": {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "id": "string",
- "name": "string"
}
], - "custom": true,
- "description": "string"
}, - "scope": {
- "property1": null,
- "property2": null
}
}
In Probely, findings are connected to vulnerability definitions. This is how we keep track of the type of vulnerability. It also includes a name and description.
length | integer Number of results to return per page. |
ordering | string Which field to use when ordering the results. |
page | integer A page number within the paginated result set. |
passive | boolean |
search | string A search term. |
severity | Array of integers or null Items Enum: 10 20 30 Default vulnerability severity.
|
{- "count": 6,
- "page_total": 1,
- "page": 1,
- "length": 10,
- "results": [
- {
- "id": "string",
- "name": "string",
- "desc": "string",
- "changed": "2019-08-24T14:15:22Z",
- "severity": 10,
- "cvss_vector": "string",
- "cwe_id": "string",
- "cwe_name": "string",
- "passive": true
}
]
}
id required | string A unique Base58 value identifying this object. |
{- "id": "string",
- "name": "string",
- "desc": "string",
- "changed": "2019-08-24T14:15:22Z",
- "severity": 10,
- "cvss_vector": "string",
- "cwe_id": "string",
- "cwe_name": "string",
- "passive": true
}
end_dt | string <date-time> Include instances created before ISO-formatted timestamp |
start_dt | string <date-time> Include instances created after ISO-formatted timestamp |
user | string
|
user_id,username,user_name,date,action,object_model,object_id,field,old_value,new_value
organization_name | string <= 254 characters |
{- "organization_name": "string"
}
{- "organization_name": "string",
- "connected": true,
- "reauthentication_failed": true
}
organization_name | string <= 254 characters |
{- "organization_name": "string"
}
{- "organization_name": "string",
- "connected": true,
- "reauthentication_failed": true
}
id required | string |
required | object |
work_item_type required | string <= 254 characters |
auto_sync | boolean Sync findings to Azure DevOps |
auto_sync_closed | boolean Default: false |
{- "project": {
- "property1": null,
- "property2": null
}, - "work_item_type": "string",
- "auto_sync": true,
- "auto_sync_closed": false
}
{- "project": {
- "property1": null,
- "property2": null
}, - "work_item_type": "string",
- "auto_sync": true,
- "auto_sync_closed": false
}
id required | string |
object | |
work_item_type | string <= 254 characters |
auto_sync | boolean Sync findings to Azure DevOps |
auto_sync_closed | boolean Default: false |
{- "project": {
- "property1": null,
- "property2": null
}, - "work_item_type": "string",
- "auto_sync": true,
- "auto_sync_closed": false
}
{- "project": {
- "property1": null,
- "property2": null
}, - "work_item_type": "string",
- "auto_sync": true,
- "auto_sync_closed": false
}
id required | string |
scope required | string |
selective_sync | boolean |
{- "selective_sync": true
}
{- "selective_sync": true,
- "work_item_id": 0
}
id required | string |
scope required | string |
selective_sync | boolean |
{- "selective_sync": true
}
{- "selective_sync": true,
- "work_item_id": 0
}
{- "consumer_key": "string",
- "consumer_secret": "string",
- "verify_tls": true,
- "skip_jira_webhooks": true
}
base_url required | string <uri> |
consumer_key required | string <= 1024 characters |
consumer_secret required | string |
verify_tls required | boolean |
skip_jira_webhooks | boolean |
{- "consumer_key": "string",
- "consumer_secret": "string",
- "verify_tls": true,
- "skip_jira_webhooks": true
}
{- "consumer_key": "string",
- "consumer_secret": "string",
- "verify_tls": true,
- "skip_jira_webhooks": true
}
base_url | string <uri> |
consumer_key | string <= 1024 characters |
consumer_secret | string |
verify_tls | boolean |
skip_jira_webhooks | boolean |
{- "consumer_key": "string",
- "consumer_secret": "string",
- "verify_tls": true,
- "skip_jira_webhooks": true
}
{- "consumer_key": "string",
- "consumer_secret": "string",
- "verify_tls": true,
- "skip_jira_webhooks": true
}
id required | string |
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
id required | string |
auto_sync | boolean |
auto_sync_closed | boolean Default: false |
project_id required | string |
issue_type_id required | string |
object or null | |
object or null |
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
id required | string |
auto_sync | boolean |
auto_sync_closed | boolean Default: false |
project_id | string |
issue_type_id | string |
object or null | |
object or null |
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
id required | string |
{- "<field name>": [
- "Errors related to field <field name>."
], - "non_field_errors": [
- "Errors not related to any field specific field."
]
}
id required | string |
scope required | string |
selective_sync | boolean |
{- "selective_sync": true
}
{- "selective_sync": true,
- "issue_id": "string"
}
id required | string |
scope required | string |
selective_sync | boolean |
{- "selective_sync": true
}
{- "selective_sync": true,
- "issue_id": "string"
}
id required | string |
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
id required | string |
auto_sync | boolean |
auto_sync_closed | boolean Default: false |
project_id required | string |
issue_type_id required | string |
object or null | |
object or null |
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
id required | string |
auto_sync | boolean |
auto_sync_closed | boolean Default: false |
project_id | string |
issue_type_id | string |
object or null | |
object or null |
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
{- "auto_sync": true,
- "auto_sync_closed": false,
- "project_id": "string",
- "issue_type_id": "string",
- "status_mapping": {
- "property1": null,
- "property2": null
}, - "priority_mapping": {
- "property1": null,
- "property2": null
}
}
id required | string |
scope required | string |
selective_sync | boolean |
key | string <= 32 characters |
{- "selective_sync": true,
- "key": "string"
}
{- "selective_sync": true,
- "issue_id": "string",
- "link": "string",
- "key": "string"
}
id required | string |
scope required | string |
selective_sync | boolean |
key | string <= 32 characters |
{- "selective_sync": true,
- "key": "string"
}
{- "selective_sync": true,
- "issue_id": "string",
- "link": "string",
- "key": "string"
}