PIpipeshub-ai
Connector Instances

Get connector instance

Changed on

Retrieve a specific connector instance by ID, together with the setup form of its connector type (<code>config</code>).<br><br> <b>Who can read an instance:</b><br>

<ul> <li>Team scope: the creator and org admins. Other members get <code>404</code>, although the lists show them the instance.</li> <li>Personal scope: the creator only. An admin gets <code>404</code>.</li> </ul> The ID of a knowledge base is accepted too: a knowledge base is stored as a connector instance of type <code>KB</code>.
get/connectors/{connectorId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/{connectorId}
  • 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 (_key of the instance)

Response

Connector instance

successboolean required

Example response

{
  "connector": {
    "_key": "7b387394-1248-4fb6-810d-e8ac9ac226eb",
    "name": "Company Google Drive",
    "type": "Drive Workspace",
    "documentationLinks": [
      {
        "title": "Azure AD App Registration Setup",
        "type": "setup"
      }
    ],
    "authType": "OAUTH",
    "scope": "team",
    "status": "IDLE",
    "config": {
      "documentationLinks": [
        {
          "title": "Azure AD App Registration Setup",
          "type": "setup"
        }
      ],
      "sync": {
        "scheduledConfig": {
          "timezone": "UTC"
        },
        "realtimeConfig": {
          "connectionType": "WEBSOCKET"
        }
      }
    }
  }
}

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

    • warning

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

    • warning

      added the new RECORD_LEVEL enum value to the // response property for the response 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

      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 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

    • warning

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