Keys

Create a key

post/keys

Request

  • Base URL: https://api.warplink.app/v1
  • URL: https://api.warplink.app/v1/keys
  • Auth: HTTP bearer

Request body

type'api' | 'sdk'

sdk creates a mobile SDK key with fixed scopes that never expires. api is the default.

namestring required
app_idstring uuid nullable

Only for sdk keys. Ties the key to one app of your organization, so it works only with the SDK and only for that app. Omit or send null for a key that works for any app. An api key cannot be tied to an app. An id that is not an app of your organization is a validation error.

scopesstring[]

Required for api keys. Ignored for sdk keys, whose scopes are fixed.

expires_atstring date-time

Must be in the future.

Response

Key created. The raw_key field is only returned once.

idstring uuid
type'api' | 'sdk'
key_prefixstring
namestring
app_idstring uuid nullable

The app an sdk key is tied to. Null for api keys and for sdk keys that work for any app.

scopesstring[]
last_used_atstring date-time nullable
expires_atstring date-time nullable
created_atstring date-time
updated_atstring date-time
raw_keystring

Example response

{
  "key_prefix": "wl_live_",
  "raw_key": "wl_live_abc123def456"
}

Changes

No recorded changes to this operation across all 1 revision of this API.