The Status Labels API allows you to manage the status labels that define whether assets are deployable, pending, archived, or undeployable.
List Status Labels
curl -X GET "https://your-domain.com/api/v1/statuslabels" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Number of results to return
Search string to filter results
sort
string
default:"created_at"
Column to sort by. Allowed values: id, name, assets_count, color, default_label
Filter by status type: deployable, pending, archived, undeployable
Total number of status labels
Array of status label objects
Status type: deployable, pending, archived, or undeployable
Hex color code for the label
Whether to show in navigation sidebar
Whether this is the default status label
Number of assets with this status
Get Status Label by ID
curl -X GET "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Create Status Label
curl -X POST "https://your-domain.com/api/v1/statuslabels" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"name": "Ready to Deploy",
"type": "deployable",
"color": "#00FF00",
"show_in_nav": true
}'
Status type. Allowed values: deployable, pending, archived, undeployable
Hex color code (e.g., #FF5733)
Whether to show this status in the navigation sidebar
Whether this should be the default status label for new assets
Status Types:
- deployable: Assets that can be checked out to users
- pending: Assets awaiting some action (repairs, configuration, etc.)
- archived: Assets that are no longer in active use
- undeployable: Assets that cannot be deployed (broken, lost, etc.)
Update Status Label
curl -X PATCH "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Status Name",
"color": "#0000FF"
}'
Delete Status Label
curl -X DELETE "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
A status label cannot be deleted if it has any assets assigned to it. You must first change the status of all associated assets.
Check if Deployable
curl -X GET "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}/deployable" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Get Assets by Status
curl -X GET "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}/assetlist" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Number of results to return
Get Asset Count by Status Name
curl -X GET "https://your-domain.com/api/v1/statuslabels/assets/name" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Get Asset Count by Status Type
curl -X GET "https://your-domain.com/api/v1/statuslabels/assets/type" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
