Update a consumer

Updates an existing consumer. The optional registries and auths fields each replace the whole association set of that kind in the same atomic request, so an identity change and the auths it needs travel together.

PUT /v1/gateways/{gateway_id}/consumers/{id}

Error

A valid request URL is required to generate request examples

200

{
  "active": true,
  "audience": "application",
  "auth_binding": {
    "allowed_certificate_subjects": [
      "<string>"
    ],
    "allowed_client_ids": [
      "<string>"
    ]
  },
  "auth_ids": [
    "<string>"
  ],
  "created_at": "<string>",
  "description": "<string>",
  "fail_mode": "<string>",
  "fallback": {
    "budget": {
      "max_attempts": 123,
      "max_total_latency_ms": 123
    },
    "chain": [
      "<string>"
    ],
    "enabled": true,
    "triggers": [
      "<string>"
    ]
  },
  "gateway_id": "<string>",
  "headers": {},
  "id": "<string>",
  "identity": {},
  "label_sets": [
    {
      "id": "<string>",
      "instructions": "<string>",
      "labels": [
        {
          "description": "<string>",
          "name": "<string>"
        }
      ],
      "name": "<string>"
    }
  ],
  "lb_config": {
    "algorithm": "<string>",
    "embedding_config": {
      "auth": {
        "api_key": "<string>",
        "header_name": "<string>",
        "header_value": "<string>",
        "param_location": "<string>",
        "param_name": "<string>",
        "param_value": "<string>"
      },
      "model": "<string>",
      "provider": "<string>"
    },
    "enabled": true,
    "members": [
      {
        "model": "<string>",
        "models": [
          "<string>"
        ],
        "registry_id": "<string>",
        "weight": 123
      }
    ],
    "pool_alias": "<string>",
    "smart_routing": {
      "sr1": {
        "cache_ttl_seconds": 123,
        "escape_hatch_enabled": true
      },
      "tiers": [
        {
          "min_score": 123,
          "model": "<string>",
          "registry_id": "<string>"
        }
      ]
    }
  },
  "model_policies": [
    {
      "allowed": [
        "<string>"
      ],
      "default": "<string>",
      "registry_id": "<string>"
    }
  ],
  "name": "<string>",
  "registry_ids": [
    "<string>"
  ],
  "registry_weights": [
    {
      "registry_id": "<string>",
      "weight": 123
    }
  ],
  "slug": "<string>",
  "synthetic": true,
  "toolkit": [
    {
      "expose_as": "<string>",
      "prompt": "<string>",
      "registry_id": "<string>",
      "resource": "<string>",
      "tool": "<string>"
    }
  ],
  "type": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization · string · header · required

Path Parameters

gateway_id · string<uuid> · required

Gateway id

id · string<uuid> · required

Consumer id

Body

application/json

Consumer fields to update

active · boolean

audience · enum<string>

Audience is set at create and cannot change: a value other than the stored one answers 422.

Available options: application, personal

auth_binding · object

AuthBinding replaces the whole binding. Omit to keep it; send empty lists to clear it.

Show child attributes

auths · string[]

Auths replaces the whole auth association set with the listed auth ids: auths absent from the list are detached. Omit the field to leave the associations as they are; send an empty list to detach every auth.

description · string

Description replaces the free-text description. Omit it to keep the current one; send an empty string to clear it.

Maximum string length: 500

fail_mode · string

fallback · object

Show child attributes

headers · object

Show child attributes

identity · object

Identity replaces who the consumer acts for. Omit to keep it as it is.

Show child attributes

lb_config · object

Show child attributes

model_policies · object[]

Show child attributes

name · string

registries · object[]

Registries replaces the whole registry association set: registries absent from the list are detached. Omit the field to leave the associations as they are; send an empty list to detach every registry.

Show child attributes

toolkit · object[]

Show child attributes

type · string

Response

200

application/json

OK

active · boolean

audience · enum<string>

Available options: application, personal

auth_binding · object

Show child attributes

auth_ids · string[]

created_at · string

description · string

fail_mode · string

fallback · object

Show child attributes

gateway_id · string

headers · object

Show child attributes

id · string

identity · object

label_sets · object[]

LabelSets are the traffic label sets the consumer's chat requests are classified against; empty when it has none.

Show child attributes

lb_config · object

Show child attributes

model_policies · object[]

Show child attributes

name · string

registry_ids · string[]

registry_weights · object[]

Show child attributes

slug · string

synthetic · boolean

Synthetic marks a consumer the gateway serves without storing: today the MCP Store. It has no row, so it cannot be edited, deleted or given a key, and it is only listed when a caller asks for it.

toolkit · object[]

Show child attributes

type · string

updated_at · string