Get-ConfluenceCloudId

SYNOPSIS

Get the cloud ID for a Confluence Cloud site.

SYNTAX

__AllParameterSets

Get-ConfluenceCloudId [-Site] <string>

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Looks up the cloud ID for an Atlassian Confluence Cloud site from the public /_edge/tenant_info endpoint (a GET request), so a caller can supply a site name or URL instead of the cloud ID. Accepts a bare subdomain (myorg), a host (myorg.atlassian.net), or any URL on the site (https://myorg.atlassian.net/wiki/...). No authentication is required.

EXAMPLES

EXAMPLE 1

Get-ConfluenceCloudId -Site 'msxorg'

Returns the cloud ID for https://msxorg.atlassian.net.

EXAMPLE 2

'https://msxorg.atlassian.net/wiki/spaces/DOCS' | Get-ConfluenceCloudId

Resolves the cloud ID from a full site URL supplied through the pipeline.

EXAMPLE 3

Connect-Confluence -CloudId (Get-ConfluenceCloudId -Site 'msxorg') -Username $user -Token $token

Uses the resolved cloud ID to connect, so the caller only needs the site name.

PARAMETERS

-Site

The site to resolve: a subdomain (myorg), a host (myorg.atlassian.net), or any URL on the site (https://myorg.atlassian.net/...).

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Url
- Uri
- Name
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

{{ Fill in the Description }}

OUTPUTS

System.String

{{ Fill in the Description }}

NOTES

RELATED LINKS