API key

Get all API keys

get

API key Resource Fields

Field
id
created_at
is_of__actor
name
description

---

GET /v7/api_key

Usage Variations

---

Get all API keys of a device by UUID

GET /v7/api_key?$filter=is_of__actor/any(a:a/is_of__device/any(d:d/uuid eq '<DEVICE_UUID>'))

---

Get all API keys of an application by slug

GET /v7/api_key?$filter=is_of__actor/any(a:a/is_of__application/any(ioa:ioa/slug eq '<SLUG>'))

---

Get all user API keys for the authenticated user

GET /v7/api_key?$filter=is_of__actor/any(a:a/is_of__user eq <USER_ID>))

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

get

/v7/api_key

HTTPcURLJavaScriptPython

GET /v7/api_key HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Update the expiry date for an API Key

patch

PATCH /v7/api_key(<ID>)

Request Body:

{
    "expiry_date": <ISO_8601_DATE_TIME>
}

Note: Select a date in the past to expire an API Key immediately.

Usage Variations

---

Clear the expiry date of an API Key

PATCH /v7/api_key(<ID>)

Request Body:

{
    "expiry_date": null
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

Body

application/json

objectOptional

patch

/v7/api_key({ID})

HTTPcURLJavaScriptPython

PATCH /v7/api_key({ID}) HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "expiry_date": "<ISO_8601_DATE_TIME>"
}

Update the expiry date for an API KeyClear the expiry date of an API Key

Create new API key

post

POST /api-key/user/full

Request Body:

{
    "name": <NAME>,
    "description": <DESCRIPTION>
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

post

/api-key/user/full

HTTPcURLJavaScriptPython

POST /api-key/user/full HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "name": "<NAME>",
  "description": "<DESCRIPTION>"
}