For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
  • REST
    • Authentication
    • Platform
    • Event-Driven Sync (EDRTS)
    • Content
    • FeedAMP Order
    • FeedAMP Order V2
    • FeedAMP Order Source
LogoLogo
On this page
  • Rate Limiting
REST

Platform API

Was this page helpful?
Previous

Generate authentication token

Next

Retrieves a list of dbs with status on their imports and exports

Built with

The Platform API helps manage databases and streamline operations across channels. Use it to handle accounts, databases, data transformations, and import/export schedules efficiently.

Use this API to:

  • Create and manage accounts and databases
  • Configure and update imports, exports, and schedules
  • Add, update, and delete data transformers
  • Manage channel credentials securely with vault entries

Rate Limiting

Included headers in every authenticated response (success or failure):

  • X-Rate-Limit-Group: The name of the API group.
  • X-Rate-Limit-Remaining: The number of remaining requests in the current time window.
  • X-Rate-Limit-Reset: The timestamp when the rate limit will reset.

If the rate limit is exceeded, the API will return an HTTP 429 status code and a message with how many seconds to wait until the limit resets.

1{"status":"fail","message":"Rate Limit Exceeded. Please wait -timeUntilReset- seconds before trying again."}