# Vast.ai Documentation – Affordable GPU Cloud Marketplace ## Docs - [create api-key](https://docs.vast.ai/api-reference/accounts/create-api-key.md): Creates a new API key with specified permissions for the authenticated user. CLI Usage: `vastai create api-key --name --permission_file [--key_params ]` - [create env-var](https://docs.vast.ai/api-reference/accounts/create-env-var.md): Creates a new encrypted environment variable for the authenticated user. Keys are automatically converted to uppercase. Values are encrypted before storage. There is a limit on the total number of environment variables per user. CLI Usage: `vastai create env-var ` - [create ssh-key](https://docs.vast.ai/api-reference/accounts/create-ssh-key.md): Creates a new SSH key and associates it with your account. The key will be automatically added to all your current instances. CLI Usage: `vastai create ssh-key ` - [create subaccount](https://docs.vast.ai/api-reference/accounts/create-subaccount.md): Creates either a standalone user account or a subaccount under a parent account. Subaccounts can be restricted to host-only functionality. CLI Usage: `vastai create subaccount --email --username --password [--type host]` - [delete api key](https://docs.vast.ai/api-reference/accounts/delete-api-key.md): Deletes an existing API key belonging to the authenticated user. The API key is soft-deleted by setting a deleted_at timestamp. CLI Usage: `vastai delete api-key ` - [delete env var](https://docs.vast.ai/api-reference/accounts/delete-env-var.md): Deletes an environment variable associated with the authenticated user. The variable must exist and belong to the requesting user. CLI Usage: `vastai delete env-var ` - [delete ssh key](https://docs.vast.ai/api-reference/accounts/delete-ssh-key.md): Removes an SSH key from the authenticated user's account CLI Usage: `vastai delete ssh-key ` - [set user](https://docs.vast.ai/api-reference/accounts/set-user.md): Updates the user data for the authenticated user. CLI Usage: `vastai set user --file ` - [show api keys](https://docs.vast.ai/api-reference/accounts/show-api-keys.md): Retrieves all API keys associated with the authenticated user. CLI Usage: `vastai show api-keys` - [show connections](https://docs.vast.ai/api-reference/accounts/show-connections.md): Retrieves the list of cloud connections associated with the authenticated user. CLI Usage: `vastai show connections` - [show env vars](https://docs.vast.ai/api-reference/accounts/show-env-vars.md): Retrieve a list of environment variables (secrets) for the authenticated user. CLI Usage: `vastai show env-vars [-s]` - [show ipaddrs](https://docs.vast.ai/api-reference/accounts/show-ipaddrs.md): This endpoint retrieves the history of IP address accesses for the authenticated user. CLI Usage: `vastai show ipaddrs` - [show ssh keys](https://docs.vast.ai/api-reference/accounts/show-ssh-keys.md): Retrieve a list of SSH keys associated with the authenticated user's account. CLI Usage: `vastai show ssh-keys` - [show subaccounts](https://docs.vast.ai/api-reference/accounts/show-subaccounts.md): Retrieve a list of subaccounts associated with the authenticated user's account. CLI Usage: `vastai show subaccounts` - [show team role](https://docs.vast.ai/api-reference/accounts/show-team-role.md): Retrieve details of a specific team role by its name. CLI Usage: `vastai show team-role ` - [show user](https://docs.vast.ai/api-reference/accounts/show-user.md): Retrieve information about the current authenticated user, excluding the API key. CLI Usage: `vastai show user` - [transfer credit](https://docs.vast.ai/api-reference/accounts/transfer-credit.md): Transfers specified amount of credits from the authenticated user's account to another user's account. The recipient can be specified by either email address or user ID. CLI Usage: `vastai transfer credit ` - [update env var](https://docs.vast.ai/api-reference/accounts/update-env-var.md): Updates the value of an existing environment variable for the authenticated user. CLI Usage: `vastai update env-var ` - [update ssh key](https://docs.vast.ai/api-reference/accounts/update-ssh-key.md): Updates the specified SSH key with the provided value. CLI Usage: `vastai update ssh-key ` - [search invoices](https://docs.vast.ai/api-reference/billing/search-invoices.md): This endpoint allows users to search and retrieve invoices based on specified filters. CLI Usage: `vastai search invoices` - [show deposit](https://docs.vast.ai/api-reference/billing/show-deposit.md): Retrieves the deposit details for a specified instance. CLI Usage: `vastai show deposit ` - [show earnings](https://docs.vast.ai/api-reference/billing/show-earnings.md): Retrieves the earnings history for a specified time range and optionally per machine. CLI Usage: `vastai show earnings [options]` - [show invoices](https://docs.vast.ai/api-reference/billing/show-invoices.md): This endpoint retrieves billing history reports for the authenticated user, including charges and credits. CLI Usage: `vastai show invoices` - [attach ssh-key](https://docs.vast.ai/api-reference/instances/attach-ssh-key.md): Attaches an SSH key to the specified instance, allowing SSH access using the provided key. CLI Usage: `vastai attach ssh ` - [cancel copy](https://docs.vast.ai/api-reference/instances/cancel-copy.md): Cancel a remote copy operation specified by the destination ID (dst_id). CLI Usage: `vastai cancel copy --dst_id ` - [cancel sync](https://docs.vast.ai/api-reference/instances/cancel-sync.md): Cancels an in-progress remote sync operation identified by the destination instance ID. This operation cannot be resumed once canceled and must be restarted if needed. CLI Usage: `vastai cancel sync --dst_id ` - [change bid](https://docs.vast.ai/api-reference/instances/change-bid.md): Change the current bid price of an instance to a specified price. CLI Usage: `vastai change bid --price ` - [cloud copy](https://docs.vast.ai/api-reference/instances/cloud-copy.md): Starts a cloud copy operation by sending a command to the remote server. The operation can transfer data between an instance and a cloud service. CLI Usage: `vastai cloud copy [options]` - [copy](https://docs.vast.ai/api-reference/instances/copy.md): Initiate a remote copy operation to transfer data from one instance to another or between an instance and the local machine. CLI Usage: `vastai copy ` - [create instance](https://docs.vast.ai/api-reference/instances/create-instance.md): Creates a new instance by accepting an "ask" contract from a provider. This is the main endpoint for launching new instances on Vast.ai. CLI Usage: `vastai create instance [options]` - [destroy instance](https://docs.vast.ai/api-reference/instances/destroy-instance.md): Destroys/deletes an instance permanently. This is irreversible and will delete all data. CLI Usage: `vastai destroy instance ` - [detach ssh-key](https://docs.vast.ai/api-reference/instances/detach-ssh-key.md): Detaches an SSH key from a specified instance, removing SSH access for that key. CLI Usage: `vastai detach ` - [execute](https://docs.vast.ai/api-reference/instances/execute.md): Executes a constrained remote command on a specified instance. The command output can be retrieved from the returned result URL. CLI Usage: `vastai execute ` - [manage instance](https://docs.vast.ai/api-reference/instances/manage-instance.md): Manage instance state and labels. The operation is determined by the request body parameters. CLI Usage: - To stop: `vastai stop instance ` - To start: `vastai start instance ` - To label: `vastai label instance