Skip to content

Returns HTTP 501 with business_required because tool version rings require Business; no ring is read or changed.

PUT
/v1/m/sessions/tool-rings/{driver}
curl --request PUT \
--url https://example.com/v1/m/sessions/tool-rings/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "accept_promotion": true, "group_ref": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "version": "example" }'

Returns HTTP 501 with business_required because tool version rings require Business; no ring is read or changed.

driver
required
string

Path parameter driver.

X-Olivares-Tenant
string format: uuid

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

Media type application/json
object
accept_promotion

Start over a promoted ring, giving up the pins its rollback would have restored.

boolean
group_ref
required

The agent group whose members run the candidate version.

string format: uuid
version
required

An installed version of the tool to try on that group.

string
>= 1 characters <= 128 characters
Example generated
{
"accept_promotion": true,
"group_ref": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"version": "example"
}

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
{}