Graph

get

Return direct descendants of a provided node

🔒 Requires the read:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typestring · enumRequired

The type of provided node to retrieve edges for:

collection - edges will consist of blueprint nodes based on deployments for provided collection id
deployment - edges will consist of blueprint nodes for provided deployment id
blueprint - edges will consist of either blueprint nodes (if nested under provided blueprint) or property nodes for provided blueprint id.

Possible values:

idstringRequired

Graph node id to retrieve edges for

Responses

200

List of edges for provided node

application/json

400

Failed to get edges for provided graph node

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment permission

application/json

404

Graph node not found

application/json

429

Too many requests

application/json

get

/api/v1/graph/edges/{type}/{id}

GET /api/v1/graph/edges/{type}/{id} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "nodes": [
    {
      "type": "ENVIRONMENT",
      "childCount": 1,
      "id": "f27d96be-c486-4075-a926-0ee96775119e",
      "slug": "production-europe",
      "name": "Production Europe",
      "color": "#0000ff",
      "allow_pre_release": false,
      "is_default": true,
      "enabled_policies": [
        "require_owner_approval"
      ],
      "is_active": true,
      "is_deleted": true,
      "created": "2026-03-03T03:20:08.986Z",
      "users": [
        {
          "id": "prov0|1234567890",
          "name": "John Doe",
          "email": "johndoe@mail.com",
          "nickname": "JD",
          "picture": "https://example.com/profile.jpg",
          "roles": [
            {
              "id": "rol_abCdeFghIjklMnmP",
              "name": "Admin",
              "description": "Role for managing Admin permissions"
            }
          ],
          "membership_role": "member"
        }
      ],
      "cloud_account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Production Europe",
        "provider": "aws",
        "type": "execution",
        "slug": "production-europe",
        "is_active": true,
        "is_deleted": false,
        "created": "2026-03-03T03:20:08.986Z",
        "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",
          "tenant_id": "text",
          "subscription_id": "text",
          "federated_app_client_id": "text",
          "oidc_issuer_url": "https://example.com",
          "oidc_audience": "text",
          "client_secret": "text",
          "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"
      },
      "discovery_cloud_account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Production Europe",
        "provider": "aws",
        "type": "execution",
        "slug": "production-europe",
        "is_active": true,
        "is_deleted": false,
        "created": "2026-03-03T03:20:08.986Z",
        "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",
          "tenant_id": "text",
          "subscription_id": "text",
          "federated_app_client_id": "text",
          "oidc_issuer_url": "https://example.com",
          "oidc_audience": "text",
          "client_secret": "text",
          "cluster_name": "text",
          "service_account_namespace": "text",
          "service_account_name": "text",
          "cluster_oidc_url": "https://example.com",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ]
}

get

Return properties of a provided node alongside with its siblings and parent recursively to the beginning of the graph

🔒 Requires the read:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typestring · enumRequired

The type of provided node to retrieve details for:

collection - response will consist of collection details for provided id alongside with its siblings
deployment - response will consist of deployment details for provided id alongside with its siblings within same collection, parent collection and its siblings
blueprint - response will consist of blueprint details for provided id alongside with its siblings within same deployment, parent deployment, parent collection and their siblings correspondingly
property - response will consist of property details for provided id alongside with its siblings within same blueprint, parent blueprint, parent deployment, parent collection and its siblings correspondingly

Possible values:

idstringRequired

Graph node id to retrieve details, siblings and parent for

Query parameters

no_siblingsbooleanOptional

If true, response will not include siblings of provided and parent nodes

Default: false

Responses

200

Detailed node information with graph relations

application/json

400

Failed to get node details

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment permission

application/json

404

Graph node not found

application/json

429

Too many requests

application/json

get

/api/v1/graph/{type}/{id}

GET /api/v1/graph/{type}/{id} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "node": {
    "type": "ENVIRONMENT",
    "childCount": 1,
    "id": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "name": "Production Europe",
    "color": "#0000ff",
    "allow_pre_release": false,
    "is_default": true,
    "enabled_policies": [
      "require_owner_approval"
    ],
    "is_active": true,
    "is_deleted": true,
    "created": "2026-03-03T03:20:08.986Z",
    "users": [
      {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "email": "johndoe@mail.com",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg",
        "roles": [
          {
            "id": "rol_abCdeFghIjklMnmP",
            "name": "Admin",
            "description": "Role for managing Admin permissions"
          }
        ],
        "membership_role": "member"
      }
    ],
    "cloud_account": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "type": "execution",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2026-03-03T03:20:08.986Z",
      "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",
        "tenant_id": "text",
        "subscription_id": "text",
        "federated_app_client_id": "text",
        "oidc_issuer_url": "https://example.com",
        "oidc_audience": "text",
        "client_secret": "text",
        "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"
    },
    "discovery_cloud_account": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "type": "execution",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2026-03-03T03:20:08.986Z",
      "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",
        "tenant_id": "text",
        "subscription_id": "text",
        "federated_app_client_id": "text",
        "oidc_issuer_url": "https://example.com",
        "oidc_audience": "text",
        "client_secret": "text",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "siblings": [
    {
      "type": "ENVIRONMENT",
      "childCount": 1,
      "id": "f27d96be-c486-4075-a926-0ee96775119e",
      "slug": "production-europe",
      "name": "Production Europe",
      "color": "#0000ff",
      "allow_pre_release": false,
      "is_default": true,
      "enabled_policies": [
        "require_owner_approval"
      ],
      "is_active": true,
      "is_deleted": true,
      "created": "2026-03-03T03:20:08.986Z",
      "users": [
        {
          "id": "prov0|1234567890",
          "name": "John Doe",
          "email": "johndoe@mail.com",
          "nickname": "JD",
          "picture": "https://example.com/profile.jpg",
          "roles": [
            {
              "id": "rol_abCdeFghIjklMnmP",
              "name": "Admin",
              "description": "Role for managing Admin permissions"
            }
          ],
          "membership_role": "member"
        }
      ],
      "cloud_account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Production Europe",
        "provider": "aws",
        "type": "execution",
        "slug": "production-europe",
        "is_active": true,
        "is_deleted": false,
        "created": "2026-03-03T03:20:08.986Z",
        "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",
          "tenant_id": "text",
          "subscription_id": "text",
          "federated_app_client_id": "text",
          "oidc_issuer_url": "https://example.com",
          "oidc_audience": "text",
          "client_secret": "text",
          "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"
      },
      "discovery_cloud_account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Production Europe",
        "provider": "aws",
        "type": "execution",
        "slug": "production-europe",
        "is_active": true,
        "is_deleted": false,
        "created": "2026-03-03T03:20:08.986Z",
        "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",
          "tenant_id": "text",
          "subscription_id": "text",
          "federated_app_client_id": "text",
          "oidc_issuer_url": "https://example.com",
          "oidc_audience": "text",
          "client_secret": "text",
          "cluster_name": "text",
          "service_account_namespace": "text",
          "service_account_name": "text",
          "cluster_oidc_url": "https://example.com",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "parent": null
}

get

Return all nodes for provided type

🔒 Requires the read:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typestring · enumRequired

Node type

Possible values:

Query parameters

filterstringOptional

Structure: [key1=value1,key2=value2&value3]

searchstringOptional

Enables searching within the list of node names that match a particular querye.g. my_collection

Responses

200

List of nodes for provided type

application/json

400

Failed to get graph nodes

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment permission

application/json

429

Too many requests

application/json

get

/api/v1/graph/{type}

GET /api/v1/graph/{type} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "nodes": [
    {
      "type": "ENVIRONMENT",
      "childCount": 1,
      "id": "f27d96be-c486-4075-a926-0ee96775119e",
      "slug": "production-europe",
      "name": "Production Europe",
      "color": "#0000ff",
      "allow_pre_release": false,
      "is_default": true,
      "enabled_policies": [
        "require_owner_approval"
      ],
      "is_active": true,
      "is_deleted": true,
      "created": "2026-03-03T03:20:08.986Z",
      "users": [
        {
          "id": "prov0|1234567890",
          "name": "John Doe",
          "email": "johndoe@mail.com",
          "nickname": "JD",
          "picture": "https://example.com/profile.jpg",
          "roles": [
            {
              "id": "rol_abCdeFghIjklMnmP",
              "name": "Admin",
              "description": "Role for managing Admin permissions"
            }
          ],
          "membership_role": "member"
        }
      ],
      "cloud_account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Production Europe",
        "provider": "aws",
        "type": "execution",
        "slug": "production-europe",
        "is_active": true,
        "is_deleted": false,
        "created": "2026-03-03T03:20:08.986Z",
        "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",
          "tenant_id": "text",
          "subscription_id": "text",
          "federated_app_client_id": "text",
          "oidc_issuer_url": "https://example.com",
          "oidc_audience": "text",
          "client_secret": "text",
          "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"
      },
      "discovery_cloud_account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Production Europe",
        "provider": "aws",
        "type": "execution",
        "slug": "production-europe",
        "is_active": true,
        "is_deleted": false,
        "created": "2026-03-03T03:20:08.986Z",
        "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",
          "tenant_id": "text",
          "subscription_id": "text",
          "federated_app_client_id": "text",
          "oidc_issuer_url": "https://example.com",
          "oidc_audience": "text",
          "client_secret": "text",
          "cluster_name": "text",
          "service_account_namespace": "text",
          "service_account_name": "text",
          "cluster_oidc_url": "https://example.com",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ]
}

post

Import state from a file

🔒 Requires the create:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

state_filestring · binaryRequired

State file to import

Example: state_file=@path/to/tfstate.json

deployment_namestringOptional

Deployment name for imported state (optional)

Responses

200

Imported state node details

application/json

400

Failed to import state

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:environment permission

application/json

409

Imported state with provided name already exists

application/json

429

Too many requests

application/json

post

/api/v1/graph/state/import

POST /api/v1/graph/state/import HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 74

{
  "state_file": "state_file=@path/to/tfstate.json",
  "deployment_name": "text"
}

{
  "type": "BLUEPRINT",
  "id": "text",
  "name": "@bluebricks/aws-vpc",
  "version": "1.2.3",
  "relativeId": 1,
  "packageUniqueId": "text",
  "packageType": "blueprint",
  "created": "2026-03-03T03:20:08.986Z",
  "timestamp": "2026-03-03T03:20:08.986Z",
  "iacType": [
    "terraform"
  ],
  "deployment": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "text",
    "stage": "pending",
    "task": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "collection": {
        "id": "f27d96be-c486-4075-a926-0ee96775119e",
        "name": "Production Europe"
      }
    }
  }
}

delete

Delete imported state

🔒 Requires the update:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

deployment_idstringRequired

Deployment id to delete imported state

Responses

200

State deleted successfully

application/json

400

Failed to delete imported state

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment permission

application/json

404

Imported state not found

application/json

429

Too many requests

application/json

delete

/api/v1/graph/state/delete

DELETE /api/v1/graph/state/delete HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "deployment_id": "text"
}

No content

PreviousGit Repositories NextOrganization

Last updated 3 months ago

Was this helpful?