UNunkeyed
cli

Start CLI device login

Changed on

Starts a device login for unkey login. The response includes the user code and the dashboard URL where the user confirms it and chooses permissions. No authentication is required. Requests are rate limited per IP address.

post/v2/cli.startDeviceLogin

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/cli.startDeviceLogin
  • Auth
    none required

Request body

deviceNamestring

Hostname or other label shown on the authorize page.

Response

Device login started.

Example response

{
  "meta": {
    "requestId": "req_123"
  }
}

Changes

  • 5949ec68734aRevision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status

  • 9829df3465a0Revision changes
    • info

      endpoint added