List Teams
GET/teams/
Request
Query Parameters
Number of results to return per page.
Which field to use when ordering the results.
A page number within the paginated result set.
A search term.
Responses
- 200
- 400
- 401
- 500
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
pdf- PDF file format.docx- DOCX file format.Array [
]
]
Array [
]
]
Total number of results.
Total number of pages.
Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.
Number of results returned per page.
results
object[]
A unique Base58 value identifying this object.
Possible values: <= 255 characters
Name of the team.
Maximum length is 255 characters.
Number of API Keys added to the team.
Number of users in the team.
Number of targets added to the team.
Possible values: <= 4294967295
Number of targets the team can create.
If true, the account has target slots reserved for the team to ensure the fulfillment of the team's quota.
Defaults to false.
targets
object[]
Targets of the team.
Possible values: <= 255 characters
Name of the target.
The maximum length is 255 characters.
site
object
required
Core settings of the target.
Includes basic target information like the name and URL.
A unique Base58 value identifying this object.
Possible values: <= 255 characters
Name of the target or extra host.
The maximum length is 255 characters.
Possible values: <= 2048 characters
URL of the target.
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
changed_by
object
required
User who last made changes.
A unique Base58 value identifying this object.
Possible values: <= 254 characters
Email of the user.
Possible values: <= 60 characters
Name of the user.
Type of target.
Possible values are "single" for a web application and "api" for an API.
Defaults to "single".
Description of the target.
Defaults to "".
labels
object[]
required
A unique Base58 value identifying this object.
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$
Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.
changed_by
object
required
User who last made changes.
A unique Base58 value identifying this object.
Possible values: <= 254 characters
Email of the user.
Possible values: <= 60 characters
Name of the user.
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
Possible values: [pdf, docx]
Report format for the target:
(Defaults to pdf)
scanning_agent
object
nullable
required
Return serializer_class with all fields as read_only except key. The key is the field use to retrieve the object in to_internal_value.
This is for the drf-spectacular documentation generation.
Possible values: <= 255 characters
teams
object[]
required
A unique Base58 value identifying this object.
blackout_period
object
required
Time window during which scans are temporarily interrupted.
Time of when the blackout period starts, in ISO 8601 UTC format.
For example, "13:27".
Time of when the blackout period ceases, in ISO 8601 UTC format.
For example, "13:27".
If true, the blackout period is enabled.
Possible values: <= 64 characters
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
changed_by
object
required
User who last made changes.
A unique Base58 value identifying this object.
Possible values: <= 254 characters
Email of the user.
Possible values: <= 60 characters
Name of the user.
scanning_agents
object[]
Scanning agents of the team.
Learn more about How to scan internal applications with a Scanning Agent?.
Possible values: <= 255 characters
Number of available targets.
{
"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": 0,
"reserve": true,
"targets": [
{
"id": "string",
"site": {
"id": "string",
"name": "string",
"url": "string",
"changed": "2024-07-29T15:51:28.071Z",
"changed_by": {
"id": "string",
"email": "[email protected]",
"name": "string"
}
},
"type": "string",
"labels": [
{
"id": "string",
"name": "string",
"color": "string",
"changed_by": {
"id": "string",
"email": "[email protected]",
"name": "string"
},
"changed": "2024-07-29T15:51:28.071Z"
}
],
"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": "string",
"cease": "string",
"weekdays": [
0
],
"enabled": true,
"timezone": "string",
"changed": "2024-07-29T15:51:28.071Z",
"changed_by": {
"id": "string",
"email": "[email protected]",
"name": "string"
}
}
}
],
"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
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
{
"<field name>": [
"Errors related to field <field name>."
],
"non_field_errors": [
"Errors not related to any field specific field."
]
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Incorrect authentication credentials."
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Unexpected error while handling your request."
}