# Ping

> Source: https://developers.cloud66.com/v3/endpoints/ping/

## Authenticated Ping

URL: https://developers.cloud66.com/v3/endpoints/ping/#auth
Endpoint: GET /ping/auth
OAuth scope: public

# 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

<Callout type="info" title="Authentication Required">
This endpoint requires valid OAuth authentication. Use `/ping` for unauthenticated connectivity testing.
</Callout>

**Related models:** User, Account

### Response

```json
{
  "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"
}
```

---

## Basic Ping

URL: https://developers.cloud66.com/v3/endpoints/ping/#basic
Endpoint: GET /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

<Callout type="info" title="No Authentication Required">
This endpoint does not require any authentication or API keys. It's designed for basic connectivity testing.
</Callout>

## Related Endpoints

For authenticated connectivity testing, use the [Authenticated Ping](/v3/endpoints/ping/auth) endpoint.

### Response

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