---
title: "Update an AI Gateway Agent"
url: "https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3/operations/update-ai-gateway-agent"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3.md

# Update an AI Gateway Agent

`PUT` `/ai-gateways/{gatewayId}/agents/{agentId}`

Operation ID: `update-ai-gateway-agent`

Updates the configuration of an existing AI Gateway agent.

## Path parameters

- `gatewayId` (string, uuid, required) - The unique ID of the AI Gateway.
- `agentId` (string, uuid, required) - The unique ID of the AI Gateway agent.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Agent updated successfully.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `429` - Too Many Requests

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect AI Gateway
  version: 0.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /ai-gateways/{gatewayId}/agents/{agentId}:
    parameters:
      - $ref: "#/components/parameters/AIGatewayId"
      - $ref: "#/components/parameters/AIGatewayAgentId"
    put:
      operationId: update-ai-gateway-agent
      summary: Update an AI Gateway Agent
      description: Updates the configuration of an existing AI Gateway agent.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateAIGatewayAgentRequest"
      responses:
        "200":
          $ref: "#/components/responses/UpdateAIGatewayAgentResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      tags:
        - AI Gateway Agents
security:
  - konnectAccessToken: []
components:
  parameters:
    AIGatewayId:
      name: gatewayId
      in: path
      required: true
      description: The unique ID of the AI Gateway.
      example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
      schema:
        $ref: "#/components/schemas/UUID"
    AIGatewayAgentId:
      name: agentId
      in: path
      required: true
      description: The unique ID of the AI Gateway agent.
      example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
      schema:
        $ref: "#/components/schemas/UUID"
  schemas:
    UpdateAIGatewayAgentRequest:
      type: object
      properties:
        display_name:
          description: The display name for this agent.
          type: string
          example: Kong Air Flight Booking Agent
        ref:
          description: A user-defined unique identifier for this agent, used as a stable
            human-readable reference.
          type: string
          example: kongair-flight-booking-agent
        type:
          description: The type of the agent.
          type: string
          example: a2a
          enum:
            - a2a
            - http
        policies:
          type: array
          items:
            $ref: "#/components/schemas/AIGatewayPolicyReference"
        acls:
          description: Access control rules for allowing or denying consumer groups access
            to this agent.
          allOf:
            - $ref: "#/components/schemas/AIGatewayACLS"
        config:
          description: Configuration for the agent. The structure varies depending on the
            agent type.
          type: object
          additionalProperties: false
          properties:
            url:
              description: >
                Helper field to set protocol, host, port and path of the
                upstream A2A Agent using a URL.

                This is the same as a Kong Gateway Service URL:
                ${scheme}://${host}:${port}/${path}
              type: string
              format: uri
              example: https://booking-agent.internal.kongair.com
            route:
              $ref: "#/components/schemas/AIGatewayRouteConfig"
            logging:
              $ref: "#/components/schemas/AIGatewayLoggingConfig"
            max_payload_size:
              description: Max payload size in bytes.
              type: integer
              example: 524288
        labels:
          $ref: "#/components/schemas/PublicLabels"
        managed_by:
          $ref: "#/components/schemas/AIGatewayManagedBy"
      additionalProperties: true
      required:
        - display_name
        - ref
        - type
        - policies
        - acls
        - config
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    AIGatewayPolicyReference:
      description: Lightweight object used to reference a policy instance, identified
        by its `ref`.
      type: object
      properties:
        ref:
          description: The user-defined unique identifier for a policy instance.
          type: string
          example: ai-pii-sanitizer-1234
      additionalProperties: false
      required:
        - ref
    AIGatewayACLS:
      type: object
      properties:
        allow:
          description: List of consumer group names permitted access.
          type: array
          items:
            type: string
        deny:
          description: List of consumer group names denied access.
          type: array
          items:
            type: string
      additionalProperties: false
      required:
        - allow
        - deny
    AIGatewayRouteConfig:
      description: Configuration for an AI Gateway route.
      type: object
      properties:
        destinations:
          description: A list of IP destinations of incoming connections that match this
            route when using stream routing. Each entry is an object with fields
            ip (optionally in CIDR range notation) and/or port.
          type: array
          items:
            type: object
            properties:
              ip:
                type: string
              port:
                type: integer
            example:
              ip: 10.1.0.0/16
              port: 1234
        headers:
          description: "One or more lists of values indexed by header name that will cause
            this route to match if present in the request. The `Host` header
            cannot be used with this attribute: hosts should be specified using
            the `hosts` attribute. When `headers` contains only one value and
            that value starts with the special prefix `~*`, the value is
            interpreted as a regular expression."
          type: object
          example:
            version:
              - v1
              - v2
          additionalProperties: true
        hosts:
          description: A list of domain names that match this route. Note that the hosts
            value is case sensitive.
          type: array
          items:
            type: string
            example: foo.example.com
        https_redirect_status_code:
          description: "The status code Kong responds with when all properties of a route
            match except the protocol i.e. if the protocol of the request is
            `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if
            the field is set to 301, 302, 307 or 308. Note: This config applies
            only if the route is configured to only accept the `https`
            protocol."
          type: integer
          default: 426
        id:
          type: string
          example: 56c4566c-14cc-4132-9011-4139fcbbe50a
        methods:
          description: A list of HTTP methods that match this route.
          type: array
          items:
            type: string
        name:
          description: The name of the route. Route names must be unique, and they are
            case sensitive. For example, there can be two different routes named
            test and Test.
          type: string
        path_handling:
          description: Controls how the service path, route path and requested path are
            combined when sending a request to the upstream. See above for a
            detailed description of each behavior.
          type: string
          default: v0
        paths:
          description: A list of paths that match this route.
          type: array
          items:
            type: string
        preserve_host:
          description: When matching a route via one of the `hosts` domain names, use the
            request `Host` header in the upstream request headers. If set to
            `false`, the upstream `Host` header will be that of the service's
            `host`.
          type: boolean
          default: false
        protocols:
          description: An array of the protocols this route should allow. See the [route
            Object](#route-object) section for a list of accepted protocols.
            When set to only `https`, HTTP requests are answered with an upgrade
            error. When set to only `http`, HTTPS requests are answered with an
            error.
          type: array
          items:
            type: string
          default:
            - http
            - https
        regex_priority:
          description: A number used to choose which route resolves a given request when
            several routes match it using regexes simultaneously. When two
            routes match the path and have the same `regex_priority`, the older
            one (lowest `created_at`) is used. Note that the priority for
            non-regex routes is different (longer non-regex routes are matched
            before shorter ones).
          type: integer
          default: 0
        request_buffering:
          description: Whether to enable request body buffering or not. With HTTP 1.1, it
            may make sense to turn this off on services that receive data with
            chunked transfer encoding.
          type: boolean
          default: true
        response_buffering:
          description: Whether to enable response body buffering or not. With HTTP 1.1, it
            may make sense to turn this off on services that send data with
            chunked transfer encoding.
          type: boolean
          default: true
        service:
          description: The service this route is associated to. This is where the route
            proxies traffic to.
          type: object
          additionalProperties: false
          properties:
            id:
              type: string
        snis:
          description: A list of SNIs that match this route when using stream routing.
          type: array
          items:
            type: string
        sources:
          description: A list of IP sources of incoming connections that match this route
            when using stream routing. Each entry is an object with fields ip
            (optionally in CIDR range notation) and/or port.
          type: array
          items:
            type: object
            properties:
              ip:
                type: string
              port:
                type: integer
            example:
              ip: 10.1.0.0/16
              port: 1234
        strip_path:
          description: When matching a route via one of the `paths`, strip the matching
            prefix from the upstream request URL.
          type: boolean
          default: true
        tags:
          description: An optional set of strings associated with the route for grouping
            and filtering.
          type: array
          items:
            type: string
      additionalProperties: false
    AIGatewayLoggingConfig:
      description: Configuration for AI Gateway logging.
      type: object
      properties:
        payloads:
          type: boolean
          default: false
        statistics:
          type: boolean
          default: false
      additionalProperties: false
      required:
        - payloads
        - statistics
    PublicLabels:
      description: >
        Public labels store information about an entity that can be used for
        filtering a list of objects.


        Public labels are intended to store **PUBLIC** metadata. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        category: finance
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: PublicLabels
    AIGatewayManagedBy:
      description: >
        Indicates the managing entities for a resource. A maximum of 5 keys is
        allowed.


        Keys must be 63 characters or less, starting and ending with an
        alphanumeric character,

        and may include dashes (-), underscores (_), and dots (.).


        Values must be non-empty strings of 127 characters or less.


        Keys and values must not contain spaces or control characters, and are
        case-insensitive.
      type: object
      example:
        team: platform
        owner: kong
      additionalProperties:
        type: string
        minLength: 1
        maxLength: 127
      maxProperties: 5
      nullable: true
    AIGatewayAgent:
      type: object
      properties:
        display_name:
          description: The display name for this agent.
          type: string
          example: Kong Air Flight Booking Agent
        ref:
          description: A user-defined unique identifier for this agent, used as a stable
            human-readable reference.
          type: string
          example: kongair-flight-booking-agent
        type:
          description: The type of the agent.
          type: string
          example: a2a
          enum:
            - a2a
            - http
        policies:
          type: array
          items:
            $ref: "#/components/schemas/AIGatewayPolicyReference"
        acls:
          description: Access control rules for allowing or denying consumer groups access
            to this agent.
          allOf:
            - $ref: "#/components/schemas/AIGatewayACLS"
        config:
          description: Configuration for the agent. The structure varies depending on the
            agent type.
          type: object
          additionalProperties: false
          properties:
            url:
              description: >
                Helper field to set protocol, host, port and path of the
                upstream A2A Agent using a URL.

                This is the same as a Kong Gateway Service URL:
                ${scheme}://${host}:${port}/${path}
              type: string
              format: uri
              example: https://booking-agent.internal.kongair.com
            route:
              $ref: "#/components/schemas/AIGatewayRouteConfig"
            logging:
              $ref: "#/components/schemas/AIGatewayLoggingConfig"
            max_payload_size:
              description: Max payload size in bytes.
              type: integer
              example: 524288
        labels:
          $ref: "#/components/schemas/PublicLabels"
        managed_by:
          $ref: "#/components/schemas/AIGatewayManagedBy"
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: true
      required:
        - display_name
        - ref
        - type
        - policies
        - acls
        - config
        - id
        - created_at
        - updated_at
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    TooManyRequestsError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 429
            title:
              example: Too Many Requests
            type:
              example: https://httpstatuses.com/429
            instance:
              example: kong:trace:1234567890
            detail:
              example: Too Many Requests
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  responses:
    UpdateAIGatewayAgentResponse:
      description: Agent updated successfully.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AIGatewayAgent"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    TooManyRequests:
      description: Too Many Requests
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/TooManyRequestsError"
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
