Skip to main content
POST
/
v1
/
migrations.enqueueKeys
Enqueue key migration
curl --request POST \
  --url https://api.unkey.dev/v1/migrations.enqueueKeys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "migrationId": "<string>",
  "apiId": "<string>",
  "keys": [
    {
      "prefix": "<string>",
      "name": "my key",
      "plaintext": "<string>",
      "hash": {
        "value": "<string>",
        "variant": "sha256_base64"
      },
      "start": "unkey_32kq",
      "ownerId": "team_123",
      "meta": {
        "billingTier": "PRO",
        "trialEnds": "2023-06-16T17:16:37.161Z"
      },
      "roles": [
        "admin",
        "finance"
      ],
      "permissions": [
        "domains.create_record",
        "say_hello"
      ],
      "expires": 1623869797161,
      "remaining": 1000,
      "refill": {
        "interval": "daily",
        "amount": 100
      },
      "ratelimit": {
        "type": "fast",
        "limit": 10,
        "duration": 60000
      },
      "enabled": false,
      "environment": "<string>"
    }
  ]
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
migrationId
string
required

Contact [email protected] to receive your migration id.

​
apiId
string
required

The id of the api, you want to migrate keys to

​
keys
object[]
required
Maximum array length: 100

Response

The key ids of all created keys

The response is of type object.