Skip to main content
GET
/
v1
/
chicklets
/
{id}
Get a chicklet
curl --request GET \
  --url https://api.chicklet.io/v1/chicklets/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "tier": "<string>",
  "state": "<string>",
  "phase": "<string>",
  "pod_ip": "<string>",
  "ssh_port": 123,
  "node_ports": {},
  "user_id": 123,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication (e.g. "Bearer your-api-key")

Path Parameters

​
id
string
required

Chicklet name or ID

Response

OK

​
id
string

Unique chicklet ID

​
name
string

Chicklet name

​
tier
string

Tier (small, medium, large)

​
state
string

Current state (running, stopped)

​
phase
string

Pod phase

​
pod_ip
string

Internal pod IP

​
ssh_port
integer

SSH port number

​
node_ports
object

Map of exposed container ports to node ports

​
user_id
integer
​
created_at
string<date-time>