# Ping

Source: https://neondeerdata.com/docs/api/meta/ping/

Check API availability without an API key.

## Request

```http
GET /v1/ping

```

Checks that the API is up. Needs no key.

No authentication is required.

This route is available through REST only.

No request parameters are needed.

## Response

| HTTP status | Result           |
| ----------- | ---------------- |
| `200`       | The API answers. |

Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.

| Response field | Type     | Required in object | Notes |
| -------------- | -------- | ------------------ | ----- |
| `data`         | Ping     | Yes                |       |
| `data.object`  | `"ping"` | Yes                |       |
| `data.status`  | `"ok"`   | Yes                |       |

## Errors

| HTTP status | Meaning                                            |
| ----------- | -------------------------------------------------- |
| `400`       | credential_in_url: an API key was sent in the URL. |
| `429`       | rate_limited.                                      |
| `503`       | One of: service_unavailable.                       |

See [errors and recovery](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write.

The [public OpenAPI document](https://neondeerdata.com/docs/api/meta/openapi/) lists generally available API families. Alpha operations may not appear in that document; their request and response fields are listed on this page. Use the [API Playground](https://neondeerdata.com/docs/api/testing/) to inspect a real response with your connection's access.