Detailed information for resources

balenaCloud API Resources

Note: We recently renamed applications to fleets and are in the process of updating our API resources. Application resources continue to function correctly and can be used to work with fleets. Find out more about the changes here.

Available fields

id
created_at
is_of__actor
name
description

Examples

Get all API keys

curl -X GET \
"https://api.balena-cloud.com/v6/api_key" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>"

Get all API keys of a device by UUID

curl -X GET \
"https://api.balena-cloud.com/v6/api_key?\$filter=is_of__actor/any(a:a/is_of__device/any(d:d/uuid%20eq%20'<DEVICE_UUID>'))" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>"

Get all API keys of an application by slug

curl -X GET \
"https://api.balena-cloud.com/v6/api_key?\$filter=is_of__actor/any(a:a/is_of__application/any(ioa:ioa/slug%20eq%20'<SLUG>'))" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>"

Get all user API keys for the authenticated user

curl -X GET \
"https://api.balena-cloud.com/v6/api_key?\$filter=is_of__actor/any(a:a/is_of__user%20eq%20<USER_ID>))" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>"

Update the expiry date for an API Key

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

curl -X PATCH \
"https://api.balena-cloud.com/v6/api_key(<ID>)" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>" \
--data '{
    "expiry_date": "<ISO_8601_DATE_TIME>"
}'

Clear the expiry date of an API Key

curl -X PATCH \
"https://api.balena-cloud.com/v6/api_key(<ID>)" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>" \
--data '{
    "expiry_date": null
}'

Create new API key

curl -X POST \
"https://api.balena-cloud.com/api-key/user/full" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>" \
--data '{
    "name": "<NAME>",
    "description": "<DESCRIPTION>"
}'