Skip to content

Update trail recording

PUT
/api/v1/config/trails
curl --request PUT \
--url http://localhost:11044/api/v1/config/trails \
--header 'Content-Type: application/json' \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
--data '{ "enabled": true }'

Turns trail recording on or off for this world, replacing the stored setting. Takes effect on the next completed run.

enabled: whether the engine records this world’s trails. Stored as this world’s own setting; the deployment default no longer applies to it

Media typeapplication/json

This world’s trail recording setting

object
enabled
required

Turn recording on or off for this world, overriding the deployment default

boolean

Example generated

{
"enabled": true
}

Trail settings updated

Media type*/*

A config change was saved. Carries only the acknowledgement — the caller already knows what it sent

object
status
required

Always updated

string

Example

updated