API Overview
What the Catio API does, its base URL, and how it behaves: pagination, retries, secrets and merge patches.
The Catio API lets you manage your organization's integrations from scripts, CI pipelines, and infrastructure as code. Use it to connect new cloud accounts as they are created, keep integration settings in version control, and trigger extraction runs from your own automation, instead of clicking through the console.
What you can do
| Resource | What it is | Operations |
|---|---|---|
| Integration types | The kinds of integration the API can create, and the properties each one needs | List, get |
| Integrations | Your organization's connected sources | List, create, get, update, delete |
| Runs | Extraction runs of an integration | List, start, get |
The API can create three integration types today: aws (an AWS account's resources), aws-vpc-flow-logs (VPC Flow Logs), and aws-cost-usage (an AWS Cost and Usage Report). Other integration types are configured in the console. See What is an Integration?.
Base URL
https://api.catio.tech/v1
Every request is authenticated with an API key. See Authentication.
How the API behaves
- JSON in, JSON out. Requests and responses are JSON. Errors use
application/problem+json. See Errors. - Property values are strings. Integration properties are always sent as JSON strings, so send an integer as
"5"and a boolean as"true". - Secrets are write-only. Properties marked secret are stored encrypted and never returned.
- Retries are safe. Creating an integration that already exists with the same properties returns the existing one with
200, and starting a run while one is active returns the active run with200. Neither creates a duplicate. - Pagination. List operations return up to
pageSizeitems (default 50, maximum 100) and anextPageToken. Pass it back aspageTokenand keep reading while it is present. A filtered page can hold fewer items thanpageSize, even none, before the last page. - Updates are merge patches.
PATCHtakes only the fields that change, so you can rotate a secret without resending the rest.
Start here
- Authentication: create a key and make your first call.
- Quickstart: Connect an AWS Account: create an integration and run it, end to end.
- Errors and Rate Limits and Versioning: what to handle before you ship.
The full reference for every endpoint, with a request builder you can call from the page, is generated from the OpenAPI specification.
Updated 15 days ago
