API Ping

System

Test API connectivity and verify authentication

GET POST /api/system/ping Auth Required

Action Cost: This tool consumes 0 actions per request.

Parameters

No parameters required.

Request Example

curl -X POST https://nisastack.com/api/system/ping \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[]'

Response Format

Success Response (200 OK)

{
  "success": true,
  "data": {
    "user": {
        "name": "John Doe",
        "email": "[email protected]"
    },
    "organization": {
        "name": "Acme Inc",
        "slug": "acme-inc",
        "role": "owner"
    }
},
  "metadata": {
    "actions_consumed": 0
  }
}

Error Response

{
  "success": false,
  "error": "Error message describing what went wrong"
}

Additional Notes

This endpoint is free (0 actions) and designed for integration testing, health checks, and verifying API credentials.

Try it out

Test this tool interactively in the playground with your own API token.