---
updatedAt: 2025-06-05T21:08:15.000Z
agentTools:
  projectIndex: https://docs.securitytrails.com/llms.txt
---

# Ping

You can use this simple endpoint to test your authentication and access to the SecurityTrails API.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "SecurityTrails API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.securitytrails.com/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/ping": {
      "get": {
        "summary": "Ping",
        "description": "You can use this simple endpoint to test your authentication and access to the SecurityTrails API.",
        "operationId": "ping-old",
        "parameters": [
          {
            "name": "apikey",
            "in": "query",
            "description": "Your SecurityTrails API key. See [authentication documentation](doc:authentication)",
            "schema": {
              "type": "string",
              "default": "your_api_key"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": true\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"message\": \"Invalid API key\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Invalid API key"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "429",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"message\": \"API rate limit exceeded\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "API rate limit exceeded"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```