Skip to content
Platform API 3.0
/
/
Create a target and its i...

Create a target and its initial scan configuration

Request

Creates a new target and its initial configuration from the request body. Validates the configuration and may check connectivity before returning.

Security
bearer-key
Path
orgUuidstring, (uuid)required
applicationUuidstring, (uuid)required
projectUuidstring, (uuid)required
Query
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.

Default:false
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.

Bodyapplication/jsonrequired
namestring

Optional. When present, this value is the target name and overrides any top-level description in the YAML config. When omitted, the YAML description is used instead. If neither is present, the request fails with 400.

configstringrequired

YAML configuration

forceboolean
{
  "name": "string",
  "config": "string",
  "force": true
}

Responses

Created

Headers
X-Correlation-IDstring, (uuid)

Correlation id used for this request (caller-supplied UUID, or a UUID generated when the request omitted the header). Same value as supportToken.

Bodyapplication/json
supportTokenstring, (uuid)(SupportToken)required

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

responseobject(CreatedTarget)required
Response
{
  "supportToken": "5bac741e-3f1c-4cd4-ad0d-a1492df0a5cc",
  "response": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "configurationId": "254ffdcc-3725-465c-b0a0-22afb2bec267",
    "version": 0,
    "warnings": { … },
    "connectivityWarning": "string",
    "_links": { … }
  }
}