Skip to content

Update Source/Client State

POST
/api/components/{id}/state
curl --request POST \
--url https://example.com/api/components/example/state \
--header 'Content-Type: application/json' \
--cookie ms.session_token=<ms.session_token> \
--data '{ "state": "stop", "reason": "example" }'
id
required
string
Media typeapplication/json
object
state
required
string
Allowed values: stop start restart ignore monitor
reason
string

Success

The request failed validation

Media typeapplication/json

The request’s body, query or params didn’t match the route’s schema

object
error
required
string
Allowed value: Validation failed
details
required

What was wrong, one entry per problem

Array<object>
object
message
required
string
path

Where the problem is, e.g. [“amount”] or [“items”, 0, “id”]

Array

Example

{
"error": "Validation failed"
}