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

# Configure proxy

> Sets the outbound proxy for the instance named in the `{instance}` path parameter.



## OpenAPI

````yaml openapi.evolution-v2.json POST /proxy/set/{instance}
openapi: 3.1.0
info:
  title: Evolution V2 Layer
  version: 1.0.0
  description: >-
    Pilot Status API Layer — Evolution V2. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-v2`. Authenticate with the
    `apikey` header (your Pilot Status `ps_` key). Instance/session endpoints
    are NOT available through the layer.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-v2
security:
  - apiKey: []
tags:
  - name: Call & Business
  - name: Chat
  - name: Group
  - name: Label
  - name: Message
  - name: Profile
  - name: Settings & Proxy
  - name: Storage (S3)
  - name: Template
paths:
  /proxy/set/{instance}:
    post:
      tags:
        - Settings & Proxy
      summary: Configure proxy
      description: >-
        Sets the outbound proxy for the instance named in the `{instance}` path
        parameter.
      operationId: post__proxy_set_instance
      parameters:
        - name: instance
          in: path
          required: true
          schema:
            type: string
          description: The number's display name in the Pilot Status dashboard.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether the proxy is enabled for this instance.
                  example: true
                host:
                  type: string
                  description: Proxy host name or IP address.
                  example: proxy.example.com
                port:
                  type: string
                  description: Proxy port.
                  example: '8080'
                protocol:
                  type: string
                  description: Proxy protocol (e.g. `http`, `https`, `socks5`).
                  example: http
                username:
                  type: string
                  description: Username for proxy authentication.
                  example: proxyuser
                password:
                  type: string
                  description: Password for proxy authentication.
                  example: proxypass
              required:
                - enabled
                - host
                - port
                - protocol
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Confirmation that the instance proxy configuration was saved.
                  Echoes the instance name and the proxy payload that was
                  persisted.
                properties:
                  proxy:
                    type: object
                    properties:
                      instanceName:
                        type: string
                        description: Name of the instance the proxy was applied to.
                      proxy:
                        type: object
                        description: >-
                          The proxy payload that was persisted. When disabled,
                          the host/port/protocol/username/password fields are
                          cleared to empty strings.
                        properties:
                          enabled:
                            type: boolean
                            description: Whether the proxy is enabled for this instance.
                          host:
                            type: string
                            description: Proxy host name or IP address.
                          port:
                            type: string
                            description: Proxy port.
                          protocol:
                            type: string
                            description: Proxy protocol (e.g. http, https, socks4, socks5).
                          username:
                            type: string
                            description: Proxy authentication username.
                          password:
                            type: string
                            description: Proxy authentication password.
              example:
                proxy:
                  instanceName: my-instance
                  proxy:
                    enabled: true
                    host: proxy.example.com
                    port: '3128'
                    protocol: http
                    username: proxyuser
                    password: proxypass
        default:
          description: Error — provider or layer error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  response:
                    type: object
              example:
                status: 400
                error: Bad Request
                message: Invalid payload
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Your Pilot Status API key (ps_...). Evolution GO also accepts
        `Authorization: Bearer <key>`.

````