API & CLI

Automate everything with the REST API, personal API keys and the SDK.

API keys

Create keys under Settings → API Keys. The full key is shown once at creation — store it in your secrets manager.

Example: list servers

curl -H "Authorization: Bearer YOUR_KEY" \
  https://your-host/api/v1/instances

Python SDK

from ghconsole import Client
c = Client(api_key="YOUR_KEY", base_url="https://your-host")
for i in c.instances.list():
    print(i["name"], i["status"])

Webhooks

Use settings → Webhooks to receive events (deploy results, instance state changes) in your own systems.