Download OpenAPI specification:Download
Brainboard API documentation
List all available architecture templates.
approved | boolean |
object (model.User) | |
clone_count | integer |
cloud_provider | string Enum: "aws" "azurerm" "google" "scaleway" "oci" "azuread" "azuredevops" "azurestack" "kubernetes" "databricks" "" Filled during the clone process |
object (JSON) | |
created_at | string |
created_by | string <uuid> |
current_version_id | string <uuid> |
description | string |
environment | string <uuid> |
import_type | string (model.ImportType) Enum: "git" "files" "brainboard" "cloud" "ai" |
imported | boolean |
name | string |
project | string <uuid> |
object (hcl.ProviderConfigs) | |
readme | string |
object (ArchitectureRevision) | |
snapshot_url | string |
status | string |
synced | boolean |
object (JSON) | |
tags | Array of strings |
template | boolean |
terraform_binary | string |
object (hcl.TerraformConfig) | |
terraform_provider | string todo: remove after migration |
terraform_version | string |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
object (FlattenJSON) | |
visibility | string (brainboard_co_brainboard_pkg_domain_security_visibility.Visibility) Enum: "public" "organization" |
[- {
- "approved": true,
- "author": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "clone_count": 0,
- "cloud_provider": "aws",
- "cloud_providers_version": { },
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "current_version_id": "158beffb-f9de-457f-bbee-873740e72504",
- "description": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "import_type": "git",
- "imported": true,
- "name": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "provider_configs": {
- "property1": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
], - "property2": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
]
}, - "readme": "string",
- "revision": {
- "architecture_id": "string",
- "connectors": {
- "property1": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}, - "property2": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}
}, - "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "message": "string",
- "nodes": {
- "property1": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}, - "property2": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}
}, - "reverted": true,
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "snapshot_url": "string",
- "status": "string",
- "synced": true,
- "synced_architectures": { },
- "tags": [
- "string"
], - "template": true,
- "terraform_binary": "string",
- "terraform_config": {
- "required_providers": {
- "property1": {
- "source": "string",
- "version": "string"
}, - "property2": {
- "source": "string",
- "version": "string"
}
}
}, - "terraform_provider": "string",
- "terraform_version": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "variable_settings": {
- "property1": "string",
- "property2": "string"
}, - "visibility": "public"
}
]
Creates a new architecture template.
CloneArchitecture Request
architecture required | string <uuid> source architecture or template ID |
description | string new architecture description |
name required | string new architecture name |
visibility required | string Enum: "public" "organization" architecture template visibility |
approved | boolean |
object (model.User) | |
clone_count | integer |
cloud_provider | string Enum: "aws" "azurerm" "google" "scaleway" "oci" "azuread" "azuredevops" "azurestack" "kubernetes" "databricks" "" Filled during the clone process |
object (JSON) | |
created_at | string |
created_by | string <uuid> |
current_version_id | string <uuid> |
description | string |
environment | string <uuid> |
import_type | string (model.ImportType) Enum: "git" "files" "brainboard" "cloud" "ai" |
imported | boolean |
name | string |
project | string <uuid> |
object (hcl.ProviderConfigs) | |
readme | string |
object (ArchitectureRevision) | |
snapshot_url | string |
status | string |
synced | boolean |
object (JSON) | |
tags | Array of strings |
template | boolean |
terraform_binary | string |
object (hcl.TerraformConfig) | |
terraform_provider | string todo: remove after migration |
terraform_version | string |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
object (FlattenJSON) | |
visibility | string (brainboard_co_brainboard_pkg_domain_security_visibility.Visibility) Enum: "public" "organization" |
{- "architecture": "7638ff16-0349-4686-bf45-5444f117cc0c",
- "description": "string",
- "name": "string",
- "visibility": "public"
}
{- "approved": true,
- "author": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "clone_count": 0,
- "cloud_provider": "aws",
- "cloud_providers_version": { },
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "current_version_id": "158beffb-f9de-457f-bbee-873740e72504",
- "description": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "import_type": "git",
- "imported": true,
- "name": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "provider_configs": {
- "property1": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
], - "property2": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
]
}, - "readme": "string",
- "revision": {
- "architecture_id": "string",
- "connectors": {
- "property1": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}, - "property2": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}
}, - "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "message": "string",
- "nodes": {
- "property1": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}, - "property2": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}
}, - "reverted": true,
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "snapshot_url": "string",
- "status": "string",
- "synced": true,
- "synced_architectures": { },
- "tags": [
- "string"
], - "template": true,
- "terraform_binary": "string",
- "terraform_config": {
- "required_providers": {
- "property1": {
- "source": "string",
- "version": "string"
}, - "property2": {
- "source": "string",
- "version": "string"
}
}
}, - "terraform_provider": "string",
- "terraform_version": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "variable_settings": {
- "property1": "string",
- "property2": "string"
}, - "visibility": "public"
}
This endpoint clones an architecture from a template.
architectureUUID required | string Architecture Template UUID |
CloneArchitecture Request
description | string new architecture description |
environment required | string <uuid> parent environment ID |
name required | string new architecture name |
project required | string <uuid> parent project ID |
object list of variables to override the cloned architecture variables | |
workflow_template | string <uuid> workflow template ID |
object The new architecture | |
object The new workflow if workflow_template was defined in the request, null otherwise |
{- "description": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "name": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "variable_values": {
- "property1": "string",
- "property2": "string"
}, - "workflow_template": "098a1f63-b575-4217-9b55-44bb5bf1744b"
}
{- "architecture": {
- "approved": true,
- "author": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "clone_count": 0,
- "cloud_provider": "aws",
- "cloud_providers_version": { },
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "current_version_id": "158beffb-f9de-457f-bbee-873740e72504",
- "description": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "import_type": "git",
- "imported": true,
- "name": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "provider_configs": {
- "property1": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
], - "property2": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
]
}, - "readme": "string",
- "revision": {
- "architecture_id": "string",
- "connectors": {
- "property1": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}, - "property2": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}
}, - "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "message": "string",
- "nodes": {
- "property1": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}, - "property2": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}
}, - "reverted": true,
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "snapshot_url": "string",
- "status": "string",
- "synced": true,
- "synced_architectures": { },
- "tags": [
- "string"
], - "template": true,
- "terraform_binary": "string",
- "terraform_config": {
- "required_providers": {
- "property1": {
- "source": "string",
- "version": "string"
}, - "property2": {
- "source": "string",
- "version": "string"
}
}
}, - "terraform_provider": "string",
- "terraform_version": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "variable_settings": {
- "property1": "string",
- "property2": "string"
}, - "visibility": "public"
}, - "workflow": {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "editor": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "notification_recipients": [
- "string"
], - "notify_on_failure": true,
- "tasks": [
- {
- "action": "string",
- "arguments": {
- "property1": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}, - "property2": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}
}, - "depends_on": [
- "string"
], - "graphics": {
- "x": 0,
- "y": 0
}, - "title": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "title": "string",
- "triggers": {
- "property1": "string",
- "property2": "string"
}, - "type": "one_action",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
Creates a new architecture cloned from a source architecture.
architectureUUID required | string Architecture ID |
CloneArchitecture Request
description | string new architecture description |
environment required | string <uuid> parent environment ID |
name required | string new architecture name |
project required | string <uuid> parent project ID |
synced | boolean Set to true to sync the cloned architecture with the source architecture |
object list of variables to override the cloned architecture variables | |
workflow_template | string <uuid> workflow template ID |
approved | boolean |
object (model.User) | |
clone_count | integer |
cloud_provider | string Enum: "aws" "azurerm" "google" "scaleway" "oci" "azuread" "azuredevops" "azurestack" "kubernetes" "databricks" "" Filled during the clone process |
object (JSON) | |
created_at | string |
created_by | string <uuid> |
current_version_id | string <uuid> |
description | string |
environment | string <uuid> |
import_type | string (model.ImportType) Enum: "git" "files" "brainboard" "cloud" "ai" |
imported | boolean |
name | string |
project | string <uuid> |
object (hcl.ProviderConfigs) | |
readme | string |
object (ArchitectureRevision) | |
snapshot_url | string |
status | string |
synced | boolean |
object (JSON) | |
tags | Array of strings |
template | boolean |
terraform_binary | string |
object (hcl.TerraformConfig) | |
terraform_provider | string todo: remove after migration |
terraform_version | string |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
object (FlattenJSON) | |
visibility | string (brainboard_co_brainboard_pkg_domain_security_visibility.Visibility) Enum: "public" "organization" |
{- "description": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "name": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "synced": true,
- "variable_values": {
- "property1": "string",
- "property2": "string"
}, - "workflow_template": "098a1f63-b575-4217-9b55-44bb5bf1744b"
}
{- "approved": true,
- "author": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "clone_count": 0,
- "cloud_provider": "aws",
- "cloud_providers_version": { },
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "current_version_id": "158beffb-f9de-457f-bbee-873740e72504",
- "description": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "import_type": "git",
- "imported": true,
- "name": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "provider_configs": {
- "property1": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
], - "property2": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
]
}, - "readme": "string",
- "revision": {
- "architecture_id": "string",
- "connectors": {
- "property1": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}, - "property2": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}
}, - "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "message": "string",
- "nodes": {
- "property1": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}, - "property2": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}
}, - "reverted": true,
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "snapshot_url": "string",
- "status": "string",
- "synced": true,
- "synced_architectures": { },
- "tags": [
- "string"
], - "template": true,
- "terraform_binary": "string",
- "terraform_config": {
- "required_providers": {
- "property1": {
- "source": "string",
- "version": "string"
}, - "property2": {
- "source": "string",
- "version": "string"
}
}
}, - "terraform_provider": "string",
- "terraform_version": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "variable_settings": {
- "property1": "string",
- "property2": "string"
}, - "visibility": "public"
}
List all architectures from a parent environment.
environmentUUID required | string Environment ID |
approved | boolean |
object (model.User) | |
clone_count | integer |
cloud_provider | string Enum: "aws" "azurerm" "google" "scaleway" "oci" "azuread" "azuredevops" "azurestack" "kubernetes" "databricks" "" Filled during the clone process |
object (JSON) | |
created_at | string |
created_by | string <uuid> |
current_version_id | string <uuid> |
description | string |
environment | string <uuid> |
import_type | string (model.ImportType) Enum: "git" "files" "brainboard" "cloud" "ai" |
imported | boolean |
name | string |
project | string <uuid> |
object (hcl.ProviderConfigs) | |
readme | string |
object (ArchitectureRevision) | |
snapshot_url | string |
status | string |
synced | boolean |
object (JSON) | |
tags | Array of strings |
template | boolean |
terraform_binary | string |
object (hcl.TerraformConfig) | |
terraform_provider | string todo: remove after migration |
terraform_version | string |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
object (FlattenJSON) | |
visibility | string (brainboard_co_brainboard_pkg_domain_security_visibility.Visibility) Enum: "public" "organization" |
[- {
- "approved": true,
- "author": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "clone_count": 0,
- "cloud_provider": "aws",
- "cloud_providers_version": { },
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "current_version_id": "158beffb-f9de-457f-bbee-873740e72504",
- "description": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "import_type": "git",
- "imported": true,
- "name": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "provider_configs": {
- "property1": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
], - "property2": [
- {
- "alias": "string",
- "attributes": { },
- "blocks": {
- "property1": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "attributes": { },
- "blocks": {
- "property1": { },
- "property2": { }
}
}
}
}
]
}, - "readme": "string",
- "revision": {
- "architecture_id": "string",
- "connectors": {
- "property1": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}, - "property2": {
- "automatic": true,
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "label": {
- "graphics": {
- "color": 0,
- "fontSize": "string"
}, - "offset": {
- "x": 0,
- "y": 0
}, - "pathPercentage": 0,
- "text": "string"
}, - "metadata": {
- "terraform_reference": "string"
}, - "points": [
- {
- "floating": true,
- "node": {
- "anchor": "north",
- "id": "string"
}, - "x": 0,
- "y": 0
}
]
}
}, - "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "message": "string",
- "nodes": {
- "property1": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}, - "property2": {
- "cloudConfig": { },
- "graphics": {
- "color": 0,
- "endPointShape": "string",
- "shape": "orthogonal",
- "startPointShape": "string",
- "style": "string",
- "width": 0
}, - "metadata": {
- "terraform_reference": "string"
}
}
}, - "reverted": true,
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "snapshot_url": "string",
- "status": "string",
- "synced": true,
- "synced_architectures": { },
- "tags": [
- "string"
], - "template": true,
- "terraform_binary": "string",
- "terraform_config": {
- "required_providers": {
- "property1": {
- "source": "string",
- "version": "string"
}, - "property2": {
- "source": "string",
- "version": "string"
}
}
}, - "terraform_provider": "string",
- "terraform_version": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "variable_settings": {
- "property1": "string",
- "property2": "string"
}, - "visibility": "public"
}
]
List all architecture workflows.
created_at | string |
created_by | string <uuid> |
description | string |
object (model.User) | |
notification_recipients | Array of strings |
notify_on_failure | boolean |
Array of objects (WorkflowTaskConfiguration) | |
title | string |
object (FlattenJSON) | |
type | string (WorkflowType) Enum: "one_action" "state_action" |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
[- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "editor": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "notification_recipients": [
- "string"
], - "notify_on_failure": true,
- "tasks": [
- {
- "action": "string",
- "arguments": {
- "property1": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}, - "property2": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}
}, - "depends_on": [
- "string"
], - "graphics": {
- "x": 0,
- "y": 0
}, - "title": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "title": "string",
- "triggers": {
- "property1": "string",
- "property2": "string"
}, - "type": "one_action",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
Triggers a pipeline for a given workflow and architecture.
workflowID required | string Workflow ID |
architectureUUID required | string Architecture ID |
architecture_id | string |
object (model.User) | |
created_at | string |
created_by | string <uuid> |
finish_time | string |
Array of objects (model.Job) | |
notification_recipients | Array of strings |
notify_on_failure | boolean |
start_time | string |
started_reason | string (runner.WorkflowTrigger) Enum: "cron" "manual" "one-action" "state-action" |
status | string (runner.WorkflowStatus) Enum: "scheduled" "manual" "pending" "running" "succeeded" "failed" "error" "warning" "terminated" |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
object (Workflow) |
{- "architecture_id": "string",
- "author": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "finish_time": "string",
- "jobs": [
- {
- "action": "string",
- "app_url": "string",
- "approved_by": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "architecture_id": "string",
- "arguments": {
- "property1": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}, - "property2": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}
}, - "cli_arguments": {
- "property1": "string",
- "property2": "string"
}, - "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "credentials": [
- "string"
], - "depends_on": [
- "string"
], - "graphics": {
- "x": 0,
- "y": 0
}, - "pipeline_id": "string",
- "runner_id": "string",
- "status": "scheduled",
- "title": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "workflow_id": "string"
}
], - "notification_recipients": [
- "string"
], - "notify_on_failure": true,
- "start_time": "string",
- "started_reason": "cron",
- "status": "scheduled",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "workflow": {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "editor": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "notification_recipients": [
- "string"
], - "notify_on_failure": true,
- "tasks": [
- {
- "action": "string",
- "arguments": {
- "property1": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}, - "property2": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}
}, - "depends_on": [
- "string"
], - "graphics": {
- "x": 0,
- "y": 0
}, - "title": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "title": "string",
- "triggers": {
- "property1": "string",
- "property2": "string"
}, - "type": "one_action",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
Lists all available workflow templates.
created_at | string |
created_by | string <uuid> |
description | string |
object (model.User) | |
notification_recipients | Array of strings |
notify_on_failure | boolean |
Array of objects (WorkflowTaskConfiguration) | |
title | string |
object (FlattenJSON) | |
type | string (WorkflowType) Enum: "one_action" "state_action" |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
{- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "editor": {
- "accept_news": true,
- "avatar_url": "string",
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "disabled": true,
- "email": "string",
- "email_confirmed": true,
- "firstname": "string",
- "lastname": "string",
- "organization_role": "string",
- "role": "string",
- "terraform_modules_pinned": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "notification_recipients": [
- "string"
], - "notify_on_failure": true,
- "tasks": [
- {
- "action": "string",
- "arguments": {
- "property1": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}, - "property2": {
- "defaultValue": "string",
- "dependsOn": "string",
- "env": "string",
- "options": [
- "string"
], - "required": true,
- "type": "string",
- "value": null
}
}, - "depends_on": [
- "string"
], - "graphics": {
- "x": 0,
- "y": 0
}, - "title": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "title": "string",
- "triggers": {
- "property1": "string",
- "property2": "string"
}, - "type": "one_action",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
Lists all organization projects.
created_at | string |
created_by | string <uuid> |
description | string |
Array of objects (Environment) | |
name | string |
role | string Used to give the User role in this project in ListProjects() |
tags | Array of strings |
Array of objects (Team) | |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
[- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "environments": [
- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "name": "string",
- "tags": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "name": "string",
- "role": "string",
- "tags": [
- "string"
], - "teams": [
- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "force_2fa": true,
- "name": "string",
- "role": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
Creates a new project.
CreateProject body
description | string description of the project |
required | Array of objects (Environment) new project environments |
name required | string name of the project |
required | Array of objects (Team) list of teams allowed to access the new project |
{- "description": "string",
- "environments": [
- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "name": "string",
- "tags": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "name": "string",
- "teams": [
- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "force_2fa": true,
- "name": "string",
- "role": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
}
{- "property1": "string",
- "property2": "string"
}
Lists all environments from a project.
projectUUID required | string Parent project ID |
created_at | string |
created_by | string <uuid> |
description | string |
name | string |
tags | Array of strings |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
[- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "description": "string",
- "name": "string",
- "tags": [
- "string"
], - "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
Imports variables from terraform files into an existing architecture.
ImportVariables body
override | boolean set to true to override existing variables |
{- "content": { },
- "error_code": "INTERNAL_ERROR"
}
Lists all architecture variables.
architectureUUID required | string Architecture ID |
created_at | string |
created_by | string <uuid> |
default | string |
description | string |
name | string |
scope | string (VariableScope) Enum: "organization" "project" "environment" "architecture" "locals" |
scope_id | string <uuid> |
sensitive | boolean |
type | string |
updated_at | string |
updated_by | string <uuid> |
uuid | string <uuid> |
validation | string |
value | string |
[- {
- "created_at": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "default": "string",
- "description": "string",
- "name": "string",
- "scope": "organization",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "sensitive": true,
- "type": "string",
- "updated_at": "string",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "validation": "string",
- "value": "string"
}
]
Update a single variable.
variableUUID required | string variable ID |
createOrUpdateVariable Request
default | string default variable value |
description | string variable description |
name | string variable name |
scope | string (VariableScope) Enum: "organization" "project" "environment" "architecture" "locals" |
scope_id | string |
sensitive | boolean set to true to hide variable value in terraform commands output |
type | string variable type |
validation | string variable validation rules |
value | string variable value |
{- "default": "string",
- "description": "string",
- "name": "string",
- "scope": "organization",
- "scope_id": "string",
- "sensitive": true,
- "type": "string",
- "validation": "string",
- "value": "string"
}
{- "content": { },
- "error_code": "INTERNAL_ERROR"
}