---
title: "Ping the system"
method: GET
path: "/v1/ping"
tags: ["ping_endpoints"]
---

# Ping the system

`GET /v1/ping`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/v1/ping`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `ping`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/ping/get.ts> (a function with typed inputs; its response is checked against the schema)

Rate limit: 8 requests per minute.

## Headers

- `X-Store-Id` string, required: The unique identifier of the store in your app. This ID, along with the `Application ID`, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to `onboarding:905bb725-b141-4a9b-832a-1f254f772c94` (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided `internalStoreId` (a.k.a. Sku-Sku ID).
- `X-Echo-Error` string: The error message to be returned by the endpoint, for testing purposes.

## Response `200`

The ping was successfully received.

- PongObject
  - `response` string: A text response.
  - `currentTime` string, date-time: The current timestamp.

## Other responses

- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `418`: I am a teapot.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)