HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
HashiCorp Cloud Platform
HashiCorp Cloud Platform

ConnectionService_ListConnections

get

/infragraph/organizations/{location.organization_id}/connections

ConnectionService_ListConnections

https://api.cloud.hashicorp.com/infragraph/2025-05-07/organizations/{location.organization_id}/connections

Request

Path Parameters
location.organization_idstring
Required

organization_id is the id of the organization.

Query Parameters
location.project_idstring

project_id is the projects id.

Response

200 - OK
connectionsobject[]

Connection represents a connection from an infragraph connector to a data source.

  • idstring

    id is the unique identifier for the connection.

  • organization_idstring

    organization_id identifies the organization that owns this connection.

  • sourcestring
  • configobject
    • aws_configobject
      • account_idsstring[]
      • role_namestring
      • nrt_configobject
        • queue_urlstring
      • is_organizationboolean
    • packer_configobject
    • azure_configobject
      • regionstring
      • tenant_idstring
      • client_idstring
      • subscription_idsstring[]
      • management_group_idstring
    • terraform_configobject
      • tf_tokenstring
      • tf_organization_namesstring[]
      • register_webhookboolean
      • tf_project_namesstring[]
      • tf_workspace_namesstring[]
    • hcp_configobject
      • service_principal_client_idstring
      • service_principal_client_secretstring
    • tfe_configobject
      • tf_tokenstring
      • hostnamestring

        Hostname where Terraform Enterprise is accessed (e.g., terraform.example.com).

    • github_configobject
      • personal_access_tokenstring

        personal_access_token is deprecated and replaced by GitHub App auth fields.

      • organizationsstring[]
      • base_urlstring

        base_url is the GitHub API base URL used for GitHub Enterprise instances.

      • github_app_private_keystring

        github_app_private_key is the PEM private key for the GitHub App.

      • github_app_installation_idstring

        github_app_installation_id is the installation ID for the GitHub App.

      • github_app_idstring

        github_app_id is the ID of the GitHub App used by InfraGraph to make calls to GitHub.

  • deletedboolean

    deleted indicates whether the connection has been soft deleted.

  • created_atstring

    created_time is the timestamp when the connection was created.

  • updated_atstring

    updated_at is the timestamp when the connection was last updated.

  • latest_snapshot_idstring

    latest_snapshot_id is the identifier of the latest snapshot associated with this connection. This field is optional and will not be set if no snapshots have occurred for this connection.

  • snapshot_schedule_stateobject

    SnapshotScheduleState holds information about the current state of scheduled snapshots for a connection.

    • disabledboolean

      disabled indicates whether scheduled snapshots are currently disabled for the connection.

    • run_afterstring

      run_after is the timestamp in UTC after which the next scheduled snapshot could run. Ideally snapshots run shortly after this timestamp, but there may be some delay.

    • last_finished_atstring

      last_finished_at is the timestamp in UTC when the most recent scheduled snapshot finished.

  • manual_snapshot_stateobject

    ManualSnapshotState holds information about the current state of manual snapshot for a connection.

    • disabledboolean

      disabled indicates whether manual snapshots are currently disabled for the connection.

    • reasonstring

      ManualSnapshotDisabledReason defines the possible reasons why manual snapshots may be disabled for a connection.

      • MANUAL_SNAPSHOT_DISABLED_REASON_TOO_SOON: RATE_LIMIT indicates that manual snapshots are temporarily disabled due to hitting a rate limit.
      • MANUAL_SNAPSHOT_DISABLED_REASON_RUNNING_SNAPSHOT: RUNNING_SNAPSHOT indicates that manual snapshots are disabled because a snapshot is currently running for the connection.
    • disabled_untilstring

      disabled_until is specified when manual snapshots are disabled due to a rate limit, indicating when manual snapshots will be re-enabled.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring