dataConnectors

Retrieve a connection

Changed on

This method retrieves details about the specified connection.

get/connections/{connection_id}

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/connections/{connection_id}
  • Auth: API key in header x-api-key

Path parameters

connection_idstring required

The unique identifier of the connection to retrieve.

Response

The connection has been successfully retrieved.

_idstring

The unique identifier of the connection.

provider'google_drive'

The data connector provider.

status'active' | 'expired' | 'revoked'

The status of the connection. See The connection object for the possible values.

custom_idstring

The label you supplied when you authorized the connection. The platform does not interpret this value, and it does not need to be unique. Multiple connections can share the same custom_id value.

scopesstring[]

The scopes granted to the connection.

connected_atstring date-time

The date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the connection was established.

last_used_atstring date-time

The date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the connection was last used.

Changes

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API

  • 6205c7327cdeRevision changes
    • info

      api operation id retrieve-connection removed and replaced with dataConnectors_retrieve-connection