Skip to main content

Overview

Private Endpoints endpoints

Available Operations

  • List - List private endpoints
  • Create - Create a private endpoint
  • Delete - Delete a private endpoint
  • Get - Get a private endpoint
  • Update - Update a private endpoint
  • Activate - Activate a validated private endpoint
  • Disable - Disable a private endpoint
  • Enable - Enable a private endpoint
  • Validate - Validate a draft private endpoint

List

List the organization’s private endpoints, including drafts. Requires the private endpoints entitlement. Management key required.

Example Usage

Parameters

Response

*components.ListPrivateEndpointsResponse, error

Errors

Create

Create a private endpoint as a draft. Drafts are not routable: validate one with POST /private-endpoints/{id}/validate, then activate it with POST /private-endpoints/{id}/activate. Pass activate to do all three in one call; if validation fails the draft is kept and returned with the failed checks. Send an Idempotency-Key header to make retries safe: a repeated key with the same request returns the endpoint the first request created; reusing it with different fields returns 422 idempotency_key_reused. Returns 400 parameters_invalid when tool_choice is declared without tools. The response does not echo declared_parameters or tested_parameters; read them with GET /private-endpoints/{id}. Management key required.

Example Usage

Parameters

Response

*components.ManagedPrivateEndpointResponse, error

Errors

Delete

Delete a private endpoint and stop routing to it. Pass draft_only=true to refuse (409) when the endpoint has been activated. Management key required.

Example Usage

Parameters

Response

*components.DeletePrivateEndpointResponse, error

Errors

Get

Get one private endpoint with its upstream configuration and current pricing. Management key required.

Example Usage

Parameters

Response

*components.PrivateEndpointResponse, error

Errors

Update

Change any of the endpoint fields you own in one call; only the fields present change, and the response is the whole endpoint. pricing and declared_parameters replace their stored value, settings changes only the fields it names (null clears a limit or restores the provider default); routing picks these up for subsequent requests on drafts and active endpoints alike. declared_zdr and declared_region change on drafts and active endpoints alike; on an active endpoint the change keeps its validation and tested parameters, and routing applies it to subsequent requests. upstream_model_id and base_url re-point a draft: an omitted upstream_model_id or base_url keeps the stored one, omitted data-policy declarations are kept while the upstream is unchanged and cleared when it changes, and any change to the upstream or declarations of a draft clears earlier validation. Naming upstream_model_id or base_url on an active endpoint returns 409 already_active and writes nothing, even alongside other fields; delete and re-create instead. Every group is checked before anything is written: 400 parameters_invalid when tool_choice is declared without tools tested or declared, 400 settings_invalid when max_prompt_tokens exceeds the context length, both completion APIs are off, or excluded_parameters names a tested parameter, 422 pricing_invalid for rates the provider strategy cannot represent, or pricing_cache_read_unsupported or pricing_cache_write_unsupported when that rate is a cache rate the strategy has no SKU for. Management key required.

Example Usage

Parameters

Response

*components.PrivateEndpointResponse, error

Errors

Activate

Make a validated draft routable. Returns 409 when the endpoint was never validated, the validation is stale, or it is already active. Management key required.

Example Usage

Parameters

Response

*components.ManagedPrivateEndpointResponse, error

Errors

Disable

Stop routing to an active endpoint without deleting it. Management key required.

Example Usage

Parameters

Response

*components.ManagedPrivateEndpointResponse, error

Errors

Enable

Resume routing to a disabled endpoint. Management key required.

Example Usage

Parameters

Response

*components.ManagedPrivateEndpointResponse, error

Errors

Validate

Send a live test request to the draft endpoint using the given workspace’s BYOK credential for its provider. A passing validation is required before activation. Failed checks return 200 with passed: false. Management key required.

Example Usage

Parameters

Response

*components.PrivateEndpointValidationResponse, error

Errors