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

# Ping

> Check connectivity to the ShortPen API. Limited to 30 requests per minute per IP address.

Use this endpoint to verify that your client can reach the ShortPen API host.

<Tip>
  No authentication is required, but the route is rate limited to 30 requests per minute per IP address.
</Tip>

* Returns the plain-text string `PONG` when the service is healthy.
* Ideal for uptime probes and health checks before issuing authenticated calls.
* Because the response is not JSON, you may need to force your HTTP client to treat it as plain text.


## OpenAPI

````yaml GET /v1/ping
openapi: 3.1.0
info:
  title: ShortPen API
  version: 1.0.0
  description: >-
    Create branded links, fetch organization resources, and pull analytics
    programmatically with the ShortPen REST API.
servers:
  - url: https://{environment}.shortpen.com
    description: ShortPen API host
    variables:
      environment:
        default: api
        enum:
          - api
          - staging-api
security: []
tags:
  - name: Core
    description: Utility endpoints for checking service health.
  - name: Authentication
    description: Endpoints that return identity, limits, and feature availability.
  - name: Links
    description: Create, edit, and list links and their auxiliary assets like QR codes.
  - name: Resources
    description: >-
      Lookup supporting entities such as domains, workspaces, folders, and
      pixels.
  - name: Analytics
    description: Retrieve click analytics and raw tracking events.
paths:
  /v1/ping:
    get:
      tags:
        - Core
      summary: Ping
      description: >-
        Check connectivity to the ShortPen API. Limited to 30 requests per
        minute per IP address.
      operationId: ping
      responses:
        '200':
          description: API is reachable
          content:
            text/plain:
              schema:
                type: string
                example: PONG
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        status_code:
          type: integer
          example: 401
        message:
          type: string
          example: There was an error while processing your request.
        data:
          description: Optional payload returned for additional context.
          nullable: true
      required:
        - success
        - status_code
        - message

````