Skip to content
Platform API 3.0
/
/
Update an organization-sc...

Update an organization-scoped scan template

Request

Updates an organization-scoped template. At least one of name, description, scopeType, or config must be provided.

Security
bearer-key
Path
orgUuidstring, (uuid)required
templateIdstring, (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
non-empty
namestring, [ 1 .. 50 ] characters
descriptionstring, [ 1 .. 150 ] characters
scopeTypestring(ScopeType)

Same URL rules as on create.

Enum:"organization""application""project"
configobject(TemplateConfig)
{
  "name": "string",
  "description": "string",
  "scopeType": "organization",
  "config": {
    "probes": [ … ],
    "strategies": [ … ],
    "numTests": 0,
    "maxConcurrency": 0,
    "language": "string",
    "probeTimeoutMs": 0,
    "maxCampaignTimeMs": 0
  }
}

Responses

Updated

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(Template)required
Response
{
  "supportToken": "5bac741e-3f1c-4cd4-ad0d-a1492df0a5cc",
  "response": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "config": { … },
    "scopeType": "organization",
    "organization": "string",
    "application": "string",
    "project": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "canEdit": true,
    "canDelete": true,
    "_links": { … }
  }
}