Portable App

Blog

Developer Documentation

API Reference

Support

Get flow

The id of the destination associated with the flow

The frequency at which the flow should run

The id of the source associated with the flow

bearerAuth

Example section for showcasing API endpoints

Introduction

Get to know the entities and concepts that make up the Portable API.

Concepts

List source specs

Get source spec

List all the sources. A source is an instantiation of a source spec.

List sources

Create source

Get source

Delete source

Update source

Use this endpoint to validate the properties for the specified source. If any required property is missing, the response will include a relevant error message. If all required properties are present, it attempts to establish a connection with the source's API servers and returns a status message indicating whether the connection was successful.
The response is an array of check messages. Each element in the array includes two fields: `isError`, a boolean flag, and `message`, a string. The `isError` field should be used to distinguish between error messages and informational messages. See the provided example for more details.
All this process is performed synchronously, so it may take a few seconds to complete. There is also a timeout of 10 seconds for the whole process.


Verify if a source is properly configured

List destination specs

Get destination spec

List all the destinations for the given user. A destination is where the data from a source gets loaded into.

List destinations

Create a destination

Get destination

Delete destination

Update destination

Use this endpoint to validate the properties for the specified destination. If any required property is missing, the response will include a relevant error message. If all required properties are present, it attempts to establish a connection with the destination and returns a status message indicating whether the connection was successful.
The response is an array of check messages. Each element in the array includes two fields: `isError`, a boolean flag, and `message`, a string. The `isError` field should be used to distinguish between error messages and informational messages. See the provided example for more details.
All this process is performed synchronously, so it may take a few seconds to complete. There is also a timeout of 10 seconds for the whole process.


Verify if a destination is properly configured

List all the existing flows. A flow is a combination of a source and an environment.

List flows

Create flow

Delete flow

Update flow

Get a flow's status by flow ID. Use this endpoint to check whether a flow is running or not, or get details about the flow's last run.
The response includes the flow's lifecycle status, disposition, and the status of the resources involved in the


Get flow status

Get flow run attempts

Initiates a run of a flow by flow ID. The flow will be run asynchronously. Use `/v2/flows/{id}/status` to check the status of this run.


Run a flow

Cancels an ongoing run of a flow by flow ID. If the flow is not running, this operation has no effect. You can use `/v2/flows/{id}/status` to check the status of this run.


API Documentation

Source Specs

Sources

Destination Specs

Destinations

Flows

Get flow

Authorizations

Path Parameters

Response