Tasks
Return task information
The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
Task details
Failed to get task details
Failed to authenticate runtime
Task not found
Too many requests
GET /api/v1/task/{taskId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Basic username:password
Accept: */*
{
"taskId": "123e4567-e89b-12d3-a456-426614174000",
"command": "force_install",
"planOnly": true,
"user": "text",
"organization": "text",
"stage": "pending",
"environment": {
"id": "f27d96be-c486-4075-a926-0ee96775119e",
"slug": "production-europe",
"name": "Production Europe",
"color": "#0000ff",
"allow_pre_release": false,
"is_default": true,
"is_active": true,
"is_deleted": true,
"created": "2025-11-11T15:54:19.923Z",
"users": [
{
"id": "prov0|1234567890",
"name": "John Doe",
"email": "[email protected]",
"nickname": "JD",
"picture": "https://example.com/profile.jpg",
"roles": [
{
"id": "rol_abCdeFghIjklMnmP",
"name": "Admin",
"description": "Role for managing Admin permissions"
}
]
}
],
"cloud_account": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Production Europe",
"provider": "aws",
"slug": "production-europe",
"is_active": true,
"is_deleted": false,
"created": "2025-11-11T15:54:19.923Z",
"cloud_account": "123456789012",
"assume_role_arn": "arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF",
"external_id": "abcdef-ghijklm",
"cloud_config": {
"service_account_email": "sa@project_id.iam.gserviceaccount.com",
"scopes": "https://www.googleapis.com/auth/cloud-platform",
"cluster_name": "text",
"service_account_namespace": "text",
"service_account_name": "text",
"cluster_oidc_url": "https://example.com",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_primary": true,
"profile": "secrets-manager"
}
},
"props": null,
"secrets": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"decryptionKeyId": null,
"deployments": [
{
"guid": "123e4567-e89b-12d3-a456-426614174000",
"parent": null,
"taskId": "123e4567-e89b-12d3-a456-426614174000",
"depend": null,
"stage": "pending",
"type": "blueprint",
"plan_file": null,
"state_file": null,
"origin_state_location": null,
"slug": null,
"package": {
"qualified_name": "text",
"url": null,
"version": "text",
"uniqueId": "text"
}
}
]
}Delete task and deployments
🔒 Requires the delete:deployment permission
The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
Task deleted with related deployments
Failed to delete task and deployments
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:deployment permission
Task not found
Too many requests
DELETE /api/v1/task/{taskId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"task": "123e4567-e89b-12d3-a456-426614174000",
"deployments": [
"123e4567-e89b-12d3-a456-426614174000"
]
}Return a task's status
🔒 Requires the read:task permission
The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
If true, return elaborated version of the status. Otherwise, return a summarized version
Task details
Failed to get task status
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:task permission
Task not found
Too many requests
GET /api/v1/task/{taskId}/status HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"task": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"command": "force_install",
"planOnly": true,
"deployments": {
"total": 1,
"states": {
"pending": 1,
"planning": 1,
"no_change": 1,
"planned": 1,
"plan_approved": 1,
"installing": 1,
"canceled": 1,
"completed": 1,
"error": 1
}
},
"statusTimestamps": {
"pending": "2025-11-11T15:54:19.923Z",
"planning": "2025-11-11T15:54:19.923Z",
"no_change": "2025-11-11T15:54:19.923Z",
"planned": "2025-11-11T15:54:19.923Z",
"plan_approved": "2025-11-11T15:54:19.923Z",
"installing": "2025-11-11T15:54:19.923Z",
"completed": "2025-11-11T15:54:19.923Z",
"canceled": "2025-11-11T15:54:19.923Z",
"error": "2025-11-11T15:54:19.923Z"
},
"errors": null,
"created": "2025-11-11T15:54:19.923Z",
"updated": null,
"completed": null
}Update task status
The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
If true, return elaborated version of the status. Otherwise, return a summarized version
Task details
Failed to update task status
Failed to authenticate runtime
Task not found
Too many requests
POST /api/v1/task/{taskId}/status HTTP/1.1
Host: api.bluebricks.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"status": "pending",
"error": "text"
}{
"task": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"deployments": {
"total": 1,
"states": {
"pending": 1,
"planning": 1,
"no_change": 1,
"planned": 1,
"plan_approved": 1,
"installing": 1,
"canceled": 1,
"completed": 1,
"error": 1
}
},
"created": "2025-11-11T15:54:19.923Z",
"updated": null,
"completed": null
}Return task information
The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
Inserted deployment ids
Failed to insert deployments
Failed to authenticate runtime
Task not found
Deployment already exists
Too many requests
POST /api/v1/task/{taskId}/deployments HTTP/1.1
Host: api.bluebricks.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 185
[
{
"package": {
"name": "my-app",
"version": "1.2.3",
"uniqueId": "my-unique-id",
"type": "blueprint"
},
"dependencies": {
"direct": "my-dependent-app"
},
"parent": null,
"action": "pending",
"payload": {}
}
][
{
"deployment": "123e4567-e89b-12d3-a456-426614174000"
}
]Return pending tasks
Pending tasks list
Failed to get pending tasks
Failed to authenticate runtime
Too many requests
GET /api/v1/tasks HTTP/1.1
Host: api.bluebricks.co
Authorization: Basic username:password
Accept: */*
[
{
"taskId": "123e4567-e89b-12d3-a456-426614174000",
"token": null,
"stage": "pending"
}
]Last updated
Was this helpful?