> ## Documentation Index
> Fetch the complete documentation index at: https://docs.barndoor.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a model access policy

> Updates a model access policy. Only the fields you send are changed. Send `null` for `scope_id` or `scope_value` to unbind the policy from a single entity.



## OpenAPI

````yaml api-reference/llm-gateway-openapi.yml put /admin/model-access/{id}
openapi: 3.1.0
info:
  title: Barndoor LLM Gateway Admin API
  version: 1.0.0
  description: >
    Configure the Barndoor LLM Gateway programmatically: credentials and
    providers,

    model routes and route groups, pricing, routing policies and rules, launch
    profiles,

    budgets, rate limits, model access, API keys, and organization-wide
    governance settings.


    These are the same APIs the Barndoor app uses under **LLM Management**, and
    the

    Barndoor Terraform provider manages its LLM Gateway resources through them.
    Every

    endpoint is scoped to the organization of the calling token.


    ## Base URL


    ```

    https://app.barndoor.ai/api/llm-gateway

    ```


    For a dedicated deployment, replace `app.barndoor.ai` with the host you sign
    in to.


    ## Authentication


    Send an access token from Barndoor's identity provider in the
    `Authorization` header:


    ```

    Authorization: Bearer <access-token>

    ```


    For scripts and CI, use a service-account token from the OAuth 2.0
    client-credentials

    grant, as the Terraform provider does. The caller needs the admin role in
    the

    organization.


    The `bd-...` API keys you create with these endpoints are for LLM traffic

    (`/v1/chat/completions`, `/v1/messages`, and so on), not for these
    administrative calls.


    ## Partial updates


    Most `PUT` endpoints change only the fields you send. Where a field can be
    cleared,

    send it as `null`; omitting it leaves it unchanged. The exceptions are
    called out on

    the endpoint: `PUT /admin/governance-config` replaces the whole
    configuration,

    `PUT /admin/routing-rules/{id}` replaces the whole rule, and

    `PUT /admin/agent-runtime-profiles/{slug}` replaces the profile's models.


    ## Errors


    Errors are returned as JSON:


    ```json

    { "error": { "message": "retry_on_429_count must be between 0 and 10",
    "type": "invalid_request_error" } }

    ```
  contact:
    name: Barndoor Support
    url: https://barndoor.ai
servers:
  - url: https://{host}/api/llm-gateway
    description: Your Barndoor platform host.
    variables:
      host:
        default: app.barndoor.ai
        description: >-
          The host serving your Barndoor deployment. Use the default for
          Barndoor SaaS; for a dedicated deployment, use the host you sign in
          to.
security:
  - BearerAuth: []
tags:
  - name: Credentials
    description: >-
      Stored upstream secrets (API keys, AWS roles, Google credentials) that
      providers reference
  - name: Providers
    description: Named upstream providers backed by a credential and a model family
  - name: Model Routes
    description: >-
      Map caller-facing aliases to upstream models on one or more providers,
      with failover order, retries, timeouts, and cooldowns
  - name: Route Groups
    description: >-
      Named sets of model aliases that model access policies can target as one
      unit
  - name: Model Pricing
    description: >-
      Versioned per-million-token costs used for cost reporting and cost-based
      budgets
  - name: Routing Policies
    description: Model aliases that pick one of several model slots for each request
  - name: Routing Rules
    description: >-
      Plain-English rules that set a minimum slot or forbid slots on a routing
      policy
  - name: Launch Profiles
    description: >-
      Models and capabilities applied when members start an agent with barndoor
      run
  - name: Rate Limits
    description: Requests-per-minute and tokens-per-minute ceilings
  - name: Budgets
    description: Daily, weekly, or monthly token and cost ceilings
  - name: Model Access
    description: >-
      Allowlist and denylist policies for models, providers, aliases, and route
      groups
  - name: Governance
    description: Organization-wide LLM Gateway settings
  - name: API Keys
    description: Organization-managed `bd-...` gateway API keys for LLM traffic
paths:
  /admin/model-access/{id}:
    put:
      tags:
        - Model Access
      summary: Update a model access policy
      description: >-
        Updates a model access policy. Only the fields you send are changed.
        Send `null` for `scope_id` or `scope_value` to unbind the policy from a
        single entity.
      operationId: updateModelAccess
      parameters:
        - name: id
          in: path
          description: Record ID (UUID)
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateModelAccessRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithAttribution_ModelAccessPolicy'
        '400':
          description: Invalid request. The error message says which field or rule failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Your role does not allow this action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Another record already uses this name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    UpdateModelAccessRequest:
      type: object
      properties:
        change_note:
          type:
            - string
            - 'null'
          description: >-
            Optional note explaining this change. Omitting it clears the
            previous note.
        enabled:
          type:
            - boolean
            - 'null'
        name:
          type:
            - string
            - 'null'
        policy_type:
          type:
            - string
            - 'null'
        scope_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            UUID of the scoped entity, for UUID-keyed scope types such as
            `user`, `team`, or `api_key`. Omit to leave unchanged; send `null`
            to clear.
        scope_type:
          type:
            - string
            - 'null'
        scope_value:
          type:
            - string
            - 'null'
          description: >-
            Name of the scoped entity, for name-keyed scope types, such as a
            role or IdP group name. Omit to leave unchanged; send `null` to
            clear.
        targets:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ModelAccessTarget'
        traffic_type:
          type:
            - string
            - 'null'
    WithAttribution_ModelAccessPolicy:
      allOf:
        - type: object
          required:
            - id
            - org_id
            - name
            - scope_type
            - policy_type
            - targets
            - traffic_type
            - enabled
          properties:
            enabled:
              type: boolean
            id:
              type: string
              format: uuid
            name:
              type: string
            org_id:
              type: string
              format: uuid
            policy_type:
              type: string
            scope_id:
              type:
                - string
                - 'null'
              format: uuid
            scope_type:
              type: string
            scope_value:
              type:
                - string
                - 'null'
            targets:
              type: array
              items:
                $ref: '#/components/schemas/ModelAccessTarget'
            traffic_type:
              type: string
        - $ref: '#/components/schemas/ChangeAttribution'
      description: A model access policy.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              description: Human-readable explanation of what went wrong.
            type:
              type: string
              description: >-
                Error category, such as `invalid_request_error`,
                `authentication_error`, `permission_error`, `not_found_error`,
                or `conflict_error`.
            code:
              type:
                - string
                - 'null'
              description: Machine-readable code, when one applies.
      example:
        error:
          message: retry_on_429_count must be between 0 and 10
          type: invalid_request_error
    ModelAccessTarget:
      oneOf:
        - type: object
          description: >-
            Match the model alias the caller sent in `model`. A trailing `*` is
            a wildcard.
          required:
            - alias
            - kind
          properties:
            alias:
              type: string
            kind:
              type: string
              enum:
                - model_alias
        - type: object
          description: >-
            Match the upstream model a request resolves to, whatever alias was
            used. A trailing `*` is a wildcard.
          required:
            - model
            - kind
          properties:
            kind:
              type: string
              enum:
                - model
            model:
              type: string
        - type: object
          description: >-
            Match models on one provider. As a denial this covers everything
            routed to the provider, custom aliases included; as a grant it
            covers the provider's own models only.
          required:
            - provider_id
            - kind
          properties:
            kind:
              type: string
              enum:
                - provider
            provider_id:
              type: string
              format: uuid
        - type: object
          description: Match a model alias only when it is served by a specific provider.
          required:
            - provider_id
            - model
            - kind
          properties:
            kind:
              type: string
              enum:
                - provider_model
            model:
              type: string
            provider_id:
              type: string
              format: uuid
        - type: object
          description: >-
            Match every route in a route group. Membership is read when the
            policy is evaluated, so adding a route to the group extends the
            policy.
          required:
            - group_id
            - kind
          properties:
            group_id:
              type: string
              format: uuid
            kind:
              type: string
              enum:
                - route_group
      description: One thing a model access policy allows or denies, selected by `kind`.
    ChangeAttribution:
      type: object
      description: >-
        Who created and last changed the record, and why. Records created before
        attribution was added have no values until their next change.
      properties:
        created_by_email:
          type:
            - string
            - 'null'
        created_by_name:
          type:
            - string
            - 'null'
        created_by_user_id:
          type:
            - string
            - 'null'
          format: uuid
        last_change_note:
          type:
            - string
            - 'null'
          description: Note explaining the last change.
        last_modified_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the last attributed change was made.
        last_modified_by_email:
          type:
            - string
            - 'null'
        last_modified_by_name:
          type:
            - string
            - 'null'
        last_modified_by_user_id:
          type:
            - string
            - 'null'
          format: uuid
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        An access token from Barndoor's identity provider, sent as
        `Authorization: Bearer <token>`. Use a service-account token from the
        OAuth 2.0 client-credentials grant for scripts and CI, or a signed-in
        user's token. The caller needs the admin role in the organization.
        Gateway API keys (`bd-...`) are not accepted here.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.