API ReferenceHelp Center and Knowledge BaseDownload CLIGo to AppBook a Demo

Organization

get

Return all existing roles in the organization

🔒 Requires the read:organization permission

Authorizations
Responses
200

All existing roles

application/json
get
/api/v1/organization/roles
GET /api/v1/organization/roles HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "rol_abCdeFghIjklMnmP",
    "name": "Admin",
    "description": "Role for managing Admin permissions"
  }
]
get

Return information about current organization

🔒 Requires the read:organization permission

Authorizations
Responses
200

Information about organization

application/json
get
/api/v1/organization
GET /api/v1/organization HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "org_abCdeFghIjklMnmP",
  "name": "acme-corp",
  "display_name": "ACME Corp.",
  "branding": {
    "logo_url": "https://example.com/logo.png",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "org_status": "paid"
  },
  "is_trial": true,
  "created_at": "2021-01-01T00:00:00Z",
  "trial_started": "2021-01-01T00:00:00Z"
}
patch

Update current organization

🔒 Requires the update:organization permission

Authorizations
Body
namestringOptional

The organization slug, provided by Bluebricks, cannot be changed

Example: acme-corp
display_namestringOptional

The organization display name, can be changed

Example: ACME Corp.
Responses
200

Updated information about organization

application/json
patch
/api/v1/organization
PATCH /api/v1/organization HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "name": "acme-corp",
  "display_name": "ACME Corp.",
  "branding": {
    "logo_url": "https://example.com/logo.png",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "org_status": "paid"
  }
}
{
  "id": "org_abCdeFghIjklMnmP",
  "name": "acme-corp",
  "display_name": "ACME Corp.",
  "branding": {
    "logo_url": "https://example.com/logo.png",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "org_status": "paid"
  },
  "is_trial": true,
  "created_at": "2021-01-01T00:00:00Z",
  "trial_started": "2021-01-01T00:00:00Z"
}
get

Return members of current organization

🔒 Requires the read:users permission

Authorizations
Query parameters
limitnumberOptional

Results limit to allow pagination, e.g. 50

Default: 20Example: 10
offsetnumberOptional

Results offset to allow pagination e.g. 10

Default: 0Example: 10
filterstringOptional

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

searchstringOptional

Enables searching within the list for members that match a particular query. e.g. john

Responses
200

List of organization members

application/json
get
/api/v1/organization/members
GET /api/v1/organization/members HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "members": [
    {
      "id": "prov0|1234567890",
      "name": "John Doe",
      "email": "[email protected]",
      "picture": "https://example.com/profile.jpg",
      "roles": [
        {
          "id": "rol_abCdeFghIjklMnmP",
          "name": "Admin",
          "description": "Role for managing Admin permissions"
        }
      ],
      "assigned_environments": [
        {
          "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-11T03:34:50.310Z",
          "cloud_account": null
        }
      ]
    }
  ]
}
post

Invite new members current organization

🔒 Requires the create:users permission

Authorizations
Body
Responses
200

Invite details

application/json
post
/api/v1/organization/members
POST /api/v1/organization/members HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "invitees": [
    {
      "email": "[email protected]",
      "role": "rol_abCdeFghIjklMnmP"
    }
  ]
}
{
  "invites": [
    {
      "id": "uinv_abCdeFghIjklMnmP",
      "invitee": "[email protected]",
      "organization_id": "org_abCdeFghIjklMnmP",
      "invitation_url": "https://app.bluebricks.co/sign-in?..."
    }
  ],
  "errors": [
    {
      "email": "[email protected]",
      "statusCode": 404,
      "error": "NOT_FOUND",
      "message": "Role does not exist"
    }
  ]
}
delete

Remove member from current organization

🔒 Requires the delete:users permission

Authorizations
Path parameters
memberIdstringRequired

The user's unique ID e.g. prov0|1234567890

Example: prov0|1234567890
Responses
200

Status of remove request

application/json
delete
/api/v1/organization/members/{memberId}
DELETE /api/v1/organization/members/{memberId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success"
}
get

Return public encryption keys for the organization to encrypt secrets

🔒 Requires the read:organization permission

Authorizations
Responses
200

Public key data

application/json
get
/api/v1/public-keys
GET /api/v1/public-keys HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----"
}
post

Create and store managed public key for the organization to encrypt secrets

🔒 Requires the update:organization permission

Authorizations
Body
public_keystringRequired

PEM-formatted RSA public key (minimum 2048 bits)

Example: -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA... -----END PUBLIC KEY-----
key_identifierstringRequired

Cloud provider key identifier (AWS KMS ARN, Azure Key Vault URI, or GCP KMS resource name)

Example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Responses
200

Successfully created public key

application/json
post
/api/v1/public-keys
POST /api/v1/public-keys HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 213

{
  "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----",
  "key_identifier": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
}
{
  "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----",
  "key_identifier": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
  "created_at": "2025-11-11T03:34:50.310Z",
  "created_by": {
    "id": "prov0|1234567890",
    "name": "John Doe",
    "nickname": "JD",
    "picture": "https://example.com/profile.jpg"
  }
}
patch

Update organization trial status (internal API)

Path parameters
organizationIdstringRequired

The organization ID

Example: org_abCdeFghIjklMnmP
Body
is_trialbooleanRequired

Set or unset trial organization status

Responses
200

Updated trial organization status

application/json
patch
/internal-api/v1/organization/{organizationId}/trial
PATCH /internal-api/v1/organization/{organizationId}/trial HTTP/1.1
Host: api.bluebricks.co
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "is_trial": true
}
{
  "is_trial": true
}
PreviousEnvironmentsNextRescue

Last updated

Was this helpful?