Get Site Association

Get Site Association

Get specified site association.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/site/associations/{id}
COPY
Path Parameters
string
id
Required

Site Association ID Urn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SiteAssociation of type(s) application/json;version=39.1 
{
    "id": "string",
    "name": "string",
    "maxSupportedApiVersion": "string",
    "restApiEndpoint": "string",
    "baseUiEndpoint": "string",
    "status": "string",
    "publicKey": "string"
}
string
id
Optional

A unique identifier for the associated site.

string As ^[a-zA-Z0-9_\-\.\!\'\(\),\$]+$
name
Optional
Constraints: maxLength: 128

Name of the associated site.

string
maxSupportedApiVersion
Optional

The API version of the associated site.

string
restApiEndpoint
Optional

URL for the REST endpoint of the associated site.

string
baseUiEndpoint
Optional

URL of a webpage for the UI of the associated site.

string
status
Optional

The status of the associated site. Possible statuses include symmetric, asymmetric, or error.

string
publicKey
Optional

PEM-encoded public key for the associated site.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/site/associations/{id}
Availability
Added in 37.0
On This Page
Site Association Operations
GET
Query Site Associations
GET
Get Site Association