Join

Parallels REST API

SupportDocumentation

post

Joins a Tenant Broker.

Query parameters

siteIdinteger · int32

Site ID from which to retrieve the Tenant Broker settings (optional).

Body

hashKeystring | nullablerequired

<para type="description">This can be the Tenant Broker secret key located at Farm | Settings | Tenant Broker, or the Tenant invitation hash created at Farm | Tenants | Add.</para>

tenantBrokerstring | nullable

<para type="description">The IP or DNS address of the Tenant Broker to join.</para>

tenantNamestring | nullable

<para type="description">The Tenant name. Applicable only if Farms are allowed to register using a secret key.</para>

publicDomainAddressesstring | nullable

<para type="description">The accessible name. Applicable only if Farms are allowed to register using a secret key.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/TenantBroker/Join' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "hashKey": "text",
    "tenantBroker": "text",
    "tenantName": "text",
    "publicDomainAddresses": "text"
  }'

204

400

401

404

412

No body

No Content