Report Notifications

Download schema

Activate report notification

POST

https://api.costfluent.com

/v1/cost-report-subscriptions/{subscriptionId}/activate

Bearer (API token)

Activates a paused report notification.

Needs a token with manageCostReportSubscriptions on the workspace.

Activate report notification › path Parameters

subscriptionId

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

Activate report notification › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Activate report notification › Headers

If-Match

string

Applies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.

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.

Needs a token with viewCostReportSubscriptions on the workspace.

List report notifications › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

costReportId

page

integer · int32

The page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.

Default: 1

limit

integer · int32

Items per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.

Default: 20

List report notifications › Responses

Success

PaginatedResponseOfCostReportSubscriptionResponse

PaginationLinks · required

CostReportSubscriptionResponse[] · required

GET/v1/cost-report-subscriptions

curl 'https://api.costfluent.com/v1/cost-report-subscriptions?workspaceId=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "links": {
    "self": "self",
    "first": "first",
    "prev": "prev",
    "next": "next",
    "last": "last"
  },
  "data": [
    {
      "id": "id",
      "costReportId": "costReportId",
      "name": "name",
      "scheduleType": "scheduleType",
      "deliveryHour": 0,
      "timeZone": "timeZone",
      "appIds": [
        "string"
      ],
      "isActive": true,
      "lastSentAt": "2024-08-25T15:00:00Z",
      "nextScheduledAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create report notification

POST

https://api.costfluent.com

/v1/cost-report-subscriptions

Bearer (API token)

Creates a new scheduled report notification.

Needs a token with manageCostReportSubscriptions on the workspace.

Create report notification › Headers

Idempotency-Key

string · minLength: 1 · maxLength: 255

A 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.

Create report notification › Request Body

CreateCostReportSubscriptionRequest

workspaceId

WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

costReportId

CostReportPublicId · minLength: 1 · pattern: ^crp_[A-Za-z0-9_-]{2… · required

name

string · minLength: 0 · maxLength: 200 · required

scheduleType

ScheduleType · required

appIds

AppPublicId[] · minLength: 1 · required

deliveryHour

integer | null · int32 · min: 0 · max: 23

timeZone

string | null

Create report notification › Responses

Created

CostReportSubscriptionCreatedResponse

id

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

name

string · required

POST/v1/cost-report-subscriptions

curl https://api.costfluent.com/v1/cost-report-subscriptions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workspaceId": "workspaceId",
  "costReportId": "costReportId",
  "name": "name",
  "scheduleType": "scheduleType",
  "deliveryHour": 0,
  "timeZone": "timeZone",
  "appIds": [
    "string"
  ]
}'

Example Request Body

{
  "workspaceId": "workspaceId",
  "costReportId": "costReportId",
  "name": "name",
  "scheduleType": "scheduleType",
  "deliveryHour": 0,
  "timeZone": "timeZone",
  "appIds": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name"
}

json

application/json

Deactivate report notification

POST

https://api.costfluent.com

/v1/cost-report-subscriptions/{subscriptionId}/deactivate

Bearer (API token)

Deactivates a report notification.

Needs a token with manageCostReportSubscriptions on the workspace.

Deactivate report notification › path Parameters

subscriptionId

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

Deactivate report notification › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Deactivate report notification › Headers

If-Match

string

Applies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.

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.

Needs a token with viewCostReportSubscriptions on the workspace.

Get report notification › path Parameters

subscriptionId

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

Get report notification › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Get report notification › Responses

Success

CostReportSubscriptionResponse

id

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

costReportId

CostReportPublicId · pattern: ^crp_[A-Za-z0-9_-]{2… · required

name

string · required

scheduleType

ScheduleType · required

deliveryHour

integer · int32 · required

timeZone

string · required

appIds

AppPublicId[] · required

isActive

boolean · required

createdAt

string · date-time · required

lastSentAt

string | null · date-time

nextScheduledAt

string | null · date-time

updatedAt

string | null · date-time

Update report notification

PATCH

https://api.costfluent.com

/v1/cost-report-subscriptions/{subscriptionId}

Bearer (API token)

Updates a report notification and returns it as stored.

Needs a token with manageCostReportSubscriptions on the workspace.

Update report notification › path Parameters

subscriptionId

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

Update report notification › Headers

If-Match

string

Applies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.

Update report notification › Request Body

UpdateCostReportSubscriptionRouteRequest

workspaceId

WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

name

string | null · minLength: 0 · maxLength: 200

deliveryHour

integer | null · int32 · min: 0 · max: 23

timeZone

string | null

appIds

array | null

Update report notification › Responses

Success

CostReportSubscriptionResponse

id

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

costReportId

CostReportPublicId · pattern: ^crp_[A-Za-z0-9_-]{2… · required

name

string · required

scheduleType

ScheduleType · required

deliveryHour

integer · int32 · required

timeZone

string · required

appIds

AppPublicId[] · required

isActive

boolean · required

createdAt

string · date-time · required

lastSentAt

string | null · date-time

nextScheduledAt

string | null · date-time

updatedAt

string | null · date-time

PATCH/v1/cost-report-subscriptions/{subscriptionId}

curl https://api.costfluent.com/v1/cost-report-subscriptions/:subscriptionId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workspaceId": "workspaceId",
  "name": "name",
  "scheduleType": "string",
  "deliveryHour": 0,
  "timeZone": "timeZone",
  "appIds": [
    "string"
  ]
}'

Example Request Body

{
  "workspaceId": "workspaceId",
  "name": "name",
  "scheduleType": "string",
  "deliveryHour": 0,
  "timeZone": "timeZone",
  "appIds": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "costReportId": "costReportId",
  "name": "name",
  "scheduleType": "scheduleType",
  "deliveryHour": 0,
  "timeZone": "timeZone",
  "appIds": [
    "string"
  ],
  "isActive": true,
  "lastSentAt": "2024-08-25T15:00:00Z",
  "nextScheduledAt": "2024-08-25T15:00:00Z",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete report notification

DELETE

https://api.costfluent.com

/v1/cost-report-subscriptions/{subscriptionId}

Bearer (API token)

Deletes a report notification.

Needs a token with manageCostReportSubscriptions on the workspace.

Delete report notification › path Parameters

subscriptionId

CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required

Delete report notification › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Delete report notification › Headers

If-Match

string

Applies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.

Delete report notification › Responses

No Content

No data returned

Providers Saved Filters