---
updatedAt: 2025-11-11T22:56:00.000Z
agentTools:
  projectIndex: https://pegasus.digitalcomtech.com/llms.txt
---

# Get site info

Get site's API information

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Pegasus Cloud IoT API",
    "description": "Pegasus IoT Cloud API reference documentation. [Github Repo](https://github.com/dctdevelop/pegasus) / [Release notes](https://github.com/dctdevelop/pegasus/tree/master/releases)",
    "contact": {
      "email": "developer@digitalcomtech.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.0.12"
  },
  "servers": [
    {
      "url": "https://api.pegasusgateway.com",
      "description": "Production server"
    },
    {
      "url": "https://auth.pegasusgateway.com",
      "description": "Authentication server"
    }
  ],
  "tags": [
    {
      "name": "Authentication"
    }
  ],
  "paths": {
    "/": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "summary": "Get site info",
        "description": "Get site's API information",
        "operationId": "getApi",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseApi200"
                }
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseApi401"
                }
              }
            }
          }
        },
        "security": [
          {
            "apikeyAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "responseApi200": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "description": "Pegasus site url",
            "example": "pegasus1.pegasusgateway.com"
          },
          "name": {
            "type": "string",
            "description": "Site name",
            "example": "7.0.0"
          },
          "pegasus_id": {
            "type": "number",
            "description": "Site ID",
            "example": 1
          },
          "live_url": {
            "type": "string",
            "description": "URL of live websockets library",
            "example": "https://aws-live-1.pegasusgateway.com"
          },
          "tag": {
            "type": "string",
            "description": "Site version",
            "example": "7.0.0"
          },
          "date": {
            "type": "string",
            "description": "Date of last update on API",
            "example": "Apr 13 11:14:24 2022"
          },
          "_deprecated": {
            "type": "array",
            "description": "Deprecated fields",
            "example": [
              "live-url"
            ],
            "items": {
              "type": "string"
            }
          }
        }
      },
      "responseApi401": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "User is NOT Logged in | Authenticated"
          }
        }
      }
    },
    "securitySchemes": {
      "apikeyAuth": {
        "type": "apiKey",
        "name": "authenticate",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```