Costfluent Public API
​​integer · int32 · required
​string · minLength: 0 · maxLength: 200 · required​CostfluentDomainEnumsScheduleType · enum · required​string · required
​string · required​string · required​boolean​string | null · date-time​string | null · date-time​string · date-time​string | null · date-time
Activate report notification
POST
https://api.costfluent.com
/v1/cost-report-subscriptions/{subscriptionId}/activate
Bearer (API token)
Activates a paused report notification
path Parameters
​CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId · required
query Parameters
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
Activate report notification › Responses
No Content
No data returned
List report notifications
GET
https://api.costfluent.com
/v1/cost-report-subscriptions
Bearer (API token)
Returns all report notifications for a workspace
query Parameters
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
costReportIdList report notifications › Responses
Success
​CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionResponse[] · required
totalCreate report notification
POST
https://api.costfluent.com
/v1/cost-report-subscriptions
Bearer (API token)
Creates a new scheduled report notification
Create report notification › Request Body
​CostfluentSharedKernelPublicIdsWorkspacePublicId · minLength: 1 · required
​CostfluentSharedKernelPublicIdsCostReportPublicId · minLength: 1 · required
namescheduleTypeEnum values:
daily
weekly
monthly
​CostfluentSharedKernelPublicIdsAppPublicId[] · minLength: 1 · required
Create report notification › Responses
Success
​CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId · required
nameDeactivate report notification
POST
https://api.costfluent.com
/v1/cost-report-subscriptions/{subscriptionId}/deactivate
Bearer (API token)
Deactivates a report notification
path Parameters
​CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId · required
query Parameters
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
Deactivate report notification › Responses
No Content
No data returned
Get report notification
GET
https://api.costfluent.com
/v1/cost-report-subscriptions/{subscriptionId}
Bearer (API token)
Returns a specific report notification
path Parameters
​CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId · required
query Parameters
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
Get report notification › Responses
Success
​CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId · required
​CostfluentSharedKernelPublicIdsCostReportPublicId · required
namescheduleType​CostfluentSharedKernelPublicIdsAppPublicId[] · required
isActivelastSentAtnextScheduledAtcreatedAtupdatedAtDelete report notification
DELETE
https://api.costfluent.com
/v1/cost-report-subscriptions/{subscriptionId}
Bearer (API token)
Deletes a report notification
path Parameters
​CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId · required
query Parameters
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
Delete report notification › Responses
No Content
No data returned
Update report notification
PATCH
https://api.costfluent.com
/v1/cost-report-subscriptions/{subscriptionId}
Bearer (API token)
Updates a report notification
path Parameters
​CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId · required
Update report notification › Responses
No Content
No data returned