Federated Tables API (Beta)

The Federated Tables API allows you to perform live queries to a remote database.

This component is still under support but it will not be further developed. We don’t recommend starting new projects with it as it will eventually become deprecated. Instead, learn more about our new APIs here

What is Federated Tables API?

Federated Tables is in BETA stage and the API might change or have limited support.

This API consists of several HTTP requests targeted at a set of CARTO endpoints that deal with remote databases, schemas, and tables. To understand the fundamentals of Federated Tables API, read the guides. To view the source code, browse the open-source repository in GitHub and contribute. Otherwise, read the full reference API, or find different support options.

Guides

Quick reference guides for learning how to use Federated Tables API features.

Reference

Browse the interactive API documentation to search for specific Federated Tables API methods, arguments, and sample code that can be used to build your applications.

Check Full Reference API 
1
2
3
4
5
6
7
8
9

curl -X POST -H "Content-Type: application/json" "https://documentation.carto.com/api/v4/federated_servers?api_key=bec1667cdedaa6fd70165f5099981d0c61ec1112" -d '{
    "federated_server_name": "example_server",
    "mode": "read-only",
    "dbname": "geometries",
    "host": "example.com",
    "port": "5432",
    "username": "remote_user",
    "password": "remote_password"
}'

Support

Get help or learn about known issues.