Sites Get

Sites Get

This request retrieves information for a given paired Cloud site.

Request
URI
GET
https://{api_host}/sites/{site}
COPY
Path Parameters
string
site
Required

The site name.

site example 
site2
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PeerSiteInfo of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
This response body class contains all of the following: SiteInfoBase 
{
    "apiThumbprint": "SHA-256:DB:CA:47:F1:50:66:7C:8C:B1:03:85:94:3D:F7:F5:12:DE:6A:9F:7E:83:4A:0B:84:03:09:19:C6:E0:0E:0C:5B",
    "apiUrl": "https://address:8048",
    "description": "some description",
    "site": "site1",
    "apiPublicUrl": "https://vcdainstance.com:8048",
    "apiVersion": "4.6",
    "buildVersion": "4.5.0.5226630-ab9eb01ccb",
    "isLocal": true,
    "state": {
        "incomingCommError": {
            "args": [],
            "code": "Forbidden",
            "msg": "Permission denied.",
            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
        },
        "outgoingCommError": {
            "args": [],
            "code": "Forbidden",
            "msg": "Permission denied.",
            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
        }
    }
}
string
apiPublicUrl
Optional

The public URL of the site.

string
apiVersion
Optional

The API version.

string
buildVersion
Optional

The build number.

boolean
isLocal
Optional

Indicates whether the site is local.

PeerState
state
Optional

state


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Sites Operations
POST
Sites Add
GET
Sites Capabilities
DELETE
Sites Delete
GET
Sites Get
GET
Sites List
PUT
Sites Update