Skip to content
Download OpenAPI description
Overview
Languages
Servers
Mock server

https://docs.pers.ninja/_mock/swagger/

https://api.pers.ninja/v2/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Platform Infrastructure

Core platform infrastructure endpoints including health checks, system status, and platform configuration. Provides essential system-level operations and monitoring.
**Infrastructure Operations:**

• **Health Monitoring:** System health checks and status reporting

• **Platform Status:** Real-time platform operational status

• **Configuration Access:** System configuration and environment information

• **Diagnostic Tools:** Platform diagnostics and troubleshooting endpoints

• **System Integration:** Core infrastructure for system-level operations

Request

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/

Responses

Request

Security
projectKey and businessApiKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/healthcheck \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Check if tenant system api key is valid

Request

Check if tenant system api key is valid

Security
projectKey and businessApiKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/system \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Request

Get if admin

Security
tenantAdminJWT
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/admin \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request

Security
projectKey and businessApiKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/geolocation \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Operations
Operations
Operations
Operations
Operations