Skip to main content
POST
/
api-keys
Create an API key
curl --request POST \
  --url https://app.ezyshield.com.au/api/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "abilities": []
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "token": "<string>",
      "abilities": [
        "<string>"
      ],
      "created_at": "<string>",
      "last_used_at": "<string>",
      "expires_at": "<string>"
    },
    "relationships": {
      "creator": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
include
enum<string>[]
Available options:
creator
​
fields[api-keys]
enum<string>[]
Available options:
name,
token,
abilities,
created_at,
last_used_at,
expires_at
​
fields[users]
enum<string>[]
Available options:
name,
email,
created_at,
updated_at

Body

application/json
​
name
string
required

The name of the API key.

Maximum string length: 255
​
abilities
enum<string>[]
required

The abilities/permissions granted to the API key.

A single API key ability.

Available options:
api_key:read,
api_key:write,
verification:read,
verification:write,
check:read,
check:write,
webhook_subscription:read,
webhook_subscription:write,
webhook_event:read,
aba_check:read,
aba_check:write

Response

ApiKeyResource

​
data
ApiKeyResource · object
required
​
included
UserResource · object[]