Sign in
Private Endpoints

Update a draft private endpoint

Replace a draft endpoint's upstream configuration: send upstream_model_id, and base_url to change it (an omitted base_url keeps the stored one). Omitted data-policy declarations are kept while the upstream is unchanged and cleared when it changes. Any change clears earlier validation. Active endpoints return 409; delete and re-create them instead. Management key required.

patch/private-endpoints/{id}

Path parameters

idstring uuid required

Stable identifier of the private endpoint.

Example:5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11

Stable identifier of the private endpoint.

Request body

base_urlstring

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

declared_region'global' | 'europe' | 'us' | 'null' nullable

Attest where this deployment processes data.

declared_zdrboolean nullable

Attest that this deployment retains no prompt or completion data.

upstream_model_idstring required

Model or deployment identifier sent to the upstream provider.

Example request

{
  "base_url": "https://contoso.openai.azure.com",
  "declared_region": "us",
  "upstream_model_id": "gpt-4o-prod"
}

Response

The updated endpoint

Example response

{
  "data": {
    "base_url": "https://contoso.openai.azure.com",
    "declared_region": "us",
    "declared_zdr": true,
    "id": "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
    "model_name": "OpenAI: GPT-4o",
    "model_permaslug": "openai/gpt-4o-2024-08-06",
    "model_slug": "openai/gpt-4o",
    "pricing": {
      "completion": "0.00001",
      "prompt": "0.0000025"
    },
    "provider_name": "Azure",
    "provider_slug": "azure",
    "status": "active",
    "upstream_model_id": "gpt-4o-prod"
  }
}

Changes

Changed in 1 of the 339 revisions of this API.1