Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions cli/reference/accept-price-increase.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: "vastai accept price-increase"
sidebarTitle: "accept price-increase"
---

Accept one or more pending host price increases

## Usage

```bash
vastai accept price-increase ID [ID ...] [--yes]
```

## Arguments

<ParamField path="ids" type="integer" required>
instance IDs to accept (one or more).
</ParamField>

## Options

<ParamField path="--yes" type="boolean">
skip the interactive prompt; required when stdin is not a TTY
</ParamField>

## Description

Review pending price increases with `vastai show pending-price-increases`
before accepting. The CLI fans out one PUT per instance ID (no batch
endpoint exists on the backend), and the new rate applies only after
each contract's current end_date — your remaining time on the current
term is billed at the original price.

## Examples

```bash
vastai accept price-increase 123 --yes
vastai accept price-increase 1 2 3 --yes

Exit codes:
0 — every requested row was accepted
1 — at least one row failed (non-stale)
2 — at least one row was stale (re-run `show pending-price-increases`)
```

## Global Options

The following options are available for all commands:

| Option | Description |
| --- | --- |
| `--url URL` | Server REST API URL |
| `--retry N` | Retry limit |
| `--raw` | Output machine-readable JSON |
| `--explain` | Verbose explanation of API calls |
| `--api-key KEY` | API key (defaults to `~/.config/vastai/vast_api_key`) |
32 changes: 29 additions & 3 deletions cli/reference/cancel-maint.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
---
title: "vastai cancel maint"
sidebarTitle: "cancel maint"
description: "Host command"
---

import CancelMaintCLI from '/snippets/host/cli/cancel-maint.mdx';
[Host] Cancel maint window

<CancelMaintCLI />
## Usage

```bash
vastai cancel maint id
```

## Arguments

<ParamField path="id" type="integer" required>
id of machine to cancel maintenance(s) for
</ParamField>

## Description

For deleting a machine's scheduled maintenance window(s), use this cancel maint command.
Example: vastai cancel maint 8207

## Global Options

The following options are available for all commands:

| Option | Description |
| --- | --- |
| `--url URL` | Server REST API URL |
| `--retry N` | Retry limit |
| `--raw` | Output machine-readable JSON |
| `--explain` | Verbose explanation of API calls |
| `--api-key KEY` | API key (defaults to `~/.config/vastai/vast_api_key`) |
21 changes: 8 additions & 13 deletions cli/reference/change-bid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,36 +24,31 @@ vastai change bid id [--price PRICE]
</ParamField>

<ParamField path="--schedule" type="string">
try to schedule a command to run hourly, daily, or monthly. Valid values are HOURLY, DAILY, WEEKLY For ex. `--schedule` DAILY Choices: `HOURLY`, `DAILY`, `WEEKLY`
try to schedule a command to run hourly, daily, or weekly. Valid values are HOURLY, DAILY, WEEKLY For ex. --schedule DAILY
Allowed values: HOURLY, DAILY, WEEKLY
</ParamField>

<ParamField path="--start_date" type="string">
<ParamField path="--start_date" type="string" default="2026-06-23">
Start date/time in format 'YYYY-MM-DD HH:MM:SS PM' (UTC). Default is now. (optional)
</ParamField>

<ParamField path="--end_date" type="string">
<ParamField path="--end_date" type="string" default="2026-06-30">
End date/time in format 'YYYY-MM-DD HH:MM:SS PM' (UTC). Default is 7 days from now. (optional)
</ParamField>

<ParamField path="--day" type="integer" default="0">
Day of week you want scheduled job to run on (0-6, where 0=Sunday) or "*". Default will be 0. For ex. `--day` 0
<ParamField path="--day" type="parse_day_cron_style">
Day of week you want scheduled job to run on (0-6, where 0=Sunday) or "*". Default will be 0. For ex. --day 0
</ParamField>

<ParamField path="--hour" type="integer" default="0">
Hour of day you want scheduled job to run on (0-23) or "*" (UTC). Default will be 0. For ex. `--hour` 16
<ParamField path="--hour" type="parse_hour_cron_style">
Hour of day you want scheduled job to run on (0-23) or "*" (UTC). Default will be 0. For ex. --hour 16
</ParamField>

## Description

Change the current bid price of instance id to PRICE.
If PRICE is not specified, then a winning bid price is used as the default.

## Examples

```bash
vastai change bid <ID>
```

## Global Options

The following options are available for all commands:
Expand Down
34 changes: 31 additions & 3 deletions cli/reference/cleanup-machine.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,37 @@
---
title: "vastai cleanup machine"
sidebarTitle: "cleanup machine"
description: "Host command"
---

import CleanupMachineCLI from '/snippets/host/cli/cleanup-machine.mdx';
[Host] Remove all expired storage instances from the machine, freeing up space

<CleanupMachineCLI />
## Usage

```bash
vastai cleanup machine ID [options]
```

## Arguments

<ParamField path="id" type="integer" required>
id of machine to cleanup
</ParamField>

## Description

Instances expire on their end date. Expired instances still pay storage fees, but can not start.
Since hosts are still paid storage fees for expired instances, we do not auto delete them.
Instead you can use this CLI/API function to delete all expired storage instances for a machine.
This is useful if you are running low on storage, want to do maintenance, or are subsidizing storage, etc.

## Global Options

The following options are available for all commands:

| Option | Description |
| --- | --- |
| `--url URL` | Server REST API URL |
| `--retry N` | Retry limit |
| `--raw` | Output machine-readable JSON |
| `--explain` | Verbose explanation of API calls |
| `--api-key KEY` | API key (defaults to `~/.config/vastai/vast_api_key`) |
14 changes: 4 additions & 10 deletions cli/reference/clone-volume.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,19 @@ vastai clone volume <source_id> <dest_id> [options]

## Options

<ParamField path="-s" type="number">
Size of new volume contract, in GB. Must be greater than or equal to the source volume, and less than or equal to the destination offer. (alias: `--size`)
<ParamField path="--size" type="number">
Size of new volume contract, in GB. Must be greater than or equal to the source volume, and less than or equal to the destination offer.
</ParamField>

<ParamField path="-d" type="boolean">
Do not compress volume data before copying. (alias: `--disable_compression`)
<ParamField path="--disable_compression" type="boolean">
Do not compress volume data before copying.
</ParamField>

## Description

Create a new volume with the given offer, by copying the existing volume.
Size defaults to the size of the existing volume, but can be increased if there is available space.

## Examples

```bash
vastai clone volume <SOURCE> <DEST>
```

## Global Options

The following options are available for all commands:
Expand Down
15 changes: 8 additions & 7 deletions cli/reference/cloud-copy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Copy files/folders to and from cloud providers
## Usage

```bash
vastai cloud copy --src SRC --dst DST --instance INSTANCE_ID -connection CONNECTION_ID --transfer TRANSFER_TYPE
vastai cloud copy --src SRC --dst DST --instance INSTANCE_ID --connection CONNECTION_ID --transfer TRANSFER_TYPE
```

## Options
Expand Down Expand Up @@ -54,23 +54,24 @@ vastai cloud copy --src SRC --dst DST --instance INSTANCE_ID -connection CONNECT
</ParamField>

<ParamField path="--schedule" type="string">
try to schedule a command to run hourly, daily, or monthly. Valid values are HOURLY, DAILY, WEEKLY For ex. `--schedule` DAILY Choices: `HOURLY`, `DAILY`, `WEEKLY`
try to schedule a command to run hourly, daily, or weekly. Valid values are HOURLY, DAILY, WEEKLY For ex. --schedule DAILY
Allowed values: HOURLY, DAILY, WEEKLY
</ParamField>

<ParamField path="--start_date" type="string">
<ParamField path="--start_date" type="string" default="2026-06-23">
Start date/time in format 'YYYY-MM-DD HH:MM:SS PM' (UTC). Default is now. (optional)
</ParamField>

<ParamField path="--end_date" type="string">
End date/time in format 'YYYY-MM-DD HH:MM:SS PM' (UTC). Default is contract's end. (optional)
</ParamField>

<ParamField path="--day" type="integer" default="0">
Day of week you want scheduled job to run on (0-6, where 0=Sunday) or "*". Default will be 0. For ex. `--day` 0
<ParamField path="--day" type="parse_day_cron_style">
Day of week you want scheduled job to run on (0-6, where 0=Sunday) or "*". Default will be 0. For ex. --day 0
</ParamField>

<ParamField path="--hour" type="integer" default="0">
Hour of day you want scheduled job to run on (0-23) or "*" (UTC). Default will be 0. For ex. `--hour` 16
<ParamField path="--hour" type="parse_hour_cron_style">
Hour of day you want scheduled job to run on (0-23) or "*" (UTC). Default will be 0. For ex. --hour 16
</ParamField>

## Description
Expand Down
4 changes: 2 additions & 2 deletions cli/reference/copy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ vastai copy SRC DST

## Options

<ParamField path="-i" type="string">
Location of ssh private key (alias: `--identity`)
<ParamField path="--identity" type="string">
Location of ssh private key
</ParamField>

## Description
Expand Down
6 changes: 0 additions & 6 deletions cli/reference/create-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,6 @@ vastai create api-key --name NAME --permission_file PERMISSIONS
In order to create api keys you must understand how permissions must be sent via json format.
You can find more information about permissions here: https://vast.ai/docs/cli/roles-and-permissions

## Examples

```bash
vastai create api-key
```

## Global Options

The following options are available for all commands:
Expand Down
44 changes: 0 additions & 44 deletions cli/reference/create-cluster.mdx

This file was deleted.

12 changes: 3 additions & 9 deletions cli/reference/create-endpoint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ vastai create endpoint [OPTIONS]

## Options

<ParamField path="--min_load" type="number" default="0.0">
<ParamField path="--min_load" type="number">
minimum floor load in perf units/s (token/s for LLms)
</ParamField>

<ParamField path="--min_cold_load" type="number" default="0.0">
<ParamField path="--min_cold_load" type="number">
minimum floor load in perf units/s (token/s for LLms), but allow handling with cold workers
</ParamField>

Expand Down Expand Up @@ -57,13 +57,7 @@ vastai create endpoint [OPTIONS]

Create a new endpoint group to manage many autoscaling groups

Example: vastai create endpoint `--target_util` 0.9 `--cold_mult` 2.0 `--endpoint_name` "LLama"

## Examples

```bash
vastai create endpoint
```
Example: vastai create endpoint --target_util 0.9 --cold_mult 2.0 --endpoint_name "LLama"

## Global Options

Expand Down
6 changes: 0 additions & 6 deletions cli/reference/create-env-var.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,6 @@ vastai create env-var <name> <value>
Environment variable value
</ParamField>

## Examples

```bash
vastai create env-var <NAME> <VALUE>
```

## Global Options

The following options are available for all commands:
Expand Down
Loading