# Command Line Interface (CLI) Reference for doctl – DigitalOcean Documentation > A complete reference for every command provided by the doctl command line interface (CLI). ## doctl 1-click The commands under `doctl 1-click` are for interacting with DigitalOcean 1-Click applications. - [doctl 1-click list](https://docs.digitalocean.com/reference/doctl/reference/1-click/list/index.html.md): Use this command to retrieve a list of 1-Click applications. You can narrow it by type, current types: kubernetes, droplet ## doctl account The subcommands of `doctl account` retrieve information about DigitalOcean accounts. For example, `doctl account get` retrieves account profile details, and `doctl account ratelimit` retrieves API usage details. - [doctl account get](https://docs.digitalocean.com/reference/doctl/reference/account/get/index.html.md): Retrieve the following details from your account profile: - Email address - Team - Account Droplet limit - Email verification status - UUID for the account - Account status (active or disabled). - [doctl account ratelimit](https://docs.digitalocean.com/reference/doctl/reference/account/ratelimit/index.html.md): Retrieve the following details about your account's API usage: - The current limit on your account for API calls (default is 5,000 per hour per OAuth token) - The number of API calls you have made in the last hour - When the API call count resets to zero, … ## doctl apps The subcommands of `doctl app` manage your App Platform apps. For documentation on app specs, see the [app spec reference](https://www.digitalocean.com/docs/app-platform/concepts/app-spec). - [doctl apps dev build](https://docs.digitalocean.com/reference/doctl/reference/apps/dev/build/index.html.md): [BETA] Build an app component locally. The component name is optional unless running non-interactively. All command line flags as optional. You may specify flags to be applied to the current build or use the command `doctl app dev config` to permanently … - [doctl apps console](https://docs.digitalocean.com/reference/doctl/reference/apps/console/index.html.md): Instantiates a console session for a component of an app. Note: avoid creating scripts or making changes that need to persist on these instances, as they are ephemeral and may be terminated at any time - [doctl apps create](https://docs.digitalocean.com/reference/doctl/reference/apps/create/index.html.md): Create an app with the given app spec. To create an app, App Platform must have access to your repository service. Click one of the following links to provide access for your preferred service: [GitHub](https://cloud.digitalocean.com/apps/gitlab/install), … - [doctl apps create-deployment](https://docs.digitalocean.com/reference/doctl/reference/apps/create-deployment/index.html.md): Creates an app using the provided app spec. To redeploy an existing app using its latest image or source code changes, use the --update-sources flag. To update an existing app’s spec configuration without pulling its latest changes or image, use the … - [doctl apps delete](https://docs.digitalocean.com/reference/doctl/reference/apps/delete/index.html.md): Deletes the specified app. This permanently deletes the app and all of its associated deployments. - [doctl apps get](https://docs.digitalocean.com/reference/doctl/reference/apps/get/index.html.md): Get an app with the provided id. Only basic information is included with the text output format. For complete app details including its app spec, use the JSON format. - [doctl apps spec get](https://docs.digitalocean.com/reference/doctl/reference/apps/spec/get/index.html.md): Use this command to retrieve the latest spec of an app. Optionally, pass a deployment ID to get the spec of that specific deployment. - [doctl apps tier instance-size get](https://docs.digitalocean.com/reference/doctl/reference/apps/tier/instance-size/get/index.html.md): Use this command to retrieve information about a specific app instance size. - [doctl apps get-deployment](https://docs.digitalocean.com/reference/doctl/reference/apps/get-deployment/index.html.md): Gets information about a specific deployment for the given app, including when the app updated and what triggered the deployment (Cause). Only basic information is included with the text output format. For complete app details including an updated app … - [doctl apps get-job-invocation](https://docs.digitalocean.com/reference/doctl/reference/apps/get-job-invocation/index.html.md): Gets information about a specific job invocation for the given app, including when the job was created. Only basic information is included with the text output format. For complete app details including an updated app spec, use the `--output` global flag … - [doctl apps list](https://docs.digitalocean.com/reference/doctl/reference/apps/list/index.html.md): Lists all apps associated with your account, including their ID, spec name, creation date, and other information. Only basic information is included with the text output format. For complete app details including an updated app spec, use the `--output` … - [doctl apps tier instance-size list](https://docs.digitalocean.com/reference/doctl/reference/apps/tier/instance-size/list/index.html.md): Use this command to list all the available app instance sizes. - [doctl apps list-alerts](https://docs.digitalocean.com/reference/doctl/reference/apps/list-alerts/index.html.md): Lists all alerts associated to an app and its component, such as deployment failures and domain failures. - [doctl apps list-buildpacks](https://docs.digitalocean.com/reference/doctl/reference/apps/list-buildpacks/index.html.md): Lists all buildpacks available on App Platform - [doctl apps list-deployments](https://docs.digitalocean.com/reference/doctl/reference/apps/list-deployments/index.html.md): List all deployments for an app. Only basic information is included with the text output format. For complete app details including the app specs, use the JSON format. - [doctl apps list-instances](https://docs.digitalocean.com/reference/doctl/reference/apps/list-instances/index.html.md): Returns an app's currently running ephemeral compute instances. - [doctl apps list-job-invocations](https://docs.digitalocean.com/reference/doctl/reference/apps/list-job-invocations/index.html.md): List all job invocations for an app. Only basic information is included with the text output format. For complete app details including the app specs, use the JSON format. - [doctl apps list-regions](https://docs.digitalocean.com/reference/doctl/reference/apps/list-regions/index.html.md): Lists all regions supported by App Platform, including details about their current availability. - [doctl apps logs](https://docs.digitalocean.com/reference/doctl/reference/apps/logs/index.html.md): Retrieves component logs for a deployment or a job invocation of an app. Three types of logs are supported and can be specified with the --type flag: - build - deploy - run - run_restarted To retrieve job invocation logs, pass the job invocation ID with … - [doctl apps propose](https://docs.digitalocean.com/reference/doctl/reference/apps/propose/index.html.md): Reviews and validates an app specification for a new or existing app. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the … - [doctl apps restart](https://docs.digitalocean.com/reference/doctl/reference/apps/restart/index.html.md): Restarts the specified app or some of its components. - [doctl apps dev config set](https://docs.digitalocean.com/reference/doctl/reference/apps/dev/config/set/index.html.md): Set a value in the local development configuration settings. KEY is the name of a configuration option, for example: spec=/path/to/app.yaml Nested component KEYs can also be set, for example: components.my-component.build_command="go build ." Multiple … - [doctl apps dev config unset](https://docs.digitalocean.com/reference/doctl/reference/apps/dev/config/unset/index.html.md): Unset a value in the local development configuration settings. KEY is the name of a configuration option to unset, for example: spec Nested component KEYs can also be unset, for example: components.my-component.build_command Multiple KEYs may be specified … - [doctl apps update](https://docs.digitalocean.com/reference/doctl/reference/apps/update/index.html.md): Updates an existing app with the attached app spec. By default, this does not retrieve the latest image from the app’s container registry or changes source repository. To deploy an app with changes from its source repository and app spec configuration, use … - [doctl apps update-alert-destinations](https://docs.digitalocean.com/reference/doctl/reference/apps/update-alert-destinations/index.html.md): Updates alert destinations - [doctl apps upgrade-buildpack](https://docs.digitalocean.com/reference/doctl/reference/apps/upgrade-buildpack/index.html.md): Upgrades an app's buildpack. For more information about buildpacks, see the [buildpack reference](https://docs.digitalocean.com/products/app-platform/reference/buildpacks/) - [doctl apps spec validate](https://docs.digitalocean.com/reference/doctl/reference/apps/spec/validate/index.html.md): Use this command to check whether a given app spec (YAML or JSON) is valid. You may pass - as the filename to read from stdin. ## doctl auth The `doctl auth` commands allow you to authenticate doctl for use with your DigitalOcean account using tokens that you generate in the control panel at https://cloud.digitalocean.com/account/api/tokens. If you work with a just one account, call `doctl auth init` and supply the token when prompted. This creates an authentication context named `default`. To switch between multiple DigitalOcean accounts, including team accounts, create named contexts using `doctl auth init --context `, then providing the applicable token when prompted. This saves the token under the name you provide. To switch between contexts, use `doctl auth switch --context `. To remove accounts from the configuration file, run `doctl auth remove --context `. This removes the token under the name you provide. - [doctl auth init](https://docs.digitalocean.com/reference/doctl/reference/auth/init/index.html.md): This command allows you to initialize doctl with a token that allows it to query and manage your account details and resources. The command requires and API token to authenticate, which you can generate in the control panel at … - [doctl auth list](https://docs.digitalocean.com/reference/doctl/reference/auth/list/index.html.md): List named authentication contexts that you created with `doctl auth init`. To switch between the contexts use `doctl auth switch --context `, where `` is one of the contexts listed. To create new contexts, see the help for `doctl auth init`. - [doctl auth remove](https://docs.digitalocean.com/reference/doctl/reference/auth/remove/index.html.md): This command allows you to remove authentication contexts you've already created. To see a list of available authentication contexts, call `doctl auth list`. For details on creating an authentication context, see the help for `doctl auth init`. - [doctl auth switch](https://docs.digitalocean.com/reference/doctl/reference/auth/switch/index.html.md): This command allows you to switch between authentication contexts you've already created. To see a list of available authentication contexts, call `doctl auth list`. For details on creating an authentication context, see the help for `doctl auth init`. - [doctl auth token](https://docs.digitalocean.com/reference/doctl/reference/auth/token/index.html.md): Display the current authentication context's token that you created with `doctl auth init`. To switch between the contexts use `doctl auth switch --context `, where `` is one of the contexts from: `doctl auth list` To create new contexts, see the help for … ## doctl balance The subcommands of `doctl balance` retrieve information about your account balance. - [doctl balance get](https://docs.digitalocean.com/reference/doctl/reference/balance/get/index.html.md): This command retrieves the following details about your account balance: - Your month-to-date balance including your account balance and month-to-date usage. - Your current overall balance as of your most recent billing activity. - Your usage in the … ## doctl billing-history The subcommands of `doctl billing-history` are used to access the billing history for your DigitalOcean account. - [doctl billing-history list](https://docs.digitalocean.com/reference/doctl/reference/billing-history/list/index.html.md): This command retrieves the following details for each event in your billing history: - The date of the event - The type of billing event - A description of the event - The amount of the event in USD - The invoice ID associated with the event, if applicable … ## doctl compute The subcommands under `doctl compute` are for managing DigitalOcean resources. - [doctl compute droplet actions](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/actions/index.html.md): Retrieves a list of previous actions taken on the Droplet, such as reboots, resizes, and snapshots actions. - [doctl compute firewall add-droplets](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/add-droplets/index.html.md): Assigns Droplets to a cloud firewall on your account. - [doctl compute load-balancer add-droplets](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/add-droplets/index.html.md): Use this command to add Droplets to a load balancer. - [doctl compute load-balancer add-forwarding-rules](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/add-forwarding-rules/index.html.md): Use this command to add forwarding rules to a load balancer, specified with the `--forwarding-rules` flag. Valid rules include: - `entry_protocol`: The entry protocol used for traffic to the load balancer. Possible values are: `http`, `https`, `http2`, … - [doctl compute firewall add-rules](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/add-rules/index.html.md): Add inbound or outbound rules to a cloud firewall. - [doctl compute firewall add-tags](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/add-tags/index.html.md): Add tags to a cloud firewall. This adds all assets using that tag to the firewall. - [doctl compute tag apply](https://docs.digitalocean.com/reference/doctl/reference/compute/tag/apply/index.html.md): Tag one or more resources. You can tag Droplets, images, volumes, volume snapshots, and database clusters. Resources must be specified as Uniform Resource Names (URNs) and has the following syntax: `do::`. - [doctl compute reserved-ip-action assign](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ip-action/assign/index.html.md): Assigns a reserved IP address to the specified Droplet. - [doctl compute reserved-ipv6 assign](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ipv6/assign/index.html.md): Assigns a reserved IPv6 address to the specified Droplet. - [doctl compute volume-action attach](https://docs.digitalocean.com/reference/doctl/reference/compute/volume-action/attach/index.html.md): Attaches a block storage volume to a Droplet. You can only attach one Droplet to a volume at a time. However, you can attach up to fifteen different volumes to a Droplet at a time. When you attach a pre-formatted volume to Ubuntu, Debian, Fedora, Fedora … - [doctl compute droplet backups](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/backups/index.html.md): Lists backup images for a Droplet, including each image's slug and ID. - [doctl compute droplet-action change-backup-policy](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/change-backup-policy/index.html.md): Changes backup policy for a Droplet with enabled backups. - [doctl compute droplet-action change-kernel](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/change-kernel/index.html.md): Changes a Droplet's kernel. This is only available for externally managed kernels. All Droplets created after 17 March 2017 have internally managed kernels by default. Use the `doctl compute droplet kernels ` command to retrieve a list of kernels for the … - [doctl compute cdn create](https://docs.digitalocean.com/reference/doctl/reference/compute/cdn/create/index.html.md): Creates a Content Delivery Network (CDN) on the origin server you specify and automatically generates an endpoint. You can also use a custom subdomain you own to create an additional endpoint, which must be secured with SSL. The Time To Live (TTL) value is … - [doctl compute certificate create](https://docs.digitalocean.com/reference/doctl/reference/compute/certificate/create/index.html.md): Creates a new Let's Encrypt certificate or adds an existing custom certificate to your team. There are two supported certificate types: Let's Encrypt certificates, and custom certificates. Let's Encrypt certificates are free, auto-renewed and managed for … - [doctl compute domain create](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/create/index.html.md): Adds a domain to your account that you can assign to Droplets, load balancers, and other resources. - [doctl compute domain records create](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/records/create/index.html.md): Create DNS records for a domain. - [doctl compute droplet-autoscale create](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/create/index.html.md): Usage doctl compute droplet-autoscale create [flags] Flags Option Description --cooldown-minutes Cooldown durationDefault: 0 --cpu-target CPU target threshold --droplet-agent Enable droplet agentDefault: true --enable-ipv6 Enable droplet IPv6Default: true … - [doctl compute droplet create](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/create/index.html.md): Creates a new Droplet on your account. The command requires values for the `--size`, and `--image` flags. To retrieve a list of size slugs, use the `doctl compute size list` command. To retrieve a list of image slugs, use the `doctl compute image list` … - [doctl compute firewall create](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/create/index.html.md): Creates a cloud firewall. This command must contain at least one inbound or outbound access rule. - [doctl compute image create](https://docs.digitalocean.com/reference/doctl/reference/compute/image/create/index.html.md): Creates an image in your DigitalOcean account. Specify a URL to download the image from and the region to store the image in. You can add additional metadata to the image using the optional flags. - [doctl compute load-balancer create](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/create/index.html.md): Use this command to create a new load balancer on your account. Valid forwarding rules are: - `entry_protocol`: The entry protocol used for traffic to the load balancer. Possible values are: `http`, `https`, `http2`, `http3`, `tcp`, or `udp`. - … - [doctl compute reserved-ip create](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ip/create/index.html.md): Creates a new reserved IP address. Reserved IP addresses can either be assigned to Droplets or held in the region they were created in on your account, but because of the IPv4 address shortage, unassigned reserved IP addresses incur charges. - [doctl compute reserved-ipv6 create](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ipv6/create/index.html.md): Creates a new reserved IPv6 address. Reserved IPv6 addresses can be held in the region they were created in on your account. - [doctl compute ssh-key create](https://docs.digitalocean.com/reference/doctl/reference/compute/ssh-key/create/index.html.md): Use this command to add a new SSH key to your account. Specify a `` for the key, and set the `--public-key` flag to a string with the contents of the key. Note that creating a key will not add it to any Droplets. - [doctl compute tag create](https://docs.digitalocean.com/reference/doctl/reference/compute/tag/create/index.html.md): Creates a new tag that you can apply to resources. - [doctl compute volume create](https://docs.digitalocean.com/reference/doctl/reference/compute/volume/create/index.html.md): Creates a block storage volume on your account. You can use flags to specify the volume size, region, description, filesystem type, tags, and to create a volume from an existing volume snapshot. Use the `doctl compute volume-action attach ` command to … - [doctl compute vpc-nat-gateway create](https://docs.digitalocean.com/reference/doctl/reference/compute/vpc-nat-gateway/create/index.html.md): Usage doctl compute vpc-nat-gateway create [flags] Aliases c Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Name, Type, State, Region, VPCs, Egresses, Timeouts. --help, -h Help for this command … - [doctl compute cdn delete](https://docs.digitalocean.com/reference/doctl/reference/compute/cdn/delete/index.html.md): Deletes the CDN specified by the ID. You can retrieve a list of CDN IDs by calling `doctl compute cdn list` - [doctl compute certificate delete](https://docs.digitalocean.com/reference/doctl/reference/compute/certificate/delete/index.html.md): Deletes the specified certificate. Use `doctl compute certificate list` to see all available certificates associated with your account. - [doctl compute domain delete](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/delete/index.html.md): Permanently deletes a domain from your account. You cannot undo this command once done. - [doctl compute domain records delete](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/records/delete/index.html.md): Deletes DNS records for a domain. - [doctl compute droplet-autoscale delete](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/delete/index.html.md): Usage doctl compute droplet-autoscale delete [flags] Aliases d, rm Flags Option Description --force Force delete without a confirmation promptDefault: false --help, -h Help for this command Related Commands Command Description doctl compute … - [doctl compute droplet delete](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/delete/index.html.md): Permanently deletes a Droplet. This is irreversible. - [doctl compute firewall delete](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/delete/index.html.md): Permanently deletes a cloud firewall. This is irreversible, but does not delete any Droplets assigned to the cloud firewall. - [doctl compute image delete](https://docs.digitalocean.com/reference/doctl/reference/compute/image/delete/index.html.md): Permanently deletes an image from your account. This is irreversible. - [doctl compute load-balancer delete](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/delete/index.html.md): Use this command to permanently delete the specified load balancer. This is irreversible. - [doctl compute reserved-ip delete](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ip/delete/index.html.md): Permanently deletes a reserved IP address. This is irreversible. - [doctl compute reserved-ipv6 delete](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ipv6/delete/index.html.md): Permanently deletes a reserved IPv6 address. This is irreversible. - [doctl compute snapshot delete](https://docs.digitalocean.com/reference/doctl/reference/compute/snapshot/delete/index.html.md): Deletes the specified snapshot or volume. This is irreversible. - [doctl compute ssh-key delete](https://docs.digitalocean.com/reference/doctl/reference/compute/ssh-key/delete/index.html.md): Use this command to permanently delete an SSH key from your account. Note that this does not delete an SSH key from any Droplets. - [doctl compute tag delete](https://docs.digitalocean.com/reference/doctl/reference/compute/tag/delete/index.html.md): Deletes a tag from your account. Deleting a tag also removes the tag from all the resources that had been tagged with it. - [doctl compute volume delete](https://docs.digitalocean.com/reference/doctl/reference/compute/volume/delete/index.html.md): Deletes a block storage volume by ID, destroying all of its data and removing it from your account. This is irreversible. - [doctl compute vpc-nat-gateway delete](https://docs.digitalocean.com/reference/doctl/reference/compute/vpc-nat-gateway/delete/index.html.md): Usage doctl compute vpc-nat-gateway delete [flags] Aliases d, rm Flags Option Description --force Force delete without a confirmation promptDefault: false --help, -h Help for this command Related Commands Command Description doctl compute vpc-nat-gateway … - [doctl compute droplet-autoscale delete-dangerous](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/delete-dangerous/index.html.md): Usage doctl compute droplet-autoscale delete-dangerous [flags] Flags Option Description --force Force delete without a confirmation promptDefault: false --help, -h Help for this command Related Commands Command Description doctl compute droplet-autoscale … - [doctl compute volume-action detach](https://docs.digitalocean.com/reference/doctl/reference/compute/volume-action/detach/index.html.md): Detaches a block storage volume from a Droplet. - [doctl compute volume-action detach-by-droplet-id](https://docs.digitalocean.com/reference/doctl/reference/compute/volume-action/detach-by-droplet-id/index.html.md): This command detaches a volume. This command is deprecated. Use `doctl compute volume-action detach` instead. - [doctl compute droplet-action disable-backups](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/disable-backups/index.html.md): Disables backups on a Droplet. This does not delete existing backups. - [doctl compute droplet-action enable-backups](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/enable-backups/index.html.md): Enables backups on a Droplet. This automatically creates and stores a disk image of the Droplet. By default, backups happen daily. - [doctl compute droplet-action enable-ipv6](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/enable-ipv6/index.html.md): Enables IPv6 networking on a Droplet. When executed, we automatically assign an IPv6 address to the Droplet. The Droplet may require additional network configuration to properly use the new IPv6 address. For more information, see: … - [doctl compute droplet-action enable-private-networking](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/enable-private-networking/index.html.md): Enables VPC networking on a Droplet. This command adds a private IPv4 address to the Droplet that other resources inside the Droplet's VPC network can access. The Droplet is placed in the default VPC network for the region it resides in. All Droplets … - [doctl compute cdn flush](https://docs.digitalocean.com/reference/doctl/reference/compute/cdn/flush/index.html.md): Flushes the cache of a Content Delivery Network (CDN), which: - purges all copies of the files in the cache - re-caches the files - retrieves files from the origin server for any requests that hit the CDN endpoint until all the files are re-cached This … - [doctl compute action get](https://docs.digitalocean.com/reference/doctl/reference/compute/action/get/index.html.md): Retrieve the following details about a specific action taken on one of your resources: - The action ID - The action status (`pending`, `completed`, etc) - The action type, such as: `create`, `destroy`, `power_cycle`, `power_off`, `power_on`, `backup`, … - [doctl compute cdn get](https://docs.digitalocean.com/reference/doctl/reference/compute/cdn/get/index.html.md): Lists the following details for the specified Content Delivery Network (CDNs): - The ID for the CDN, in UUID format - The fully qualified domain name (FQDN) for the origin server, which provides the content to the CDN. Currently, only Spaces are supported … - [doctl compute certificate get](https://docs.digitalocean.com/reference/doctl/reference/compute/certificate/get/index.html.md): This command retrieves the following details about a certificate: - The certificate ID - The name you gave the certificate - A comma-separated list of domain names associated with the certificate - The SHA-1 fingerprint of the certificate - The … - [doctl compute domain get](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/get/index.html.md): Retrieves information about a domain on your account. - [doctl compute droplet-action get](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/get/index.html.md): Retrieves information about an action performed on a Droplet, including its status, type, and completion time. - [doctl compute droplet-autoscale get](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/get/index.html.md): Usage doctl compute droplet-autoscale get [flags] Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Name, Region, Status, Min Instance, Max Instance, Target Instance, Avg CPU Util, Avg Mem Util, Target … - [doctl compute droplet backup-policies get](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/backup-policies/get/index.html.md): Retrieves a backup policy of a Droplet. - [doctl compute droplet get](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/get/index.html.md): Retrieves information about a Droplet, including: - The Droplet's ID - The Droplet's name - The Droplet's public IPv4 address - The Droplet's private IPv4 address - The Droplet's IPv6 address - The memory size of the Droplet in MB - The number of vCPUs on … - [doctl compute firewall get](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/get/index.html.md): Retrieves information about an existing cloud firewall, including: - The firewall's UUID - The firewall's name - The status of the firewall. Possible values: `waiting`, `succeeded`, `failed`. - The firewall's creation date, in ISO8601 combined date and … - [doctl compute image-action get](https://docs.digitalocean.com/reference/doctl/reference/compute/image-action/get/index.html.md): Retrieves the status of an image action, including the following details: - The unique ID used to identify and reference an image action - The status of the image action. Possible values: `in-progress`, `completed`, `errored`. - When the action was … - [doctl compute image get](https://docs.digitalocean.com/reference/doctl/reference/compute/image/get/index.html.md): Returns the following information about the specified image: - The image's ID - The image's name - The type of image. Possible values: `snapshot`, `backup`, `custom`. - The distribution of the image. For custom images, this is user defined. - The image's … - [doctl compute load-balancer get](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/get/index.html.md): Use this command to retrieve information about a load balancer instance, including: - The load balancer's ID - The load balancer's name - The load balancer's IP address - The current state of the load balancer. This can be `new`, `active`, or `errored`. - … - [doctl compute reserved-ip-action get](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ip-action/get/index.html.md): Retrieves the status of a reserved IP action. Outputs the following information: - The unique numeric ID used to identify and reference a reserved IP action - The status of the reserved IP action. Possible values: "in-progress", "completed", "errored" - … - [doctl compute reserved-ip get](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ip/get/index.html.md): Retrieves detailed information about a reserved IP address, including its region and the ID of the Droplet its assigned to. - [doctl compute reserved-ipv6 get](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ipv6/get/index.html.md): Retrieves detailed information about a reserved IPv6 address, including its region and the ID of the Droplet its assigned to. - [doctl compute snapshot get](https://docs.digitalocean.com/reference/doctl/reference/compute/snapshot/get/index.html.md): Retrieves information about a Droplet or block storage volume snapshot, including: - The snapshot's ID - The snapshot's name - The date and time when the snapshot was created - The slugs of the datacenter regions in which the snapshot is available - The … - [doctl compute ssh-key get](https://docs.digitalocean.com/reference/doctl/reference/compute/ssh-key/get/index.html.md): Use this command to get the id, fingerprint, public_key, and name of a specific SSH key on your account. - [doctl compute tag get](https://docs.digitalocean.com/reference/doctl/reference/compute/tag/get/index.html.md): Retrieves the number of resources using the tag. - [doctl compute volume-action get](https://docs.digitalocean.com/reference/doctl/reference/compute/volume-action/get/index.html.md): Retrieves the status of a volume action, including the following details: - The unique numeric ID used to identify and reference a volume action. - The status of the volume action. Possible values: `in-progress`, `completed`, `errored`. - When the action … - [doctl compute volume get](https://docs.digitalocean.com/reference/doctl/reference/compute/volume/get/index.html.md): Retrieves information about a block storage volume. - [doctl compute vpc-nat-gateway get](https://docs.digitalocean.com/reference/doctl/reference/compute/vpc-nat-gateway/get/index.html.md): Usage doctl compute vpc-nat-gateway get [flags] Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Name, Type, State, Region, VPCs, Egresses, Timeouts. --help, -h Help for this command --no-header Return … - [doctl compute ssh-key import](https://docs.digitalocean.com/reference/doctl/reference/compute/ssh-key/import/index.html.md): Use this command to add a new SSH key to your account, using a local public key file. Note that importing a key to your account will not add it to any Droplets - [doctl compute droplet kernels](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/kernels/index.html.md): Retrieves a list of all kernels available to a Droplet. This command is only available for Droplets with externally managed kernels. All Droplets created after March 2017 have internally managed kernels by default. - [doctl compute action list](https://docs.digitalocean.com/reference/doctl/reference/compute/action/list/index.html.md): Retrieve a list of all actions taken on your resources. The following details are provided: - The action ID - The action status (`pending`, `completed`, etc) - The action type, such as: `create`, `destroy`, `power_cycle`, `power_off`, `power_on`, `backup`, … - [doctl compute cdn list](https://docs.digitalocean.com/reference/doctl/reference/compute/cdn/list/index.html.md): Retrieves a list of your existing Content Delivery Networks (CDNs) and their following details: - The ID for the CDN, in UUID format - The fully qualified domain name (FQDN) for the origin server, which provides the content to the CDN. Currently, only … - [doctl compute certificate list](https://docs.digitalocean.com/reference/doctl/reference/compute/certificate/list/index.html.md): This command retrieves a list of all certificates associated with the account. The following details are shown for each certificate: - The certificate ID - The name you gave the certificate - A comma-separated list of domain names associated with the … - [doctl compute domain list](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/list/index.html.md): Retrieves a list of domains on your account. - [doctl compute domain records list](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/records/list/index.html.md): Lists the DNS records for a domain. - [doctl compute droplet-autoscale list](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/list/index.html.md): Usage doctl compute droplet-autoscale list [flags] Aliases ls Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Name, Region, Status, Min Instance, Max Instance, Target Instance, Avg CPU Util, Avg Mem … - [doctl compute droplet 1-click list](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/1-click/list/index.html.md): Retrieves a list of Droplet 1-Click application slugs. You can use 1-click slugs to create Droplets by using them as the argument for the `--image` flag in the `doctl compute droplet create` command. For example, the following command creates a Droplet … - [doctl compute droplet backup-policies list](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/backup-policies/list/index.html.md): List droplet backup policies for all existing Droplets. - [doctl compute droplet list](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/list/index.html.md): Retrieves a list of Droplets on your account, including the following information about each: - The Droplet's ID - The Droplet's name - The Droplet's public IPv4 address - The Droplet's private IPv4 address - The Droplet's IPv6 address - The memory size of … - [doctl compute firewall list](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/list/index.html.md): Retrieves a list of cloud firewalls on your account. - [doctl compute image list](https://docs.digitalocean.com/reference/doctl/reference/compute/image/list/index.html.md): Lists all private images on your account. To list public images, use the `--public` flag. This command returns the following information about each image: - The image's ID - The image's name - The type of image. Possible values: `snapshot`, `backup`, … - [doctl compute load-balancer list](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/list/index.html.md): Use this command to get a list of the load balancers on your account, including the following information for each: - The load balancer's ID - The load balancer's name - The load balancer's IP address - The current state of the load balancer. This can be … - [doctl compute region list](https://docs.digitalocean.com/reference/doctl/reference/compute/region/list/index.html.md): List DigitalOcean datacenter regions displaying their name, slug, and availability. Use the slugs displayed by this command to specify regions in other commands. - [doctl compute reserved-ip list](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ip/list/index.html.md): Retrieves a list of all the reserved IP addresses on your account. - [doctl compute reserved-ipv6 list](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ipv6/list/index.html.md): Retrieves a list of all the reserved IPv6 addresses on your account. - [doctl compute size list](https://docs.digitalocean.com/reference/doctl/reference/compute/size/list/index.html.md): Retrieves a list of slug identifiers, RAM amounts, vCPU counts, disk sizes, and pricing details for each Droplet size. Use these slugs to specify the size of Droplet in other commands, such as `doctl compute droplet create --size `. - [doctl compute snapshot list](https://docs.digitalocean.com/reference/doctl/reference/compute/snapshot/list/index.html.md): Retrieves a list of snapshots and their information, including: - The snapshot's ID - The snapshot's name - The date and time when the snapshot was created - The slugs of the datacenter regions in which the snapshot is available - The type of resource the … - [doctl compute ssh-key list](https://docs.digitalocean.com/reference/doctl/reference/compute/ssh-key/list/index.html.md): Use this command to list the id, fingerprint, public_key, and name of all SSH keys on your account. - [doctl compute tag list](https://docs.digitalocean.com/reference/doctl/reference/compute/tag/list/index.html.md): Retrieves a list of all the tags in your account and how many resources are using each tag. - [doctl compute volume-action list](https://docs.digitalocean.com/reference/doctl/reference/compute/volume-action/list/index.html.md): Retrieves a list of actions taken on a volume. The following details are provided: - The unique numeric ID used to identify and reference a volume action. - The status of the volume action. Possible values: `in-progress`, `completed`, `errored`. - When the … - [doctl compute volume list](https://docs.digitalocean.com/reference/doctl/reference/compute/volume/list/index.html.md): Lists all of the block storage volumes on your account. - [doctl compute vpc-nat-gateway list](https://docs.digitalocean.com/reference/doctl/reference/compute/vpc-nat-gateway/list/index.html.md): Usage doctl compute vpc-nat-gateway list [flags] Aliases ls Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Name, Type, State, Region, VPCs, Egresses, Timeouts. --help, -h Help for this command … - [doctl compute image list-application](https://docs.digitalocean.com/reference/doctl/reference/compute/image/list-application/index.html.md): Lists all public one-click apps that are currently available on the DigitalOcean Marketplace. This command returns the following information about each image: - The image's ID - The image's name - The type of image. Possible values: `snapshot`, `backup`, … - [doctl compute firewall list-by-droplet](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/list-by-droplet/index.html.md): Lists the cloud firewalls assigned to a Droplet. - [doctl compute image list-distribution](https://docs.digitalocean.com/reference/doctl/reference/compute/image/list-distribution/index.html.md): Lists the distribution images available from DigitalOcean. This command returns the following information about each image: - The image's ID - The image's name - The type of image. Possible values: `snapshot`, `backup`, `custom`. - The distribution of the … - [doctl compute droplet-autoscale list-history](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/list-history/index.html.md): Usage doctl compute droplet-autoscale list-history [flags] Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Current Instance, Target Instance, Status, Reason, Error Reason. --help, -h Help for this … - [doctl compute droplet-autoscale list-members](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/list-members/index.html.md): Usage doctl compute droplet-autoscale list-members [flags] Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Status, Health Status, Unhealthy Reason, CPU Util, Mem Util. --help, -h Help for this command … - [doctl compute droplet backup-policies list-supported](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/backup-policies/list-supported/index.html.md): List of all supported droplet backup policies. - [doctl compute image list-user](https://docs.digitalocean.com/reference/doctl/reference/compute/image/list-user/index.html.md): Use this command to list user-created images, such as snapshots or custom images that you have uploaded to your account. This command returns the following information about each image: - The image's ID - The image's name - The type of image. Possible … - [doctl compute droplet neighbors](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/neighbors/index.html.md): Lists your Droplets that are on the same physical hardware, including the following details: - The Droplet's ID - The Droplet's name - The Droplet's public IPv4 address - The Droplet's private IPv4 address - The Droplet's IPv6 address - The memory size of … - [doctl compute droplet-action password-reset](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/password-reset/index.html.md): Initiates a root password reset on a Droplet. We provide a new password for the Droplet via the accounts email address. The password must be changed after first use. This also powercycles the Droplet. - [doctl compute droplet-action power-cycle](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/power-cycle/index.html.md): Powercycles a Droplet. A powercycle action is similar to pushing the reset button on a physical machine. - [doctl compute droplet-action power-off](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/power-off/index.html.md): Use this command to power off a Droplet. A `power_off` event is a hard shutdown and should only be used if the shutdown action is not successful. It is similar to cutting the power on a server and could lead to complications. Droplets that are powered off … - [doctl compute droplet-action power-on](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/power-on/index.html.md): Powers on a Droplet. This is similar to pressing the power button on a physical machine. - [doctl compute load-balancer purge-cache](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/purge-cache/index.html.md): Use this command to purge the CDN cache for specified global load balancer. - [doctl compute droplet-action reboot](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/reboot/index.html.md): Reboots a Droplet. A reboot action is an attempt to reboot the Droplet in a graceful way, similar to using the reboot command from the Droplet's console. - [doctl compute droplet-action rebuild](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/rebuild/index.html.md): Rebuilds a Droplet from an image, such as an Ubuntu base image or a backup image of the Droplet. Set the image attribute to an image ID or slug. To retrieve a list of images on your account, use the `doctl compute image list` command. To retrieve a list of … - [doctl compute tag remove](https://docs.digitalocean.com/reference/doctl/reference/compute/tag/remove/index.html.md): Removes a tag from one or more resources. Resources must be specified as Uniform Resource Names (URNs) and has the following syntax: `do::`. - [doctl compute firewall remove-droplets](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/remove-droplets/index.html.md): Removes Droplets from a cloud firewall. - [doctl compute load-balancer remove-droplets](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/remove-droplets/index.html.md): Use this command to remove Droplets from a load balancer. This command does not destroy any Droplets. - [doctl compute load-balancer remove-forwarding-rules](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/remove-forwarding-rules/index.html.md): Use this command to remove forwarding rules from a load balancer, specified with the `--forwarding-rules` flag. Valid rules include: - `entry_protocol`: The entry protocol used for traffic to the load balancer. Possible values are: `http`, `https`, … - [doctl compute firewall remove-rules](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/remove-rules/index.html.md): Remove inbound or outbound rules from a cloud firewall. - [doctl compute firewall remove-tags](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/remove-tags/index.html.md): Removes tags from a cloud firewall. This removes all assets using that tag from the firewall. - [doctl compute droplet-action rename](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/rename/index.html.md): Renames a Droplet. When using a Fully Qualified Domain Name (FQDN) this also updates the Droplet's pointer (PTR) record. - [doctl compute droplet-action resize](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/resize/index.html.md): Resizes a Droplet to a different plan. By default, this command only increases or decreases the CPU and RAM of the Droplet, not its disk size. Unlike increasing disk size, you can reverse this action. To also increase the Droplet's disk size, choose a size … - [doctl compute volume-action resize](https://docs.digitalocean.com/reference/doctl/reference/compute/volume-action/resize/index.html.md): Resizes a block storage volume. Volumes may only be resized upwards. The maximum size for a volume is 16 TiB. - [doctl compute droplet-action restore](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/restore/index.html.md): Restores a Droplet from a backup image. You must pass an image ID that is a backup of the current Droplet instance. The operation leaves any embedded SSH keys intact. To retrieve a list of backup images, use the `doctl compute image list` command. - [doctl compute droplet-action shutdown](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/shutdown/index.html.md): Shuts down a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the shutdown command from the Droplet's console. Since a shutdown command can fail, this action guarantees that the command is issued, not … - [doctl compute droplet-action snapshot](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-action/snapshot/index.html.md): Takes a snapshot of a Droplet. Snapshots are complete disk images that contain all of the data on a Droplet at the time of the snapshot. This can be useful for restoring and rebuilding Droplets. We recommend that you power off the Droplet before taking a … - [doctl compute volume snapshot](https://docs.digitalocean.com/reference/doctl/reference/compute/volume/snapshot/index.html.md): Creates a snapshot of a block storage volume by ID. You can use a block storage volume snapshot ID as a flag with `doctl volume create` to create a new block storage volume with the same data as the volume the snapshot was taken from. - [doctl compute droplet snapshots](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/snapshots/index.html.md): Retrieves a list of snapshots created from this Droplet. - [doctl compute ssh](https://docs.digitalocean.com/reference/doctl/reference/compute/ssh/index.html.md): Access a Droplet using SSH by providing its ID or name. You may specify the user to login with by passing the `--ssh-user` flag. To access the Droplet on a non-default port, use the `--ssh-port` flag. By default, the connection will be made to the … - [doctl compute droplet tag](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/tag/index.html.md): Applies a tag to a Droplet. Specify the tag with the `--tag-name` flag. - [doctl compute image-action transfer](https://docs.digitalocean.com/reference/doctl/reference/compute/image-action/transfer/index.html.md): Transfers an image to a different datacenter region. Also outputs the following details: - The unique ID used to identify and reference an image action - The status of the image action. Possible values: `in-progress`, `completed`, `errored`. - When the … - [doctl compute reserved-ip-action unassign](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ip-action/unassign/index.html.md): Unassigns a reserved IP address from a Droplet. Due to a shortage on IPv4 addresses, unassigned reserved IP addresses remain available on your account but accumulate charges for not being assigned. - [doctl compute reserved-ipv6 unassign](https://docs.digitalocean.com/reference/doctl/reference/compute/reserved-ipv6/unassign/index.html.md): Unassigns a reserved IPv6 address from a Droplet. - [doctl compute droplet untag](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/untag/index.html.md): Removes a tag from a Droplet. Specify the tag with the `--tag-name` flag. - [doctl compute cdn update](https://docs.digitalocean.com/reference/doctl/reference/compute/cdn/update/index.html.md): Updates the configuration details of an existing Content Delivery Network (CDN). - [doctl compute domain records update](https://docs.digitalocean.com/reference/doctl/reference/compute/domain/records/update/index.html.md): Updates or changes the properties of DNS records for a domain. - [doctl compute droplet-autoscale update](https://docs.digitalocean.com/reference/doctl/reference/compute/droplet-autoscale/update/index.html.md): Usage doctl compute droplet-autoscale update [flags] Flags Option Description --cooldown-minutes Cooldown durationDefault: 0 --cpu-target CPU target threshold --droplet-agent Enable droplet agentDefault: true --enable-ipv6 Enable droplet IPv6Default: true … - [doctl compute firewall update](https://docs.digitalocean.com/reference/doctl/reference/compute/firewall/update/index.html.md): Updates the configuration of an existing cloud firewall. The request should contain a full representation of the firewall, including existing attributes. Any attributes that are not provided are reset to their default values. - [doctl compute image update](https://docs.digitalocean.com/reference/doctl/reference/compute/image/update/index.html.md): Updates an image's metadata, including its name, description, and distribution. - [doctl compute load-balancer update](https://docs.digitalocean.com/reference/doctl/reference/compute/load-balancer/update/index.html.md): Use this command to update the configuration of a specified load balancer. Using all applicable flags, the command should contain a full representation of the load balancer including existing attributes, such as the load balancer's name, region, forwarding … - [doctl compute ssh-key update](https://docs.digitalocean.com/reference/doctl/reference/compute/ssh-key/update/index.html.md): Use this command to update the name of an SSH key. - [doctl compute vpc-nat-gateway update](https://docs.digitalocean.com/reference/doctl/reference/compute/vpc-nat-gateway/update/index.html.md): Usage doctl compute vpc-nat-gateway update [flags] Aliases u Flags Option Description --format Columns for output in a comma-separated list. Possible values: ID, Name, Type, State, Region, VPCs, Egresses, Timeouts. --help, -h Help for this command … - [doctl compute action wait](https://docs.digitalocean.com/reference/doctl/reference/compute/action/wait/index.html.md): Block the current thread, returning when an action completes. For example, if you find an action when calling `doctl compute action list` that has a status of `in-progress`, you can note the action ID and call `doctl compute action wait `, and doctl will … ## doctl databases The commands under `doctl databases` are for managing your MySQL, Redis, Valkey, PostgreSQL, MongoDB, Kafka and Opensearch database services. - [doctl databases firewalls append](https://docs.digitalocean.com/reference/doctl/reference/databases/firewalls/append/index.html.md): Appends a single rule to the existing firewall rules of the specified database. This command requires the `--rule` flag specifying the resource or resources allowed to access the database cluster. The rule passed to the `--rule` flag must be in a : format … - [doctl databases backups](https://docs.digitalocean.com/reference/doctl/reference/databases/backups/index.html.md): Retrieves a list of backups created for the specified database cluster. The list contains the size in GB, and the date and time the backup was created. - [doctl databases connection](https://docs.digitalocean.com/reference/doctl/reference/databases/connection/index.html.md): Retrieves the following connection details for a database cluster: - A connection string for the database cluster - The default database name - The fully-qualified domain name of the publicly-connectable host - The port on which the database is listening … - [doctl databases replica connection](https://docs.digitalocean.com/reference/doctl/reference/databases/replica/connection/index.html.md): Retrieves information for connecting to the specified read-only database replica in the specified database cluster This command requires that you pass in the replica's name, which you can retrieve by querying a database ID: doctl databases replica list … - [doctl databases create](https://docs.digitalocean.com/reference/doctl/reference/databases/create/index.html.md): Creates a database cluster with the specified name. You can customize the configuration using the listed flags, all of which are optional. Without any flags set, the command creates a single-node, single-CPU PostgreSQL database cluster. - [doctl databases db create](https://docs.digitalocean.com/reference/doctl/reference/databases/db/create/index.html.md): Creates a database with the specified name in the specified database cluster. You can get a list of existing database clusters and their IDs by calling: doctl databases list - [doctl databases pool create](https://docs.digitalocean.com/reference/doctl/reference/databases/pool/create/index.html.md): Creates a connection pool for the specified database cluster. In addition to the pool's name, you must also use flags to specify the pool's target database, its size, and a database user that the pool uses to authenticate. If you do not specify a user, the … - [doctl databases replica create](https://docs.digitalocean.com/reference/doctl/reference/databases/replica/create/index.html.md): Creates a read-only database replica for the specified database cluster, giving it the specified name. This command requires the ID of a database cluster, which you can retrieve by calling: doctl databases list - [doctl databases topics create](https://docs.digitalocean.com/reference/doctl/reference/databases/topics/create/index.html.md): This command creates a kafka topic for the specified kafka database cluster, giving it the specified name. Example: doctl databases topics create --replication_factor 2 --partition_count 4 - [doctl databases user create](https://docs.digitalocean.com/reference/doctl/reference/databases/user/create/index.html.md): Creates a new user for a database. New users are given a role of `normal` and are given an automatically-generated password. To retrieve a list of your databases and their IDs, call `doctl databases list`. - [doctl databases db delete](https://docs.digitalocean.com/reference/doctl/reference/databases/db/delete/index.html.md): Deletes the specified database from the specified database cluster. You can get a list of existing database clusters and their IDs by calling: doctl databases list You can get a list of existing databases that are hosted within a cluster by calling: doctl … - [doctl databases delete](https://docs.digitalocean.com/reference/doctl/reference/databases/delete/index.html.md): Deletes the database cluster with the specified ID. To retrieve a list of your database clusters and their IDs, use `doctl databases list`. - [doctl databases indexes delete](https://docs.digitalocean.com/reference/doctl/reference/databases/indexes/delete/index.html.md): Usage doctl databases indexes delete [flags] Aliases rm Flags Option Description --force, -f Deletes the opensearch index without a confirmation promptDefault: false --help, -h Help for this command Related Commands Command Description doctl databases … - [doctl databases pool delete](https://docs.digitalocean.com/reference/doctl/reference/databases/pool/delete/index.html.md): Deletes the specified connection pool for the specified database cluster. You can get a list of existing connection pools by calling: doctl databases pool list You can get a list of existing database clusters and their IDs by calling: doctl databases list - [doctl databases replica delete](https://docs.digitalocean.com/reference/doctl/reference/databases/replica/delete/index.html.md): Deletes the specified read-only replica for the specified database cluster. This command requires that you pass in the replica's name, which you can retrieve by querying a database ID: doctl databases replica list This command requires the ID of a database … - [doctl databases topics delete](https://docs.digitalocean.com/reference/doctl/reference/databases/topics/delete/index.html.md): Usage doctl databases topics delete [flags] Aliases rm Flags Option Description --force, -f Deletes the kafka topic without a confirmation promptDefault: false --help, -h Help for this command Related Commands Command Description doctl databases topics … - [doctl databases user delete](https://docs.digitalocean.com/reference/doctl/reference/databases/user/delete/index.html.md): Deletes the specified database user. To retrieve a list of your databases and their IDs, call `doctl databases list`. - [doctl databases options engines](https://docs.digitalocean.com/reference/doctl/reference/databases/options/engines/index.html.md): Lists the available database engines for DigitalOcean Managed Databases. - [doctl databases fork](https://docs.digitalocean.com/reference/doctl/reference/databases/fork/index.html.md): Creates a new database cluster from an existing cluster. The forked database contains all of the data from the original database at the time the fork is created. - [doctl databases configuration get](https://docs.digitalocean.com/reference/doctl/reference/databases/configuration/get/index.html.md): Retrieves the advanced configuration for the specified cluster, including its backup settings, temporary file limit, and session timeout values. - [doctl databases db get](https://docs.digitalocean.com/reference/doctl/reference/databases/db/get/index.html.md): Retrieves the name of the specified database hosted in the specified database cluster. You can get a list of existing database clusters and their IDs by calling: doctl databases list You can get a list of existing databases that are hosted within a cluster … - [doctl databases get](https://docs.digitalocean.com/reference/doctl/reference/databases/get/index.html.md): Retrieves the following details about the specified database cluster: - The database ID, in UUID format - The name you gave the database cluster - The database engine. Possible values: `redis`, `valkey`, `pg`, `mysql` , `mongodb`, `kafka`, `opensearch` - … - [doctl databases maintenance-window get](https://docs.digitalocean.com/reference/doctl/reference/databases/maintenance-window/get/index.html.md): Retrieves the following information on currently-scheduled maintenance windows for the specified database cluster: - The day of the week the maintenance window occurs - The hour in UTC when maintenance updates will be applied, in 24 hour format, such as … - [doctl databases pool get](https://docs.digitalocean.com/reference/doctl/reference/databases/pool/get/index.html.md): This command retrieves the following information about the specified connection pool for the specified database cluster: - The database user that the connection pool uses. When excluded, all connections to the database use the inbound user. - The … - [doctl databases replica get](https://docs.digitalocean.com/reference/doctl/reference/databases/replica/get/index.html.md): Gets the following details for the specified read-only replica of the specified database cluster: - The name of the replica - The information required to connect to the read-only replica - The region where the database cluster is located, such as `nyc3` or … - [doctl databases sql-mode get](https://docs.digitalocean.com/reference/doctl/reference/databases/sql-mode/get/index.html.md): Displays the configured SQL modes for the specified MySQL database cluster. - [doctl databases topics get](https://docs.digitalocean.com/reference/doctl/reference/databases/topics/get/index.html.md): This command lists the following details for a given topic in a kafka database cluster: - The Name of the topic. - The Partitions of the topic - the number of partitions in the topics - The Replication Factor of the topic - number of brokers the topic's … - [doctl databases user get](https://docs.digitalocean.com/reference/doctl/reference/databases/user/get/index.html.md): Retrieves the following details about the specified user: - The username for the user - The password for the user - The user's role, either "primary" or "normal" Primary user accounts are created by DigitalOcean at database cluster creation time and can't … - [doctl databases get-ca](https://docs.digitalocean.com/reference/doctl/reference/databases/get-ca/index.html.md): Retrieves a database certificate - [doctl databases maintenance-window install](https://docs.digitalocean.com/reference/doctl/reference/databases/maintenance-window/install/index.html.md): Starts the installation of updates for the specified database cluster immediately outside of a maintenance window. - [doctl databases db list](https://docs.digitalocean.com/reference/doctl/reference/databases/db/list/index.html.md): Retrieves a list of databases being hosted in the specified database cluster. You can get a list of existing database clusters and their IDs by calling: doctl databases list - [doctl databases events list](https://docs.digitalocean.com/reference/doctl/reference/databases/events/list/index.html.md): Retrieves a list of database clusters events: You can get a list of database events by calling: doctl databases events list - [doctl databases firewalls list](https://docs.digitalocean.com/reference/doctl/reference/databases/firewalls/list/index.html.md): This command lists the following details for each firewall rule in a given database: - The UUID of the firewall rule - The UUID of the cluster for which the rule is applied - The type of resource that the firewall rule allows to access the database … - [doctl databases indexes list](https://docs.digitalocean.com/reference/doctl/reference/databases/indexes/list/index.html.md): This command lists the following details for each index in an opensearch cluster: - The Name of the index. - The Status of the index. - The Health of the index. - The Number of Shards in the index. - The Number of Replicas in the index. - The Number of … - [doctl databases list](https://docs.digitalocean.com/reference/doctl/reference/databases/list/index.html.md): Retrieves a list of database clusters and their following details: - The database ID, in UUID format - The name you gave the database cluster - The database engine. Possible values: `redis`, `valkey`, `pg`, `mysql` , `mongodb`, `kafka`, `opensearch` - The … - [doctl databases pool list](https://docs.digitalocean.com/reference/doctl/reference/databases/pool/list/index.html.md): Lists the existing connection pools for the specified database. The command returns the following details about each connection pool: - The database user that the connection pool uses. When excluded, all connections to the database use the inbound user. - … - [doctl databases replica list](https://docs.digitalocean.com/reference/doctl/reference/databases/replica/list/index.html.md): Lists the following details for read-only replicas for the specified database cluster. - The replica's name - The region where the database cluster is located, such as `nyc3`, `sfo2` - The replica's status. Possible values: `forking` and `active` This … - [doctl databases topics list](https://docs.digitalocean.com/reference/doctl/reference/databases/topics/list/index.html.md): This command lists the following details for each topic in a kafka database cluster: - The Name of the topic. - The State of the topic. - The Replication Factor of the topic - number of brokers the topic's partitions are replicated across. - [doctl databases user list](https://docs.digitalocean.com/reference/doctl/reference/databases/user/list/index.html.md): Retrieves a list of users for the specified database with the following details: - The username for the user - The password for the user - The user's role, either "primary" or "normal" Primary user accounts are created by DigitalOcean at database cluster … - [doctl databases migrate](https://docs.digitalocean.com/reference/doctl/reference/databases/migrate/index.html.md): Migrates the specified database cluster to a new region. - [doctl databases topics partitions](https://docs.digitalocean.com/reference/doctl/reference/databases/topics/partitions/index.html.md): This command lists the following details for each partition of a given topic in a kafka database cluster: - The Id - identifier of the topic partition. - The Size - size of the topic partition, in bytes. - The InSyncReplicas - number of brokers that are in … - [doctl databases replica promote](https://docs.digitalocean.com/reference/doctl/reference/databases/replica/promote/index.html.md): Promotes a read-only database replica to become its own independent primary cluster. Promoted replicas no longer stay in sync with primary cluster they were forked from. This command requires that you pass in the replica's name, which you can retrieve by … - [doctl databases options regions](https://docs.digitalocean.com/reference/doctl/reference/databases/options/regions/index.html.md): Lists the available regions for a given database engine. Some engines may not be available in certain regions. - [doctl databases firewalls remove](https://docs.digitalocean.com/reference/doctl/reference/databases/firewalls/remove/index.html.md): Removes single rule from the list of firewall rules for a specified database. You can retrieve a firewall rule's UUIDs by calling: doctl database firewalls list - [doctl databases firewalls replace](https://docs.digitalocean.com/reference/doctl/reference/databases/firewalls/replace/index.html.md): Replace the firewall rules for a specified database. This command requires the `--rule` flag. You can configure multiple rules for the firewall by passing additional arguments in a comma-separated list with the `--rule` flag. Each rule passed using the … - [doctl databases user reset](https://docs.digitalocean.com/reference/doctl/reference/databases/user/reset/index.html.md): Resets the auth password or the MySQL authorization plugin for a given user and returns the user's new credentials. When resetting MySQL auth, valid values for `` are `caching_sha2_password` and `mysql_native_password`. - [doctl databases resize](https://docs.digitalocean.com/reference/doctl/reference/databases/resize/index.html.md): Resizes the specified database cluster. You must specify the desired number of nodes and size of the nodes. For example: doctl databases resize ca9f591d-9999-5555-a0ef-1c02d1d1e352 --num-nodes 2 --size db-s-16vcpu-64gb Database nodes cannot be resized to … - [doctl databases sql-mode set](https://docs.digitalocean.com/reference/doctl/reference/databases/sql-mode/set/index.html.md): This command configures the SQL modes for the specified MySQL database cluster. The SQL modes should be provided as a space separated list. This command replaces the existing SQL mode configuration completely. Include all of the current values when adding … - [doctl databases options slugs](https://docs.digitalocean.com/reference/doctl/reference/databases/options/slugs/index.html.md): Lists the available slugs for a given database engine. - [doctl databases configuration update](https://docs.digitalocean.com/reference/doctl/reference/databases/configuration/update/index.html.md): Updates the specified database cluster's advanced configuration. Using this command, you can update various settings like backup times, temporary file limits, and session timeouts. Available settings vary by database engine. This command functions as a … - [doctl databases maintenance-window update](https://docs.digitalocean.com/reference/doctl/reference/databases/maintenance-window/update/index.html.md): Updates the maintenance window for the specified database cluster. Maintenance windows are hour-long blocks of time during which DigitalOcean performs automatic maintenance on databases every week. During this time, health checks, security updates, version … - [doctl databases pool update](https://docs.digitalocean.com/reference/doctl/reference/databases/pool/update/index.html.md): Updates the specified connection pool for the specified database cluster. You can get a list of existing connection pools by calling: doctl databases pool list You can get a list of existing database clusters and their IDs by calling: doctl databases list - [doctl databases topics update](https://docs.digitalocean.com/reference/doctl/reference/databases/topics/update/index.html.md): This command updates a kafka topic for the specified kafka database cluster. Example: doctl databases topics update - [doctl databases options versions](https://docs.digitalocean.com/reference/doctl/reference/databases/options/versions/index.html.md): Lists the available versions for a given database engine. ## doctl genai The subcommands of `doctl genai` manage your GenAI resources. - [doctl genai agent route add](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/route/add/index.html.md): Use this command to add an agent route to an agent. The command requires values for the `--parent-agent-id` and `--child-agent-id` flags. - [doctl genai knowledge-base add-datasource](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/add-datasource/index.html.md): Add a datasource for knowledge base by its uuid. Add only one Spaces or Webcrawler as a datasource. For more info about datasources, see the [datasources … - [doctl genai knowledge-base attach](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/attach/index.html.md): Attach a knowledge base to an agent using knowledge base uuid and agent uuid. It returns the information of corresponding agent. - [doctl genai agent apikeys create](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/apikeys/create/index.html.md): Creates an API key for your GenAI agent on your account. The command requires values for the `--name``--agent-id` The API key is created in the specified agent. - [doctl genai agent create](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/create/index.html.md): Creates a GenAI agent on your account. The command requires values for the `--name``--project-id``--model-id``--region`, and `--instruction` flags. - [doctl genai agent functionroute create](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/functionroute/create/index.html.md): Create a function route for your GenAI agent.The command requires values for the `--agent-id``--description``--faas_name``--faas_namespace` `--function_name``--input_schema `, and `--output_schema ` flags. - [doctl genai knowledge-base create](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/create/index.html.md): Creates a knowledge base and returns the following information - The Knowledge Base UUID - The Knowledge Base Name - The Knowledge Base Region - The Knowledge Base Project ID - The Knowledge Base Database ID - The Knowledge Base Last Indexing Job - The … - [doctl genai openai-key create](https://docs.digitalocean.com/reference/doctl/reference/genai/openai-key/create/index.html.md): Creates a new OpenAI API Key with the specified name and API key. - [doctl genai agent apikeys delete](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/apikeys/delete/index.html.md): Deletes an api-key for an agent by ID. - [doctl genai agent delete](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/delete/index.html.md): Deletes a GenAI agent by ID. - [doctl genai agent functionroute delete](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/functionroute/delete/index.html.md): Use this command to delete a function route of an agent. The command requires values for the `--agent-id` and `--function-id` flags. - [doctl genai agent route delete](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/route/delete/index.html.md): Use this command to delete an agent route to an agent. The command requires values for the `--parent-agent-id` and `--child-agent-id` flags. - [doctl genai knowledge-base delete](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/delete/index.html.md): Deletes the knowledge bases by its valid uuid. - [doctl genai openai-key delete](https://docs.digitalocean.com/reference/doctl/reference/genai/openai-key/delete/index.html.md): Deletes an OpenAI API Key by its UUID. - [doctl genai knowledge-base delete-datasource](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/delete-datasource/index.html.md): Delete a datasource for knowledge base using its id. - [doctl genai knowledge-base detach](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/detach/index.html.md): Detaches a knowledge base from an agent using knowledge base uuid and agent uuid. - [doctl genai agent get](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/get/index.html.md): Retrieves information about an agent, including: - The Agent ID - The Agent name - The Agent's region - The Agent's model ID - The Agent's project ID - The Agent creation date, in ISO8601 combined date and time format - The ID of the user who created the … - [doctl genai knowledge-base get](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/get/index.html.md): Retrieves information about a Knowledge Base, including: - The Knowledge Base UUID - The Knowledge Base Name - The Knowledge Base Region - The Knowledge Base Project ID - The Knowledge Base Database ID - The Knowledge Base Last Indexing Job - The Knowledge … - [doctl genai openai-key get](https://docs.digitalocean.com/reference/doctl/reference/genai/openai-key/get/index.html.md): Retrieves information about an OpenAI API Key - [doctl genai openai-key get-agents](https://docs.digitalocean.com/reference/doctl/reference/genai/openai-key/get-agents/index.html.md): Lists all agents that are using the specified OpenAI API Key - [doctl genai agent apikeys list](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/apikeys/list/index.html.md): Retrieves a list of all the api keys for your agent, including the following details: - The ApiKey ID - The ApiKey name - The ID of the user who created the Apikey - The ApiKey's Secret Key - The ApiKey deletion date, in ISO8601 combined date and time … - [doctl genai agent list](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/list/index.html.md): Retrieves a list of all the agents on your account, including the following information for each: - The Agent ID - The Agent name - The Agent's region - The Agent's model ID - The Agent's project ID - The Agent creation date, in ISO8601 combined date and … - [doctl genai knowledge-base list](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/list/index.html.md): List all knowledge bases for agents where each knowledge base contains the following information: - The Knowledge Base UUID - The Knowledge Base Name - The Knowledge Base Region - The Knowledge Base Project ID - The Knowledge Base Database ID - The … - [doctl genai openai-key list](https://docs.digitalocean.com/reference/doctl/reference/genai/openai-key/list/index.html.md): Lists all OpenAI API Keys available in your account - [doctl genai knowledge-base list-datasources](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/list-datasources/index.html.md): List all datasource for a valid knowledge base uuid. - [doctl genai list-models](https://docs.digitalocean.com/reference/doctl/reference/genai/list-models/index.html.md): The `doctl genai list-models` command lists all available GenAI models. The command returns the following details for each model: - The model ID - The model name - Agreement name - The model creation date, in ISO8601 combined date and time format - The … - [doctl genai list-regions](https://docs.digitalocean.com/reference/doctl/reference/genai/list-regions/index.html.md): The `doctl genai list-regions` command lists all available GenAI regions. The command returns the following details for each region: - Inference URL: The URL for the inference server - Region: The region code - Serves Batch: Whether this datacenter is … - [doctl genai agent list-versions](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/list-versions/index.html.md): Retrieves a list of all the versions for an agent on your account including the following information for each version: - The Agent ID - Can it be rollbacked - The Version creation date, in ISO8601 combined date and time format - The Email of the user who … - [doctl genai agent apikeys regenerate](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/apikeys/regenerate/index.html.md): Regenerates an api-key for an agent by ID. - [doctl genai agent apikeys update](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/apikeys/update/index.html.md): Use this command to update the name of an API key. - [doctl genai agent functionroute update](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/functionroute/update/index.html.md): Use this command to update function route of an agent.The command requires values for the `--agent-id` and `--function-id` flags. - [doctl genai agent route update](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/route/update/index.html.md): Use this command to updates an agent route to an agent.The command requires values for the `--parent-agent-id` and `--child-agent-id` flags. - [doctl genai agent update](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/update/index.html.md): Use this command to update the name and configuration of an agent. - [doctl genai knowledge-base update](https://docs.digitalocean.com/reference/doctl/reference/genai/knowledge-base/update/index.html.md): Update a knowledge base by its uuid and returns the updated information of the knowledge base with following details - The Knowledge Base UUID - The Knowledge Base Name - The Knowledge Base Region - The Knowledge Base Project ID - The Knowledge Base … - [doctl genai openai-key update](https://docs.digitalocean.com/reference/doctl/reference/genai/openai-key/update/index.html.md): Updates an existing OpenAI API Key with the specified name and API key. - [doctl genai agent update-visibility](https://docs.digitalocean.com/reference/doctl/reference/genai/agent/update-visibility/index.html.md): Update the visibility of a GenAI agent. ## doctl invoice The subcommands of `doctl invoice` retrieve details about invoices for your account. - [doctl invoice csv](https://docs.digitalocean.com/reference/doctl/reference/invoice/csv/index.html.md): Downloads a CSV-formatted file of a specific invoice to your local machine. Use the `doctl invoice list` command to find the UUID of the invoice to retrieve. - [doctl invoice get](https://docs.digitalocean.com/reference/doctl/reference/invoice/get/index.html.md): Retrieves an itemized list of resources and their costs on the specified invoice, including each resource's: - ID - UUID (if applicable) - Product name - Description - Group description - Amount charged, in USD - Duration of usage for the invoice period - … - [doctl invoice list](https://docs.digitalocean.com/reference/doctl/reference/invoice/list/index.html.md): Lists all of the invoices on your account including the UUID, amount in USD, and time period for each. - [doctl invoice pdf](https://docs.digitalocean.com/reference/doctl/reference/invoice/pdf/index.html.md): This command downloads a PDF summary of a specific invoice to the provided location. Use the `doctl invoice list` command to find the UUID of the invoice to retrieve. - [doctl invoice summary](https://docs.digitalocean.com/reference/doctl/reference/invoice/summary/index.html.md): Retrieves a summary of an invoice, including the following details: - The invoice's UUID - The year and month of the billing period - The total amount of the invoice, in USD - The name of the user associated with the invoice - The company associated with … ## doctl kubernetes The commands under `doctl kubernetes` are for managing Kubernetes clusters and viewing configuration options relating to clusters. A typical workflow is to use `doctl kubernetes cluster create` to create the cluster on DigitalOcean's infrastructure, then call `doctl kubernetes cluster kubeconfig` to configure `kubectl` to connect to the cluster. You are then able to use `kubectl` to create and manage workloads. The commands under `doctl kubernetes options` retrieve values used while creating clusters, such as the list of regions where cluster creation is supported. - [doctl kubernetes cluster registry add](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/registry/add/index.html.md): Adds container registry support to the specified Kubernetes cluster(s). - [doctl kubernetes cluster create](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/create/index.html.md): Creates a Kubernetes cluster given the specified options and using the specified name. Before creating the cluster, you can use `doctl kubernetes options` to see possible values for the various configuration flags. If no configuration flags are used, a … - [doctl kubernetes cluster node-pool create](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/node-pool/create/index.html.md): Creates a new node pool for the specified cluster. The command requires values for the `--name`, `--size`, and `--count` flags to create a node pool. You can also specify that you'd like to enable autoscaling and set minimum and maximum node poll sizes. - [doctl kubernetes cluster delete](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/delete/index.html.md): Deletes the specified Kubernetes clusters and the Droplets associated with them. To delete all other DigitalOcean resources created during the operation of the clusters, such as load balancers, volumes or volume snapshots, use the `--dangerous` flag. - [doctl kubernetes cluster node-pool delete](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/node-pool/delete/index.html.md): Deletes a node pool in a cluster, which also removes all the nodes inside that pool. You cannot reverse this action. - [doctl kubernetes cluster node-pool delete-node](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/node-pool/delete-node/index.html.md): Deletes a node in the specified node pool. By default, this deletion happens gracefully and Kubernetes drains the node of any pods before deleting it. - [doctl kubernetes cluster delete-selective](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/delete-selective/index.html.md): Deletes the specified Kubernetes cluster and Droplets associated with it. It also deletes the specified associated resources. Associated resources can be load balancers, volumes and volume snapshots. - [doctl kubernetes cluster get](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/get/index.html.md): Retrieves the following details about a Kubernetes cluster: - A unique ID for the cluster - A human-readable name for the cluster - The slug identifying the region where the Kubernetes cluster is located - The slug identifying the cluster's Kubernetes … - [doctl kubernetes cluster node-pool get](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/node-pool/get/index.html.md): Retrieves information about the specified node pool in the specified cluster, including: - The node pool ID - The slug indicating the machine size of the nodes, such as `s-1vcpu-2gb` - The number of nodes in the pool - The tags applied to the node pool - … - [doctl kubernetes cluster get-upgrades](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/get-upgrades/index.html.md): Retrieves a list of slugs representing Kubernetes upgrade versions you can use to upgrade the cluster. To upgrade your cluster, use the `doctl kubernetes cluster upgrade` command. - [doctl kubernetes 1-click install](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/1-click/install/index.html.md): Installs 1-click applications on a Kubernetes cluster. Use the `--1-click` flag to specify one or multiple pieces of software to install on the cluster. - [doctl kubernetes 1-click list](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/1-click/list/index.html.md): Retrieves a list of Kubernetes 1-Click applications you can install on a Kubernetes cluster. - [doctl kubernetes cluster list](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/list/index.html.md): Retrieves the following details about all Kubernetes clusters that are on your account: - A unique ID for the cluster - A human-readable name for the cluster - The slug identifying the region where the Kubernetes cluster is located - The slug identifying … - [doctl kubernetes cluster node-pool list](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/node-pool/list/index.html.md): Retrieves information about the specified cluster's node pools, including: - The node pool ID - The slug indicating the machine size of the nodes, such as `s-1vcpu-2gb` - The number of nodes in the pool - The tags applied to the node pool - The names of … - [doctl kubernetes cluster list-associated-resources](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/list-associated-resources/index.html.md): Retrieves the following details for a Kubernetes cluster: - Volume IDs for volumes created by the DigitalOcean CSI driver - Volume snapshot IDs for volume snapshots created by the DigitalOcean CSI driver - Load balancer IDs for load balancers managed by … - [doctl kubernetes options regions](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/options/regions/index.html.md): Lists regions that support DigitalOcean Kubernetes clusters - [doctl kubernetes cluster kubeconfig remove](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/kubeconfig/remove/index.html.md): This command removes the specified cluster's credentials from your local kubeconfig. After running this command, you cannot use `kubectl` to interact with your cluster. - [doctl kubernetes cluster registry remove](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/registry/remove/index.html.md): Removes container registry support from the specified Kubernetes cluster(s). - [doctl kubernetes cluster node-pool replace-node](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/node-pool/replace-node/index.html.md): Deletes the specified node in the specified node pool, and then creates a new node in its place. This is useful if you suspect a node has entered an undesired state. By default, the deletion happens gracefully and Kubernetes drains the node of any pods … - [doctl kubernetes cluster kubeconfig save](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/kubeconfig/save/index.html.md): Adds the credentials for the specified cluster to your local kubeconfig. After this, your kubectl installation can directly manage the specified cluster. - [doctl kubernetes cluster kubeconfig show](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/kubeconfig/show/index.html.md): Returns the raw YAML for the specified cluster's kubeconfig. - [doctl kubernetes options sizes](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/options/sizes/index.html.md): Lists machine sizes that you can use in a DigitalOcean Kubernetes cluster - [doctl kubernetes cluster node-pool update](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/node-pool/update/index.html.md): Updates a node pool in a cluster. You can update any value for which there is a flag. - [doctl kubernetes cluster update](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/update/index.html.md): Updates the configuration values for a Kubernetes cluster. The cluster must be referred to by its name or ID. Use the `doctl kubernetes cluster list` command to get a list of clusters on your account. - [doctl kubernetes cluster upgrade](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/cluster/upgrade/index.html.md): Upgrades a Kubernetes cluster. By default, this upgrades the cluster to the latest available release, but you can also specify any version listed for your cluster by using `doctl k8s cluster get-upgrades`. - [doctl kubernetes options versions](https://docs.digitalocean.com/reference/doctl/reference/kubernetes/options/versions/index.html.md): Lists Kubernetes versions that you can use with DigitalOcean clusters ## doctl monitoring The sub-commands of `doctl monitoring` manage the monitoring on your account. You can create alert policies to monitor the resource consumption of your Droplets, and uptime checks to monitor the availability of your websites and services - [doctl monitoring alert create](https://docs.digitalocean.com/reference/doctl/reference/monitoring/alert/create/index.html.md): Creates a new alert policy. You can create policies that monitor various metrics of your Droplets and send you alerts when a metric exceeds a specified threshold. For example, you can create a policy that monitors a Droplet's CPU usage and triggers an … - [doctl monitoring uptime alert create](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/alert/create/index.html.md): Creates an alert policy for an uptime check. You can create an alert policy based on the following metrics: - `latency`: Alerts on the response latency. `--threshold` value is an integer representing milliseconds. - `down`: Alerts on whether the endpoints … - [doctl monitoring uptime create](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/create/index.html.md): Creates an uptime check on your account. Uptime checks monitor any endpoint that is accessible over HTTP, HTTPS, ping (ICMP). You can use this check to set up an alert policy using the `doctl monitoring uptime alert` commands. - [doctl monitoring alert delete](https://docs.digitalocean.com/reference/doctl/reference/monitoring/alert/delete/index.html.md): Deletes an alert policy. - [doctl monitoring uptime alert delete](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/alert/delete/index.html.md): Deletes an uptime check on your account by ID. - [doctl monitoring uptime delete](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/delete/index.html.md): Deletes an uptime check on your account. - [doctl monitoring alert get](https://docs.digitalocean.com/reference/doctl/reference/monitoring/alert/get/index.html.md): Retrieves an alert policy and its configuration. - [doctl monitoring uptime alert get](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/alert/get/index.html.md): Retrieves information about an uptime alert policy. - [doctl monitoring uptime get](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/get/index.html.md): Retrieves information about an uptime check on your account. - [doctl monitoring alert list](https://docs.digitalocean.com/reference/doctl/reference/monitoring/alert/list/index.html.md): Retrieves a list of all the alert policies in your account. - [doctl monitoring uptime alert list](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/alert/list/index.html.md): Retrieves a list of the alert policies for an uptime check. - [doctl monitoring uptime list](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/list/index.html.md): Retrieves a list of all of the uptime checks on your account. - [doctl monitoring alert update](https://docs.digitalocean.com/reference/doctl/reference/monitoring/alert/update/index.html.md): Updates an existing alert policy. - [doctl monitoring uptime alert update](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/alert/update/index.html.md): Updates an uptime alert configuration. - [doctl monitoring uptime update](https://docs.digitalocean.com/reference/doctl/reference/monitoring/uptime/update/index.html.md): Updates an uptime check on your account. All of these flags are required. Uptime checks cannot be disabled via `doctl`. You can only disable them using the control panel or the public API. ## doctl network The commands under `doctl network` are for managing network products - [doctl network attachment create](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/create/index.html.md): Use this command to create a new Partner Attachment on your account. - [doctl network byoip-prefix create](https://docs.digitalocean.com/reference/doctl/reference/network/byoip-prefix/create/index.html.md): Creates a new BYOIP Prefix. BYOIP Prefixes can be held in the region they were created in on your account. - [doctl network attachment delete](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/delete/index.html.md): Deletes information about a Partner Attachment. This is irreversible - [doctl network byoip-prefix delete](https://docs.digitalocean.com/reference/doctl/reference/network/byoip-prefix/delete/index.html.md): Permanently deletes a BYOIP Prefix. This is irreversible and it needs all IPs of the prefix to be unassigned - [doctl network attachment get](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/get/index.html.md): Retrieves information about a Partner Attachment, including: - The Partner Attachment ID - The Partner Attachment Name - The Partner Attachment State - The Partner Attachment Connection Bandwidth in Mbps - The Partner Attachment Region - The Partner … - [doctl network byoip-prefix get](https://docs.digitalocean.com/reference/doctl/reference/network/byoip-prefix/get/index.html.md): Retrieves detailed information about a BYOIP Prefix - [doctl network attachment get-bgp-auth-key](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/get-bgp-auth-key/index.html.md): Retrieves information about a BGP Auth key of Partner Attachment - [doctl network attachment get-service-key](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/get-service-key/index.html.md): Retrieves information about a Service key of Partner Attachment, including: - The Service key Value - The Service key State - The Service key CreatedAt - [doctl network attachment list](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/list/index.html.md): Retrieves a list of the Partner Attachment on your account, including the following information for each: - The Partner Attachment ID - The Partner Attachment Name - The Partner Attachment State - The Partner Attachment Connection Bandwidth in Mbps - The … - [doctl network byoip-prefix list](https://docs.digitalocean.com/reference/doctl/reference/network/byoip-prefix/list/index.html.md): Retrieves a list of all the BYOIP Prefixes in your account. - [doctl network attachment list-routes](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/list-routes/index.html.md): Retrieves a list of the Partner Attachment Routes on your account, including the following information for each: - The Partner Attachment ID - The Partner Attachment Cidr - [doctl network attachment regenerate-service-key](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/regenerate-service-key/index.html.md): Regenerates information about a Service key of Partner Attachment - [doctl network byoip-prefix resource](https://docs.digitalocean.com/reference/doctl/reference/network/byoip-prefix/resource/index.html.md): Retrieves a list of all the Resources in your prefix. - [doctl network attachment update](https://docs.digitalocean.com/reference/doctl/reference/network/attachment/update/index.html.md): Use this command to update the name and and configuration of a Partner Attachment - [doctl network byoip-prefix update](https://docs.digitalocean.com/reference/doctl/reference/network/byoip-prefix/update/index.html.md): Updates the advertisement status of a BYOIP Prefix ## doctl nfs The subcommands of `doctl nfs` allow you to access and manage Network File Storage. - [doctl nfs create](https://docs.digitalocean.com/reference/doctl/reference/nfs/create/index.html.md): Create an NFS share with the provided config. - [doctl nfs snapshot create](https://docs.digitalocean.com/reference/doctl/reference/nfs/snapshot/create/index.html.md): Creates a snapshot of the NFS share with the given share ID. - [doctl nfs delete](https://docs.digitalocean.com/reference/doctl/reference/nfs/delete/index.html.md): Delete an NFS share with the given ID and region. - [doctl nfs snapshot delete](https://docs.digitalocean.com/reference/doctl/reference/nfs/snapshot/delete/index.html.md): Delete an NFS share with the given ID and region. - [doctl nfs get](https://docs.digitalocean.com/reference/doctl/reference/nfs/get/index.html.md): Get an NFS share with the given ID and region. - [doctl nfs snapshot get](https://docs.digitalocean.com/reference/doctl/reference/nfs/snapshot/get/index.html.md): Get an NFS snapshot with the given ID and region. - [doctl nfs list](https://docs.digitalocean.com/reference/doctl/reference/nfs/list/index.html.md): List all NFS shares in the given region. - [doctl nfs snapshot list](https://docs.digitalocean.com/reference/doctl/reference/nfs/snapshot/list/index.html.md): List all NFS snapshots in the given region. - [doctl nfs resize](https://docs.digitalocean.com/reference/doctl/reference/nfs/resize/index.html.md): Resize an NFS share with the given ID and region. ## doctl projects The subcommands of `doctl projects` allow you to create, manage, and assign resources to your projects. Projects allow you to organize your DigitalOcean resources (like Droplets, Spaces, load balancers, domains, and floating IPs) into groups that fit the way you work. You can create projects that align with the applications, environments, and clients that you host on DigitalOcean. - [doctl projects resources assign](https://docs.digitalocean.com/reference/doctl/reference/projects/resources/assign/index.html.md): Assign one or more resources to a project by specifying the resource's uniform resource name ("URN"). A valid URN has the format: `do:resource_type:resource_id`. For example: - `do:droplet:4126873` - `do:volume:6fc4c277-ea5c-448a-93cd-dd496cfef71f` - … - [doctl projects create](https://docs.digitalocean.com/reference/doctl/reference/projects/create/index.html.md): Creates a new project in your account. Projects allow you to organize your DigitalOcean resources (like Droplets, Spaces, load balancers, domains, and floating IPs) into groups that fit the way you work. You can create projects that align with the … - [doctl projects delete](https://docs.digitalocean.com/reference/doctl/reference/projects/delete/index.html.md): Deletes a project. To be deleted, a project must not have any resources assigned to it. - [doctl projects get](https://docs.digitalocean.com/reference/doctl/reference/projects/get/index.html.md): Retrieves the following details for an existing project (use `default` as the to retrieve details about your default project): - The project's ID, in UUID format - The project owner's account UUID - The name of the project - The project's description - The … - [doctl projects resources get](https://docs.digitalocean.com/reference/doctl/reference/projects/resources/get/index.html.md): Retrieve information about a resource by specifying its uniform resource name ("URN"). Currently, only Droplets, floating IPs, load balancers, domains, volumes, and App Platform apps are supported. A valid URN has the format: … - [doctl projects list](https://docs.digitalocean.com/reference/doctl/reference/projects/list/index.html.md): List details for your DigitalOcean projects, including: - The project's ID, in UUID format - The project owner's account UUID - The name of the project - The project's description - The project's specified purpose - The project's environment (Development, … - [doctl projects resources list](https://docs.digitalocean.com/reference/doctl/reference/projects/resources/list/index.html.md): List all of the resources assigned to the specified project displaying their uniform resource names ("URNs"). - [doctl projects update](https://docs.digitalocean.com/reference/doctl/reference/projects/update/index.html.md): Updates information about an existing project. Use `default` as the to update your default project. ## doctl registries The subcommands of `doctl registries` allow you to manage multiple registries. - [doctl registries options available-regions](https://docs.digitalocean.com/reference/doctl/reference/registries/options/available-regions/index.html.md): Lists available container registry regions - [doctl registries garbage-collection cancel](https://docs.digitalocean.com/reference/doctl/reference/registries/garbage-collection/cancel/index.html.md): Cancels the currently-active garbage collection for a container registry. - [doctl registries create](https://docs.digitalocean.com/reference/doctl/reference/registries/create/index.html.md): Creates a new registry in your account. The registry name must be unique and can contain only lowercase letters, numbers, and hyphens. - [doctl registries delete](https://docs.digitalocean.com/reference/doctl/reference/registries/delete/index.html.md): Permanently deletes a registry from your account. - [doctl registries repository delete-manifest](https://docs.digitalocean.com/reference/doctl/reference/registries/repository/delete-manifest/index.html.md): Permanently deletes one or more repository manifests by digest. - [doctl registries repository delete-tag](https://docs.digitalocean.com/reference/doctl/reference/registries/repository/delete-tag/index.html.md): Permanently deletes one or more repository tags. - [doctl registries docker-config](https://docs.digitalocean.com/reference/doctl/reference/registries/docker-config/index.html.md): Outputs a JSON-formatted Docker configuration that you can use to configure a Docker client to authenticate with your private container registry. This configuration is useful for configuring third-party tools that need access to your registry. By default … - [doctl registries get](https://docs.digitalocean.com/reference/doctl/reference/registries/get/index.html.md): Retrieves information about a registry in your account, including: - The registry name - The endpoint used to access it - The region where it resides - [doctl registries garbage-collection get-active](https://docs.digitalocean.com/reference/doctl/reference/registries/garbage-collection/get-active/index.html.md): Retrieves the currently-active garbage collection for a container registry, if any active garbage collection exists. Information included about the registry includes: - UUID - Status - Registry name - Create time - Updated at time - Blobs deleted - Freed … - [doctl registries kubernetes-manifest](https://docs.digitalocean.com/reference/doctl/reference/registries/kubernetes-manifest/index.html.md): Outputs a YAML-formatted Kubernetes secret manifest that can be used to grant a Kubernetes cluster pull access to your private container registry. By default, the secret manifest is applied to all the namespaces for the Kubernetes cluster using the … - [doctl registries garbage-collection list](https://docs.digitalocean.com/reference/doctl/reference/registries/garbage-collection/list/index.html.md): Retrieves a list of past garbage collections for a registry. Information about each garbage collection includes: - UUID - Status - Registry name - Create time - Updated at time - Blobs deleted - Freed bytes - [doctl registries list](https://docs.digitalocean.com/reference/doctl/reference/registries/list/index.html.md): Lists information about all registries in your account, including: - The registry name - The endpoint used to access it - The region where it resides - [doctl registries repository list-manifests](https://docs.digitalocean.com/reference/doctl/reference/registries/repository/list-manifests/index.html.md): Retrieves information about manifests in a repository, including: - The manifest digest - The compressed size - The uncompressed size - The last updated timestamp - The manifest tags - The manifest blobs (available in detailed output only) - [doctl registries repository list-tags](https://docs.digitalocean.com/reference/doctl/reference/registries/repository/list-tags/index.html.md): Retrieves information about tags in a repository, including: - The tag name - The compressed size - The manifest digest - The last updated timestamp - [doctl registries repository list-v2](https://docs.digitalocean.com/reference/doctl/reference/registries/repository/list-v2/index.html.md): Retrieves information about repositories in a registry, including: - The repository name - The latest manifest of the repository - The latest manifest's latest tag, if any - The number of tags in the repository - The number of manifests in the repository - [doctl registries login](https://docs.digitalocean.com/reference/doctl/reference/registries/login/index.html.md): Logs Docker into Container Registry making pull and push commands to your private container registry authenticated. - [doctl registries logout](https://docs.digitalocean.com/reference/doctl/reference/registries/logout/index.html.md): This command logs Docker out of the private container registry, revoking access to it. - [doctl registries garbage-collection start](https://docs.digitalocean.com/reference/doctl/reference/registries/garbage-collection/start/index.html.md): Starts a garbage collection on a container registry. You can only have one active garbage collection at a time for a given registry. - [doctl registries options subscription-tiers](https://docs.digitalocean.com/reference/doctl/reference/registries/options/subscription-tiers/index.html.md): Lists available container registry subscription tiers ## doctl registries The subcommands of `doctl registries` create, manage, and allow access to your private container registry. - [doctl registries options available-regions](https://docs.digitalocean.com/reference/doctl/reference/registry/options/available-regions/index.html.md): Lists available container registry regions - [doctl registries garbage-collection cancel](https://docs.digitalocean.com/reference/doctl/reference/registry/garbage-collection/cancel/index.html.md): Cancels the currently-active garbage collection for a container registry. - [doctl registries create](https://docs.digitalocean.com/reference/doctl/reference/registry/create/index.html.md): Creates a new private container registry with the provided name. - [doctl registries delete](https://docs.digitalocean.com/reference/doctl/reference/registry/delete/index.html.md): Permanently deletes a private container registry and all of its contents. This is irreversible. - [doctl registries repository delete-manifest](https://docs.digitalocean.com/reference/doctl/reference/registry/repository/delete-manifest/index.html.md): Permanently deletes one or more repository manifests by digest. - [doctl registries repository delete-tag](https://docs.digitalocean.com/reference/doctl/reference/registry/repository/delete-tag/index.html.md): Permanently deletes one or more repository tags. - [doctl registries docker-config](https://docs.digitalocean.com/reference/doctl/reference/registry/docker-config/index.html.md): Outputs a JSON-formatted Docker configuration that you can use to configure a Docker client to authenticate with your private container registry. This configuration is useful for configuring third-party tools that need access to your registry. For … - [doctl registries get](https://docs.digitalocean.com/reference/doctl/reference/registry/get/index.html.md): Retrieves details about a private container registry, including its name and the endpoint used to access it. - [doctl registries garbage-collection get-active](https://docs.digitalocean.com/reference/doctl/reference/registry/garbage-collection/get-active/index.html.md): Retrieves the currently-active garbage collection for a container registry, if any active garbage collection exists. Information included about the registry includes: - UUID - Status - Registry name - Create time - Updated at time - Blobs deleted - Freed … - [doctl registries kubernetes-manifest](https://docs.digitalocean.com/reference/doctl/reference/registry/kubernetes-manifest/index.html.md): Outputs a YAML-formatted Kubernetes secret manifest that can be used to grant a Kubernetes cluster pull access to your private container registry. By default, the secret manifest is applied to all the namespaces for the Kubernetes cluster using the … - [doctl registries garbage-collection list](https://docs.digitalocean.com/reference/doctl/reference/registry/garbage-collection/list/index.html.md): Retrieves a list of past garbage collections for a registry. Information about each garbage collection includes: - UUID - Status - Registry name - Create time - Updated at time - Blobs deleted - Freed bytes - [doctl registries repository list-manifests](https://docs.digitalocean.com/reference/doctl/reference/registry/repository/list-manifests/index.html.md): Retrieves information about manifests in a repository, including: - The manifest digest - The compressed size - The uncompressed size - The last updated timestamp - The manifest tags - The manifest blobs (available in detailed output only) - [doctl registries repository list-tags](https://docs.digitalocean.com/reference/doctl/reference/registry/repository/list-tags/index.html.md): Retrieves information about tags in a repository, including: - The tag name - The compressed size - The manifest digest - The last updated timestamp - [doctl registries repository list-v2](https://docs.digitalocean.com/reference/doctl/reference/registry/repository/list-v2/index.html.md): Retrieves information about repositories in a registry, including: - The repository name - The latest manifest of the repository - The latest manifest's latest tag, if any - The number of tags in the repository - The number of manifests in the repository - [doctl registries login](https://docs.digitalocean.com/reference/doctl/reference/registry/login/index.html.md): Logs Docker into Container Registry making pull and push commands to your private container registry authenticated. - [doctl registries logout](https://docs.digitalocean.com/reference/doctl/reference/registry/logout/index.html.md): This command logs Docker out of the private container registry, revoking access to it. - [doctl registries garbage-collection start](https://docs.digitalocean.com/reference/doctl/reference/registry/garbage-collection/start/index.html.md): Starts a garbage collection on a container registry. You can only have one active garbage collection at a time for a given registry. - [doctl registries options subscription-tiers](https://docs.digitalocean.com/reference/doctl/reference/registry/options/subscription-tiers/index.html.md): Lists available container registry subscription tiers ## doctl serverless The `doctl serverless` commands provide an environment for developing, testing, and deploying serverless functions. One or more local file system areas are employed, along with one or more 'functions namespaces' in the cloud. A one-time install of the serverless software is needed (use `doctl serverless install` to install the software, then `doctl serverless connect` to connect to a functions namespace associated with your account). Other `doctl serverless` commands are used to develop, test, and deploy. - [doctl serverless connect](https://docs.digitalocean.com/reference/doctl/reference/serverless/connect/index.html.md): This command connects `doctl serverless` support to a functions namespace of your choice. The optional argument should be a (complete or partial) match to a namespace label or id. If there is no argument, all namespaces are matched. If the result is … - [doctl serverless namespaces create](https://docs.digitalocean.com/reference/doctl/reference/serverless/namespaces/create/index.html.md): `Use `doctl serverless namespaces create` to create a new functions namespace. Both a region and a label must be specified. - [doctl serverless namespaces delete](https://docs.digitalocean.com/reference/doctl/reference/serverless/namespaces/delete/index.html.md): Use `doctl serverless namespaces delete` to delete a functions namespace. The full label or full id of the namespace is required as an argument. You are prompted for confirmation unless `--force` is specified. - [doctl serverless deploy](https://docs.digitalocean.com/reference/doctl/reference/serverless/deploy/index.html.md): At any time you can use `doctl serverless deploy` to upload the contents of a functions project in your file system for testing in your serverless namespace. The project must be organized in the fashion expected by an App Platform Functions component. The … - [doctl serverless activations get](https://docs.digitalocean.com/reference/doctl/reference/serverless/activations/get/index.html.md): Retrieve the activation record for a previously invoked function. You can limit output to the result or the logs. The `doctl serverless activation logs` command has additional advanced capabilities for retrieving logs. - [doctl serverless functions get](https://docs.digitalocean.com/reference/doctl/reference/serverless/functions/get/index.html.md): Retrieves the code or metadata of a deployed function. - [doctl serverless get-metadata](https://docs.digitalocean.com/reference/doctl/reference/serverless/get-metadata/index.html.md): The `doctl serverless get-metadata` command produces a JSON structure that summarizes the contents of a functions project (a directory you have designated for functions development). This can be useful for feeding into other tools. - [doctl serverless init](https://docs.digitalocean.com/reference/doctl/reference/serverless/init/index.html.md): The `doctl serverless init` command specifies a directory in your file system which will hold functions and supporting artifacts while you're developing them. This 'functions project' can be uploaded to your functions namespace for testing. Later, after … - [doctl serverless install](https://docs.digitalocean.com/reference/doctl/reference/serverless/install/index.html.md): This command installs additional software under `doctl` needed to make the other serverless commands work. The install operation is long-running, and a network connection is required. - [doctl serverless functions invoke](https://docs.digitalocean.com/reference/doctl/reference/serverless/functions/invoke/index.html.md): Invokes a function in your functions namespace. You can provide inputs and inspect outputs. - [doctl serverless activations list](https://docs.digitalocean.com/reference/doctl/reference/serverless/activations/list/index.html.md): Use `doctl serverless activations list` to list the activation records that are present in the cloud for previously invoked functions. - [doctl serverless functions list](https://docs.digitalocean.com/reference/doctl/reference/serverless/functions/list/index.html.md): Lists the functions in your functions namespace. - [doctl serverless namespaces list](https://docs.digitalocean.com/reference/doctl/reference/serverless/namespaces/list/index.html.md): Use `doctl serverless namespaces list` to list your functions namespaces. - [doctl serverless namespaces list-regions](https://docs.digitalocean.com/reference/doctl/reference/serverless/namespaces/list-regions/index.html.md): Use `doctl serverless namespaces list-regions` to list the values that are accepted in the `--region` flag of `doctl serverless namespaces create`. - [doctl serverless activations logs](https://docs.digitalocean.com/reference/doctl/reference/serverless/activations/logs/index.html.md): Use `doctl serverless activations logs` to retrieve the logs portion of one or more activation records with various options, such as selecting by package or function, and optionally watching continuously for new arrivals. - [doctl serverless activations result](https://docs.digitalocean.com/reference/doctl/reference/serverless/activations/result/index.html.md): Retrieve just the results portion of one or more activation records. - [doctl serverless status](https://docs.digitalocean.com/reference/doctl/reference/serverless/status/index.html.md): This command reports the status of serverless support and some details concerning its connected functions namespace. With the `--languages flag, it will report the supported languages. With the `--version flag, it will show just version information about … - [doctl serverless undeploy](https://docs.digitalocean.com/reference/doctl/reference/serverless/undeploy/index.html.md): This command removes functions, entire packages, or all functions and packages, from your function namespace. In general, deploying new content does not remove old content although it may overwrite it. Use `doctl serverless undeploy` to effect removal. The … - [doctl serverless uninstall](https://docs.digitalocean.com/reference/doctl/reference/serverless/uninstall/index.html.md): Removes serverless support from `doctl` - [doctl serverless upgrade](https://docs.digitalocean.com/reference/doctl/reference/serverless/upgrade/index.html.md): This command upgrades the serverless support software under `doctl` by installing over the existing version. The install operation is long-running, and a network connection is required. - [doctl serverless watch](https://docs.digitalocean.com/reference/doctl/reference/serverless/watch/index.html.md): Type `doctl serverless watch ` in a separate terminal window. It will run until interrupted. It will watch the directory (which should be one you initialized for serverless development) and will deploy the contents to the cloud incrementally as it detects … ## doctl spaces The subcommands of `doctl spaces` allow you to access and manage Spaces. - [doctl spaces keys create](https://docs.digitalocean.com/reference/doctl/reference/spaces/keys/create/index.html.md): Create a key for a Space with the provided name. - [doctl spaces keys delete](https://docs.digitalocean.com/reference/doctl/reference/spaces/keys/delete/index.html.md): Delete a key for a Space. - [doctl spaces keys get](https://docs.digitalocean.com/reference/doctl/reference/spaces/keys/get/index.html.md): Get the key for a Space by Access Key ID. - [doctl spaces keys list](https://docs.digitalocean.com/reference/doctl/reference/spaces/keys/list/index.html.md): List all keys for a Space. - [doctl spaces keys update](https://docs.digitalocean.com/reference/doctl/reference/spaces/keys/update/index.html.md): Update a key for a Space. ## doctl vpcs The commands under `doctl vpcs` are for managing your VPC networks. With the VPC commands, you can list, create, or delete VPCs, and manage their configuration details. - [doctl vpcs create](https://docs.digitalocean.com/reference/doctl/reference/vpcs/create/index.html.md): Use this command to create a new VPC network on your account. - [doctl vpcs peerings create](https://docs.digitalocean.com/reference/doctl/reference/vpcs/peerings/create/index.html.md): Use this command to create a new VPC Peering on your account. - [doctl vpcs delete](https://docs.digitalocean.com/reference/doctl/reference/vpcs/delete/index.html.md): Permanently deletes the specified VPC. This is irreversible. You cannot delete VPCs that are default networks for a region. To delete a default VPC network, make another VPC network the default for the region using the `doctl vpcs update --default=true` … - [doctl vpcs peerings delete](https://docs.digitalocean.com/reference/doctl/reference/vpcs/peerings/delete/index.html.md): Permanently deletes the specified VPC Peering. This is irreversible. - [doctl vpcs get](https://docs.digitalocean.com/reference/doctl/reference/vpcs/get/index.html.md): Retrieve information about a VPC network, including: - The VPC network's ID - The uniform resource name (URN) for the VPC network - The VPC network's name - The VPC network's description - The range of IP addresses in the VPC network, in CIDR notation - … - [doctl vpcs peerings get](https://docs.digitalocean.com/reference/doctl/reference/vpcs/peerings/get/index.html.md): Retrieves information about a VPC Peering, including: - The VPC Peering ID - The VPC Peering Name - The Peered VPC network IDs - The VPC Peering Status - The VPC Peering creation date, in ISO8601 combined date and time format - [doctl vpcs list](https://docs.digitalocean.com/reference/doctl/reference/vpcs/list/index.html.md): Retrieves a list of the VPCs on your account, including the following information for each: - The VPC network's ID - The uniform resource name (URN) for the VPC network - The VPC network's name - The VPC network's description - The range of IP addresses in … - [doctl vpcs peerings list](https://docs.digitalocean.com/reference/doctl/reference/vpcs/peerings/list/index.html.md): Retrieves a list of the VPC Peerings on your account, including the following information for each: - The VPC Peering ID - The VPC Peering Name - The Peered VPC network IDs - The VPC Peering Status - The VPC Peering creation date, in ISO8601 combined date … - [doctl vpcs peerings update](https://docs.digitalocean.com/reference/doctl/reference/vpcs/peerings/update/index.html.md): Use this command to update the name of a VPC Peering - [doctl vpcs update](https://docs.digitalocean.com/reference/doctl/reference/vpcs/update/index.html.md): Updates a VPC network's configuration. You can update its name, description, and default state.