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

# Update Egress Exit

> Change an exit; only the fields sent change.

Changing where it leads or its credentials restarts the running instances bound to it.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/workspaces/{workspace}/egress-exits/{exit_id}
openapi: 3.1.0
info:
  description: >-
    Modular and extensible framework for building AI agents. This API requires
    JWT Bearer token authentication for most endpoints. Include your JWT token
    in the Authorization header. Public endpoints include /, /health, /docs,
    /redoc, and /openapi.json.
  title: AgentArea API
  version: 0.1.2
servers: []
security:
  - bearer: []
paths:
  /v1/workspaces/{workspace}/egress-exits/{exit_id}:
    patch:
      tags:
        - v1
        - protected
        - egress-exits
      summary: Update Egress Exit
      description: >-
        Change an exit; only the fields sent change.


        Changing where it leads or its credentials restarts the running
        instances bound to it.
      operationId: update_egress_exit_v1_egress_exits__exit_id__patch
      parameters:
        - in: path
          name: exit_id
          required: true
          schema:
            format: uuid
            title: Exit Id
            type: string
        - description: Slug of the workspace the request acts in
          in: path
          name: workspace
          required: true
          schema:
            description: Slug of the workspace the request acts in
            maxLength: 120
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            title: Workspace
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EgressExitUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EgressExitResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    EgressExitUpdate:
      additionalProperties: false
      description: 'Patch an exit: only the fields sent change; null clears an optional one.'
      properties:
        allow_plaintext_credentials:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Allow Plaintext Credentials
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        name:
          anyOf:
            - maxLength: 255
              minLength: 1
              type: string
            - type: 'null'
          title: Name
        password_secret_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Password Secret Id
        upstream_url:
          anyOf:
            - maxLength: 512
              type: string
            - type: 'null'
          title: Upstream Url
        username:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          title: Username
      title: EgressExitUpdate
      type: object
    EgressExitResponse:
      properties:
        allow_plaintext_credentials:
          title: Allow Plaintext Credentials
          type: boolean
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by:
          title: Created By
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          format: uuid
          title: Id
          type: string
        managed_by:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            "platform" for an exit the deployment supplies; null for the
            workspace's own.
          title: Managed By
        name:
          title: Name
          type: string
        password_secret_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Password Secret Id
        updated_at:
          format: date-time
          title: Updated At
          type: string
        upstream_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Upstream Url
        username:
          anyOf:
            - type: string
            - type: 'null'
          title: Username
        via:
          anyOf:
            - type: string
            - type: 'null'
          description: The platform hop this exit leaves through, if any.
          title: Via
      required:
        - id
        - name
        - description
        - upstream_url
        - username
        - password_secret_id
        - via
        - allow_plaintext_credentials
        - managed_by
        - created_by
        - created_at
        - updated_at
      title: EgressExitResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: JWT Bearer token for authentication
      scheme: bearer
      type: http
    HTTPBearer:
      scheme: bearer
      type: http

````

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