POST /api/admin/cognitive_engines/{engine}/state

POST /api/admin/cognitive_engines/{engine}/state

Set Engine State

Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.

Parameters

Name	In	Type	Required	Description
`engine`	path	string	Yes	-
`X-Org-ID`	header	string \| null	No	-

Request body

A JSON request body is required.

Field	Type	Required	Description
`enabled`	boolean	Yes	-
`reason`	string	Yes	-

Example request

curl -X POST https://api.cognitivx.io/api/admin/cognitive_engines/{engine}/state \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false,
    "reason": "string"
  }'

Example response

200 application/json

null

Responses

Status	Description
`200`	Success. Returns the response body shown below.
`422`	Request validation failed. `detail` lists each offending field.