Rest API

In this doc, we will cover how to setup a Connection to a Rest API endpoint.

Prerequisites

• Rest API Endpoint
• Response pagination information
• Response data field name (if needed)
• Credentials (if needed)

Create New Rest API Connection

• ACCESS TYPE: Select whether this connection can be used for both Read and Write Connectors. This connection only supports reading.
• CONNECTION NAME: The name to identify the connection.
• BASE URL: URL of the endpoint.
• RESPONSE DATA FIELD NAME: Field name that contains the data. Leave blank if you'd like to ingest the whole response object.
• PAGINATION TYPE: Pagination type of the response: No Pagination, Offset and Limit, or Next Token.
• REQUIRES CREDENTIALS: If de-selected, only the publicly accessible datasets can be accessed.

Create New Credentials

• CREDENTIAL NAME: The name to identify the credential.
• CREDENTIAL TYPE: REST API.
• AUTHORIZATION TYPE: Type of authorization: Query Parameter or Authorization Header.
• VALUE: Credential value.