HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. gcpCloudDeployment

Deploy Cloud Hub(s) in GCP

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

Creates a new GCP Cloud Hub deployment. Validates configuration, fetches portal metadata, and queues instances for deployment. Orchestrator must be registered to Cloud Portal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

GCP deployment configuration including account, network settings, and instance specifications.

Configuration for deploying Cloud Hub instances in GCP. Contains account credentials, network settings, and instance specifications.

string
required
^[a-zA-Z0-9-]{1,20}$

Unique deployment name. Alphanumeric and dash only, max 20 characters.

string
required

GCP project ID of a registered service account. Must be added via POST /cloudDeployment/gcp/accounts first.

string
enum

Cloud provider identifier. Must be 'gcp' for GCP deployments.

Allowed:
string

Default bandwidth tier for the deployment in Mbps. Used for display purposes.

boolean
Defaults to false

Enable WAN Optimization (boost) capability on the appliances.

number
required
≥ 1

Number of instances to deploy. Must match the length of the instances array.

string
required

SSH public key in OpenSSH format for instance access. Must be single line (no newlines).

string

CIDR block for the GCP VPC network. Three /26 subnets (mgmt0, wan0, lan0) will be created per region.

string

Optional description or notes for the deployment.

string

Optional GCP resource labels as comma-separated key=value pairs.

instances
array of objects
required
length ≥ 1

Array of Cloud Hub instance configurations. At least one instance required.

instances*

GCP Cloud Hub instance configuration. Used for both POST requests and GET responses.

string
required

GCP region for the instance (e.g., us-central1, europe-west1).

string
required

GCP zone within the region (e.g., us-central1-a).

string
required

GCP machine type determining CPU/memory allocation.

number
enum
required

Bandwidth in Kbps. Valid values: 50000, 100000, 200000, 500000, 1000000, 2000000.

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

Unique appliance tag. Alphanumeric and dash only, max 25 characters.

string

Optional descriptive comment for the instance.

Responses

Updated about 15 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 15 hours ago

Did this page help you?