Partial Update Team

PATCH 
/teams/:id/

Request

Path Parameters

id stringrequired

application/json

Body

name stringrequired

Possible values: <= 255 characters

Name of the team.
Maximum length is 255 characters.

quota int64nullablerequired

Possible values: <= 4294967295

Number of targets the team can create.

reserve booleanrequired

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.
Array [
id stringrequired
]
scanning_agents object[]
Scanning agents of the team.
Learn more about How to scan internal applications with a Scanning Agent?.
Array [
id stringrequired
]

application/x-www-form-urlencoded

Body

name stringrequired

Possible values: <= 255 characters

Name of the team.
Maximum length is 255 characters.

quota int64nullablerequired

Possible values: <= 4294967295

Number of targets the team can create.

reserve booleanrequired

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.
Array [
id stringrequired
]
scanning_agents object[]
Scanning agents of the team.
Learn more about How to scan internal applications with a Scanning Agent?.
Array [
id stringrequired
]

multipart/form-data

Body

name stringrequired

Possible values: <= 255 characters

Name of the team.
Maximum length is 255 characters.

quota int64nullablerequired

Possible values: <= 4294967295

Number of targets the team can create.

reserve booleanrequired

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.
Array [
id stringrequired
]
scanning_agents object[]
Scanning agents of the team.
Learn more about How to scan internal applications with a Scanning Agent?.
Array [
id stringrequired
]

Responses

200

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Name of the team.
Maximum length is 255 characters.

num_api_keys integerrequired

Number of API Keys added to the team.

num_users integerrequired

Number of users in the team.

num_targets integerrequired

Number of targets added to the team.

quota int64nullablerequired

Possible values: <= 4294967295

Number of targets the team can create.

reserve booleanrequired

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.
Array [
id stringrequired
name stringrequired
Possible values: <= 255 characters
Name of the target.
The maximum length is 255 characters.
site objectrequired
Core settings of the target.
Includes basic target information like the name and URL.
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Name of the target or extra host.
The maximum length is 255 characters.
url stringrequired
Possible values: <= 2048 characters
URL of the target.
changed date-timerequired
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
changed_by objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
Possible values: <= 254 characters
Email of the user.
name stringrequired
Possible values: <= 60 characters
Name of the user.
type stringrequired
Type of target.
Possible values are "single" for a web application and "api" for an API.
Defaults to "single".
desc stringnullablerequired
Description of the target.
Defaults to "".
labels object[]required
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
color stringrequired
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 objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
Possible values: <= 254 characters
Email of the user.
name stringrequired
Possible values: <= 60 characters
Name of the user.
changed date-timerequired
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
]
has_assets booleanrequired
report_fileformat stringrequired
Possible values: [pdf, docx]
Report format for the target:
(Defaults to pdf)
• pdf - PDF file format.
• docx - DOCX file format.
scanning_agent objectnullablerequired
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.
id stringrequired
name stringrequired
Possible values: <= 255 characters
installer_generated booleanrequired
online booleanrequired
fallback booleanrequired
rx_bytes integerrequired
tx_bytes integerrequired
latest_handshake integerrequired
teams object[]required
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
]
blackout_period objectrequired
Time window during which scans are temporarily interrupted.
begin timerequired
Time of when the blackout period starts, in ISO 8601 UTC format.
For example, "13:27".
cease timerequired
Time of when the blackout period ceases, in ISO 8601 UTC format.
For example, "13:27".
weekdays integer[]required
enabled booleanrequired
If true, the blackout period is enabled.
timezone stringrequired
Possible values: <= 64 characters
changed date-timerequired
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
changed_by objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
Possible values: <= 254 characters
Email of the user.
name stringrequired
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?.
Array [
id stringrequired
name stringrequired
Possible values: <= 255 characters
installer_generated booleanrequired
online booleanrequired
fallback booleanrequired
rx_bytes integerrequired
tx_bytes integerrequired
latest_handshake integerrequired
]
num_available_targets integerrequired

Number of available targets.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "num_api_keys": 0,
  "num_users": 0,
  "num_targets": 0,
  "quota": 0,
  "reserve": true,
  "targets": [
    {
      "id": "string",
      "name": "string",
      "site": {
        "id": "string",
        "name": "string",
        "url": "string",
        "changed": "2024-09-18T08:50:22.658Z",
        "changed_by": {
          "id": "string",
          "email": "[email protected]",
          "name": "string"
        }
      },
      "type": "string",
      "desc": "string",
      "labels": [
        {
          "id": "string",
          "name": "string",
          "color": "string",
          "changed_by": {
            "id": "string",
            "email": "[email protected]",
            "name": "string"
          },
          "changed": "2024-09-18T08:50:22.658Z"
        }
      ],
      "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-09-18T08:50:22.658Z",
        "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
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...