Get Your API Key - {Un}pack API Documentation

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

$schema

string <uri>

read-onlyoptional

A URL to the JSON Schema for this object.

Example:

https://api.unpack.dev/schemas/Key.json

createdAt

string <date-time>

required

Creation timestamp of the API key

enabled

boolean

required

Indicates whether the API key is enabled

id

string

required

Unique identifier of the API key

key

string

required

The actual API key string

label

string

required

Label or name assigned to the API key

profileId

string

required

Reference identifier to the user id

rateLimit

integer <int32>

required

Rate limit applied to the API key

rateLimitDuration

string

required

Duration of the rate limit (e.g., second, minute, hour)

roles

array[string]

required

Roles associated with the API key

suspended

boolean

required

Indicates whether the API key is suspended

updatedAt

string <date-time>

required

Last update timestamp of the API key

Example

{
  "$schema": "https://api.unpack.dev/schemas/Key.json",
  "createdAt": "2019-08-24T14:15:22Z",
  "enabled": true,
  "id": "string",
  "key": "string",
  "label": "string",
  "profileId": "string",
  "rateLimit": 0,
  "rateLimitDuration": "string",
  "roles": [
    "string"
  ],
  "suspended": true,
  "updatedAt": "2019-08-24T14:15:22Z"
}

🔴500Error