Skip to main content
PATCH
Update a private endpoint

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Path Parameters

id
string<uuid>
required

Stable identifier of the private endpoint.

Example:

"5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11"

Body

application/json

Only the fields present change. base_url, upstream_model_id, declared_zdr and declared_region are accepted on a draft only; pricing and declared_parameters replace their value; settings is itself a partial update where null clears a limit or restores the provider default.

base_url
string

HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex).

Minimum string length: 1
Example:

"https://contoso.openai.azure.com"

declared_parameters
enum<string>[]

Parameters the upstream supports beyond the tested ones. Replaces the earlier declaration; tested parameters stay. Order and repeated names are ignored, but the list holds at most as many entries as there are declarable parameters, repeats included. tool_choice requires tools to be tested or declared.

Maximum array length: 25

A chat request parameter the endpoint accepts.

Available options:
temperature,
top_p,
top_k,
min_p,
top_a,
frequency_penalty,
presence_penalty,
repetition_penalty,
max_tokens,
max_completion_tokens,
logit_bias,
logprobs,
top_logprobs,
prediction,
seed,
response_format,
structured_outputs,
stop,
tools,
tool_choice,
parallel_tool_calls,
reasoning,
reasoning_effort,
web_search_options,
verbosity
Example:
declared_region
enum<string> | null

Attest where this deployment processes data.

Available options:
global,
europe,
us,
null
Example:

"us"

declared_zdr
boolean | null

Attest that this deployment retains no prompt or completion data.

pricing
object

Replaces the whole pricing object: omitting cache_read or cache_write reverts that rate to the pricing strategy default.

Example:
settings
object

Only the fields present change; an omitted field keeps its stored value and null clears a limit or reverts a flag to the provider default.

Example:
upstream_model_id
string

Model or deployment identifier sent to the upstream provider.

Minimum string length: 1
Example:

"gpt-4o-prod"

Response

The updated endpoint

data
object
required
Example: