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

Update GCP instance comment

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

Updates the comment/description of a specific GCP Cloud Hub instance within a deployment. The comment is stored in the instance configuration and persisted to the database.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
required
≥ 0

Orchestrator-assigned deployment ID. Must reference an existing GCP deployment.

string
required
length ≥ 1

Unique instance identifier (UUID) assigned by Orchestrator when the instance was created.

Body Params

Instance update payload containing the new comment value.

Request payload for updating a GCP Cloud Hub instance's comment.

string

Descriptive text for the instance. Used for labeling and documentation purposes. If null or empty, clears the existing comment.

Responses

Updated about 12 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 12 hours ago

Did this page help you?