{ "components": { "schemas": { "Account": { "properties": { "allow_xlarge": { "type": "boolean" }, "closed_at": { "description": "Closed (`POST /account/close`): unix seconds. Reopen before `erase_at`.", "format": "int64", "type": [ "integer", "null" ] }, "data_retention": { "$ref": "#/components/schemas/DataRetention", "default": { "monitoring_off": false, "snapshots_off": false, "zero_data_retention": false } }, "deletion_operation": { "description": "The closing's deletion operation (`dop_…`, `GET /deletion-operations/{id}`).", "type": [ "string", "null" ] }, "email": { "type": "string" }, "erase_at": { "description": "When a closed account's data is erased for good (closed_at + 30 days).", "format": "int64", "type": [ "integer", "null" ] }, "id": { "type": "string" }, "max_sandboxes": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "org": { "anyOf": [ { "$ref": "#/components/schemas/OrgSummary" }, { "type": "null" } ], "description": "The organization this request acted in (`X-Froog-Org`, or the active one); absent in your personal workspace. `id` and `email` stay yours." } }, "required": [ "allow_xlarge", "email", "id", "max_sandboxes" ], "type": "object" }, "AccountClosing": { "description": "`POST /v1/account/close` and `POST /v1/account/reopen`.", "properties": { "account": { "$ref": "#/components/schemas/Account" }, "operation": { "$ref": "#/components/schemas/DeletionOperation" } }, "required": [ "account", "operation" ], "type": "object" }, "AddAiCredential": { "description": "Add an account to a profile (`POST /v1/ai/profiles/{profile}/credentials`). A provider that already has one gets another, used when the first hits a rate or usage limit.", "properties": { "base_url": { "description": "Custom APIs: an https:// URL with a public DNS name. Bedrock: the AWS region (default us-east-1) goes in `region`.", "type": [ "string", "null" ] }, "name": { "description": "Custom APIs: the variable name (A-Z, 0-9, _; not a provider's).", "type": [ "string", "null" ] }, "provider": { "description": "anthropic, openai, gemini, deepseek, mistral, openrouter, xai, bedrock or custom.", "type": "string" }, "region": { "description": "Bedrock: the AWS region, e.g. us-west-2.", "type": [ "string", "null" ] }, "secret_header": { "description": "Custom APIs: the header the proxy puts the secret in, and only there (default `Authorization` with `Bearer `). The placeholder anywhere else in the request is removed.", "type": [ "string", "null" ] }, "secret_prefix": { "description": "Custom APIs: what comes before the secret in the header, e.g. `Bearer ` or `Token ` (default `Bearer ` when neither `secret_header` nor `secret_query` is given, else none).", "type": [ "string", "null" ] }, "secret_query": { "description": "Custom APIs: put the secret in this query parameter instead of a header (e.g. `api_key`).", "type": [ "string", "null" ] }, "value": { "description": "The key: one token of up to 8192 printable characters. Bedrock: a Bedrock API key, or `ACCESS_KEY_ID:SECRET_ACCESS_KEY[:SESSION_TOKEN]`.", "type": "string" } }, "required": [ "provider", "value" ], "type": "object" }, "AddSshKey": { "properties": { "name": { "type": "string" }, "public_key": { "type": "string" } }, "required": [ "name", "public_key" ], "type": "object" }, "AgentEvent": { "description": "One event of the agent's work.\n\n`type`: `status` (data: status, error), `text` (content, partial), `tool_call` (name, input, id), `tool_result` (output, is_error, id), `steer` (message, native, mode), `log` (a line the harness printed that isn't an event), `error` (message).", "properties": { "at": { "description": "Unix milliseconds.", "format": "int64", "type": "integer" }, "conversation_id": { "type": "string" }, "data": true, "id": { "description": "Increasing; pass the last one back as `cursor`.", "format": "int64", "type": "integer" }, "prompt_id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "at", "conversation_id", "data", "id", "prompt_id", "type" ], "type": "object" }, "AiCredential": { "description": "One account of a provider in a profile. Never the secret.", "properties": { "active": { "description": "The account the proxy uses first for this provider (the first one not resting).", "type": "boolean" }, "base_url": { "description": "Custom APIs: where the proxy sends the requests.", "type": [ "string", "null" ] }, "created_at": { "format": "int64", "type": "integer" }, "id": { "description": "`cred_…`", "type": "string" }, "label": { "description": "The last characters of the key, e.g. `…7f3a`.", "type": "string" }, "limited_reason": { "type": [ "string", "null" ] }, "limited_until": { "description": "Hit a rate or usage limit: the proxy skips it until then (unix seconds).", "format": "int64", "type": [ "integer", "null" ] }, "name": { "description": "Custom APIs: the variable name the sandbox gets (e.g. `STRIPE_KEY`).", "type": [ "string", "null" ] }, "provider": { "description": "anthropic, openai, gemini, deepseek, mistral, openrouter, xai, bedrock or custom.", "type": "string" }, "secret_header": { "description": "Custom APIs: the header the proxy puts the secret in (e.g. `Authorization`), after `secret_prefix`. Absent when it goes in the query string (`secret_query`).", "type": [ "string", "null" ] }, "secret_prefix": { "description": "Custom APIs: what comes before the secret in `secret_header` (e.g. `Bearer `).", "type": [ "string", "null" ] }, "secret_query": { "description": "Custom APIs: the query parameter the proxy puts the secret in, instead of a header.", "type": [ "string", "null" ] } }, "required": [ "active", "created_at", "id", "label", "provider" ], "type": "object" }, "AiProfile": { "description": "A credential profile: a named set of AI credentials.", "properties": { "created_at": { "format": "int64", "type": "integer" }, "credentials": { "description": "In switching order per provider.", "items": { "$ref": "#/components/schemas/AiCredential" }, "type": "array" }, "default": { "description": "Sandboxes get the default profile unless their environment or the sandbox names another.", "type": "boolean" }, "environments": { "description": "Environments whose sandboxes get this profile.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "`aip_…`", "type": "string" }, "name": { "type": "string" } }, "required": [ "created_at", "credentials", "default", "environments", "id", "name" ], "type": "object" }, "AiProxy": { "description": "The account's AI proxy settings (`GET /v1/ai/proxy`).", "properties": { "blocked": { "description": "Every proxied sandbox of the account is refused (403 `ai_blocked`).", "type": "boolean" }, "enabled": { "description": "On: sandboxes started from now on get placeholder keys and base URLs pointing at the proxy; the real keys stay on froog. Default off.", "type": "boolean" }, "url": { "description": "The base URL sandboxes send their AI requests to.", "type": "string" }, "withhold_subscriptions": { "description": "With the proxy on, keep subscription sign-ins (Claude, ChatGPT) out of sandboxes too. They are never proxied. Default false: they pass as without the proxy.", "type": "boolean" } }, "required": [ "blocked", "enabled", "url", "withhold_subscriptions" ], "type": "object" }, "AiSandboxUsage": { "description": "Usage of one sandbox in the account view.", "properties": { "blocked": { "type": "boolean" }, "sandbox": { "description": "Its name (or its id once deleted).", "type": "string" }, "sandbox_id": { "type": "string" }, "totals": { "$ref": "#/components/schemas/AiTotals" } }, "required": [ "blocked", "sandbox", "sandbox_id", "totals" ], "type": "object" }, "AiTotals": { "description": "Tokens and requests over a period.", "properties": { "cache_read_tokens": { "format": "uint64", "minimum": 0.0, "type": "integer" }, "cache_write_tokens": { "format": "uint64", "minimum": 0.0, "type": "integer" }, "cost_usd": { "description": "Estimated provider cost in USD, from list prices built into froog. Not a froog charge.", "format": "double", "type": "number" }, "errors": { "description": "Answers with status 400 or above (including the proxy's own refusals upstream).", "format": "uint64", "minimum": 0.0, "type": "integer" }, "input_tokens": { "description": "Input tokens not read from a cache.", "format": "uint64", "minimum": 0.0, "type": "integer" }, "output_tokens": { "format": "uint64", "minimum": 0.0, "type": "integer" }, "requests": { "format": "uint64", "minimum": 0.0, "type": "integer" } }, "required": [ "cache_read_tokens", "cache_write_tokens", "cost_usd", "errors", "input_tokens", "output_tokens", "requests" ], "type": "object" }, "AiUsage": { "description": "The account's AI usage (`GET /v1/ai/usage`).", "properties": { "days": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "sandboxes": { "description": "Most expensive first.", "items": { "$ref": "#/components/schemas/AiSandboxUsage" }, "type": "array" }, "totals": { "$ref": "#/components/schemas/AiTotals" } }, "required": [ "days", "sandboxes", "totals" ], "type": "object" }, "AiUsageRow": { "description": "One row: a UTC day, provider and model.", "properties": { "cache_read_tokens": { "format": "uint64", "minimum": 0.0, "type": "integer" }, "cache_write_tokens": { "format": "uint64", "minimum": 0.0, "type": "integer" }, "cost_usd": { "description": "Estimated provider cost in USD, from list prices built into froog. Not a froog charge.", "format": "double", "type": "number" }, "day": { "description": "YYYY-MM-DD (UTC).", "type": "string" }, "errors": { "description": "Answers with status 400 or above (including the proxy's own refusals upstream).", "format": "uint64", "minimum": 0.0, "type": "integer" }, "input_tokens": { "description": "Input tokens not read from a cache.", "format": "uint64", "minimum": 0.0, "type": "integer" }, "model": { "type": "string" }, "output_tokens": { "format": "uint64", "minimum": 0.0, "type": "integer" }, "provider": { "type": "string" }, "requests": { "format": "uint64", "minimum": 0.0, "type": "integer" } }, "required": [ "cache_read_tokens", "cache_write_tokens", "cost_usd", "day", "errors", "input_tokens", "model", "output_tokens", "provider", "requests" ], "type": "object" }, "AlertSettings": { "description": "`GET /v1/account/alerts`: which emails the account gets, and whether an errored sandbox is rebuilt from its last snapshot by itself.", "properties": { "auto_rebuild": { "description": "Rebuild a sandbox whose VM was lost (state `error`) from its last snapshot, and email (default on).", "type": "boolean" }, "emails": { "items": { "$ref": "#/components/schemas/EmailAlert" }, "type": "array" } }, "required": [ "auto_rebuild", "emails" ], "type": "object" }, "ApiKeyInfo": { "description": "An API key as listed (the key itself is shown only once, at creation).", "properties": { "actions": { "default": [], "description": "What the key may do (`scopes::ACTIONS`); `[\"*\"]` = everything.", "items": { "type": "string" }, "type": "array" }, "created_at": { "format": "int64", "type": "integer" }, "created_by": { "description": "An organization key: the email of the member who made it (it acts as that member).", "type": [ "string", "null" ] }, "environments": { "description": "Limited to sandboxes of these environments (names); None = any environment.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "expires_at": { "default": null, "description": "None = never expires.", "format": "int64", "type": [ "integer", "null" ] }, "id": { "type": "string" }, "label": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Limited to sandboxes that have all of these labels; None = any labels.", "type": [ "object", "null" ] }, "last_used_at": { "default": null, "format": "int64", "type": [ "integer", "null" ] }, "preset": { "description": "The preset its actions match, if any (read-only, full-sandbox, ci, admin).", "type": [ "string", "null" ] }, "requests_30d": { "default": 0, "description": "Requests made with it in the last 30 days.", "format": "uint64", "minimum": 0.0, "type": "integer" }, "sandboxes": { "default": null, "description": "The sandboxes it may touch (names), besides those it created; None = all.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "sandboxes_created": { "default": 0, "description": "Sandboxes this key created that still exist.", "format": "uint32", "minimum": 0.0, "type": "integer" } }, "required": [ "created_at", "id", "label" ], "type": "object" }, "AuditEvent": { "description": "One entry of the account's audit log (`GET /audit`): who changed what, from where. Kept 90 days.", "properties": { "action": { "description": "What happened, e.g. sandbox.create, api_key.revoke, webhook.update, billing.plan.", "type": "string" }, "actor": { "description": "Who did it: an API key id (`key_…`), `session` (the dashboard), or `public-url` (an auto-start by a visitor of a public URL).", "type": "string" }, "actor_label": { "description": "The API key's name, or the account email for a dashboard session.", "type": [ "string", "null" ] }, "at": { "description": "Unix seconds.", "format": "int64", "type": "integer" }, "detail": { "description": "Short extra facts, e.g. the sandboxes a create or fork made.", "type": [ "string", "null" ] }, "id": { "description": "`aud_…`", "type": "string" }, "ip": { "description": "The client's IP address.", "type": [ "string", "null" ] }, "request_id": { "description": "The request's `X-Request-Id`.", "type": [ "string", "null" ] }, "target": { "description": "What it happened to: a sandbox, key, webhook or variable name or id (never a secret).", "type": [ "string", "null" ] } }, "required": [ "action", "actor", "at", "id" ], "type": "object" }, "AuditList": { "properties": { "events": { "description": "Newest first.", "items": { "$ref": "#/components/schemas/AuditEvent" }, "type": "array" }, "next_cursor": { "description": "Pass as `cursor` for the next (older) page; None at the end.", "type": [ "string", "null" ] } }, "required": [ "events" ], "type": "object" }, "AutoTopup": { "description": "`PUT /v1/billing/wallet/auto-topup`: charge this much whenever the plan's usage plus the wallet drops below 10% of it (at least $5). 0 turns it off.", "properties": { "amount_usd": { "format": "uint32", "minimum": 0.0, "type": "integer" } }, "required": [ "amount_usd" ], "type": "object" }, "Billing": { "description": "Payment status of an account (`GET /v1/billing`).", "properties": { "auto_topup_failures": { "default": 0, "description": "Declined auto top-ups in a row (3 turn auto top-up off).", "format": "uint32", "minimum": 0.0, "type": "integer" }, "auto_topup_usd": { "default": 0, "description": "Auto top-up amount in dollars; 0 = off.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "card_on_file": { "description": "A payment method is on file.", "type": "boolean" }, "enabled": { "description": "Payments are set up on this froog server.", "type": "boolean" }, "exempt": { "description": "The account isn't billed (e.g. the operator's own account).", "type": "boolean" }, "extra_starts": { "$ref": "#/components/schemas/ExtraStarts", "default": { "available": false, "brackets": [], "enabled": false, "max_minute_multiple": 0.0 }, "description": "Paying from the wallet for starts past the start limits." }, "grace_until": { "description": "Out of money: running sandboxes are stopped at this time (unix seconds) unless money is added.", "format": "int64", "type": [ "integer", "null" ] }, "included_usd": { "default": 0.0, "description": "This period: what the plan covers, what was used, and what's left (plan plus wallet).", "format": "double", "type": "number" }, "keep_disks_until": { "description": "The plan was canceled with `keep_disks`: once it ends, every sandbox stops, and stopped disks and saved snapshots are kept free until this time (unix seconds).", "format": "int64", "type": [ "integer", "null" ] }, "max_wallet_per_day_usd": { "default": 0, "description": "Most the card can be charged for the wallet in 24 hours (payments and auto top-ups).", "format": "uint32", "minimum": 0.0, "type": "integer" }, "min_topup_usd": { "default": 0, "description": "Smallest wallet payment, dollars.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "plan": { "anyOf": [ { "$ref": "#/components/schemas/CurrentPlan" }, { "type": "null" } ], "default": null, "description": "The account's plan; None until one is chosen." }, "plans": { "default": [], "description": "The plans on offer, cheapest first.", "items": { "$ref": "#/components/schemas/PlanInfo" }, "type": "array" }, "rates": { "default": [], "description": "Per-second rates, quoted per hour and per 730-hour month.", "items": { "$ref": "#/components/schemas/Rate" }, "type": "array" }, "remaining_usd": { "default": 0.0, "format": "double", "type": "number" }, "suspended": { "description": "Out of money: the plan's usage and the wallet ran out and the grace period ended, so sandboxes were stopped. Add money to start them again.", "type": "boolean" }, "used_usd": { "default": 0.0, "format": "double", "type": "number" }, "wallet_bonus": { "anyOf": [ { "$ref": "#/components/schemas/WalletBonus" }, { "type": "null" } ], "description": "The bonus added to wallet payments and auto top-ups by amount; None = no bonus." }, "wallet_usd": { "default": 0.0, "description": "The wallet: money paid in minus usage past the plan. Negative = owed.", "format": "double", "type": "number" } }, "required": [ "card_on_file", "enabled", "exempt", "suspended" ], "type": "object" }, "BillingUrl": { "description": "A Stripe-hosted page to open in a browser.", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object" }, "BrowserRequest": { "description": "`POST /sandboxes/{name}/browser`: open the browser view (only Chrome).", "properties": { "profile": { "description": "Chrome's user data directory on the sandbox: an absolute path outside the system directories, created if missing. Default: `~/.config/froog-browser`.", "type": [ "string", "null" ] } }, "type": "object" }, "ChoosePlan": { "description": "`POST /v1/billing/plan`: choose or change the plan.", "properties": { "plan": { "description": "Dollars a month: one of `Billing.plans`.", "format": "uint32", "minimum": 0.0, "type": "integer" } }, "required": [ "plan" ], "type": "object" }, "CiAnalytics": { "description": "`GET /v1/ci/analytics?days=&repo=`: what the account's jobs add up to.", "properties": { "days": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "flaky_tests": { "description": "Tests that both failed and passed on the same commit.", "items": { "$ref": "#/components/schemas/CiFlakyTest" }, "type": "array" }, "jobs": { "description": "One row per repository, workflow and job name; most job time first.", "items": { "$ref": "#/components/schemas/CiJobStats" }, "type": "array" }, "repos": { "description": "Most job time first.", "items": { "$ref": "#/components/schemas/CiRepoStats" }, "type": "array" }, "since": { "format": "int64", "type": "integer" } }, "required": [ "days", "flaky_tests", "jobs", "repos", "since" ], "type": "object" }, "CiCache": { "properties": { "name": { "description": "The name in `/cache=`.", "type": "string" }, "saved_at": { "description": "When the last default-branch job saved it.", "format": "int64", "type": "integer" }, "size_gb": { "description": "What it adds to the base image, in GB.", "format": "double", "type": [ "number", "null" ] }, "snapshot": { "description": "Its saved snapshot (`cache-`): `DELETE /v1/saved-snapshots/{snapshot}` starts it over.", "type": "string" } }, "required": [ "name", "saved_at", "snapshot" ], "type": "object" }, "CiFacet": { "properties": { "name": { "type": "string" }, "runs": { "format": "uint64", "minimum": 0.0, "type": "integer" } }, "required": [ "name", "runs" ], "type": "object" }, "CiFlakyTest": { "properties": { "commits": { "description": "Commits it both failed and passed on.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "failed": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "last_failed_at": { "format": "int64", "type": "integer" }, "message": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "passed": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "repo": { "type": "string" }, "suite": { "type": [ "string", "null" ] } }, "required": [ "commits", "failed", "last_failed_at", "name", "passed", "repo" ], "type": "object" }, "CiJob": { "description": "One GitHub Actions job (`GET /v1/ci`, `GET /v1/ci/jobs/{id}`).", "properties": { "cache_hit": { "description": "With `/cache=`: whether its VM started from the saved cache (false: a cold start).", "type": [ "boolean", "null" ] }, "conclusion": { "description": "GitHub's conclusion once completed: success | failure | cancelled | …", "type": [ "string", "null" ] }, "cost_usd": { "description": "What its job time costs at the CI price (so far, while it runs).", "format": "double", "type": [ "number", "null" ] }, "finished_at": { "format": "int64", "type": [ "integer", "null" ] }, "github_job_id": { "description": "GitHub's job id.", "format": "int64", "type": "integer" }, "head_branch": { "description": "The branch the run is for (GitHub's `head_branch`).", "type": [ "string", "null" ] }, "head_sha": { "description": "The commit the run is for.", "type": [ "string", "null" ] }, "html_url": { "type": [ "string", "null" ] }, "id": { "description": "`ci_…`", "type": "string" }, "job_name": { "type": "string" }, "labels": { "description": "The job's `runs-on` labels.", "items": { "type": "string" }, "type": "array" }, "queued_at": { "format": "int64", "type": "integer" }, "reason": { "description": "Why it waits, or why it didn't run.", "type": [ "string", "null" ] }, "repo": { "description": "owner/name", "type": "string" }, "resources": { "anyOf": [ { "$ref": "#/components/schemas/CiResources" }, { "type": "null" } ], "description": "CPU and memory the job used, once it completed (from the VM's 30-second samples)." }, "run_id": { "format": "int64", "type": "integer" }, "run_secs": { "description": "Seconds the job ran (its billed job time).", "format": "int64", "type": [ "integer", "null" ] }, "sandbox": { "description": "The sandbox that runs it (`ci--`).", "type": [ "string", "null" ] }, "size": { "$ref": "#/components/schemas/Size" }, "started_at": { "format": "int64", "type": [ "integer", "null" ] }, "state": { "description": "queued (waiting for a sandbox) | starting | running | completed | refused | failed", "type": "string" }, "tests": { "anyOf": [ { "$ref": "#/components/schemas/CiTestSummary" }, { "type": "null" } ], "description": "Test results from the JUnit XML files the job wrote, once it completed." }, "wait_secs": { "description": "Seconds from queued to the sandbox running.", "format": "int64", "type": [ "integer", "null" ] }, "workflow": { "type": [ "string", "null" ] } }, "required": [ "github_job_id", "id", "job_name", "labels", "queued_at", "repo", "run_id", "size", "state" ], "type": "object" }, "CiJobMetrics": { "description": "`GET /v1/ci/jobs/{id}/metrics`: the job's CPU and memory over time, and its steps.", "properties": { "points": { "description": "Averaged into at most 120 buckets, oldest first.", "items": { "$ref": "#/components/schemas/MetricsPoint" }, "type": "array" }, "resources": { "anyOf": [ { "$ref": "#/components/schemas/CiResources" }, { "type": "null" } ] }, "steps": { "description": "The job's steps, from GitHub, with their times.", "items": { "$ref": "#/components/schemas/CiStep" }, "type": "array" } }, "required": [ "points", "steps" ], "type": "object" }, "CiJobStats": { "properties": { "advice": { "anyOf": [ { "$ref": "#/components/schemas/CiSizeAdvice" }, { "type": "null" } ], "description": "A better size for it, when the runs say so." }, "cache_hit_rate": { "description": "With `/cache=`: the share of runs that started from the cache (0-1).", "format": "double", "type": [ "number", "null" ] }, "cancelled": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "cost_usd": { "format": "double", "type": "number" }, "cpu_avg_percent": { "description": "Average of the runs' CPU averages.", "format": "double", "type": [ "number", "null" ] }, "failed": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "failure_rate": { "format": "double", "type": "number" }, "job_name": { "type": "string" }, "memory_peak_percent": { "description": "Highest memory any run used, as a share of its VM's.", "format": "double", "type": [ "number", "null" ] }, "minutes": { "format": "double", "type": "number" }, "oom_runs": { "description": "Runs in which the kernel killed a process for want of memory.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "p50_secs": { "format": "int64", "type": [ "integer", "null" ] }, "p90_secs": { "format": "int64", "type": [ "integer", "null" ] }, "repo": { "type": "string" }, "runs": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "size": { "$ref": "#/components/schemas/Size", "description": "The size of its latest run." }, "slow_steps": { "default": [], "description": "Its slowest steps (by p50 over the runs), at most 5.", "items": { "$ref": "#/components/schemas/CiStepStats" }, "type": "array" }, "succeeded": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "wait_p50_secs": { "description": "Queued to running.", "format": "int64", "type": [ "integer", "null" ] }, "wait_p90_secs": { "format": "int64", "type": [ "integer", "null" ] }, "workflow": { "type": [ "string", "null" ] } }, "required": [ "cancelled", "cost_usd", "failed", "failure_rate", "job_name", "minutes", "oom_runs", "repo", "runs", "size", "succeeded" ], "type": "object" }, "CiJobTests": { "description": "`GET /v1/ci/jobs/{id}/tests`.", "properties": { "summary": { "anyOf": [ { "$ref": "#/components/schemas/CiTestSummary" }, { "type": "null" } ], "description": "None: the job wrote no JUnit XML froog found." }, "tests": { "description": "Failed first, then skipped, then passed; at most 1,000.", "items": { "$ref": "#/components/schemas/CiTestCase" }, "type": "array" } }, "required": [ "tests" ], "type": "object" }, "CiLogMatch": { "properties": { "at": { "description": "The line's time, from GitHub's timestamp.", "type": [ "string", "null" ] }, "branch": { "type": [ "string", "null" ] }, "conclusion": { "type": [ "string", "null" ] }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "line": { "description": "1-based line number in the job's log.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "queued_at": { "format": "int64", "type": "integer" }, "repo": { "type": "string" }, "step": { "description": "The step the line is in (from the log's `##[group]` markers).", "type": [ "string", "null" ] }, "text": { "description": "The line without its timestamp (first 500 characters).", "type": "string" }, "workflow": { "type": [ "string", "null" ] } }, "required": [ "job_id", "job_name", "line", "queued_at", "repo", "text" ], "type": "object" }, "CiLogSearch": { "description": "`GET /v1/ci/logs/search?q=&days=&limit=&order=`: lines of the account's kept CI job logs.", "properties": { "jobs_searched": { "description": "Jobs whose logs were searched.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "matches": { "description": "Newest job first (`order=oldest`: oldest first, for where a failure first appeared).", "items": { "$ref": "#/components/schemas/CiLogMatch" }, "type": "array" }, "query": { "type": "string" }, "truncated": { "description": "More lines matched than `limit`.", "type": "boolean" } }, "required": [ "jobs_searched", "matches", "query", "truncated" ], "type": "object" }, "CiMonitor": { "description": "A CI monitor (`GET/POST /v1/ci/monitors`): an alert when matching jobs fail or run long.", "properties": { "branch": { "description": "Only runs for this branch.", "type": [ "string", "null" ] }, "consecutive": { "description": "failure: alert after this many failures in a row (a success starts over).", "format": "uint32", "minimum": 0.0, "type": "integer" }, "cooldown_mins": { "description": "No second alert from this monitor for this long.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "created_at": { "format": "int64", "type": "integer" }, "duration_secs": { "description": "duration: alert when a job has run this long.", "format": "uint32", "minimum": 0.0, "type": [ "integer", "null" ] }, "email": { "description": "Email the account (webhooks listing `ci.monitor.triggered` get it either way).", "type": "boolean" }, "id": { "description": "`cim_…`", "type": "string" }, "job": { "description": "Only jobs whose name contains this.", "type": [ "string", "null" ] }, "kind": { "description": "failure (a job failed or timed out) | duration (a job ran longer than `duration_secs`)", "type": "string" }, "last_triggered_at": { "format": "int64", "type": [ "integer", "null" ] }, "log_pattern": { "description": "failure: only failures whose log contains this (any case), e.g. `OutOfMemory` or `SIGKILL`.", "type": [ "string", "null" ] }, "name": { "type": "string" }, "recent": { "default": [], "description": "Its last alerts, newest first (at most 10).", "items": { "$ref": "#/components/schemas/CiMonitorEvent" }, "type": "array" }, "repo": { "description": "Only this repository (owner/name).", "type": [ "string", "null" ] }, "streak": { "description": "Failures in a row so far.", "format": "uint32", "minimum": 0.0, "type": "integer" }, "workflow": { "description": "Only workflows whose name contains this.", "type": [ "string", "null" ] } }, "required": [ "consecutive", "cooldown_mins", "created_at", "email", "id", "kind", "name", "streak" ], "type": "object" }, "CiMonitorEvent": { "properties": { "at": { "format": "int64", "type": "integer" }, "job_id": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "at", "job_id", "reason" ], "type": "object" }, "CiOverview": { "description": "`GET /v1/ci`.", "properties": { "caches": { "default": [], "description": "The account's caches (`/cache=`: saved snapshots named `cache-`).", "items": { "$ref": "#/components/schemas/CiCache" }, "type": "array" }, "configured": { "description": "This server takes CI jobs (a GitHub App with a webhook secret is set up).", "type": "boolean" }, "connected": { "description": "The account has a linked installation.", "type": "boolean" }, "jobs": { "description": "Newest first.", "items": { "$ref": "#/components/schemas/CiJob" }, "type": "array" }, "label": { "description": "`runs-on` label: `