API Data Provider - Online Help

Connecting to Supabase

Supabase uses Management API tokens to control access to the Management API.

Using API Key Authentication

To obtain a Management API token, log in to your Supabase account and navigate to Account Settings > Access Tokens. Generate a new token with the appropriate permissions for managing your organizations and projects. You can set your API key in the ProfileSettings connection property.

Example connection string

Profile=C:\profiles\Supabase.apip;ProfileSettings='APIKey=sbp_your_management_api_token'AuthScheme=APIKey;

Usage Examples

Branch:

SELECT * FROM Branch

OrganizationMembers:

SELECT * FROM OrganizationMembers WHERE OrganizationId = 'org123'

OrganizationProjects:

SELECT * FROM OrganizationProjects WHERE OrganizationId = 'org123'

Organizations:

SELECT * FROM Organizations
INSERT INTO Organizations (Name) VALUES ('Acme Corp')

ProjectAnalyticsApiCounts:

SELECT * FROM ProjectAnalyticsApiCounts WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectAnalyticsApiRequestsCount:

SELECT * FROM ProjectAnalyticsApiRequestsCount WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectApiKeys:

SELECT * FROM ProjectApiKeys WHERE ProjectId = 'ttvohtavntbpzzvcznof'
INSERT INTO ProjectApiKeys (ProjectId, Type, Name, Description) VALUES ('ttvohtavntbpzzvcznof', 'secret', 'reporting_key', 'Key used for the reporting service')
UPDATE ProjectApiKeys SET Description = 'Updated description' WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND Id = '658cda03-68f4-4e92-8f04-d36da3776f06'
DELETE FROM ProjectApiKeys WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND Id = '658cda03-68f4-4e92-8f04-d36da3776f06'

ProjectAuthConfig:

SELECT * FROM ProjectAuthConfig WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectAuthConfig SET SiteUrl = 'https://example.com', JwtExp = 7200, IsSignupDisabled = true WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectAvailableRegions:

SELECT * FROM ProjectAvailableRegions WHERE OrganizationSlug = 'myorg'

ProjectBillingAddons:

SELECT * FROM ProjectBillingAddons WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectBranches:

SELECT * FROM ProjectBranches WHERE ProjectId = 'ttvohtavntbpzzvcznof'
INSERT INTO ProjectBranches (ProjectId, Name) VALUES ('ttvohtavntbpzzvcznof', 'feature-branch')
UPDATE ProjectBranches SET Name = 'feature-branch-renamed' WHERE Id = 'd6a1e6d2-90d1-4a8b-9c9e-3f6b0c9a1234'
DELETE FROM ProjectBranches WHERE Id = 'd6a1e6d2-90d1-4a8b-9c9e-3f6b0c9a1234'

ProjectDatabaseBackups:

SELECT * FROM ProjectDatabaseBackups WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectDatabaseJitAccess:

SELECT * FROM ProjectDatabaseJitAccess WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectDatabaseJitAccess SET UserRoles = '[{"role":"read_only"}]' WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND UserId = '3f29a7e1-52b4-4c6a-9d3e-8b7c1a2f9e60'
DELETE FROM ProjectDatabaseJitAccess WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND UserId = '3f29a7e1-52b4-4c6a-9d3e-8b7c1a2f9e60'

ProjectDatabaseMigrations:

SELECT * FROM ProjectDatabaseMigrations WHERE ProjectId = 'ttvohtavntbpzzvcznof'
INSERT INTO ProjectDatabaseMigrations (ProjectId, Name, Statements) VALUES ('ttvohtavntbpzzvcznof', 'add_users_table', 'CREATE TABLE users (id serial primary key, email text);')
UPDATE ProjectDatabaseMigrations SET Name = 'add_users_table_v2' WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND Version = '20260101000000'
DELETE FROM ProjectDatabaseMigrations WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND Version = '20260101000000'

ProjectDatabasePostgresConfig:

SELECT * FROM ProjectDatabasePostgresConfig WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectDatabasePostgresConfig SET StatementTimeout = '30s', MaxConnections = 100 WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectFunctions:

SELECT * FROM ProjectFunctions WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectFunctions SET Name = 'my-function-renamed', IsJwtVerificationEnabled = true WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND Slug = 'my-function'
DELETE FROM ProjectFunctions WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND Slug = 'my-function'

ProjectHealth:

SELECT * FROM ProjectHealth WHERE ProjectId = 'ttvohtavntbpzzvcznof' AND Services = 'api'

ProjectNetworkRestrictions:

SELECT * FROM ProjectNetworkRestrictions WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectPostgrestConfig:

SELECT * FROM ProjectPostgrestConfig WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectPostgrestConfig SET MaxRows = 500, DbPool = 20 WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectRealtimeConfig:

SELECT * FROM ProjectRealtimeConfig WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectRealtimeConfig SET MaxConcurrentUsers = 150 WHERE ProjectId = 'ttvohtavntbpzzvcznof'

Projects:

SELECT * FROM Projects
INSERT INTO Projects (Name, OrganizationSlug, Region, DatabasePassword) VALUES ('acme-project', 'acmeorg123', 'us-east-1', 'S3cureP@ssw0rd!')
UPDATE Projects SET Name = 'acme-project-renamed' WHERE Ref = 'ttvohtavntbpzzvcznof'
DELETE FROM Projects WHERE Ref = 'ttvohtavntbpzzvcznof'

ProjectSslEnforcement:

SELECT * FROM ProjectSslEnforcement WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectSslEnforcement SET CurrentConfig = '{"database":true}' WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectStorageBuckets:

SELECT * FROM ProjectStorageBuckets WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectStorageConfig:

SELECT * FROM ProjectStorageConfig WHERE ProjectId = 'ttvohtavntbpzzvcznof'
UPDATE ProjectStorageConfig SET FileSizeLimit = 10485760 WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectUpgradeEligibility:

SELECT * FROM ProjectUpgradeEligibility WHERE ProjectId = 'ttvohtavntbpzzvcznof'

ProjectUpgradeStatus:

SELECT * FROM ProjectUpgradeStatus WHERE ProjectId = 'ttvohtavntbpzzvcznof'

Snippets:

SELECT * FROM Snippets

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your Supabase Management API token for authentication.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0