Key

List My Keys

get

Authorizations

Query parameters

include_revokedbooleanOptionalDefault: false

Responses

200

Ok

application/json

get

HTTPcURLJavaScriptPython

GET //key/v1/keys HTTP/1.1
Host: api.dev.hyphen.at
Authorization: Bearer JWT
Accept: */*

200

Ok

{
  "keys": [
    {
      "publicKey": "text",
      "accountId": "text",
      "appId": "text",
      "type": "user-key",
      "name": "Hyphen Server Key",
      "keyIndex": 0,
      "userKey": {
        "type": "device",
        "app": {
          "appId": "swirl-dev",
          "appName": "Swirl"
        },
        "device": {
          "id": "deadbeef-dead-beef-cafe-deadbeefcafe",
          "publicKey": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
          "sdkVersion": "1.0.0",
          "pushToken": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
          "name": "iPhone 14",
          "osName": "iOS",
          "osVersion": "16.2",
          "deviceManufacturer": "Apple",
          "deviceModel": "SM-265N",
          "lang": "en",
          "type": "mobile"
        }
      },
      "recoverKey": {
        "type": "icloud",
        "cloudKey": {
          "accountName": "text"
        }
      },
      "lastUsedAt": "2025-06-16T04:34:36.738Z"
    }
  ]
}

Add Recovery Key

post

Authorizations

Body

Responses

200

Ok

application/json

post

HTTPcURLJavaScriptPython

POST //key/v1/recovery HTTP/1.1
Host: api.dev.hyphen.at
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "recoveryKey": {
    "publicKey": "text",
    "cloudKey": {
      "accountName": "text"
    }
  }
}

200

Ok

{
  "keys": [
    {
      "publicKey": "text",
      "accountId": "text",
      "appId": "text",
      "type": "user-key",
      "name": "Hyphen Server Key",
      "keyIndex": 0,
      "userKey": {
        "type": "device",
        "app": {
          "appId": "swirl-dev",
          "appName": "Swirl"
        },
        "device": {
          "id": "deadbeef-dead-beef-cafe-deadbeefcafe",
          "publicKey": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
          "sdkVersion": "1.0.0",
          "pushToken": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
          "name": "iPhone 14",
          "osName": "iOS",
          "osVersion": "16.2",
          "deviceManufacturer": "Apple",
          "deviceModel": "SM-265N",
          "lang": "en",
          "type": "mobile"
        }
      },
      "recoverKey": {
        "type": "icloud",
        "cloudKey": {
          "accountName": "text"
        }
      },
      "lastUsedAt": "2025-06-16T04:34:36.738Z"
    }
  ]
}