> For the complete documentation index, see llms.txt.
Skip to main content

Check out Port for yourself ➜ 

Test connection

Test connection lets you validate that an integration can authenticate with the third-party tool, and see which resource kinds your credentials can access - without running a resync or ingesting data into Port.

Availability

Test connection currently supports hosted by Port installations of GitHub, Jira, and AWS. Additional integrations will gain support over time.

What test connection checks​

When you click Test Connection, Port runs a shallow probe against the third-party tool using the credentials you provided (or the ones already stored for an installed connector). The probe reports:

  1. Authentication - Whether the credentials can connect to the tool at all.
  2. Access by kind - For each resource kind the integration can sync (for example repository, issue, or project), whether the credentials have the permissions needed to fetch that kind.

The probe does not create or update catalog entities, change your mapping, or trigger a resync. A failed or partial result is a signal to fix credentials or permissions before you rely on a sync - it does not block installing or saving the integration.

Run the tests​

Use the steps below for hosted by Port installations of supported integrations.

During installation​

Use this when you are installing a supported integration with the Hosted by Port method and want to confirm credentials before you finish setup.

  1. Go to the connectors page in Port.
  2. Select the integration you want to install (or open + Connector and choose it).
  3. Under Select your installation method, choose Hosted by Port.
  4. Fill in the required credentials and configuration fields.
  5. Click Test Connection.

A results dialog opens and updates as the probe runs. Review authentication and per-kind access, then click Done to return to the form. You can adjust credentials and run the test again before you complete the installation.

After installation​

Use this when a connector is already installed and you want to re-check credentials - for example after rotating a token or changing permissions in the third-party tool.

  1. Go to the connectors page in Port.
  2. Open the installed integration.
  3. Open the configuration view where credentials and settings are managed.
  4. Click Test Connection.

Port uses the credentials already stored for that installation. Update them in the form first if you recently rotated secrets, then run the test again.

Self-hosted integrations​

Test connection in the Port UI is for hosted by Port installations. For self-hosted Ocean integrations, validate credentials and permissions with the connection probe (ocean probe) using the same environment and secrets as your deployment.

Understand the results​

The results dialog shows an overall authentication outcome, then an Access by kind list.

ResultMeaning
SuccessAuthentication works, or the credentials have the permissions required for that kind.
FailedAuthentication failed, or one or more required permissions for that kind are missing. Expand the row to see the failure reason when available.
UnknownThe integration could not determine whether access is sufficient for that kind.
PendingThe probe is still running for that check.

Results by scope​

Some integrations split results by scope - for example by organization, account, project, or region - when the same credentials cover more than one boundary.

When scopes apply, the dialog groups checks under each scope. Expand a scope to see authentication and access by kind for that org, region, or other boundary. The scope labels depend on the integration (for example GitHub organizations).

Use results to fix permissions

If authentication succeeds but a specific kind fails, grant the missing permissions listed in the failure message in the third-party tool, then run Test Connection again. You do not need to wait for a full resync to confirm the fix.