GET

/api/v1/check

指定されたドメインが有効なMisskeyインスタンスかどうかを確認します。

Query Parameters

Parameter	Type	Required	Description
domain	string	true	確認対象のドメイン

Response

{
  "is_misskey": true,
  "data": {
    "name": "Misskey.Example",
    "version": "2024.1.0",
    "icon": "https://media.example.com/assets/icon.png",
    "banner": "https://media.example.com/assets/banner.jpg",
    "softwareName": "misskey",
    "description": "Misskey Example"
  },
  "is_embeddable": true,
  "source": "database"
}

Fields

Field	Type	Description
is_misskey	boolean	Misskeyインスタンスかどうか
is_embeddable	boolean	埋め込みに対応しているか
data	object \| null	インスタンス情報(is_misskey=true時)
.name	string	インスタンス名
.version	string	バージョン
.icon	string \| null	アイコンURL
.banner	string \| null	バナーURL
.softwareName	string \| null	ソフトウェア名
.description	string \| null	インスタンス説明
reason	string \| null	非Misskey判定時の理由
source	database \| fetch	情報の取得元 (database: DBキャッシュ, fetch: 外部取得)
error	string \| null	エラーメッセージ

Example

cURL

curl "https://servers.misskey.ink/api/v1/check?domain=example.com"