PIpipeshub-ai
Connector Configuration

Get connector configuration

Changed on

Get the current configuration for a connector instance.<br><br> <b>Security:</b><br> Stored credentials and OAuth tokens (<code>credentials</code>, <code>oauth</code>) are never returned. The saved <code>auth</code> values are returned so the form can be edited, except that each secret (an <code>isSecret</code> or <code>PASSWORD</code> field of the connector type's auth schema, and a legacy <code>private_key</code>) comes back as <code>••••••••</code>. Sending that mask back on a save keeps the stored value. A personal connector's configuration is only readable by its creator: to anyone else, admins included, it is answered 404 as if it did not exist. A team connector of another user is answered 404 to a member.

get/connectors/{connectorId}/config

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/{connectorId}/config
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: connector:read

Path parameters

connectorIdstring required

Connector instance ID

Response

Saved configuration

successboolean required

Example response

{
  "config": {
    "authType": "OAUTH",
    "scope": "team",
    "config": {
      "auth": {
        "connectorScope": "team"
      }
    }
  }
}

Changes

  • dbb5e203b445Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the ACCESS_KEY enum value from the / response property for the response status

    • info

      removed the ACCOUNT_KEY enum value from the / response property for the response status

    • info

      removed the API_TOKEN enum value from the / response property for the response status

    • info

      removed the BASIC_AUTH enum value from the / response property for the response status

    • info

      removed the BEARER_TOKEN enum value from the / response property for the response status

    • info

      removed the CONNECTION_STRING enum value from the / response property for the response status

    • info

      removed the CUSTOM enum value from the / response property for the response status

    • info

      removed the ENTRA_ID enum value from the / response property for the response status

    • info

      removed the IAM_ROLE enum value from the / response property for the response status

    • info

      removed the NONE enum value from the / response property for the response status

    • info

      removed the OAUTH enum value from the / response property for the response status

    • info

      removed the OAUTH_ADMIN_CONSENT enum value from the / response property for the response status

  • fc76aa045994Revision changes
    • warning

      added the new ENTRA_ID enum value to the / response property for the response status

    • warning

      added the new ENTRA_ID enum value to the /// response property for the response status

    • warning

      added the new IAM_ROLE enum value to the / response property for the response status

    • warning

      added the new IAM_ROLE enum value to the /// response property for the response status