REST Resource: accounts.platforms.childAccounts.sites

  • The PlatformChildSite resource represents a transparent platform child site, containing information such as its name, domain, and platform group.

  • The PlatformChildSite resource uses a JSON format with fields like name, domain, and platformGroup.

  • The name field is a string identifier with a specific format that includes account, platform, child account, and site details.

  • Two methods, list and patch, are available to interact with PlatformChildSite resources, enabling the listing and updating of child sites.

Resource: PlatformChildSite

Representation of a Transparent Platform Child Site.

JSON representation
{
  "name": string,
  "domain": string,
  "platformGroup": string
}
Fields
name

string

Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platformChildSite}

domain

string

Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.

platformGroup

string

Resource name of the Platform Group of the Platform Child Site.

Methods

get

Gets a Platform Child Site for a specified Platform Child Account and site.

list

Lists Platform Child Sites for a specified Platform Child Account.

patch

Update a Platform Child Site.