Add Cloud Hub instance(s) to an existing GCP deployment

post

http://127.0.0.1:8080/cloudDeployment/gcp/edgeconnects/instance

Adds one or more new Cloud Hub instances to an existing GCP deployment. Each instance is validated, assigned subnets automatically, and queued for deployment. The deployment must not have another action in progress.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

number

required

≥ 0

Orchestrator-assigned deployment ID. Must reference an existing GCP deployment that is not currently deploying or destroying.

Body Params

Array of GCP instance configurations to add to the deployment. Each instance must specify region, zone, instance type, and bandwidth.

Request payload for adding a new GCP Cloud Hub instance to an existing deployment.

gcpRegion

string

required

GCP region where the instance will be deployed. Must be a valid GCP region name (e.g., us-central1, europe-west1).

gcpZone

string

required

GCP zone within the region where the instance will be deployed. Must be a valid zone within the specified region.

gcpInstanceType

string

required

GCP compute instance type/machine type for the Cloud Hub. Determines CPU and memory allocation.

bandwidth

number

required

≥ 1

Expected bandwidth for the appliance in Kbps. Used for capacity planning and licensing.

tag

string

^[a-zA-Z0-9-]{1,25}$

Optional unique identifier tag for the appliance. Only alphanumeric characters and '-' allowed, max 25 characters. Auto-generated if not provided.

gcpImage

string

Optional GCP image to use for the instance. If not specified, the latest image from portal metadata is used automatically.

comment

string

Optional descriptive comment for the instance.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Instance(s) successfully added and queued for deployment. Subnets are automatically assigned based on region.

400Bad request - validation failed or deployment busy

500Internal server error