civo_list_regions
List regions
List the Civo regions available to the account, with which one is the default, whether each is out of capacity, and the features each supports (IaaS, Kubernetes, object store, load balancers, GPU, databases). A cheap way to confirm the API key works. Civo: GET /v2/regions.
無需輸入參數。
civo_get_quota
Get account quota
The account's limits and current usage: instances, CPU cores, RAM, disk, volumes, snapshots, public IPs, networks, firewalls and rules, load balancers, object storage and databases. Answers 'can I launch another one?'. Civo: GET /v2/quota.
無需輸入參數。
civo_list_charges
List charges
List billable usage for a period: each resource's product code, label, region, time span and hours (size_gb for volumes). The range may be at most 31 days; defaults to the start of the current month until now. Civo: GET /v2/charges.
輸入參數tofrom
civo_list_instance_sizes
List sizes
List the sizes (plans) that can be launched — instances, Kubernetes nodes and databases — with CPU cores, RAM, disk, transfer allowance and GPU. Civo: GET /v2/sizes.
輸入參數region
civo_list_instances
List instances
List compute instances in a region, optionally filtered by tags. Paginated: returns {page, per_page, pages, items}. Passwords are redacted. Civo: GET /v2/instances.
輸入參數pagetagsregionper_page
civo_get_instance
Get one instance
Fetch one instance: status, size, CPU/RAM/disk, public and private IPs, network, firewall, tags, attached volumes and source image. Passwords are redacted. Civo: GET /v2/instances/{id}.
輸入參數regioninstance_id必填
civo_list_kubernetes_clusters
List Kubernetes clusters
List the Kubernetes (K3s/Talos) clusters in a region with status, version, node pools, API endpoint and installed applications. Paginated: {page, per_page, pages, items}. Kubeconfigs are redacted. Civo: GET /v2/kubernetes/clusters.
輸入參數pageregionper_page
civo_get_kubernetes_cluster
Get one Kubernetes cluster
Fetch one Kubernetes cluster: status, readiness, conditions, version and available upgrade, pools and their instances, network, firewall, CNI and installed marketplace apps. The kubeconfig is redacted. Civo: GET /v2/kubernetes/clusters/{id}.
輸入參數regioncluster_id必填
civo_list_networks
List networks
List the private networks in a region: label, CIDR, whether it is the default network, status and nameservers. Civo: GET /v2/networks.
輸入參數region
civo_list_firewalls
List firewalls
List the firewalls in a region with their network, rule count and how many instances, clusters and load balancers use each. Civo: GET /v2/firewalls.
輸入參數region
civo_list_firewall_rules
List a firewall's rules
List the rules of one firewall: protocol, port range, CIDRs, direction (ingress/egress), action (allow/deny) and label — the answer to 'what is exposed to the internet?'. Civo: GET /v2/firewalls/{id}/rules.
輸入參數regionfirewall_id必填
civo_list_load_balancers
List load balancers
List the load balancers in a region: algorithm, backends (IP, protocol, source/target ports), public IP, state and the Kubernetes service each fronts. Civo: GET /v2/loadbalancers.
輸入參數region
civo_list_volumes
List volumes
List the block-storage volumes in a region: size, status, type, and the instance or cluster each is attached to (unattached volumes still bill). Civo: GET /v2/volumes.
輸入參數region
civo_list_databases
List databases
List the managed databases (MySQL, PostgreSQL) in a region: software and version, size, nodes, IPs, port, network, firewall and status. Paginated: {page, per_page, pages, items}. Passwords are redacted. Civo: GET /v2/databases.
輸入參數pageregionper_page
civo_list_dns_domains
List DNS domains
List the domains whose DNS Civo hosts for the account. Civo: GET /v2/dns.
無需輸入參數。
civo_list_dns_records
List DNS records
List the records of one hosted domain (name, type, value, priority, TTL), optionally filtered by type or name. Civo: GET /v2/dns/{domain_id}/records.
輸入參數nametypedomain_id必填
civo_reboot_instance
Reboot an instance
Reboot one instance. `soft` (default) asks the OS to restart cleanly; `hard` cuts power and boots it again, like pulling the plug — use only when soft does not work. Causes brief downtime. Civo: POST /v2/instances/{id}/soft_reboots or /hard_reboots.
輸入參數typeregioninstance_id必填
civo_stop_instance
Stop an instance
Power off one instance. Anything it serves goes offline until it is started again with civo_start_instance. A stopped instance is still billed. Civo: PUT /v2/instances/{id}/stop.
輸入參數regioninstance_id必填
civo_start_instance
Start an instance
Boot a stopped instance. Undoes civo_stop_instance. Civo: PUT /v2/instances/{id}/start.
輸入參數regioninstance_id必填
civo_set_instance_tags
Set an instance's tags
REPLACE the full tag list of one instance (tags are used for filtering and by load-balancer instance pools, so changing them can move an instance in or out of a pool). Pass the complete desired list; an empty list clears all tags. Civo: PUT /v2/instances/{id}/tags.
輸入參數tags必填regioninstance_id必填
civo_create_firewall_rule
Add a firewall rule
Add one rule to a firewall — e.g. allow TCP 443 ingress from 0.0.0.0/0. This changes what is reachable on every instance, cluster and load balancer using the firewall, so prefer narrow CIDRs. Undo by deleting the rule in the Civo dashboard or CLI. Civo: POST /v2/firewalls/{id}/rules.
輸入參數cidrlabelactionregionend_portprotocol必填directionstart_portfirewall_id必填
civo_create_dns_record
Add a DNS record
Add one record to a Civo-hosted domain. Live DNS changes propagate to the world; undo by deleting the record in the Civo dashboard or CLI. Civo: POST /v2/dns/{domain_id}/records.
輸入參數ttlname必填type必填value必填prioritydomain_id必填