Logo

Command Palette

Search for a command to run...

GET/ping/auth
Authenticated Pingpublic

Authenticated Ping

Tests API connectivity with authentication. This endpoint verifies that the API is accessible and the OAuth token is valid, returning user and account information to confirm successful authentication.

Use Cases

  • Health Checks: Verify API availability and authentication status
  • Token Validation: Confirm OAuth tokens are still valid
  • User Context: Retrieve current user and account information
  • Integration Testing: Test authenticated API connectivity

Response Fields

  • ok - Always true for successful operations
  • message - Confirmation message with user and account IDs
  • user_id - Current user's unique identifier
  • account_id - Current account's unique identifier
  • user_name - User's display name
  • account_name - Account's display name
Related Models:UserAccount

Request

GET
/ping/auth
curl -X GET \
  "https://app.cloud66.com/api/3/ping/auth" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "ok": true,
  "message": "all good. authenticated. User ID is 123. Account ID is 456",
  "user_id": 123,
  "account_id": 456,
  "user_name": "John Doe",
  "account_name": "My Company"
}
GET/ping
Basic Ping

Basic Ping

Tests API connectivity without authentication. This endpoint verifies that the API is accessible without requiring any authentication, making it useful for checking basic API availability and network connectivity.

Use Cases

  • Health Checks: Monitor API availability without authentication
  • Network Testing: Verify network connectivity to Cloud66 API
  • Service Status: Check if the API service is running
  • Load Balancer Checks: Simple endpoint for load balancer health checks

Response Fields

  • ok - Always true for successful operations
  • message - Simple confirmation message

For authenticated connectivity testing, use the Authenticated Ping endpoint.

Request

GET
/ping
curl -X GET \
  "https://app.cloud66.com/api/3/ping" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "ok": true,
  "message": "all good. unauthenticated"
}