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

# POST /admin/api/connectivity/test



## OpenAPI

````yaml /generated/openapi.json post /admin/api/connectivity/test
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /admin/api/connectivity/test:
    post:
      tags:
        - Management
      summary: POST /admin/api/connectivity/test
      parameters:
        - description: Administrative scope selected by the caller.
          in: header
          name: x-gproxy-admin-scope
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Input_ConnectivityTest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_ConnectivityResultDto'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Envelope'
          description: Gateway error
      security:
        - consoleSession: []
        - bearer: []
        - anthropicKey: []
        - googleKey: []
components:
  schemas:
    Input_ConnectivityTest:
      description: |-
        What a connectivity test should exercise. Each variant resolves the same
        client chain a real call would: the credential's profile, then the
        provider's, then the channel's default, then the instance default.
      oneOf:
        - description: The instance default profile, with no provider in the picture.
          properties:
            scope:
              const: global
              type: string
          required:
            - scope
          type: object
        - properties:
            provider_id:
              type: string
            scope:
              const: provider
              type: string
          required:
            - scope
            - provider_id
          type: object
        - description: The chain that credential's own calls take.
          properties:
            credential_id:
              type: string
            scope:
              const: credential
              type: string
          required:
            - scope
            - credential_id
          type: object
        - description: >-
            A proxy that is not configured anywhere yet: the reason this exists
            is

            to test one before saving it.
          properties:
            scope:
              const: proxy
              type: string
            url:
              type: string
          required:
            - scope
            - url
          type: object
      properties:
        proxy:
          default: null
          description: >-
            Omitted tests saved settings; null previews inheritance at this
            scope.
      type: object
    Output_ConnectivityResultDto:
      description: >-
        What the edge looks like from here. `ip` and `colo` come from
        Cloudflare's

        trace endpoint, so `ip` is the address the upstream would see — which is

        the whole point of testing a proxy.
      properties:
        colo:
          description: The Cloudflare edge that answered, e.g. `NRT`.
          type:
            - string
            - 'null'
        error:
          description: Set exactly when `ok` is false.
          type:
            - string
            - 'null'
        ip:
          type:
            - string
            - 'null'
        ipv4:
          anyOf:
            - $ref: '#/components/schemas/Output_ConnectivityProbeDto'
            - type: 'null'
        ipv4Error:
          type:
            - string
            - 'null'
        ipv6:
          anyOf:
            - $ref: '#/components/schemas/Output_ConnectivityProbeDto'
            - type: 'null'
        ipv6Error:
          type:
            - string
            - 'null'
        latencyMs:
          description: |-
            Measured across the whole exchange, including the body read, and
            reported for a failure too.
          format: uint64
          minimum: 0
          type: integer
        ok:
          type: boolean
        proxySource:
          type: string
      required:
        - ipv4
        - ipv6
        - ipv4Error
        - ipv6Error
        - proxySource
        - ok
        - latencyMs
        - ip
        - colo
        - error
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Output_ConnectivityProbeDto:
      properties:
        colo:
          type:
            - string
            - 'null'
        ip:
          type: string
        latencyMs:
          format: uint64
          minimum: 0
          type: integer
        location:
          type:
            - string
            - 'null'
      required:
        - ip
        - location
        - colo
        - latencyMs
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey
    consoleSession:
      in: cookie
      name: gproxy_session
      type: apiKey

````

## Related topics

- [POST /admin/api/models/test](https://gproxy.leenhawk.com/api-reference/management/post-adminapimodelstest.md)
- [POST /admin/api/credentials/{id}/models/test](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials-modelstest.md)
- [POST /admin/api/api-keys](https://gproxy.leenhawk.com/api-reference/management/post-adminapiapi-keys.md)
- [POST /admin/api/fonts](https://gproxy.leenhawk.com/api-reference/management/post-adminapifonts.md)
- [POST /admin/api/credentials](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials.md)


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