Costfluent Public API
​string · minLength: 1 · required​string | null · minLength: 0 · maxLength: 255​string | null · minLength: 0 · maxLength: 1000​string | null​integer · int32 · min: 60 · max: 1440​string · required​string · required​string · required
​string · required​string · required​string · required​string · required​string | null​string | null​string | null · date-time​string | null​string | null​string | null · date-time​integer · int32​string · date-time​string | null · date-time
​string · required​string · required​string · required​string[] · required​string[] · required​string · required​string | null​boolean
​integer | null · int32
​boolean · required​string | null
​boolean · required​string | null
​string | null · minLength: 0 · maxLength: 1000​string | null​integer | null · int32 · min: 60 · max: 1440​string · required​string · required​string · required​string · required​string | null​string | null​string | null · date-time​string | null​string | null​string | null · date-time​integer · int32​string · date-time​string | null · date-time
Connect provider
POST
https://api.costfluent.com
/v1/providers
Bearer (API token)
Connects a new cloud provider, platform, or integration for cost monitoring
Connect provider › Request Body
key​object · minLength: 1 · required
namedescription​
externalId​object | null
syncFrequencyMinutesConnect provider › Responses
Success
​CostfluentSharedKernelPublicIdsProviderPublicId · required
typekeynameGet provider
GET
https://api.costfluent.com
/v1/providers/{providerId}
Bearer (API token)
Returns details of a specific provider
path Parameters
​CostfluentSharedKernelPublicIdsProviderPublicId · required
Get provider › Responses
Success
​CostfluentSharedKernelPublicIdsProviderPublicId · required
typekeynamestatusdescription​
externalIdlastSyncAtlastSyncStatuslastSyncErrornextSyncAtsyncFrequencyMinutescreatedAtupdatedAtDelete provider
DELETE
https://api.costfluent.com
/v1/providers/{providerId}
Bearer (API token)
Disconnects and removes a provider. Associated cost data may be retained.
path Parameters
​CostfluentSharedKernelPublicIdsProviderPublicId · required
Delete provider › Responses
No Content
No data returned
Get available providers
GET
https://api.costfluent.com
/v1/providers/available
Bearer (API token)
Returns all supported provider types and their configuration requirements
Get available providers › Responses
Success
keytypedisplayNamerequiredCredentialFieldsoptionalSettingFieldskindiconUrlrequiresParentProviderGet provider sync history
GET
https://api.costfluent.com
/v1/providers/{providerId}/sync-history
Bearer (API token)
Returns sync history for a provider
path Parameters
​CostfluentSharedKernelPublicIdsProviderPublicId · required
query Parameters
limitGet provider sync history › Responses
Test provider connection
POST
https://api.costfluent.com
/v1/providers/{providerId}/test
Bearer (API token)
Validates credentials and connectivity to the provider
path Parameters
​CostfluentSharedKernelPublicIdsProviderPublicId · required
Test provider connection › Responses
Success
successmessage​object | null
Trigger provider sync
POST
https://api.costfluent.com
/v1/providers/{providerId}/sync
Bearer (API token)
Initiates a cost data sync from the provider. Use fullSync=true for complete re-sync.
path Parameters
​CostfluentSharedKernelPublicIdsProviderPublicId · required
Trigger provider sync › Responses
Success
triggeredmessageUpdate provider
PUT
https://api.costfluent.com
/v1/providers/{id}
Bearer (API token)
Updates provider settings, credentials, or configuration
path Parameters
​CostfluentSharedKernelPublicIdsProviderPublicId · required
Update provider › Request Body
descriptionexternalId​object | null
​object | null
syncFrequencyMinutesUpdate provider › Responses
Success
​CostfluentSharedKernelPublicIdsProviderPublicId · required
typekeynamestatusdescription​
externalIdlastSyncAtlastSyncStatuslastSyncErrornextSyncAtsyncFrequencyMinutescreatedAtupdatedAt