> ## 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.

# Read proxy

> Returns the current proxy configuration for the instance named in the `{instance}` path parameter.



## OpenAPI

````yaml openapi.evolution-v2.json GET /proxy/find/{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/find/{instance}:
    get:
      tags:
        - Settings & Proxy
      summary: Read proxy
      description: >-
        Returns the current proxy configuration for the instance named in the
        `{instance}` path parameter.
      operationId: get__proxy_find_instance
      parameters:
        - name: instance
          in: path
          required: true
          schema:
            type: string
          description: The number's display name in the Pilot Status dashboard.
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  The saved proxy record for the instance. Returns null when no
                  proxy record exists.
                properties:
                  id:
                    type: string
                    description: Unique identifier of the proxy record (cuid).
                  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.
                  createdAt:
                    type: string
                    description: Timestamp when the proxy record was created (ISO 8601).
                  updatedAt:
                    type: string
                    description: >-
                      Timestamp when the proxy record was last updated (ISO
                      8601).
                  instanceId:
                    type: string
                    description: Identifier of the instance this proxy belongs to.
              example:
                id: clzy8h3k9000108l0g7d2f1a3
                enabled: true
                host: proxy.example.com
                port: '3128'
                protocol: http
                username: proxyuser
                password: proxypass
                createdAt: '2026-07-09T18:24:11.000Z'
                updatedAt: '2026-07-09T18:24:11.000Z'
                instanceId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        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>`.

````