Reference

Quick-reference tables for all CLI commands, REST API endpoints, and MCP tools. Click any row to open the full detail page with arguments and examples.

---

CLI Commands

Base: cpctl <command>
Auth: cpctl login --token <cp-api-token>

Command	Description
cpctl login	Authenticate with Compute Portal
cpctl logout	Log out and revoke credentials
cpctl whoami	Show current authenticated user
cpctl init	Interactively create cp.json
cpctl link <service>	Link directory to a service
cpctl unlink	Remove .cp-link
cpctl open [service]	Open service URL in browser
cpctl list	List all services
cpctl deploy	Deploy a service
cpctl redeploy <service>	Re-trigger current deployment
cpctl rollback <service> [id]	Roll back to a previous deployment
cpctl machine list	List services
cpctl machine start <name>	Start a service
cpctl machine stop <name>	Stop a service
cpctl machine restart <name>	Restart a service
cpctl machine destroy <name>	Permanently destroy a service
cpctl machine status <name>	Show service health
cpctl logs <name>	Stream service logs
cpctl status <name>	Check service health
cpctl scale <name>	Scale replicas or resources
cpctl exec <name> -- <cmd>	Run command inside container
cpctl ssh <name>	Open SSH session
cpctl ps <name>	List running processes
cpctl env set <service>	Set environment variables
cpctl env list <service>	List environment variables
cpctl env unset <service>	Remove environment variables
cpctl variable	Alias for cpctl env
cpctl environment list	List environments
cpctl environment create	Create an environment
cpctl environment delete	Delete an environment
cpctl environment switch	Switch active environment
cpctl deployment list <service>	List deployment history
cpctl deployment status <service> <id>	Show deployment details
cpctl domain add <service> <domain>	Attach custom domain
cpctl domain list <service>	List domains
cpctl domain status <service> <domain>	Check domain/TLS status
cpctl domain remove <service> <domain>	Remove domain
cpctl volume list <service>	List volumes
cpctl volume add <service> <path>	Attach a volume
cpctl volume delete <service> <name>	Delete a volume
cpctl db create <type>	Create a managed database
cpctl db list	List databases
cpctl db url <name>	Print connection URL
cpctl db destroy <name>	Destroy a database
cpctl connect <name>	Open interactive database shell
cpctl metrics <service>	View service metrics
cpctl gpu list	List GPU inventory
cpctl gpu status <service>	Show GPU utilization
cpctl gpu reserve	Reserve GPU capacity
cpctl gpu run	Run a one-shot GPU job
cpctl node list	List compute nodes
cpctl node status <id>	Show node health
cpctl region list	List regions
cpctl billing usage	Show billing usage
cpctl billing history	Show invoice history
cpctl pay setup	Link a card or USDC wallet
cpctl pay status	Show linked payment method
cpctl pay authorize <service> <amount>	Pre-authorize a per-call charge
cpctl pay history	List per-call payment charges
cpctl sandbox create	Create a sandbox
cpctl sandbox list	List sandboxes
cpctl sandbox destroy <id>	Destroy a sandbox
cpctl docs	Open documentation in browser
cpctl upgrade	Upgrade the CLI
cpctl version	Print CLI version

---

REST API Endpoints

Base URL: https://api.computeportal.io
Auth: Authorization: Bearer cp_live_<hex>

Services

Method	Path	Description
GET	/v1/services	List all services
POST	/v1/services	Deploy a new service (image or repo)
GET	/v1/services/:name	Get service details
DELETE	/v1/services/:name	Delete a service
POST	/v1/services/:name/start	Start a stopped service
POST	/v1/services/:name/stop	Stop a running service
POST	/v1/services/:name/restart	Restart a service
POST	/v1/services/:name/redeploy	Re-trigger deployment
POST	/v1/services/:name/scale	Scale replicas or resources
POST	/v1/services/:name/rollback	Roll back to previous deployment
GET	/v1/services/:name/logs	Fetch recent log output
GET	/v1/services/:name/metrics	Get CPU/memory/network metrics
GET	/v1/services/:name/gpu	Get GPU utilization
GET	/v1/services/:name/deployments	List deployment history
GET	/v1/services/:name/deployments/:id	Get a specific deployment
GET	/v1/services/:name/env	List environment variables
POST	/v1/services/:name/env	Set environment variables
POST	/v1/services/:name/env/unset	Remove environment variables
GET	/v1/services/:name/volumes	List attached volumes
GET	/v1/status	Platform health check

Domains

Method	Path	Description
POST	/v1/services/:name/domains	Attach a custom hostname
GET	/v1/services/:name/domains	List all hostnames
DELETE	/v1/services/:name/domains/:hostname	Remove a custom hostname

GPU & Nodes

Method	Path	Description
GET	/v1/gpu/nodes	List GPU nodes and availability
POST	/v1/gpu/reserve	Reserve GPU capacity
POST	/v1/gpu/jobs	Run a one-shot GPU job
GET	/v1/gpu/jobs/:id/logs	Get GPU job logs
GET	/v1/nodes	List compute nodes
GET	/v1/nodes/:id	Get node details
GET	/v1/nodes/self-hosted	List self-hosted nodes
GET	/v1/regions	List available regions

Databases

Method	Path	Description
GET	/v1/databases	List databases
POST	/v1/databases	Create a database
GET	/v1/databases/:name	Get database details
DELETE	/v1/databases/:name	Destroy a database

Environments

Method	Path	Description
GET	/v1/environments	List environments
POST	/v1/environments	Create an environment
DELETE	/v1/environments/:name	Delete an environment

Sandboxes

Method	Path	Description
GET	/v1/sandboxes	List sandboxes
POST	/v1/sandboxes	Create a sandbox
DELETE	/v1/sandboxes/:id	Destroy a sandbox

Machine Payments

Method	Path	Description
GET	/v1/pay/status	Get linked payment method
POST	/v1/pay/setup	Start card/USDC setup
GET	/v1/pay/setup/poll	Poll for setup completion
POST	/v1/pay/authorize	Pre-authorize a per-call charge
GET	/v1/pay/history	List charge history

Billing

Method	Path	Description
GET	/v1/billing/usage	Current billing cycle usage
GET	/v1/billing/history	Past invoices

---

MCP Tools

Endpoint: https://mcp.computeportal.io/mcp
Auth: CP_API_TOKEN=cp_live_<hex>

Domain Tools

Tool	Description
cp_domain_add	Attach a custom hostname to a service
cp_domain_list	List all hostnames on a service
cp_domain_remove	Remove a custom hostname

Service Tools

Tool	Description
cp_service_list	List all deployed services
cp_service_get	Get details for a specific service
cp_service_create	Deploy a new service from a container image
cp_service_update	Update a service's image or configuration
cp_service_delete	Remove a service
cp_service_scale	Scale a service to N replicas
cp_service_restart	Force a rolling restart
cp_service_logs	Fetch recent log output
cp_service_inspect	Return the raw service spec
cp_env_list	List environment variables on a service
cp_env_set	Set environment variables
cp_env_unset	Remove environment variables
cp_gpu_list	List available GPU resources
cp_gpu_status	Show GPU utilization per service
cp_volume_list	List persistent volumes
cp_volume_create	Create and attach a persistent volume
cp_volume_delete	Remove a persistent volume
cp_health_check	Check service health and replicas