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

# Get your IP address

> Returns the caller's IP address. Production ingress must restrict traffic to Cloudflare because CF-Connecting-IP is trusted. Direct requests without that header use the socket address. No authentication is required.



## OpenAPI

````yaml https://controller.simplecloud.app/swagger/doc.json get /v0/ip
openapi: 3.1.0
info:
  contact:
    name: SimpleCloud support
    url: https://discord.simplecloud.app
  description: >-
    Manage Minecraft networks, server groups, persistent servers, players, and
    plugins. Authenticate with Authorization: Bearer <JWT> or
    X-Network-Credential: <network password or JWT>. Bearer authentication takes
    precedence when both headers are supplied. Network-scoped operations also
    require X-Network-ID. JWT permissions and network membership restrict
    access; network passwords grant full access to their network, except that
    they cannot read the audit log. Registration requires an existing
    credential; password authentication also requires its existing network ID.
    The admin endpoint requires an admin JWT. Credential verification accepts
    credentials in the request body without authentication headers.
  title: SimpleCloud Controller API
  version: '1.0'
servers:
  - url: https://controller.simplecloud.app/
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /v0/ip:
    get:
      tags:
        - network
      summary: Get your IP address
      description: >-
        Returns the caller's IP address. Production ingress must restrict
        traffic to Cloudflare because CF-Connecting-IP is trusted. Direct
        requests without that header use the socket address. No authentication
        is required.
      operationId: get_client_ip
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ClientIPResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Bad Request
components:
  schemas:
    models.ClientIPResponse:
      properties:
        ip:
          example: 203.0.113.10
          type: string
      type: object
    models.ErrorResponse:
      description: Generic error response
      properties:
        error:
          type: string
      type: object

````

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