---
title: "List CMX usage history."
method: GET
path: "/cmx/history"
tags: ["cmx"]
---

# List CMX usage history.

`GET /cmx/history`

List CMX usage history for both VMs and clusters.

## Query parameters

- `pageSize` integer
- `currentPage` integer
- `sortColumn` string
- `sortDesc` boolean
- `start-time` string
- `end-time` string
- `actor-filter` string
- `tag-filter` string
- `tag-sort-key` string
- `distribution-type` 'kubernetes' | 'vm'
- `count-only` boolean

## Response `200`

ListCMXHistoryResponse contains the response to listing CMX history

- object
  - `history` CMXHistory[]
    - `actor` Actor
      - `description` string
      - `id` string
      - `link` string
      - `timestamp` string, date-time
      - `type` string
    - `assigned_at` string, date-time
    - `created_at` string, date-time
    - `credits_per_hour` integer
    - `disk_gib` integer
    - `distribution` string
    - `distribution_type` string
    - `duration` integer
    - `expires_at` string, date-time
    - `flat_fee` integer
    - `guid` string
    - `id` string
    - `instance_type` string
    - `minutes_billed` integer
    - `name` string
    - `network_id` string
    - `node_groups` integer
    - `nodes` integer
    - `running_at` string, date-time
    - `status` string
    - `tags` Tag[]
      - `key` string
      - `value` string
    - `team_id` string
    - `terminated_at` string, date-time
    - `total_credits` integer
    - `ttl` string
    - `version` string
  - `total` integer

## Other responses

- `400` — Returned on bad input
- `401` — Return if the caller is not authorized
- `403` — Returned if the caller does not have the needed permission
- `404` — Returned on resource not found

---

[API](https://skmtc.net/replicated/apis/vendor-api-v3.md) · [All operations](https://skmtc.net/replicated/apis/vendor-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/replicated/vendor-api-v3/revisions/6fcf9e54aba4/schema)