PUT
/
evaluations
/
{id}
curl --request PUT \
  --url https://api.fixa.dev/v1/evaluations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "isCritical": true,
  "params": {},
  "evaluationTemplateId": "<string>",
  "scenarioId": "<string>",
  "evaluationGroupId": "<string>"
}'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "enabled": true,
  "isCritical": true,
  "params": {},
  "evaluationTemplateId": "<string>",
  "scenarioId": "<string>",
  "evaluationGroupId": "<string>",
  "agentId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
evaluationTemplateId
string
required

ID of the associated evaluation template

​
enabled
boolean
default:true

Whether the evaluation is enabled

​
isCritical
boolean
default:true

Whether this is a critical evaluation

​
params
object

JSON parameters for the evaluation

​
scenarioId
string | null

Optional ID of the associated scenario

​
evaluationGroupId
string | null

Optional ID of the associated evaluation group

Response

200
application/json
Evaluation updated successfully
​
id
string
required

Unique identifier for the evaluation

​
createdAt
string
required

Creation timestamp of the evaluation

​
enabled
boolean
required

Whether the evaluation is enabled

​
isCritical
boolean
required

Whether this is a critical evaluation

​
params
object
required

JSON parameters for the evaluation

​
evaluationTemplateId
string
required

ID of the associated evaluation template

​
scenarioId
string | null

Optional ID of the associated scenario

​
evaluationGroupId
string | null

Optional ID of the associated evaluation group

​
agentId
string | null

Optional ID of the associated agent