Red Team - Templates

Get an organization-scoped scan template

Changed on

Returns a single organization-scoped template by id.

get/api/v3.0/redteaming/orgs/{orgUuid}/templates/{templateId}

Request

Path parameters

orgUuidstring uuid required
templateIdstring uuid required

Query parameters

prettyboolean

When true, indent the JSON body (2 spaces) and render multiline string fields (e.g. YAML config) with literal newlines for human readability. Default off (compact JSON). Intended for interactive use; omit for clients that parse the body as strict JSON.

Headers

X-Correlation-IDstring uuid

Optional caller-supplied correlation id. Must be a UUID when present. When omitted or blank, the API generates a UUID. A non-UUID value returns 400 CORRELATION.INVALID. If a write fails because a UUID is already in use, the API returns 409 UUID.DUPLICATE. The value used (caller or generated) is echoed as supportToken and in the X-Correlation-ID response header.

Response

Template

supportTokenstring uuid required

Correlation id used for this request. Same value as the X-Correlation-ID response header.

Changes

    • warning

      added the new CONFIG.NO_ACTIVE_SCANNER enum value to the / response property for the response status

    • warning

      added the new CONFIG.NO_ACTIVE_SCANNER enum value to the / response property for the response status

    • warning

      added the new CONFIG.NO_ACTIVE_SCANNER enum value to the / response property for the response status

    • warning

      added the new CONFIG.NO_ACTIVE_SCANNER enum value to the / response property for the response status

    • warning

      added the new CONFIG.NO_ACTIVE_SCANNER enum value to the / response property for the response status

    • warning

      added the new CONFIG.NO_ACTIVE_SCANNER enum value to the / response property for the response status

    • warning

      added the new CONFIG.SCANNER_OUTDATED enum value to the / response property for the response status

    • warning

      added the new CONFIG.SCANNER_OUTDATED enum value to the / response property for the response status

    • warning

      added the new CONFIG.SCANNER_OUTDATED enum value to the / response property for the response status

    • warning

      added the new CONFIG.SCANNER_OUTDATED enum value to the / response property for the response status

    • warning

      added the new CONFIG.SCANNER_OUTDATED enum value to the / response property for the response status

    • warning

      added the new CONFIG.SCANNER_OUTDATED enum value to the / response property for the response status

    • info

      removed the CONFIG.MUST_USE_PROBES enum value from the / response property for the response status

    • info

      removed the CONFIG.MUST_USE_PROBES enum value from the / response property for the response status

    • info

      removed the CONFIG.MUST_USE_PROBES enum value from the / response property for the response status

    • info

      removed the CONFIG.MUST_USE_PROBES enum value from the / response property for the response status

    • info

      removed the CONFIG.MUST_USE_PROBES enum value from the / response property for the response status

    • info

      removed the CONFIG.MUST_USE_PROBES enum value from the / response property for the response status

    • info

      endpoint added