Providers
List providers
Returns all connected providers for the authenticated organization.
Needs a token with viewProviders; a workspace token lists its own workspace only.
query Parameters
typepageThe page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.
limitItems per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.
List providers › Responses
Success
Connect provider
Connects a new cloud provider, platform, or integration for cost monitoring.
Needs an organization token with manageProviders.
Headers
Idempotency-KeyA unique value, at most 255 printable ASCII characters, such as a UUID, that makes retrying this create safe. A retry with the same key and the same request within 24 hours answers the first response again, marked Idempotent-Replayed: true, and creates nothing; the same key with another request answers 422 idempotency_key_reused. A key is kept only for a create that succeeded. Without it, every request creates.
Connect provider › Request Body
keydisplayNamedescriptionexternalIdsyncFrequencyMinutesConnect provider › Responses
Created
id^prv_[A-Za-z0-9_-]{2… · requiredtypekeydisplayNameGet provider
Returns details of a specific provider.
Needs an organization token with viewProviders.
path Parameters
providerId^prv_[A-Za-z0-9_-]{2… · requiredGet provider › Responses
Success
id^prv_[A-Za-z0-9_-]{2… · requiredtypekeydisplayNamestatussyncFrequencyMinutescreatedAtdescriptionexternalIdlastSyncAtlastSyncStatuslastSyncErrornextSyncAtupdatedAtUpdate provider
Updates a provider in place: its display name, description, settings, credentials or sync frequency. A field left out keeps its value; clearDescription and clearSettings remove theirs. An update that another write to the provider overtook, or whose credentials or settings changed while the new credentials or export location were verified, answers 409 concurrency_conflict and changes nothing.
Needs an organization token with manageProviders.
path Parameters
providerId^prv_[A-Za-z0-9_-]{2… · requiredHeaders
If-MatchApplies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.
Update provider › Request Body
displayNamedescriptionclearDescriptionexternalIdclearSettingssyncFrequencyMinutesUpdate provider › Responses
Success
id^prv_[A-Za-z0-9_-]{2… · requiredtypekeydisplayNamestatussyncFrequencyMinutescreatedAtdescriptionexternalIdlastSyncAtlastSyncStatuslastSyncErrornextSyncAtupdatedAtDelete provider
Disconnects a provider: its stored credentials are deleted, every workspace stops counting it at once, and the cost data it imported is then erased. Reports, budgets and alerts stay. This cannot be undone. Refused with 409 conflict while child providers depend on it, and with 409 concurrency_conflict when another write to the provider overtook the delete.
Needs an organization token with manageProviders.
path Parameters
providerId^prv_[A-Za-z0-9_-]{2… · requiredHeaders
If-MatchApplies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.
Delete provider › Responses
No Content
Get available providers
Returns all supported provider types and their configuration requirements.
Needs any valid token.
query Parameters
pageThe page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.
limitItems per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.
Get available providers › Responses
Success
Get the AWS connector
Returns the Costfluent principal and this organization's external ID that an AWS IAM role must trust before it is connected. Stable for the organization; read-only.
Needs an organization token with manageProviders.
Get the AWS connector › Responses
Success
principalArnexternalIdregiontemplateUrlGet provider sync history
Returns the provider's newest 100 collection runs, newest first, paged. A run with status PartialFailure published incomplete data: quarantinedCount rows could not be imported.
Needs an organization token with viewProviders.
path Parameters
providerId^prv_[A-Za-z0-9_-]{2… · requiredquery Parameters
pageThe page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.
limitItems per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.
Get provider sync history › Responses
Success
Provision the GCP service account
Returns the service account this organization grants BigQuery Data Viewer on its GCP billing export dataset to, creating it on the first call. Idempotent.
Needs an organization token with manageProviders.
Provision the GCP service account › Responses
Success
serviceAccountEmailorganizationId^[0-9]+$directoryCustomerIdTest provider connection
Validates credentials and connectivity to the provider. A test whose provider's credentials or settings changed while it ran answers 409 concurrency_conflict and records nothing. A connection is tested at most once a minute with the same credentials and settings; a test sooner answers 429 rate_limit_exceeded with Retry-After and asks the provider nothing.
Needs an organization token with manageProviders.
path Parameters
providerId^prv_[A-Za-z0-9_-]{2… · requiredTest provider connection › Responses
Success
Trigger provider sync
Initiates a cost data sync from the provider. Use fullSync=true for complete re-sync.
Needs an organization token with syncProviders.
path Parameters
providerId^prv_[A-Za-z0-9_-]{2… · requiredTrigger provider sync › Responses
Success