Update Endpoint Route

PUT

/v1/admin/forge-endpoints/{endpoint_id}

curl --request PUT \
  --url http://localhost:8080/v1/admin/forge-endpoints/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "model": "example", "base_url": "example", "aws_region": "example", "gcp_project": "example", "gcp_region": "example", "credentials": { "api_key": "example", "access_key_id": "example", "secret_access_key": "example", "session_token": "example", "service_account_json": "example" }, "default_max_budget_usd": 1, "default_max_turns": 1 }'

• Local docker compose stack (default)

Parameters

Path Parameters

endpoint_id

required

Endpoint Id

string

Request Body ^required

Media type application/json

UpdatePayload

object

name

Any of:

string

string

>= 1 characters <= 128 characters /^[A-Za-z0-9 _\-./]+$/

null

null

model

Any of:

string

string

>= 1 characters <= 256 characters

null

null

base_url

Any of:

string

string

<= 2048 characters

null

null

aws_region

Any of:

string

string

<= 64 characters

null

null

gcp_project

Any of:

string

string

<= 128 characters

null

null

gcp_region

Any of:

string

string

<= 64 characters

null

null

credentials

Any of:

_CredentialsPayload

_CredentialsPayload

Backend-tagged credentials. Validated server-side.

The shape is union-y: api_key for anthropic / custom_url, access_key_id/secret_access_key/session_token? for bedrock, service_account_json for vertex. We intentionally don’t typedef each combination — server validates per backend.

object

api_key

Any of:

string

string

<= 4096 characters

null

null

access_key_id

Any of:

string

string

<= 256 characters

null

null

secret_access_key

Any of:

string

string

<= 4096 characters

null

null

session_token

Any of:

string

string

<= 8192 characters

null

null

service_account_json

Any of:

string

string

<= 32000 characters

null

null

null

null

default_max_budget_usd

Any of:

number

number

> 0 <= 10000

null

null

default_max_turns

Any of:

integer

integer

>= 1 <= 10000

null

null

Example ^generated

{
  "name": "example",
  "model": "example",
  "base_url": "example",
  "aws_region": "example",
  "gcp_project": "example",
  "gcp_region": "example",
  "credentials": {
    "api_key": "example",
    "access_key_id": "example",
    "secret_access_key": "example",
    "session_token": "example",
    "service_account_json": "example"
  },
  "default_max_budget_usd": 1,
  "default_max_turns": 1
}

Responses

200

Successful Response

Media type application/json

Response Update Endpoint Route V1 Admin Forge Endpoints Endpoint Id Put

object

key

additional properties

any

Example ^generated

{}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}