Command reference
deployments usage
Metered usage
| Command | Summary |
|---|---|
deployments usage show | Show usage aggregates |
deployments usage summary | Summarize usage per metric and hour or day |
deployments usage show
Show usage aggregates.
deployments usage show- Calls
GET /v1/usage(SDKlistUsageRecords). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
--since | string | Start timestamp | ||
--until | string | End timestamp | ||
--metric | string | Usage metric |
Also accepts the global flags.
deployments usage summary
Summarize usage per metric and hour or day.
deployments usage summary --since <since> --until <until>- Calls
GET /v1/usage/summary(SDKgetUsageSummary). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--since | string | yes | Start timestamp on an interval boundary (UTC) | |
--until | string | yes | End timestamp on an interval boundary (UTC), exclusive | |
--interval | string | Bucket width: hour (default) or day | ||
--definition | string | Only usage of runs that executed this agent definition | ||
--workspace-id | string | Only usage that names this workspace; not combinable with --definition |
Also accepts the global flags.