Provider Accounts
List Provider Accounts
Returns a a paginated collection of provider accounts for an organization.
Query Parameters
Filters supported for provider accounts.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated list for a collection of provider accounts.
ListCloudGatewayProviderAccountsResponse
returns the pagination information
Show Child Parameters
Object containing mapping for organization and cloud provider to account ID.
Show Child Parameters
Authentication
Query Parameters
Get Provider Account
Retrieves a provider account by ID.
Path Parameters
The ID of the provider account to operate on.
Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae
Response
application/json
Response
Response format for retrieving a provider account.
Cloud Gateway Provider Account
Object containing mapping for organization and cloud provider to account ID.
Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae
Name of cloud provider.
Allowed values:awsazuregcp
Example:aws
ID of the cloud provider account.
An RFC-3339 timestamp representation of provider account creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of provider account update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Custom Domains
List Custom Domains
Returns a paginated collection of custom domains across control-planes for an organization (restricted by
permitted control-plane reads).
Query Parameters
Filters supported for custom domains on the global API.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated list for a collection of custom domains.
ListGlobalCustomDomainsResponse
returns the pagination information
Show Child Parameters
Object containing information about a custom domain for a control-plane.