--- title: "List Cloud Cost" method: POST path: "/cloud-cost/get-list" tags: ["Cloud Cost"] --- # List Cloud Cost `POST /cloud-cost/get-list` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/cloud-cost/get-list` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to list all Cloud Cost items ## Request body - object - `query` CloudCostV1QuerySchema: Query schema for CloudCostV1. A field takes a plain value, which it matches exactly, or an operator its type allows. Telemetry tables are large: bound every query by day. - `projectId` union: Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `cloudAccountId` union: Query operators for cloudAccountId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `cloudConnectionId` union: Query operators for cloudConnectionId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `provider` union: Query operators for provider field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `accountId` union: Query operators for accountId field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `day` union: Query operators for day field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z. - string, date-time - object - `_type` 'NotEqual', required - `value` string, date-time, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'GreaterThan', required - `value` string, date-time, required - object - `_type` 'GreaterThanOrEqual', required - `value` string, date-time, required - object - `_type` 'LessThan', required - `value` string, date-time, required - object - `_type` 'LessThanOrEqual', required - `value` string, date-time, required - object - `_type` 'InBetween', required - `startValue` string, date-time, required - `endValue` string, date-time, required - `service` union: Query operators for service field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `region` union: Query operators for region field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `resourceId` union: Query operators for resourceId field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `cost` union: Query operators for cost field of type Decimal. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. - number - object - `_type` 'NotEqual', required - `value` number, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'GreaterThan', required - `value` number, required - object - `_type` 'GreaterThanOrEqual', required - `value` number, required - object - `_type` 'LessThan', required - `value` number, required - object - `_type` 'LessThanOrEqual', required - `value` number, required - object - `_type` 'InBetween', required - `startValue` number, required - `endValue` number, required - `currency` union: Query operators for currency field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `readAt` union: Query operators for readAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z. - string, date-time - object - `_type` 'NotEqual', required - `value` string, date-time, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'GreaterThan', required - `value` string, date-time, required - object - `_type` 'GreaterThanOrEqual', required - `value` string, date-time, required - object - `_type` 'LessThan', required - `value` string, date-time, required - object - `_type` 'LessThanOrEqual', required - `value` string, date-time, required - object - `_type` 'InBetween', required - `startValue` string, date-time, required - `endValue` string, date-time, required - `_id` union: Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `createdAt` union: Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z. - string, date-time - object - `_type` 'NotEqual', required - `value` string, date-time, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'GreaterThan', required - `value` string, date-time, required - object - `_type` 'GreaterThanOrEqual', required - `value` string, date-time, required - object - `_type` 'LessThan', required - `value` string, date-time, required - object - `_type` 'LessThanOrEqual', required - `value` string, date-time, required - object - `_type` 'InBetween', required - `startValue` string, date-time, required - `endValue` string, date-time, required - `select` CloudCostV1SelectSchema: Select schema for CloudCostV1. Set fields to true to include them in the response. - `projectId` boolean - `cloudAccountId` boolean - `cloudConnectionId` boolean - `provider` boolean - `accountId` boolean - `day` boolean - `service` boolean - `region` boolean - `resourceId` boolean - `cost` boolean - `currency` boolean - `readAt` boolean - `_id` boolean - `createdAt` boolean - `sort` CloudCostV1SortSchema: Sort schema for CloudCostV1. Only sortable fields are included. - `projectId` 'ASC' | 'DESC': Sort order for projectId field - `cloudAccountId` 'ASC' | 'DESC': Sort order for cloudAccountId field - `cloudConnectionId` 'ASC' | 'DESC': Sort order for cloudConnectionId field - `provider` 'ASC' | 'DESC': Sort order for provider field - `accountId` 'ASC' | 'DESC': Sort order for accountId field - `day` 'ASC' | 'DESC': Sort order for day field - `service` 'ASC' | 'DESC': Sort order for service field - `region` 'ASC' | 'DESC': Sort order for region field - `resourceId` 'ASC' | 'DESC': Sort order for resourceId field - `cost` 'ASC' | 'DESC': Sort order for cost field - `currency` 'ASC' | 'DESC': Sort order for currency field - `readAt` 'ASC' | 'DESC': Sort order for readAt field - `_id` 'ASC' | 'DESC': Sort order for _id field - `createdAt` 'ASC' | 'DESC': Sort order for createdAt field - `groupBy` CloudCostV1GroupBySchema: Group by schema for CloudCostV1. Only one field can be set to true for grouping. - `projectId` boolean: Group by projectId field. Only one field can be selected for grouping. - `cloudAccountId` boolean: Group by cloudAccountId field. Only one field can be selected for grouping. - `cloudConnectionId` boolean: Group by cloudConnectionId field. Only one field can be selected for grouping. - `provider` boolean: Group by provider field. Only one field can be selected for grouping. - `accountId` boolean: Group by accountId field. Only one field can be selected for grouping. - `day` boolean: Group by day field. Only one field can be selected for grouping. - `service` boolean: Group by service field. Only one field can be selected for grouping. - `region` boolean: Group by region field. Only one field can be selected for grouping. - `resourceId` boolean: Group by resourceId field. Only one field can be selected for grouping. - `currency` boolean: Group by currency field. Only one field can be selected for grouping. - `readAt` boolean: Group by readAt field. Only one field can be selected for grouping. - `_id` boolean: Group by _id field. Only one field can be selected for grouping. - `createdAt` boolean: Group by createdAt field. Only one field can be selected for grouping. - `limit` number: Maximum number of items to return. Defaults to 10. - `skip` number: Number of items to skip for pagination. Defaults to 0. ## Response `200` Successful response - object - `data` CloudCostV1[] - `projectId` string, required: Project ID - `cloudAccountId` string, required: Cloud Account ID - `cloudConnectionId` string, required: Cloud Connection ID - `provider` string, required: Cloud Provider - `accountId` string, required: Account - `day` string, date-time, required: Day - `service` string, required: Service - `region` string: Region - `resourceId` string: Resource - `cost` number, required: Cost - `currency` string, required: Currency - `readAt` string, date-time, required: Read At - `count` number ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)