This documentation covers Convox V2, our ECS-based engine. V2 is fully supported and actively maintained. Looking for the Kubernetes-based V3 engine? See docs.convox.com.

api get

Query the Rack API at the specified path and return raw JSON output. This is useful for automation scripts, debugging, and accessing API endpoints not covered by other CLI commands.

Syntax

$ convox api get <path>

Flags

Flag Short Description
--rack -r Rack name

Example Usage

$ convox api get /apps
[
  {
    "name": "myapp",
    "generation": "2",
    "locked": false,
    "release": "RABCDEFGHIJ",
    "status": "running"
  }
]

See Also