Brownfield
This section describes a set of API requests that allow managing brownfield resources, allowing users to import servers, VPCs, floating IPs, volumes, policies and Kubernetes clusters from different cloud accounts into the system, from version 10.0.0 onwards. The importation of resources is automatic, so after making a request to start the importation process for a resource type, all resources of this type included in the cloud account will be imported into the platform.
Contents
Cloud Accounts
List Brownfield Cloud Accounts
GET /v3/brownfield/cloud_accounts
It lists the cloud accounts that support importing resources.
Inputs
None
Returns
An array of cloud accounts, each with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Show Brownfield Cloud Accounts
GET /v3/brownfield/cloud_accounts/:id
It shows a cloud account that supports importing resources, given its id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Import Servers
PUT /v3/brownfield/cloud_accounts/:id/import_servers
It starts the process of importing servers on the cloud account identified by the given id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Import VPCs
PUT /v3/brownfield/cloud_accounts/:id/import_vpcs
It starts the process of importing VPCs on the cloud account identified by the given id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Import Floating IPs
PUT /v3/brownfield/cloud_accounts/:id/import_floating_ips
It starts the process of importing floating IPs on the cloud account identified by the given id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Import Volumes
PUT /v3/brownfield/cloud_accounts/:id/import_volumes
It starts the process of importing volumes on the cloud account identified by the given id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Import Policies
PUT /v3/brownfield/cloud_accounts/:id/import_policies
It starts the process of importing policies on the cloud account identified by the given id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Import Kubernetes Clusters
PUT /v3/brownfield/cloud_accounts/:id/import_kubernetes_clusters
It starts the process of importing Kubernetes clusters on the cloud account identified by the given id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
Import Key Vaults
PUT /v3/brownfield/cloud_accounts/:id/import_key_vaults
It starts the process of importing key vaults on the cloud account identified by the given id.
Inputs
None
Returns
A cloud account with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |