Ping Tier 3

GET/api/pingCopied!

APIキーが有効か確認し、そのキーに紐づくワークスペースを返します。

例

SDK

const ping = await client.ping();

CLI

youvico auth ping

cURL

curl 'https://api.youvico.com/api/ping' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "data": {
    "PONG": true,
    "workspace": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Acme Inc.",
      "avatarUrl": "https://cdn.youvico.com/workspaces/acme/avatar.avif"
    }
  }
}

リクエスト

パラメーターはありません。

レスポンス

200 OK を返します。

dataobject

Ping結果

data.PONGboolean

APIキー認証が成功したかどうか

Example: true

data.workspaceobject

APIキーに紐づくワークスペース

data.workspace.idstring

ワークスペースID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

data.workspace.namestring

ワークスペース名

Example: Acme Inc.

data.workspace.avatarUrlstring?

ワークスペースアバターURL

Example: https://cdn.youvico.com/workspaces/acme/avatar.avif