Settings

In the lower-left corner of the pgEdge Cloud console you'll find a link to the Settings dialog; you can use the Settings dialog to create an API client and obtain or set account information.

Use the tabs on the Settings page to manage account information:

• Use fields on the API Clients tab to create and manage API client details.
• The Team tab displays information about your pgEdge account; if you need to reach out for support from pgEdge, use the information to identify your account.
• Navigate to the Map tab to review a world map that displays the names and locations of selected servers.

The API Clients Tab

Select the API Clients tab to view, manage, or create an API client.

You can use options accessed on the API Clients tab, to define and delete API clients. To create an client, select the Create API Client icon. When the Create API Client popup opens:

• Provide a user-friendly name for the API client in the API Client Name field.
• Provide a brief description of the API client in the Description field.

Then, to create the API client, click the Create button.

When you create an API client, you will be provided an Auth ID and Auth Secret that you can use when connecting to pgEdge Cloud with the API, and the new client will be added to the API Clients list.

import { Callout } from 'nextra/components'

To delete one or more API client(s), check the box to the left of the client name and select the Delete selected client button, or choose the Delete option from the context menu located to the right of the API client identifiers in the API Clients table. When prompted, click the Confirm button to delete the selected client(s).

API Documentation

Use the pgEdge Cloud API link below the table to access the pgEdge Cloud API documentation.

The Team Tab

The Team tab displays information about your account:

• Provide the Account ID when contacting pgEdge support (if needed for troubleshooting).
• The External ID is used in the AWS IAM trust policy, when granting pgEdge access to an AWS account for cluster provisioning.
• Update the Team Name to match your team, division, or company name. This name appears in invitation emails when you invite other people to join your account.