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

# Site Status



## OpenAPI

````yaml POST /up
openapi: 3.1.0
info:
  title: Geekflare
  description: Official OpenAPI specification for all Geekflare endpoints.
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://api.geekflare.com
security:
  - x-api-key: []
paths:
  /up:
    post:
      tags:
        - api-tool
      summary: Check if a site is up or down
      operationId: siteStatus
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteStatusDto'
      responses:
        '200':
          description: Site status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteStatusResponseDto'
        '400':
          description: Invalid URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseErrorResponseDto'
              example:
                timestamp: 1700000000000
                apiStatus: failure
                apiCode: 400
                message: INVALID_URL
                details: The URL must be a valid HTTP or HTTPS URL.
        '429':
          description: Too many redirects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseErrorResponseDto'
              example:
                timestamp: 1700000000000
                apiStatus: failure
                apiCode: 429
                message: TOO_MANY_REDIRECTS
                details: >-
                  Exceeded the maximum number of redirects while checking the
                  target website.
        '500':
          description: Site status check failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseErrorResponseDto'
              example:
                timestamp: 1700000000000
                apiStatus: failure
                apiCode: 500
                message: SITE_STATUS_FAILED
                details: >-
                  Failed to determine the availability or status of the target
                  website.
components:
  schemas:
    SiteStatusDto:
      type: object
      properties:
        url:
          type: string
          description: Target URL
          example: https://example.com
        followRedirect:
          type: boolean
          description: Whether to follow redirects when checking site status
          example: false
          default: false
        proxyCountry:
          type: string
          description: Proxy country code to route the request
          example: us
      required:
        - url
    SiteStatusResponseDto:
      type: object
      properties:
        timestamp:
          type: number
          description: Timestamp of the request in milliseconds
          example: 1783943217189
        apiStatus:
          type: string
          description: API status message
          example: success
          enum:
            - success
            - failure
        apiCode:
          type: number
          description: API status code
          example: 200
        message:
          type: string
          description: >-
            Indicates the current status of the site. It can either be "Site is
            up" or "Unable to reach the URL."
          example: Site is up
        meta:
          description: Metadata about the site status check.
          example:
            url: example.com
            proxyCountry: US
            followRedirect: true
            redirectedURL: https://www.example.com
            test:
              id: zmkqoxxu075dwn4u61yoqhq2rwo0029m
          allOf:
            - $ref: '#/components/schemas/SiteStatusMetaDto'
        data:
          type: object
          description: HTTP status information from the site check.
          example:
            statusCode: 200
            reasonPhrase: OK
      required:
        - timestamp
        - apiStatus
        - apiCode
        - message
        - meta
        - data
    BaseErrorResponseDto:
      type: object
      properties:
        timestamp:
          type: number
          description: Timestamp of the request in milliseconds
          example: 1778737930991
        apiStatus:
          type: string
          description: API status message
          example: success
          enum:
            - success
            - failure
        apiCode:
          type: number
          description: API status code
          example: 200
        message:
          type: string
          description: Error message
          example: Invalid URL provided
        details:
          type: string
          description: Detailed error information
          example: The URL must be a valid HTTP or HTTPS URL
      required:
        - timestamp
        - apiStatus
        - apiCode
        - message
    SiteStatusMetaDto:
      type: object
      properties:
        url:
          type: string
          description: The target URL checked
          example: https://example.com
        followRedirect:
          type: boolean
          description: Whether redirects were followed
          example: true
        redirectedURL:
          type: object
          description: Final redirected URL (if applicable)
          example: https://www.example.com/home
        proxyCountry:
          type: string
          description: Proxy country used (if any)
          example: US
        test:
          description: Test details object
          allOf:
            - $ref: '#/components/schemas/TestMetaDto'
      required:
        - url
        - followRedirect
        - proxyCountry
        - test
    TestMetaDto:
      type: object
      properties:
        id:
          type: string
          description: Unique test identifier
          example: mxqx9v9y0742lap6altwdteqd28t23nq
      required:
        - id
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key required for all endpoints

````