Skip to content

Rolls the DESIRED state back to a prior revision by declaring a NEW revision whose spec equals that known-good version (forward-only, reversible history).

POST
/v1/m/deploy/definitions/{id}/rollback
curl --request POST \
--url https://example.com/v1/m/deploy/definitions/example/rollback \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "note": "example", "to_version": 1 }'

Rolls the DESIRED state back to a prior revision by declaring a NEW revision whose spec equals that known-good version (forward-only, reversible history).

id
required
string

Path parameter id.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

The handler accepts one JSON document and caps decoding at 256 KiB.

Media type application/json
object
note
Any of:

The handler limits this value to 4096 UTF-8 bytes.

string
to_version
required
integer format: int64
>= 1
Example generated
{
"note": "example",
"to_version": 1
}

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}