Renames a provider, changes its endpoint and/or rotates its credential in place.

PATCH

/v1/m/sessions/providers/{ref}

curl --request PATCH \
  --url https://example.com/v1/m/sessions/providers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "api_key": "example", "base_url": "example", "default_model": "example", "display_name": "example" }'

• this engine

Renames a provider, changes its endpoint and/or rotates its credential in place.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

ref

required

string

Path parameter ref.

Header Parameters

X-Olivares-Tenant

string format: uuid

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

Request Body ^required

Media type application/json

object

api_key

Any of:

string

Rotates the credential in place: it reseals under the SAME reference, so every profile bound to this provider keeps working and the NEXT launch uses the new value — a session already running keeps the one it started with. The previous connection test is cleared, because a verdict measured on a credential that no longer exists is not evidence about the one replacing it.

string

>= 8 characters

null

null

base_url

Any of:

string

An explicit string replaces the stored endpoint; null/omission preserves it.

string

null

null

default_model

Any of:

string

An explicit model replaces the saved default for fresh sessions; empty clears it, null/omission preserves it. Does not rotate credentials or change the last connection test.

string

null

null

display_name

Any of:

string

An explicit string replaces the stored name; null/omission preserves it.

string

null

null

Example ^generated

{
  "api_key": "example",
  "base_url": "example",
  "default_model": "example",
  "display_name": "example"
}

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}