[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Update Site

Description

Update site with new values. The new data must be complete and valid as if it were a new record.

Request

Request

URL

URL


put
https://cloud.vmwarehorizon.com/portal/v2/sites/{siteId}
Copy

Path Parameters

Path Parameters

string
siteId Required

siteId


Request Body

Request Body

Site of mimetype application/json Required

site

{
	"edges": [
		{}
	]
}
array of Edge
edges Required

List of edges


string as date-time
createdAt Optional

Time when site was created


string
description Optional

Site description


string
geoGraphicLocation Optional

Possible values are: APJEUUKUS


string
id Optional

Site Id


string
location Optional

Location that is mapped with Org Id


string
name Optional

Site name


string
orgId Optional

Site OrgId


string as date-time
updatedAt Optional

Time when site was updated

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns Site of type */*
{
	"createdAt": "string",
	"description": "Site-desc",
	"edges": [
		{
			"edgeDeploymentId": "edge-12345",
			"edgeDeploymentName": "edge-name"
		}
	],
	"geoGraphicLocation": "APJ",
	"id": "site-id-12345",
	"location": "US",
	"name": "site1",
	"orgId": "org-id-12345",
	"updatedAt": "string"
}
array of Edge
edges Required

List of edges


string as date-time
createdAt Optional

Time when site was created


string
description Optional

Site description


string
geoGraphicLocation Optional

Possible values are: APJEUUKUS


string
id Optional

Site Id


string
location Optional

Location that is mapped with Org Id


string
name Optional

Site name


string
orgId Optional

Site OrgId


string as date-time
updatedAt Optional

Time when site was updated

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"createdAt":"string","description":"Site-desc","edges":[{"edgeDeploymentId":"edge-12345","edgeDeploymentName":"edge-name"}],"geoGraphicLocation":"APJ","id":"site-id-12345","location":"US","name":"site1","orgId":"org-id-12345","updatedAt":"string"}' https://cloud.vmwarehorizon.com/portal/v2/sites/{siteId}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: site


Feedback

Was this page helpful?