Console API 参考

{ "error": "message" }

{
  "username": "admin",
  "password": "secret"
}

{
  "authenticated": true,
  "account": {
    "account_id": "acc_xxx",
    "username": "admin",
    "is_admin": true
  },
  "registration_enabled": false,
  "console_version": "v0.0.0",
  "console_repo_url": "https://..."
}

{
  "username": "dev-user",
  "password": "strong-password"
}

{
  "account": {
    "account_id": "acc_xxx",
    "username": "dev-user",
    "is_admin": false
  },
  "created_at": "2026-02-21T00:00:00Z",
  "updated_at": "2026-02-21T00:00:00Z"
}

{
  "current_password": "old-password",
  "new_password": "new-password"
}

{
  "items": [
    {
      "account_id": "acc_xxx",
      "username": "admin",
      "is_admin": true,
      "created_at": "2026-02-21T00:00:00Z",
      "updated_at": "2026-02-21T00:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 20
}

{
  "items": [
    {
      "id": "tok_xxx",
      "name": "default-token",
      "token_masked": "obx_******abcd",
      "created_at": "2026-02-21T00:00:00Z",
      "updated_at": "2026-02-21T00:00:00Z"
    }
  ],
  "total": 1
}

{
  "name": "ci-prod",
  "token": "optional-manual-token"
}

{
  "id": "tok_xxx",
  "name": "ci-prod",
  "token": "obx_plaintext_or_manual",
  "token_masked": "obx_******abcd",
  "generated": true,
  "created_at": "2026-02-21T00:00:00Z",
  "updated_at": "2026-02-21T00:00:00Z"
}

{
  "error": "token value is only returned at creation time; delete and recreate the token to obtain a new value"
}

{
  "items": [
    {
      "id": "apik_xxx",
      "name": "my-key",
      "key_masked": "obxk_******abcd",
      "created_at": "2026-02-21T00:00:00Z",
      "updated_at": "2026-02-21T00:00:00Z"
    }
  ],
  "total": 1
}

{ "name": "ci-management" }

{
  "id": "apik_xxx",
  "name": "ci-management",
  "key": "obxk_plaintext",
  "key_masked": "obxk_******abcd",
  "created_at": "2026-02-21T00:00:00Z",
  "updated_at": "2026-02-21T00:00:00Z"
}

{
  "items": [
    {
      "node_id": "worker-1",
      "node_name": "node-a",
      "executor_kind": "docker",
      "capabilities": [
        { "name": "echo", "max_inflight": 4 }
      ],
      "labels": {
        "region": "us",
        "obx.owner_id": "acc_xxx",
        "obx.worker_type": "normal"
      },
      "version": "v0.1.0",
      "status": "online",
      "registered_at": "2026-02-21T00:00:00Z",
      "last_seen_at": "2026-02-21T00:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 20
}

{
  "total": 5,
  "online": 4,
  "offline": 1,
  "stale": 1,
  "stale_after_sec": 30,
  "generated_at": "2026-02-21T00:00:00Z"
}

{
  "workers": [
    {
      "node_id": "worker-1",
      "active_session_count": 3,
      "terminal_session_capacity": {
        "known": true,
        "max_active_sessions": 4
      },
      "capabilities": [
        { "name": "pythonExec", "inflight": 1, "max_inflight": 4 }
      ]
    }
  ],
  "generated_at": "2026-02-21T00:00:00Z"
}

{
  "type": "normal"
}

{
  "node_id": "2f51f8f9-77f2-4c1a-a4f5-2036fc9fcb9e",
  "type": "normal",
  "worker_secret": "a3f8c2..."
}

{
  "error": "worker secret is returned only when creating the worker; delete and recreate to get a new startup command"
}

{
  "items": [
    {
      "account_id": "acc_xxx",
      "session_id": "sess_xxx",
      "worker_id": "worker-1",
      "status": "ready",
      "lease_expires_at": "2026-02-21T00:01:00Z",
      "last_used_at": "2026-02-21T00:00:30Z",
      "created_at": "2026-02-21T00:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 20
}

{
  "lease_ttl_sec": 300
}

{
  "session_id": "sess_xxx",
  "port": 8080
}

{
  "route_key": "ceirceirceirceirceirceirce",
  "account_id": "acc_xxx",
  "session_id": "sess_xxx",
  "port": 8080,
  "url": "https://ceirceirceirceirceirceirce.public-preview.example.com",
  "created_at": "2026-02-21T00:00:00Z",
  "expires_at": "2026-02-22T00:00:00Z"
}

{
  "items": [
    {
      "route_key": "ceirceirceirceirceirceirce",
      "account_id": "acc_xxx",
      "session_id": "sess_xxx",
      "port": 8080,
      "url": "https://ceirceirceirceirceirceirce.public-preview.example.com",
      "created_at": "2026-02-21T00:00:00Z",
      "expires_at": "2026-02-22T00:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 20
}

{
  "message": "hello",
  "timeout_ms": 5000
}

{ "message": "hello" }

{
  "command": "pwd",
  "session_id": "optional-session",
  "create_if_missing": false,
  "lease_ttl_sec": 60,
  "timeout_ms": 60000,
  "request_id": "optional-idempotency-key"
}

{
  "session_id": "sess_xxx",
  "created": true,
  "stdout": "...",
  "stderr": "...",
  "exit_code": 0,
  "stdout_truncated": false,
  "stderr_truncated": false,
  "lease_expires_unix_ms": 1770000000000
}

{
  "command": "pwd",
  "worker_id": "worker-id",
  "timeout_ms": 60000,
  "request_id": "optional-idempotency-key"
}

{"worker_list":[{"worker_id":"worker-id","node_name":"laptop","status":"online","capabilities":[]}]}

{
  "stdout": "...",
  "stderr": "...",
  "exit_code": 0,
  "stdout_truncated": false,
  "stderr_truncated": false
}

{
  "provider": "onlyboxes",
  "api_version": "2026-05-25",
  "console": { "version": "0.6.1" },
  "limits": {
    "max_task_timeout_ms": 600000,
    "max_task_wait_ms": 60000,
    "max_terminal_timeout_ms": 600000,
    "default_terminal_lease_sec": 60,
    "max_terminal_lease_sec": 86400
  },
  "capabilities": [
    {
      "name": "terminalExec",
      "available": true,
      "online_nodes": 1,
      "max_inflight": 4
    }
  ],
  "workers": {
    "total": 1,
    "online": 1,
    "offline": 0,
    "stale": 0
  }
}

{
  "capability": "pythonExec",
  "input": { "code": "print(1)" },
  "mode": "auto",
  "wait_ms": 1500,
  "timeout_ms": 60000,
  "request_id": "optional-idempotency-key"
}

{
  "task_id": "task_xxx",
  "request_id": "req-1",
  "command_id": "cmd_xxx",
  "capability": "pythonexec",
  "status": "running",
  "created_at": "2026-02-21T00:00:00Z",
  "updated_at": "2026-02-21T00:00:01Z",
  "deadline_at": "2026-02-21T00:01:00Z",
  "status_url": "/api/v1/tasks/task_xxx"
}

{
  "task_id": "task_xxx",
  "capability": "pythonexec",
  "status": "succeeded",
  "result": {
    "output": "1\n",
    "stderr": "",
    "exit_code": 0
  },
  "created_at": "2026-02-21T00:00:00Z",
  "updated_at": "2026-02-21T00:00:01Z",
  "deadline_at": "2026-02-21T00:01:00Z",
  "completed_at": "2026-02-21T00:00:01Z"
}

{
  "error": {
    "code": "execution_failed",
    "message": "..."
  }
}

obx_jit_v1.<base64url-payload>.<base64url-signature>

{ "iss": "my-platform", "sub": "user-42", "exp": 1770000000000 }

obx_dashboard_jit_v1.<base64url-payload>.<base64url-signature>

{
  "iss": "my-platform",
  "sub": "user-42",
  "scope": "dashboard",
  "exp": 1770000000000
}

{ "iss": "my-platform", "sub": "user-42", "scope": "dashboard", "exp": 1770000000000 }

import hmac, hashlib, base64, json

def make_jit_token(signing_key: str, issuer: str, subject: str) -> str:
    payload_bytes = json.dumps({"iss": issuer, "sub": subject}, separators=(",", ":")).encode()
    payload_b64 = base64.urlsafe_b64encode(payload_bytes).rstrip(b"=").decode()
    message = f"obx_jit_v1.{payload_b64}"
    sig = hmac.new(signing_key.encode(), message.encode(), hashlib.sha256).digest()
    sig_b64 = base64.urlsafe_b64encode(sig).rstrip(b"=").decode()
    return f"{message}.{sig_b64}"

token = make_jit_token("your-signing-key", "my-platform", "user-42")
# 用法：Authorization: Bearer <token>

import { createHmac } from "crypto";

function makeJitToken(signingKey: string, issuer: string, subject: string): string {
  const payload = Buffer.from(JSON.stringify({ iss: issuer, sub: subject }))
    .toString("base64url");
  const message = `obx_jit_v1.${payload}`;
  const sig = createHmac("sha256", signingKey).update(message).digest("base64url");
  return `${message}.${sig}`;
}

const token = makeJitToken("your-signing-key", "my-platform", "user-42");
// 用法：Authorization: Bearer <token>

import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/base64"
    "encoding/json"
)

func makeJITToken(signingKey, issuer, subject string) (string, error) {
    payload, err := json.Marshal(map[string]string{"iss": issuer, "sub": subject})
    if err != nil {
        return "", err
    }
    payloadB64 := base64.RawURLEncoding.EncodeToString(payload)
    message := "obx_jit_v1." + payloadB64
    mac := hmac.New(sha256.New, []byte(signingKey))
    mac.Write([]byte(message))
    sigB64 := base64.RawURLEncoding.EncodeToString(mac.Sum(nil))
    return message + "." + sigB64, nil
}

// token, _ := makeJITToken("your-signing-key", "my-platform", "user-42")
// 用法：Authorization: Bearer <token>

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.util.Base64;

public static String makeJitToken(String signingKey, String issuer, String subject) throws Exception {
    String payloadJson = String.format("{\"iss\":\"%s\",\"sub\":\"%s\"}", issuer, subject);
    String payloadB64 = Base64.getUrlEncoder().withoutPadding()
        .encodeToString(payloadJson.getBytes());
    String message = "obx_jit_v1." + payloadB64;
    Mac mac = Mac.getInstance("HmacSHA256");
    mac.init(new SecretKeySpec(signingKey.getBytes(), "HmacSHA256"));
    String sigB64 = Base64.getUrlEncoder().withoutPadding()
        .encodeToString(mac.doFinal(message.getBytes()));
    return message + "." + sigB64;
}

// String token = makeJitToken("your-signing-key", "my-platform", "user-42");
// 用法：Authorization: Bearer <token>