Sources

Manage your Cloud Data Sources with Felt REST API.

List Sources

Lists Sources that you have access to. To see the datasets in an individual Source, fetch it from the Show Source endpoint.

get

Authorizations

Query parameters

workspace_idstringoptional

Only needed when using the API as part of a plugin

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://felt.com/api/v2/sources' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

422

429

500

200

[
  {
    "automatic_sync": "enabled",
    "connection_type": "bigquery",
    "created_at": 1,
    "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
    "last_synced_at": 1,
    "links": {
      "self": "https://felt.com/api/v2/sources/V0dnOMOuTd9B9BOsL9C0UjmqC"
    },
    "name": "text",
    "owner_id": "luCHyMruTQ6ozGk3gPJfEB",
    "permissions": {
      "type": "workspace_editors"
    },
    "sync_status": "syncing",
    "type": "source_reference",
    "updated_at": 1,
    "workspace_id": "luCHyMruTQ6ozGk3gPJfEB"
  }
]

SourceReferences

Show Source

Fetches a single Source and all the datasets it contains.

get

Authorizations

Path parameters

source_idstringrequired

The ID of the source to show

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://felt.com/api/v2/sources/{source_id}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

422

429

500

200

{
  "automatic_sync": "enabled",
  "connection": {
    "account_id": "text",
    "database": "text",
    "role": "text",
    "schema": "text",
    "type": "snowflake",
    "user": "text",
    "warehouse": "text"
  },
  "created_at": 1,
  "datasets": [
    {
      "created_at": 1,
      "description": "text",
      "geometry_type": "polygon",
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "inspection_status": "completed",
      "name": "text",
      "type": "dataset",
      "updated_at": 1
    }
  ],
  "id": "luCHyMruTQ6ozGk3gPJfEB",
  "last_synced_at": 1,
  "name": "text",
  "owner_id": "luCHyMruTQ6ozGk3gPJfEB",
  "permissions": {
    "type": "workspace_editors"
  },
  "sync_status": "syncing",
  "type": "source",
  "updated_at": 1,
  "workspace_id": "luCHyMruTQ6ozGk3gPJfEB"
}

Source

Add a layer from a Source

post

Path parameters

map_idstringrequired

Body

one ofoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/maps/{map_id}/add_source_layer' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataset_id": "OI22G7wJRzOo2p1RQeHIPB",
    "from": "dataset"
  }'

202

401

403

404

422

429

500

202

{
  "links": {
    "layer_group": "https://felt.com/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layer_groups/KFFhKAbvS4anD3wxtwNEpD",
    "self": "https://felt.com/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "status": "accepted"
}

AddSourceLayerAccepted

Create a Source

Triggers the creation of a new Source. Each connection type has it's own set of required parameters, depending on what kind of Source it is. These are provided in the connection field.

Connecting the Source and inspecting it's datasets will happen asynchronously after the API response is returned. To determine when the inspection process has completed, poll the Show Source endpoint and check for sync_status: completed.

post

Authorizations

Body

connectionone ofrequired

namestringrequired

permissionsone ofoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/sources' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "connection": {
      "account_id": "text",
      "database": "text",
      "password": "text",
      "role": "text",
      "schema": "text",
      "type": "snowflake",
      "user": "text",
      "warehouse": "text"
    },
    "name": "text",
    "permissions": {
      "type": "workspace_editors"
    }
  }'

202

401

403

404

422

429

500

202

{
  "automatic_sync": "enabled",
  "connection_type": "bigquery",
  "created_at": 1,
  "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
  "last_synced_at": 1,
  "links": {
    "self": "https://felt.com/api/v2/sources/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "name": "text",
  "owner_id": "luCHyMruTQ6ozGk3gPJfEB",
  "permissions": {
    "type": "workspace_editors"
  },
  "sync_status": "syncing",
  "type": "source_reference",
  "updated_at": 1,
  "workspace_id": "luCHyMruTQ6ozGk3gPJfEB"
}

SourceReference

Sync a Source

Triggers Felt to reconnect to your Source and re-inspect all the datasets it contains. Syncing will happen asynchronously after the API response is returned. To determine when the inspection process has completed, poll the Show Source endpoint and check for sync_status: completed.

post

Authorizations

Path parameters

source_idstringrequired

The ID of the source to sync

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/sources/{source_id}/sync' \
  --header 'Authorization: YOUR_API_KEY'

202

401

403

404

422

429

500

202

{
  "automatic_sync": "enabled",
  "connection_type": "bigquery",
  "created_at": 1,
  "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
  "last_synced_at": 1,
  "links": {
    "self": "https://felt.com/api/v2/sources/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "name": "text",
  "owner_id": "luCHyMruTQ6ozGk3gPJfEB",
  "permissions": {
    "type": "workspace_editors"
  },
  "sync_status": "syncing",
  "type": "source_reference",
  "updated_at": 1,
  "workspace_id": "luCHyMruTQ6ozGk3gPJfEB"
}

SourceReference

Update a Source

Updates details of a Source. Connecting the Source and inspecting it's datasets will happen asynchronously after the API response is returned. To determine when the inspection process has completed, poll the Show Source endpoint and check for sync_status: completed.

post

Authorizations

Path parameters

source_idstringrequired

The ID of the source to update

Body

connectionone ofoptional

namestringoptional

permissionsone ofoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/sources/{source_id}/update' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "connection": {
      "account_id": "text",
      "database": "text",
      "password": "text",
      "role": "text",
      "schema": "text",
      "type": "snowflake",
      "user": "text",
      "warehouse": "text"
    },
    "name": "text",
    "permissions": {
      "type": "workspace_editors"
    }
  }'

202

401

403

404

422

429

500

202

{
  "automatic_sync": "enabled",
  "connection_type": "bigquery",
  "created_at": 1,
  "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
  "last_synced_at": 1,
  "links": {
    "self": "https://felt.com/api/v2/sources/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "name": "text",
  "owner_id": "luCHyMruTQ6ozGk3gPJfEB",
  "permissions": {
    "type": "workspace_editors"
  },
  "sync_status": "syncing",
  "type": "source_reference",
  "updated_at": 1,
  "workspace_id": "luCHyMruTQ6ozGk3gPJfEB"
}

SourceReference

Delete a Source

Deletes a Source.

Any layers created from the Source will remain after it is deleted, but they will no longer be refreshed.

delete

Authorizations

Path parameters

source_idstringrequired

The ID of the source to delete

Responses

application/json

application/json

application/json

application/json

application/json

application/json

delete

cURLJavaScriptPythonHTTP

curl -L \
  --request DELETE \
  --url 'https://felt.com/api/v2/sources/{source_id}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

422

429

500

204

No Content

No Content