{"components":{"parameters":{"AccountID":{"description":"Account identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"AccountSlug":{"description":"Account slug. Lowercase letters, digits and single hyphens, at most 39 characters.","in":"path","name":"account","required":true,"schema":{"maxLength":39,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$","type":"string"}},"AdminUserID":{"description":"User identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"AgentID":{"description":"Agent identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"ChannelGroupID":{"description":"Contact group to list. An unknown group returns an empty list.","in":"query","name":"group_id","schema":{"format":"uuid","type":"string"}},"ChannelID":{"description":"Contact channel identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"CheckID":{"description":"Check identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"ContactGroupID":{"description":"Contact group identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"IncidentID":{"description":"Incident identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"InvitationID":{"description":"Invitation identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"MaintenanceWindowID":{"description":"Maintenance window identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"PageCursor":{"description":"Opaque keyset cursor returned as next_cursor. Omit for the first page. An invalid cursor is rejected server-side with 422.","in":"query","name":"cursor","schema":{"maxLength":200,"type":"string"}},"PageLimit":{"description":"Page size. Defaults to 50. Values outside 1..100 are clamped server-side.","in":"query","name":"limit","schema":{"maximum":100,"minimum":1,"type":"integer"}},"RunID":{"description":"Run identifier.","in":"path","name":"run_id","required":true,"schema":{"format":"uuid","type":"string"}},"SessionID":{"description":"Session identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"StatusComponentID":{"description":"Status page component identifier.","in":"path","name":"component_id","required":true,"schema":{"format":"uuid","type":"string"}},"StatusIncidentID":{"description":"Editorial incident identifier.","in":"path","name":"incident_id","required":true,"schema":{"format":"uuid","type":"string"}},"StatusPageID":{"description":"Status page identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"TokenID":{"description":"API token identifier.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},"UserID":{"description":"Member user identifier.","in":"path","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}}},"responses":{"BadGateway":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The payment provider did not accept the request."},"BadRequest":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Malformed request body or parameters."},"Conflict":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The operation conflicts with existing state."},"Forbidden":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The request is not allowed. Cross-site browser requests are rejected here."},"Locked":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The account is temporarily locked.","headers":{"Retry-After":{"description":"Seconds until the client may retry.","schema":{"minimum":0,"type":"integer"}}}},"NotFound":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The resource does not exist."},"PayloadTooLarge":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The request body exceeds 64 KiB."},"Problem":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Error"},"TooManyRequests":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The client sent too many requests.","headers":{"Retry-After":{"description":"Seconds until the client may retry.","schema":{"minimum":0,"type":"integer"}}}},"Unauthorized":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The caller is not authenticated or the credentials were rejected."},"UnprocessableEntity":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"A field failed validation."},"UnsupportedMediaType":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The request body is not application/json."}},"schemas":{"APIToken":{"description":"Account API token. The secret is never included.","properties":{"created_at":{"description":"When the token was created.","format":"date-time","type":"string"},"created_by":{"description":"User who created the token.","format":"uuid","type":"string"},"expires_at":{"description":"When the token stops being accepted. Absent when the token does not expire.","format":"date-time","type":"string"},"id":{"description":"Token identifier.","format":"uuid","type":"string"},"last_used_at":{"description":"When the token was last used. Absent until the first use.","format":"date-time","type":"string"},"name":{"description":"Display name.","type":"string"},"revoked_at":{"description":"When the token was revoked. Absent while the token is active.","format":"date-time","type":"string"},"scopes":{"description":"Granted scopes.","items":{"$ref":"#/components/schemas/TokenScope"},"type":"array"}},"required":["id","name","scopes","created_by","created_at"],"type":"object"},"AcceptInvitationRequest":{"description":"Invitation token from the email link.","properties":{"token":{"description":"Raw invitation token. It is not returned by the API.","maxLength":64,"type":"string"}},"required":["token"],"type":"object"},"Account":{"description":"Personal account or organisation.","properties":{"created_at":{"description":"When the account was created.","format":"date-time","type":"string"},"id":{"description":"Account identifier.","format":"uuid","type":"string"},"kind":{"$ref":"#/components/schemas/AccountKind"},"name":{"description":"Display name.","type":"string"},"slug":{"description":"Account slug.","type":"string"}},"required":["id","kind","slug","name","created_at"],"type":"object"},"AccountKind":{"description":"user is a personal account. org is an organisation.","enum":["user","org"],"type":"string"},"AccountWithRole":{"allOf":[{"$ref":"#/components/schemas/Account"},{"properties":{"role":{"allOf":[{"$ref":"#/components/schemas/Role"}],"description":"Effective role; for API tokens derived from scopes."}},"required":["role"],"type":"object"}],"description":"Account plus the caller's effective role."},"AdminAccount":{"allOf":[{"$ref":"#/components/schemas/Account"},{"properties":{"member_count":{"description":"Personal accounts count as 1. Organisations count members.","minimum":0,"type":"integer"},"owner_email":{"description":"Personal-account user, or the earliest-joined organisation owner.","format":"email","type":"string"},"plan_slug":{"description":"Plan identifier.","type":"string"},"user_disabled":{"description":"Whether the personal-account user is disabled. False for organisations.","type":"boolean"},"user_id":{"description":"Personal-account user. Omitted for organisations.","format":"uuid","type":"string"},"user_platform_admin":{"description":"Whether the personal-account user is a platform admin. False for organisations.","type":"boolean"}},"required":["plan_slug","owner_email","member_count","user_disabled","user_platform_admin"],"type":"object"}],"description":"Account row in the platform admin list."},"AdminAccountPage":{"description":"One page of accounts, oldest first.","properties":{"items":{"description":"Accounts on this page.","items":{"$ref":"#/components/schemas/AdminAccount"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items"],"type":"object"},"Agent":{"description":"One private probe agent. The key is never included.","properties":{"arch":{"description":"CPU architecture. Empty until the agent reports one.","type":"string"},"capabilities":{"description":"Probe kinds the agent can run. An empty list is encoded as [] and never null.","items":{"type":"string"},"type":"array"},"created_at":{"description":"When the agent was registered.","format":"date-time","type":"string"},"description":{"description":"Note. Empty when unset.","type":"string"},"hostname":{"description":"Machine name. Empty until the agent reports one.","type":"string"},"id":{"description":"Agent identifier. It is also the location identifier.","format":"uuid","type":"string"},"last_ip":{"description":"Last observed address. Null until the agent connects.","nullable":true,"type":"string"},"last_seen_at":{"description":"Last heartbeat. Null until the agent connects.","format":"date-time","nullable":true,"type":"string"},"name":{"description":"Display name.","type":"string"},"os":{"description":"Operating system. Empty until the agent reports one.","type":"string"},"region":{"description":"Region label. Empty when unset.","type":"string"},"slug":{"description":"Location key derived from the name at creation.","type":"string"},"status":{"$ref":"#/components/schemas/AgentStatus"},"version":{"description":"Agent build. Empty until the agent reports one.","type":"string"}},"required":["id","slug","name","region","description","status","version","hostname","os","arch","capabilities","created_at"],"type":"object"},"AgentCreate":{"description":"New agent. The server derives the slug from the name and generates the key.","properties":{"description":{"description":"Optional note, at most 500 characters.","maxLength":500,"type":"string"},"name":{"description":"Display name, trimmed, 1 to 100 characters.","maxLength":100,"minLength":1,"type":"string"},"region":{"description":"Optional region label, at most 100 characters.","maxLength":100,"type":"string"}},"required":["name"],"type":"object"},"AgentCreated":{"allOf":[{"$ref":"#/components/schemas/Agent"},{"properties":{"key":{"description":"One-time agent secret, starting with ksa_. Shown once.","type":"string"}},"required":["key"],"type":"object"}],"description":"Newly registered agent. The key is returned only here and from key rotation."},"AgentKey":{"description":"Replacement agent secret. Shown once.","properties":{"key":{"description":"One-time agent secret, starting with ksa_. Shown once.","type":"string"}},"required":["key"],"type":"object"},"AgentPage":{"description":"The account's agents, newest first.","properties":{"items":{"description":"Agents on this account.","items":{"$ref":"#/components/schemas/Agent"},"type":"array"}},"required":["items"],"type":"object"},"AgentStatus":{"description":"Agent connectivity. online after a heartbeat, offline otherwise.","enum":["online","offline"],"type":"string"},"AgentUpdate":{"description":"Fields to change. Omitted fields stay as they are. An empty object is rejected.","properties":{"description":{"description":"Replacement note.","type":"string"},"name":{"description":"Replacement display name.","type":"string"},"region":{"description":"Replacement region label.","type":"string"}},"type":"object"},"AuditEvent":{"description":"One recorded mutation.","properties":{"action":{"description":"Stable event name.","type":"string"},"actor_email":{"description":"Acting user's email. Omitted for platform (admin.*) actions, and empty when the user has been deleted.","type":"string"},"actor_user_id":{"description":"Acting user. Omitted for platform (admin.*) actions, and absent when the user has been deleted.","format":"uuid","type":"string"},"created_at":{"description":"When the event was written.","format":"date-time","type":"string"},"id":{"description":"Event identifier.","format":"uuid","type":"string"},"ip":{"description":"Caller address. Omitted for platform (admin.*) actions, and empty when it was not recorded.","type":"string"},"metadata":{"additionalProperties":true,"description":"Event-specific JSON object.","type":"object"},"target_id":{"description":"Target identifier.","type":"string"},"target_type":{"description":"Kind of target, such as account, user, or token.","type":"string"}},"required":["id","actor_email","action","target_type","target_id","metadata","ip","created_at"],"type":"object"},"AuditPage":{"description":"One page of audit events, newest first.","properties":{"items":{"description":"Events on this page.","items":{"$ref":"#/components/schemas/AuditEvent"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items"],"type":"object"},"BillingView":{"description":"Billing state of an account. Card and date fields are null when unset.","properties":{"cancel_at_period_end":{"description":"The plan stays until current_period_end and then ends.","type":"boolean"},"card_title":{"description":"Saved payment method title. Null when no card is stored.","nullable":true,"type":"string"},"current_period_end":{"description":"End of the trial or the paid period. Null when unset.","format":"date-time","nullable":true,"type":"string"},"payments_enabled":{"description":"Whether checkout and new automatic charges are allowed.","type":"boolean"},"pending_period":{"description":"Period that replaces the current one at period end. Null when none is pending.","nullable":true,"type":"string"},"pending_plan_slug":{"description":"Plan that replaces the current one at period end. Null when none is pending.","nullable":true,"type":"string"},"period":{"description":"month or year. Null when the account has no subscription.","nullable":true,"type":"string"},"plan_slug":{"description":"Plan currently applied to the account.","type":"string"},"retry_at":{"description":"When a past_due subscription is charged again. Null otherwise.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"Subscription status. Null when the account has no subscription.","nullable":true,"type":"string"},"trial_ends_at":{"description":"End of the trial. Null when there is no trial.","format":"date-time","nullable":true,"type":"string"}},"required":["payments_enabled","plan_slug","status","period","trial_ends_at","current_period_end","cancel_at_period_end","pending_plan_slug","pending_period","card_title","retry_at"],"type":"object"},"CaptchaChallenge":{"description":"ALTCHA challenge. Property names match the widget payload, including maxNumber.","properties":{"algorithm":{"description":"Hash algorithm. Always SHA-256.","example":"SHA-256","type":"string"},"challenge":{"description":"Hex-encoded challenge.","type":"string"},"maxNumber":{"description":"Inclusive upper bound of the solution search. Always 100000.","format":"int64","type":"integer"},"salt":{"description":"Salt, including the expiry parameter.","type":"string"},"signature":{"description":"HMAC signature of the challenge.","type":"string"}},"required":["algorithm","challenge","maxNumber","salt","signature"],"type":"object"},"ChangeEmailRequest":{"description":"New sign-in address. The current password confirms the request.","properties":{"current_password":{"description":"Current password, 10 to 128 characters.","maxLength":128,"minLength":10,"type":"string"},"email":{"description":"Address that receives the confirmation link.","format":"email","type":"string"}},"required":["email","current_password"],"type":"object"},"ChangePasswordRequest":{"description":"Current and replacement passwords.","properties":{"current_password":{"description":"Current password, 10 to 128 characters.","maxLength":128,"minLength":10,"type":"string"},"new_password":{"description":"New password, 10 to 128 characters, not a common password.","maxLength":128,"minLength":10,"type":"string"}},"required":["current_password","new_password"],"type":"object"},"ChangeRoleRequest":{"description":"New role for an existing member.","properties":{"role":{"$ref":"#/components/schemas/Role"}},"required":["role"],"type":"object"},"ChannelConfig":{"additionalProperties":true,"description":"Channel settings. The handler passes the JSON object through. Secrets, verification tokens, Telegram codes, and v1: ciphertext are never returned. Email shows address. Telegram is an empty object until chat_id is set, then chat_id. MAX requires chat_id as a decimal string (signed int64, nonzero); the shared bot token is server-side. Slack stays url_set true when a URL is stored. The URL is not returned. Webhook url has no userinfo and no query, plus secret_set. The generated Go type is encoding/json.RawMessage so the handler passes the object through.\n","type":"object","x-go-type":"json.RawMessage"},"ChannelDelivery":{"description":"One delivery attempt. The outbox payload is not included.","properties":{"attempt":{"description":"Attempt number for the outbox row.","type":"integer"},"created_at":{"description":"When the attempt was recorded.","format":"date-time","type":"string"},"error":{"description":"Redacted send error. Empty when the attempt was delivered.","type":"string"},"id":{"description":"Delivery identifier.","format":"uuid","type":"string"},"status":{"description":"One of delivered or failed.","type":"string"}},"required":["id","attempt","status","error","created_at"],"type":"object"},"ChannelDeliveryPage":{"description":"One page of delivery attempts, newest first.","properties":{"items":{"description":"Attempts on this page.","items":{"$ref":"#/components/schemas/ChannelDelivery"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items"],"type":"object"},"ChannelTestResult":{"description":"Result of one channel test. error is an empty string when the send succeeds.","properties":{"error":{"description":"Redacted send error. Empty when status is delivered.","type":"string"},"status":{"description":"One of delivered or failed.","type":"string"}},"required":["status","error"],"type":"object"},"ChannelVerifyRequest":{"description":"Token from the channel verification message. The token is not logged.","properties":{"token":{"description":"Raw token from the channel verification link.","type":"string"}},"required":["token"],"type":"object"},"Check":{"description":"One probe definition. Spec secrets are redacted.","properties":{"account_id":{"description":"Owning account.","format":"uuid","type":"string"},"confirmations":{"description":"Consecutive failures that mark a location as failing.","type":"integer"},"contact_group_ids":{"description":"Notification audience, in the stored order. Empty when the check has no groups.","items":{"format":"uuid","type":"string"},"type":"array"},"created_at":{"description":"When the check was created.","format":"date-time","type":"string"},"created_by":{"description":"User who created the check.","format":"uuid","type":"string"},"enabled":{"description":"Whether the scheduler may run the check.","type":"boolean"},"failing_locations_rule":{"description":"How failing locations open an incident. One of any, majority, all.","type":"string"},"id":{"description":"Check identifier.","format":"uuid","type":"string"},"interval_seconds":{"description":"Probe interval in seconds.","type":"integer"},"last_run_at":{"description":"Previous run. Null when the check has not run.","format":"date-time","nullable":true,"type":"string"},"location_ids":{"description":"Assigned locations, ordered by slug. Empty when none are assigned.","items":{"format":"uuid","type":"string"},"type":"array"},"manual_run_at":{"description":"When a manual run was last requested. Null when none has been requested.","format":"date-time","nullable":true,"type":"string"},"name":{"description":"Display name.","type":"string"},"next_run_at":{"description":"When the scheduler may claim the check.","format":"date-time","type":"string"},"paused_until":{"description":"When a paused check resumes on its own. Null pauses until an explicit resume.","format":"date-time","nullable":true,"type":"string"},"spec":{"$ref":"#/components/schemas/CheckSpec"},"state":{"description":"One of pending, up, down, paused.","type":"string"},"state_since":{"description":"When state last changed.","format":"date-time","type":"string"},"tags":{"description":"Labels. Empty when the check has none.","items":{"type":"string"},"type":"array"},"timeout_ms":{"description":"Probe timeout in milliseconds.","type":"integer"},"type":{"description":"Probe type. One of http, ping, dns, ssl.","type":"string"},"updated_at":{"description":"When the check was last changed.","format":"date-time","type":"string"}},"required":["id","account_id","name","type","enabled","paused_until","interval_seconds","timeout_ms","confirmations","failing_locations_rule","tags","spec","state","state_since","last_run_at","next_run_at","manual_run_at","created_by","created_at","updated_at","location_ids","contact_group_ids"],"type":"object"},"CheckCounts":{"description":"Check counts for the whole account. List filters do not change these numbers.","properties":{"down":{"description":"Down checks.","type":"integer"},"paused":{"description":"Paused checks.","type":"integer"},"pending":{"description":"Pending checks.","type":"integer"},"up":{"description":"Up checks.","type":"integer"}},"required":["pending","up","down","paused"],"type":"object"},"CheckJob":{"description":"One location's work item inside a run.","properties":{"deadline":{"description":"When an unfinished job may be expired.","format":"date-time","type":"string"},"error_code":{"description":"Job failure code. Empty until the job is finished with one.","type":"string"},"id":{"description":"Job identifier.","format":"uuid","type":"string"},"location_id":{"description":"Location that owns the job.","format":"uuid","type":"string"},"result":{"$ref":"#/components/schemas/CheckResult"},"status":{"description":"One of queued, running, done.","type":"string"}},"required":["id","location_id","status","error_code","deadline"],"type":"object"},"CheckLocationState":{"description":"One assigned location and the error from its last result.","properties":{"consecutive_failures":{"description":"Stored consecutive failures. Zero when the location has no state row.","type":"integer"},"failing":{"description":"Whether the location is failing. False when the location has no state row.","type":"boolean"},"id":{"description":"Location identifier.","format":"uuid","type":"string"},"last_error_code":{"description":"Error code of the last result. Empty when there is no last result or that result succeeded.","type":"string"},"last_error_message":{"description":"Error message of the last result. Empty when there is no last result or that result succeeded.","type":"string"},"name":{"description":"Location display name.","type":"string"},"slug":{"description":"Location slug.","type":"string"}},"required":["id","slug","name","consecutive_failures","failing","last_error_code","last_error_message"],"type":"object"},"CheckPage":{"description":"One page of checks, newest first, plus account-wide state counts.","properties":{"counts":{"$ref":"#/components/schemas/CheckCounts"},"items":{"description":"Checks on this page.","items":{"$ref":"#/components/schemas/Check"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items","counts"],"type":"object"},"CheckResult":{"description":"Probe outcome stored for a job.","properties":{"details":{"additionalProperties":true,"description":"Probe document. An empty object when nothing was stored.","type":"object"},"error_code":{"description":"Failure code. Empty when the probe succeeded.","type":"string"},"error_message":{"description":"Failure text. Empty when the probe succeeded.","type":"string"},"finished_at":{"description":"When the probe finished.","format":"date-time","type":"string"},"id":{"description":"Result identifier.","format":"uuid","type":"string"},"latency_ms":{"description":"Stored probe duration in milliseconds.","type":"integer"},"location_id":{"description":"Location that produced the result.","format":"uuid","type":"string"},"ok":{"description":"Whether the probe succeeded.","type":"boolean"},"started_at":{"description":"When the probe started.","format":"date-time","type":"string"}},"required":["id","location_id","ok","latency_ms","error_code","error_message","details","started_at","finished_at"],"type":"object"},"CheckResultPage":{"description":"One page of probe results, newest first.","properties":{"items":{"description":"Results on this page.","items":{"$ref":"#/components/schemas/CheckResult"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items"],"type":"object"},"CheckRun":{"description":"One scheduled or manual execution of a check.","properties":{"check_id":{"description":"Check this run belongs to.","format":"uuid","type":"string"},"created_at":{"description":"When the run was inserted.","format":"date-time","type":"string"},"id":{"description":"Run identifier.","format":"uuid","type":"string"},"jobs":{"description":"Location jobs, oldest first.","items":{"$ref":"#/components/schemas/CheckJob"},"type":"array"},"manual":{"description":"True when a person requested the run.","type":"boolean"}},"required":["id","check_id","manual","created_at","jobs"],"type":"object"},"CheckSpec":{"additionalProperties":true,"description":"Probe document. The handler passes the JSON object through. The write shape uses value, password, and body as plaintext strings. The read shape uses value_set, password_set, and body_set and includes neither plaintext nor a v1: ciphertext prefix. HTTP: method, url, headers with name and value or value_set, body or body_set, basic_auth with username and password or password_set, follow_redirects, verify_tls, expected_status, body_contains, body_not_contains, body_regex, slow_threshold_ms. Ping: host, count, max_loss_percent, max_avg_rtt_ms. DNS: hostname, record_type, expected, match, resolver. SSL: host, port, server_name, warn_days. The generated Go type is encoding/json.RawMessage so the handler passes the object through.\n","type":"object","x-go-type":"json.RawMessage"},"CheckStats":{"description":"Aggregate series for one check. Buckets are only stored rows.","properties":{"buckets":{"description":"Stored rows in the window, oldest first.","items":{"$ref":"#/components/schemas/StatBucket"},"type":"array"},"ok":{"description":"False when the returned buckets contain no active time.","type":"boolean"},"uptime":{"description":"Ratio of active time that was not down.","format":"double","type":"number"}},"required":["buckets","uptime","ok"],"type":"object"},"CheckoutRequest":{"description":"Plan and period to buy.","properties":{"period":{"description":"month or year. Any other period is 422.","type":"string"},"plan":{"description":"basic, business or enterprise. Enterprise supports monthly billing only. Any other plan is 422.","type":"string"}},"required":["plan","period"],"type":"object"},"CheckoutResponse":{"description":"Redirect target for a card bind. confirmation_url is null when the browser can stay.","properties":{"confirmation_url":{"description":"YooKassa confirmation page. Null when no redirect is required.","nullable":true,"type":"string"}},"required":["confirmation_url"],"type":"object"},"ContactChannel":{"description":"One contact channel. Config is redacted.","properties":{"config":{"$ref":"#/components/schemas/ChannelConfig"},"created_at":{"description":"When the channel was created.","format":"date-time","type":"string"},"enabled":{"description":"Whether delivery will use the channel.","type":"boolean"},"group_id":{"description":"Contact group that receives this channel's events.","format":"uuid","type":"string"},"id":{"description":"Channel identifier.","format":"uuid","type":"string"},"name":{"description":"Optional display name. Empty when unset.","type":"string"},"type":{"description":"One of email, telegram, max, slack, or webhook.","type":"string"},"updated_at":{"description":"When the channel was last changed.","format":"date-time","type":"string"},"verified":{"description":"Whether an email or Telegram channel has been confirmed. Slack and webhook are verified when the URL is accepted. MAX is verified when its chat_id is valid; use a test notification to check delivery.","type":"boolean"}},"required":["id","group_id","type","name","enabled","verified","config","created_at","updated_at"],"type":"object"},"ContactChannelCreate":{"description":"New contact channel. Omitted enabled selects true.","properties":{"config":{"$ref":"#/components/schemas/ChannelConfig"},"enabled":{"description":"Whether the channel starts enabled. Omitted selects true.","type":"boolean"},"group_id":{"description":"Contact group on the same account.","format":"uuid","type":"string"},"name":{"description":"Optional display name.","type":"string"},"type":{"description":"One of email, telegram, max, slack, or webhook.","type":"string"}},"required":["group_id","type","config"],"type":"object"},"ContactChannelUpdate":{"description":"Fields to change on a contact channel. Omitted fields stay as they are. An empty config keeps the stored secrets.","properties":{"config":{"$ref":"#/components/schemas/ChannelConfig"},"enabled":{"description":"Replacement enabled flag.","type":"boolean"},"group_id":{"description":"Move the channel to another group on the same account.","format":"uuid","type":"string"},"name":{"description":"Replacement display name.","type":"string"}},"type":"object"},"ContactGroup":{"description":"One contact group and the events it listens for.","properties":{"created_at":{"description":"When the group was created.","format":"date-time","type":"string"},"events":{"description":"Selected events, in stored order. The known events are check.down, check.up, check.slow, check.ssl_expiring, check.no_data, agent.offline, and agent.online.\n","items":{"type":"string"},"type":"array"},"id":{"description":"Group identifier.","format":"uuid","type":"string"},"name":{"description":"Display name.","type":"string"},"remind_minutes":{"description":"Reminder interval in minutes. 0 turns reminders off. Otherwise 5 to 10080.","type":"integer"},"updated_at":{"description":"When the group was last changed.","format":"date-time","type":"string"}},"required":["id","name","events","remind_minutes","created_at","updated_at"],"type":"object"},"ContactGroupCreate":{"description":"New contact group. Omitted events select check.down and check.up. Omitted remind_minutes selects 0.","properties":{"events":{"description":"Event list. An empty array selects nothing. Omit to select check.down and check.up.","items":{"type":"string"},"type":"array"},"name":{"description":"Display name. Surrounding space is trimmed. 1 to 80 characters.","type":"string"},"remind_minutes":{"description":"Reminder interval in minutes. 0 or 5 to 10080. Omit to select 0.","type":"integer"}},"required":["name"],"type":"object"},"ContactGroupUpdate":{"description":"Fields to change on a contact group. Omitted fields stay as they are.","properties":{"events":{"description":"Replacement event list. An empty array selects nothing.","items":{"type":"string"},"type":"array"},"name":{"description":"Replacement display name.","type":"string"},"remind_minutes":{"description":"Replacement reminder interval. 0 or 5 to 10080.","type":"integer"}},"type":"object"},"CreateCheckRequest":{"description":"New check. Omitted location_ids assigns the configured builtin. An empty location_ids array stores no locations.","properties":{"confirmations":{"description":"Consecutive failures that mark a location as failing. Omitted selects 2.","type":"integer"},"contact_group_ids":{"description":"Contact groups that receive notifications for this check. Omit to store none.","items":{"format":"uuid","type":"string"},"type":"array"},"enabled":{"description":"Whether the check is scheduled. Omitted selects true.","type":"boolean"},"failing_locations_rule":{"description":"One of any, majority, all. Omitted selects majority.","type":"string"},"interval_seconds":{"description":"Probe interval. Omitted selects the default for the type and plan.","type":"integer"},"location_ids":{"description":"Builtin locations. Omit to assign the configured builtin. An empty array stores no locations.","items":{"format":"uuid","type":"string"},"type":"array"},"name":{"description":"Display name. Surrounding space is trimmed.","type":"string"},"spec":{"$ref":"#/components/schemas/CheckSpec"},"tags":{"description":"Optional labels.","items":{"type":"string"},"type":"array"},"timeout_ms":{"description":"Probe timeout in milliseconds. Omitted selects 10000.","type":"integer"},"type":{"description":"Probe type. One of http, ping, dns, ssl.","type":"string"}},"required":["name","type","spec"],"type":"object"},"CreateOrgRequest":{"description":"New organisation on the free plan.","properties":{"name":{"description":"Display name, trimmed, 1 to 100 characters.","maxLength":100,"type":"string"},"slug":{"description":"Organisation slug. Lowercase letters, digits and single hyphens, at most 39 characters.","maxLength":39,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$","type":"string"}},"required":["slug","name"],"type":"object"},"CreateTokenRequest":{"description":"New API token. The secret is generated by the server.","properties":{"current_password":{"description":"Current user password, required to authorize token issuance.","type":"string","writeOnly":true},"expires_at":{"description":"Optional expiry. Must be in the future.","format":"date-time","type":"string"},"name":{"description":"Display name, trimmed, 1 to 100 characters.","maxLength":100,"minLength":1,"type":"string"},"scopes":{"description":"Non-empty set of read and write.","items":{"$ref":"#/components/schemas/TokenScope"},"minItems":1,"type":"array","uniqueItems":true}},"required":["name","scopes","current_password"],"type":"object"},"CreatedToken":{"description":"Newly created API token. The secret is returned only here.","properties":{"secret":{"description":"Raw token secret, starting with ksk_. Shown once.","type":"string"},"token":{"$ref":"#/components/schemas/APIToken"}},"required":["token","secret"],"type":"object"},"EmailRequest":{"description":"An email address.","properties":{"email":{"description":"Address to look up.","format":"email","type":"string"}},"required":["email"],"type":"object"},"FieldError":{"description":"One invalid request field. code is stable; message is the English fallback.","properties":{"code":{"description":"Stable machine-readable field code. Clients translate errors.field.\u003ccode\u003e. One of: invalid, unknown, taken, unchanged, incorrect, too_common, length, format, reserved, future, empty, plan, no_shared_agents.\n","enum":["invalid","unknown","taken","unchanged","incorrect","too_common","length","format","reserved","future","empty","plan","no_shared_agents"],"type":"string"},"field":{"description":"Request field name.","type":"string"},"message":{"description":"Why the field was rejected, in English.","type":"string"}},"required":["field","code","message"],"type":"object"},"ForgotPasswordRequest":{"description":"Password reset request.","properties":{"captcha":{"description":"Solved ALTCHA payload.","type":"string"},"email":{"description":"Address that should receive the reset link.","format":"email","type":"string"}},"required":["email","captcha"],"type":"object"},"Incident":{"description":"One outage. Nullable columns are null when absent.","properties":{"account_id":{"description":"Owning account.","format":"uuid","type":"string"},"acknowledged_at":{"description":"When the incident was acknowledged. Null until then.","format":"date-time","nullable":true,"type":"string"},"acknowledged_by":{"description":"User who acknowledged the incident. Null until then.","format":"uuid","nullable":true,"type":"string"},"cause_error_code":{"description":"Probe error that opened the incident.","type":"string"},"cause_location_id":{"description":"Location that opened the incident. Null when none was recorded.","format":"uuid","nullable":true,"type":"string"},"cause_message":{"description":"Probe message that opened the incident.","type":"string"},"check_id":{"description":"Check that was down.","format":"uuid","type":"string"},"duration_seconds":{"description":"Closed length in seconds. Null while the incident is open.","nullable":true,"type":"integer"},"during_maintenance":{"description":"Whether the incident started inside a maintenance window.","type":"boolean"},"id":{"description":"Incident identifier.","format":"uuid","type":"string"},"resolve_note":{"description":"Note stored when the incident closed. Empty while it is open.","type":"string"},"resolved_at":{"description":"When the incident closed. Null while it is open.","format":"date-time","nullable":true,"type":"string"},"started_at":{"description":"When the incident opened.","format":"date-time","type":"string"}},"required":["id","check_id","account_id","started_at","resolved_at","duration_seconds","cause_location_id","cause_error_code","cause_message","during_maintenance","acknowledged_by","acknowledged_at","resolve_note"],"type":"object"},"IncidentPage":{"description":"One page of incidents, open incidents first, then newest start.","properties":{"items":{"description":"Incidents on this page.","items":{"$ref":"#/components/schemas/Incident"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items"],"type":"object"},"Invitation":{"description":"Pending organisation invitation. The token is only in the email.","properties":{"created_at":{"description":"When the invitation was created.","format":"date-time","type":"string"},"email":{"description":"Invited address.","format":"email","type":"string"},"expires_at":{"description":"When the invitation stops being acceptable.","format":"date-time","type":"string"},"id":{"description":"Invitation identifier.","format":"uuid","type":"string"},"invited_by":{"description":"User who created the invitation.","format":"uuid","type":"string"},"role":{"$ref":"#/components/schemas/Role"}},"required":["id","email","role","invited_by","expires_at","created_at"],"type":"object"},"InvitationForMe":{"description":"Invitation addressed to the current user.","properties":{"expires_at":{"description":"When the invitation stops being acceptable.","format":"date-time","type":"string"},"id":{"description":"Invitation identifier.","format":"uuid","type":"string"},"org_name":{"description":"Organisation display name.","type":"string"},"org_slug":{"description":"Organisation slug.","type":"string"},"role":{"$ref":"#/components/schemas/Role"}},"required":["id","org_slug","org_name","role","expires_at"],"type":"object"},"InviteRequest":{"description":"Address and role for a new organisation invitation.","properties":{"email":{"description":"Address that receives the invitation. Trimmed and lowercased.","format":"email","type":"string"},"role":{"$ref":"#/components/schemas/Role"}},"required":["email","role"],"type":"object"},"Limits":{"description":"Plan allowance for an account.","properties":{"custom_domains":{"description":"Whether custom status-page domains are allowed.","type":"boolean"},"max_agents":{"description":"Maximum number of agents. Null means unlimited.","nullable":true,"type":"integer"},"max_checks":{"description":"Maximum number of checks. Null means unlimited.","nullable":true,"type":"integer"},"max_contact_channels":{"description":"Maximum number of contact channels. Null means unlimited.","nullable":true,"type":"integer"},"max_org_members":{"description":"Maximum organisation members, including pending invitations. Null means unlimited.","nullable":true,"type":"integer"},"max_status_pages":{"description":"Maximum number of status pages. Null means unlimited.","nullable":true,"type":"integer"},"min_interval_seconds":{"description":"Shortest allowed check interval, in seconds.","type":"integer"},"plan_name":{"description":"Plan display name.","type":"string"},"plan_slug":{"description":"Plan identifier.","type":"string"},"price_month_rub":{"description":"Monthly charge in rubles. Null when the plan is not sold monthly.","nullable":true,"type":"integer"},"price_year_rub":{"description":"Yearly charge in rubles. Null when the plan is not sold yearly.","nullable":true,"type":"integer"},"retention_days":{"description":"Result history window in days. Zero when retention is measured in months.","type":"integer"},"retention_months":{"description":"Result history window in calendar months. Zero when retention is measured in days.","type":"integer"},"ssl_allowed":{"description":"Whether SSL checks may be created.","type":"boolean"}},"required":["plan_slug","plan_name","max_checks","max_agents","min_interval_seconds","max_status_pages","max_contact_channels","max_org_members","custom_domains","ssl_allowed","price_month_rub","price_year_rub","retention_days","retention_months"],"type":"object"},"Locale":{"description":"Preferred language. Omitted on input means en.","enum":["en","ru"],"type":"string"},"Location":{"description":"A probe location. Includes shared agents, legacy builtins and the caller's private agents.","properties":{"created_at":{"description":"When the location was created.","format":"date-time","type":"string"},"id":{"description":"Location identifier.","format":"uuid","type":"string"},"kind":{"description":"Location kind. One of builtin, agent, or all. The all selector expands to all registered shared agents at run time and cannot be combined with other location IDs.","type":"string"},"name":{"description":"Display name.","type":"string"},"region":{"description":"Region label. Empty when unset.","type":"string"},"shared":{"description":"True for platform-wide agents visible to every account.","type":"boolean"},"slug":{"description":"Location key.","type":"string"}},"required":["id","kind","slug","name","region","created_at"],"type":"object"},"LoginRequest":{"description":"Password sign-in.","properties":{"captcha":{"description":"Solved ALTCHA payload. Required after the first recent failure.","type":"string"},"email":{"description":"Sign-in address.","format":"email","type":"string"},"password":{"description":"Password, 10 to 128 characters.","maxLength":128,"minLength":10,"type":"string"}},"required":["email","password"],"type":"object"},"LoginRequirements":{"description":"What the next sign-in attempt must include.","properties":{"captcha_required":{"description":"True when a captcha must accompany the password.","type":"boolean"}},"required":["captcha_required"],"type":"object"},"LoginResponse":{"description":"Signed-in user. The session cookie is set on the response.","properties":{"user":{"$ref":"#/components/schemas/User"}},"required":["user"],"type":"object"},"MAXLink":{"description":"Unverified MAX channel and its one-time code. The code is returned only here and is not logged.","properties":{"channel":{"$ref":"#/components/schemas/ContactChannel"},"code":{"description":"One-time code to send to the bot. Shown once.","type":"string"},"expires_at":{"description":"When the code stops being accepted.","format":"date-time","type":"string"}},"required":["channel","code","expires_at"],"type":"object"},"MAXLinkRequest":{"description":"Start a MAX link. The bot token is not part of the request.","properties":{"group_id":{"description":"Contact group on the same account.","format":"uuid","type":"string"},"name":{"description":"Optional display name.","type":"string"}},"required":["group_id"],"type":"object"},"MaintenanceWindow":{"description":"Maintenance window for an account.","properties":{"check_ids":{"description":"Checks this window covers. Empty means none.","items":{"format":"uuid","type":"string"},"type":"array"},"description":{"description":"Window summary. Empty when unset.","type":"string"},"ends_at":{"description":"When the window closes.","format":"date-time","type":"string"},"id":{"description":"Window identifier.","format":"uuid","type":"string"},"starts_at":{"description":"When the window opens.","format":"date-time","type":"string"},"status_page_ids":{"description":"Pages this window covers. Empty means none.","items":{"format":"uuid","type":"string"},"type":"array"},"suppress_notifications":{"description":"Whether alerts for the covered checks are held.","type":"boolean"},"title":{"description":"Window heading.","type":"string"}},"required":["id","title","description","starts_at","ends_at","check_ids","status_page_ids","suppress_notifications"],"type":"object"},"MaintenanceWindowInput":{"description":"Replacement fields for a maintenance window.","properties":{"check_ids":{"description":"Checks the account owns. Empty means none.","items":{"format":"uuid","type":"string"},"type":"array"},"description":{"description":"Window summary. Empty clears it.","type":"string"},"ends_at":{"description":"When the window closes.","format":"date-time","type":"string"},"starts_at":{"description":"When the window opens.","format":"date-time","type":"string"},"status_page_ids":{"description":"Pages the account owns. Empty means none.","items":{"format":"uuid","type":"string"},"type":"array"},"suppress_notifications":{"description":"Whether alerts for the covered checks are held.","type":"boolean"},"title":{"description":"Window heading.","type":"string"}},"required":["title","description","starts_at","ends_at","check_ids","status_page_ids","suppress_notifications"],"type":"object"},"MaintenanceWindowPage":{"description":"One page of maintenance windows, newest start first.","properties":{"items":{"description":"Windows on this page.","items":{"$ref":"#/components/schemas/MaintenanceWindow"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items"],"type":"object"},"Member":{"description":"One organisation member.","properties":{"email":{"description":"Member sign-in address.","format":"email","type":"string"},"joined_at":{"description":"When the membership was created.","format":"date-time","type":"string"},"name":{"description":"Member display name.","type":"string"},"role":{"$ref":"#/components/schemas/Role"},"slug":{"description":"Member personal-account slug.","type":"string"},"user_id":{"description":"Member user identifier.","format":"uuid","type":"string"}},"required":["user_id","email","name","slug","role","joined_at"],"type":"object"},"Membership":{"description":"One account the current user belongs to.","properties":{"account":{"$ref":"#/components/schemas/Account"},"role":{"$ref":"#/components/schemas/Role"}},"required":["account","role"],"type":"object"},"Meta":{"description":"Process build metadata.","properties":{"billing_enabled":{"description":"False when this install is on-premise or KEEPSTATUS_BILLING_DISABLED is true.","type":"boolean"},"builtin_location":{"description":"Slug of the built-in probe location served by this instance, null if probing is disabled.","nullable":true,"type":"string"},"commit":{"description":"Git commit of this build.","type":"string"},"max_bot_username":{"description":"Public MAX bot username without @; empty when not configured.","type":"string"},"version":{"description":"Semantic version of this build.","example":"1.4.0","type":"string"}},"required":["version","commit","builtin_location","billing_enabled"],"type":"object"},"PauseCheckRequest":{"description":"Pause window. Omit until, or send an empty body, to pause until an explicit resume.","properties":{"until":{"description":"When the check resumes. A past timestamp is field until code invalid.","format":"date-time","type":"string"}},"type":"object"},"PaymentsSettings":{"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"Problem":{"description":"RFC 9457 problem. The code field is the stable machine-readable identifier.","properties":{"captcha_required":{"description":"Present and true when code is captcha_required.","type":"boolean"},"code":{"description":"Stable machine-readable error code. One of: bad_request, payload_too_large, unsupported_media_type, method_not_allowed, not_found, internal, conflict, payments_paused, forbidden, unauthenticated, plan_limit_exceeded, validation_failed, account_locked, too_many_requests, resend_cooldown, invalid_credentials, captcha_required, email_not_verified, user_disabled, csrf_rejected, bad_gateway.\n","type":"string"},"detail":{"description":"Extra explanation. For a typed conflict, the conflict detail.","type":"string"},"errors":{"description":"Field errors when code is validation_failed.","items":{"$ref":"#/components/schemas/FieldError"},"type":"array"},"instance":{"description":"Request path that failed.","type":"string"},"status":{"description":"HTTP status code.","type":"integer"},"title":{"description":"Short human-readable summary.","type":"string"},"type":{"description":"Problem type URI. Defaults to urn:keepstatus:error:{code}.","example":"urn:keepstatus:error:not_found","format":"uri","type":"string"}},"required":["type","title","status","code"],"type":"object"},"PublicStatus":{"description":"Public status document served as JSON and as the owner preview.","properties":{"components":{"description":"Components in position order.","items":{"$ref":"#/components/schemas/PublicStatusComponent"},"type":"array"},"incidents":{"description":"Open incidents and incidents that started within 30 days.","items":{"$ref":"#/components/schemas/PublicStatusIncident"},"type":"array"},"maintenance":{"description":"Windows on this page that have not ended.","items":{"$ref":"#/components/schemas/PublicStatusMaintenance"},"type":"array"},"title":{"description":"Page heading.","type":"string"},"updated_at":{"description":"Newest public timestamp.","format":"date-time","type":"string"}},"required":["title","updated_at","components","incidents","maintenance"],"type":"object"},"PublicStatusComponent":{"description":"One component on the public status document.","properties":{"description":{"description":"Public summary. Empty when unset.","type":"string"},"group":{"description":"Section name. Empty when the component is ungrouped.","type":"string"},"id":{"description":"Component identifier.","format":"uuid","type":"string"},"name":{"description":"Public label.","type":"string"},"status":{"description":"operational, degraded, outage, maintenance, or unknown.","type":"string"},"uptime":{"description":"UTC days that have a positive sample. Null when the component hides uptime.","items":{"$ref":"#/components/schemas/PublicUptimeDay"},"nullable":true,"type":"array"}},"required":["id","name","description","group","status","uptime"],"type":"object"},"PublicStatusIncident":{"description":"Editorial incident on the public status document.","properties":{"id":{"description":"Incident identifier.","format":"uuid","type":"string"},"impact":{"description":"none, minor, major, or critical.","type":"string"},"resolved_at":{"description":"When the incident was resolved. Null until then.","format":"date-time","nullable":true,"type":"string"},"started_at":{"description":"When the incident started.","format":"date-time","type":"string"},"status":{"description":"investigating, identified, monitoring, or resolved.","type":"string"},"title":{"description":"Incident heading.","type":"string"},"updates":{"description":"Notes, oldest first.","items":{"$ref":"#/components/schemas/PublicStatusUpdate"},"type":"array"}},"required":["id","title","impact","status","started_at","resolved_at","updates"],"type":"object"},"PublicStatusMaintenance":{"description":"Maintenance window that has not ended.","properties":{"description":{"description":"Window summary. Empty when unset.","type":"string"},"ends_at":{"description":"When the window closes.","format":"date-time","type":"string"},"id":{"description":"Window identifier.","format":"uuid","type":"string"},"starts_at":{"description":"When the window opens.","format":"date-time","type":"string"},"title":{"description":"Window heading.","type":"string"}},"required":["id","title","description","starts_at","ends_at"],"type":"object"},"PublicStatusUpdate":{"description":"One public incident note.","properties":{"body_html":{"description":"Note rendered from markdown.","type":"string"},"created_at":{"description":"When the note was stored.","format":"date-time","type":"string"},"status":{"description":"Incident status recorded with this note.","type":"string"}},"required":["status","body_html","created_at"],"type":"object"},"PublicUptimeDay":{"description":"One UTC day of a component uptime bar.","properties":{"day":{"description":"Civil day, YYYY-MM-DD.","type":"string"},"ratio":{"description":"up_seconds / (up_seconds + down_seconds).","format":"double","type":"number"}},"required":["day","ratio"],"type":"object"},"RegisterRequest":{"description":"New personal account.","properties":{"captcha":{"description":"Solved ALTCHA payload.","type":"string"},"email":{"description":"Sign-in address. Trimmed and lowercased.","format":"email","type":"string"},"locale":{"$ref":"#/components/schemas/Locale"},"name":{"description":"Display name, at most 100 characters.","maxLength":100,"type":"string"},"password":{"description":"Password, 10 to 128 characters, not a common password.","maxLength":128,"minLength":10,"type":"string"},"slug":{"description":"Personal account slug. Lowercase letters, digits and single hyphens, at most 39 characters.","maxLength":39,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$","type":"string"}},"required":["email","password","slug","name","captcha"],"type":"object"},"RegistrationSettings":{"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"ReorderComponentsRequest":{"description":"Full component id list in the new display order.","properties":{"ids":{"description":"Every component id of the page, in the new order.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["ids"],"type":"object"},"ResetPasswordRequest":{"description":"New password for a reset token.","properties":{"password":{"description":"New password, 10 to 128 characters, not a common password.","maxLength":128,"minLength":10,"type":"string"},"token":{"description":"Raw token from the reset link.","type":"string"}},"required":["token","password"],"type":"object"},"Role":{"description":"Organisation membership role. Privilege order is owner, admin, member, viewer.","enum":["owner","admin","member","viewer"],"type":"string"},"Session":{"description":"One browser sign-in. The session token is never included.","properties":{"created_at":{"description":"When the session was opened.","format":"date-time","type":"string"},"current":{"description":"True when this session made the request. Always false for a bearer token, which cannot call this endpoint.","type":"boolean"},"expires_at":{"description":"Sliding expiry, capped at one year after creation.","format":"date-time","type":"string"},"id":{"description":"Session identifier.","format":"uuid","type":"string"},"ip":{"description":"Client address stored at sign-in. Empty when the address was unknown.","type":"string"},"last_seen_at":{"description":"Last sliding touch, or the creation time.","format":"date-time","type":"string"},"user_agent":{"description":"User agent stored at sign-in.","type":"string"}},"required":["id","created_at","last_seen_at","expires_at","ip","user_agent","current"],"type":"object"},"SetPlanRequest":{"description":"Plan to assign.","properties":{"plan":{"description":"Plan slug, such as free, basic, business, or enterprise. An unknown plan is rejected server-side with 422.","maxLength":64,"minLength":1,"type":"string"}},"required":["plan"],"type":"object"},"SharedAgentCreate":{"description":"New agent. The server derives the slug from the name and generates the key.","properties":{"description":{"description":"Optional note, at most 500 characters.","maxLength":500,"type":"string"},"name":{"description":"Display name, trimmed, 1 to 100 characters.","maxLength":100,"minLength":1,"type":"string"},"region":{"description":"Required location label, at most 100 characters.","maxLength":100,"type":"string"}},"required":["name","region"],"type":"object"},"StatBucket":{"description":"One stored hourly or daily aggregate.","properties":{"avg_latency_ms":{"description":"Average result latency in milliseconds.","type":"integer"},"down_seconds":{"description":"Active time covered by an incident outside maintenance.","type":"integer"},"failures":{"description":"Results that were not ok.","type":"integer"},"p95_latency_ms":{"description":"95th percentile latency in milliseconds.","type":"integer"},"runs":{"description":"Number of check results in the bucket.","type":"integer"},"start":{"description":"Bucket start in UTC.","format":"date-time","type":"string"},"up_seconds":{"description":"Active time that was not down.","type":"integer"}},"required":["start","runs","failures","up_seconds","down_seconds","avg_latency_ms","p95_latency_ms"],"type":"object"},"StatusComponent":{"description":"One check shown on a status page.","properties":{"check_id":{"description":"Check this component displays.","format":"uuid","type":"string"},"description":{"description":"Public summary. Empty when unset.","type":"string"},"group_name":{"description":"Section name. Empty when the component is ungrouped.","type":"string"},"id":{"description":"Component identifier.","format":"uuid","type":"string"},"name":{"description":"Public label.","type":"string"},"position":{"description":"Display order. Lower comes first.","type":"integer"},"show_uptime":{"description":"Whether the public page includes an uptime bar.","type":"boolean"}},"required":["id","check_id","name","description","group_name","position","show_uptime"],"type":"object"},"StatusComponentInput":{"description":"Replacement fields for a component. Position is assigned by the service.","properties":{"check_id":{"description":"Check owned by the same account.","format":"uuid","type":"string"},"description":{"description":"Public summary. Empty clears it.","type":"string"},"group_name":{"description":"Section name. Empty clears the group.","type":"string"},"name":{"description":"Public label.","type":"string"},"show_uptime":{"description":"Whether the public page includes an uptime bar.","type":"boolean"}},"required":["check_id","name","description","group_name","show_uptime"],"type":"object"},"StatusIncident":{"description":"Editorial incident on a status page.","properties":{"component_ids":{"description":"Components this incident affects.","items":{"format":"uuid","type":"string"},"type":"array"},"id":{"description":"Incident identifier.","format":"uuid","type":"string"},"impact":{"description":"none, minor, major, or critical.","type":"string"},"resolved_at":{"description":"When the incident was resolved. Null until then.","format":"date-time","nullable":true,"type":"string"},"started_at":{"description":"When the incident started.","format":"date-time","type":"string"},"status":{"description":"investigating, identified, monitoring, or resolved.","type":"string"},"title":{"description":"Incident heading.","type":"string"},"updates":{"description":"Notes, oldest first.","items":{"$ref":"#/components/schemas/StatusIncidentUpdate"},"type":"array"}},"required":["id","title","impact","status","component_ids","started_at","resolved_at","updates"],"type":"object"},"StatusIncidentInput":{"description":"New editorial incident and its first note.","properties":{"body_md":{"description":"First note, as markdown.","type":"string"},"component_ids":{"description":"Components on the same page. Empty means none.","items":{"format":"uuid","type":"string"},"type":"array"},"impact":{"description":"none, minor, major, or critical.","type":"string"},"started_at":{"description":"When the incident started.","format":"date-time","type":"string"},"status":{"description":"investigating, identified, monitoring, or resolved.","type":"string"},"title":{"description":"Incident heading.","type":"string"}},"required":["title","impact","status","body_md","component_ids","started_at"],"type":"object"},"StatusIncidentPage":{"description":"One page of editorial incidents, newest start first.","properties":{"items":{"description":"Incidents on this page.","items":{"$ref":"#/components/schemas/StatusIncident"},"type":"array"},"next_cursor":{"description":"Cursor for the next page. Absent on the last page.","maxLength":200,"type":"string"}},"required":["items"],"type":"object"},"StatusIncidentUpdate":{"description":"One note on an editorial incident. The body is HTML rendered from markdown.","properties":{"body_html":{"description":"Note rendered from markdown. Raw HTML is escaped text.","type":"string"},"created_at":{"description":"When the note was stored.","format":"date-time","type":"string"},"id":{"description":"Update identifier.","format":"uuid","type":"string"},"status":{"description":"Incident status recorded with this note.","type":"string"}},"required":["id","status","body_html","created_at"],"type":"object"},"StatusIncidentUpdateInput":{"description":"New note on an editorial incident.","properties":{"body_md":{"description":"Note, as markdown.","type":"string"},"status":{"description":"investigating, identified, monitoring, or resolved.","type":"string"}},"required":["status","body_md"],"type":"object"},"StatusPage":{"description":"One status page. domain_token is empty when the domain is verified or the page has no domain.","properties":{"components":{"description":"Components in position, id order. Present when one page is read.","items":{"$ref":"#/components/schemas/StatusComponent"},"type":"array"},"created_at":{"description":"When the page was created.","format":"date-time","type":"string"},"custom_domain":{"description":"Optional hostname. Empty when the page has no custom domain.","type":"string"},"description":{"description":"Page summary. Empty when unset.","type":"string"},"domain_token":{"description":"Verification secret. Empty when the domain is verified or cleared.","type":"string"},"domain_verified":{"description":"Whether the custom domain has been verified.","type":"boolean"},"id":{"description":"Page identifier.","format":"uuid","type":"string"},"indexable":{"description":"Whether search engines may index the page.","type":"boolean"},"locale":{"description":"Page language. en or ru.","type":"string"},"published":{"description":"Whether the public page is visible.","type":"boolean"},"slug":{"description":"Public path segment.","type":"string"},"timezone":{"description":"IANA timezone used to format times.","type":"string"},"title":{"description":"Page heading.","type":"string"},"updated_at":{"description":"When the page was last changed.","format":"date-time","type":"string"}},"required":["id","slug","title","description","locale","timezone","published","indexable","custom_domain","domain_token","domain_verified","created_at","updated_at"],"type":"object"},"StatusPageInput":{"description":"Replacement fields for a status page. The service stores the whole document.","properties":{"custom_domain":{"description":"Optional hostname. Empty clears the domain.","type":"string"},"description":{"description":"Page summary. Empty clears it.","type":"string"},"indexable":{"description":"Whether search engines may index the page.","type":"boolean"},"locale":{"description":"Page language. en or ru. Empty selects en.","type":"string"},"published":{"description":"Whether the public page is visible.","type":"boolean"},"slug":{"description":"Public path segment.","type":"string"},"timezone":{"description":"IANA timezone. Empty selects UTC.","type":"string"},"title":{"description":"Page heading.","type":"string"}},"required":["slug","title","description","locale","timezone","published","indexable","custom_domain"],"type":"object"},"TelegramLink":{"description":"Unverified Telegram channel and its one-time code. The code is returned only here and is not logged.","properties":{"channel":{"$ref":"#/components/schemas/ContactChannel"},"code":{"description":"One-time code to send to the bot. Shown once.","type":"string"},"expires_at":{"description":"When the code stops being accepted.","format":"date-time","type":"string"}},"required":["channel","code","expires_at"],"type":"object"},"TelegramLinkRequest":{"description":"Start a Telegram link. The bot token is not part of the request.","properties":{"group_id":{"description":"Contact group on the same account.","format":"uuid","type":"string"},"name":{"description":"Optional display name.","type":"string"}},"required":["group_id"],"type":"object"},"TokenScope":{"description":"API token scope. read allows view. write allows view and resources.manage.","enum":["read","write"],"type":"string"},"UpdateAccountRequest":{"description":"Fields to change on an account. Omitted fields stay as they are. A slug change requires account.manage.","minProperties":1,"properties":{"name":{"description":"Display name, trimmed, 1 to 100 characters.","maxLength":100,"minLength":1,"type":"string"},"slug":{"description":"New account slug. Lowercase letters, digits and single hyphens, at most 39 characters.","maxLength":39,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$","type":"string"}},"type":"object"},"UpdateCheckRequest":{"description":"Fields to change. Omitted fields stay as they are. A present spec is the complete write document. A present empty location_ids, tags, or contact_group_ids clears them.\n","properties":{"confirmations":{"type":"integer"},"contact_group_ids":{"description":"Replacement audience. An empty array clears it. Omit to keep the stored list.","items":{"format":"uuid","type":"string"},"type":"array"},"enabled":{"type":"boolean"},"failing_locations_rule":{"description":"One of any, majority, all.","type":"string"},"interval_seconds":{"type":"integer"},"location_ids":{"description":"Replacement locations. An empty array removes every location.","items":{"format":"uuid","type":"string"},"type":"array"},"name":{"description":"Display name.","type":"string"},"spec":{"$ref":"#/components/schemas/CheckSpec"},"tags":{"description":"Replacement labels. An empty array clears them.","items":{"type":"string"},"type":"array"},"timeout_ms":{"type":"integer"},"type":{"description":"Probe type. One of http, ping, dns, ssl.","type":"string"}},"type":"object"},"UpdateMeRequest":{"description":"Fields to change on the current user. Omitted fields stay as they are.","minProperties":1,"properties":{"locale":{"$ref":"#/components/schemas/Locale"},"name":{"description":"Display name, trimmed, 1 to 100 characters.","maxLength":100,"minLength":1,"type":"string"}},"type":"object"},"Usage":{"description":"Plan limits and current consumption.","properties":{"limits":{"$ref":"#/components/schemas/Limits"},"usage":{"$ref":"#/components/schemas/UsageCounters"}},"required":["limits","usage"],"type":"object"},"UsageCounters":{"description":"Current consumption.","properties":{"agents":{"description":"Number of agents on the account.","type":"integer"},"channels":{"description":"Number of contact channels on the account.","type":"integer"},"checks":{"description":"Number of checks on the account.","type":"integer"},"members":{"description":"Organisation member count. A personal account counts as 1.","type":"integer"},"status_pages":{"description":"Number of status pages on the account.","type":"integer"}},"required":["members","checks","agents","channels","status_pages"],"type":"object"},"User":{"description":"Account owner visible to the client.","properties":{"account_id":{"description":"Personal account identifier.","format":"uuid","type":"string"},"email":{"description":"Normalized sign-in address.","format":"email","type":"string"},"email_verified":{"description":"True after the address has been confirmed.","type":"boolean"},"id":{"description":"User identifier.","format":"uuid","type":"string"},"locale":{"$ref":"#/components/schemas/Locale"},"name":{"description":"Display name.","type":"string"},"platform_admin":{"description":"True when the user administers the platform.","type":"boolean"},"slug":{"description":"Personal account slug.","type":"string"}},"required":["id","account_id","email","slug","name","locale","email_verified","platform_admin"],"type":"object"},"VerifyEmailRequest":{"description":"Email confirmation token from the message link.","properties":{"token":{"description":"Raw token from the verification link.","type":"string"}},"required":["token"],"type":"object"},"YooKassaNotification":{"additionalProperties":true,"description":"YooKassa payment notification. Fields other than event and object.id are accepted and ignored.","properties":{"event":{"description":"Notification event, such as payment.succeeded or payment.canceled.","type":"string"},"object":{"additionalProperties":true,"description":"Payment object from the notification. Only id is read.","properties":{"id":{"description":"YooKassa payment id.","type":"string"}},"required":["id"],"type":"object"}},"required":["event","object"],"type":"object"}},"securitySchemes":{"bearerAuth":{"description":"Account API token. The secret starts with ksk_.","scheme":"bearer","type":"http"},"cookieAuth":{"description":"Browser session cookie. HttpOnly, SameSite=Lax, Path=/.","in":"cookie","name":"ks_session","type":"apiKey"}}},"info":{"description":"Public JSON API of KeepStatus. Errors use RFC 9457 problem+json.","title":"KeepStatus API","version":"1.0.0"},"openapi":"3.0.3","paths":{"/a/{account}":{"delete":{"description":"Deletes the organisation. Requires account.manage. API tokens are rejected with 403. A personal account is 409. A non-member receives 404.","operationId":"DeleteAccount","responses":{"204":{"description":"Organisation deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Delete an organisation","tags":["accounts"]},"get":{"description":"Returns the account and the caller's role. A caller who is not a member receives 404, including for another user's personal account.","operationId":"GetAccount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountWithRole"}}},"description":"Account and the caller's role"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get an account","tags":["accounts"]},"parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"patch":{"description":"A name change requires members.manage. A slug change requires account.manage, including when both fields are sent. API tokens are rejected with 403. A non-member receives 404.","operationId":"PatchAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountWithRole"}}},"description":"Updated account and the caller's role"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Update an account","tags":["accounts"]}},"/a/{account}/agents":{"get":{"description":"Returns the account's agents, newest first. The key is not included. Requires view. A non-member receives 404.","operationId":"GetAccountAgents","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentPage"}}},"description":"Agents on the account"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List agents","tags":["agents"]},"post":{"description":"Registers an agent and returns its key once. Requires resources.manage. A second agent on the free plan is 403 plan_limit_exceeded. A non-member receives 404. The key is not logged.\n","operationId":"PostAccountAgents","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCreated"}}},"description":"Created agent and its one-time key"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Register an agent","tags":["agents"]}},"/a/{account}/agents/download/{arch}":{"get":{"description":"Requires account access and the Enterprise plan. Archive includes the binary, version, installation instructions and SHA-256 checksum.","operationId":"GetAccountAgentDownload","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"in":"path","name":"arch","required":true,"schema":{"enum":["amd64","arm64"],"type":"string"}}],"responses":{"200":{"content":{"application/gzip":{"schema":{"format":"binary","type":"string"}}},"description":"Agent archive from the deployed release"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Download the current Linux agent","tags":["agents"]}},"/a/{account}/agents/{id}":{"delete":{"description":"Deletes an agent and retires its location. Requires resources.manage. An agent in another account is 404.","operationId":"DeleteAccountAgent","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/AgentID"}],"responses":{"204":{"description":"Agent deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Delete an agent","tags":["agents"]},"get":{"description":"Returns one agent. The key is not included. Requires view. An agent in another account is 404.","operationId":"GetAccountAgent","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/AgentID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}},"description":"Agent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get an agent","tags":["agents"]},"patch":{"description":"Updates the name, region, or description. The slug stays as it was. An empty object is 422 field code empty. Requires resources.manage. An agent in another account is 404.\n","operationId":"PatchAccountAgent","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/AgentID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}},"description":"Updated agent. The key is not included."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Update an agent","tags":["agents"]}},"/a/{account}/agents/{id}/rotate-key":{"post":{"description":"Replaces the agent key and returns the new secret once. Requires resources.manage. The previous key stops working. The key is not logged. An agent in another account is 404.\n","operationId":"PostAccountAgentRotateKey","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/AgentID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentKey"}}},"description":"New one-time key"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Rotate an agent key","tags":["agents"]}},"/a/{account}/audit":{"get":{"description":"Returns audit events for the account, newest first. Requires audit.view. API tokens are rejected with 403. An invalid cursor is 422. A non-member receives 404.","operationId":"GetAccountAudit","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditPage"}}},"description":"One page of audit events"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"List audit events","tags":["audit"]}},"/a/{account}/billing":{"get":{"description":"Returns the account billing view. Requires account.manage. API tokens are rejected with 403. A non-member receives 404. Without a subscription the plan is free and the card and dates are null. Installs with billing disabled answer 404.\n","operationId":"GetAccountBilling","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingView"}}},"description":"Current billing view"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Billing state","tags":["billing"]},"parameters":[{"$ref":"#/components/parameters/AccountSlug"}]},"/a/{account}/billing/cancel":{"parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"post":{"description":"Schedules cancellation at the end of the current period. An incomplete subscription is canceled immediately. No subscription, or one that is already canceled, is 409. Requires account.manage. API tokens are rejected with 403. A non-member receives 404. Installs with billing disabled answer 404.\n","operationId":"PostAccountBillingCancel","responses":{"204":{"description":"Cancellation recorded"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Cancel at period end","tags":["billing"]}},"/a/{account}/billing/checkout":{"parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"post":{"description":"Starts a card bind, charges a saved card, or schedules a plan change. Requires account.manage. API tokens are rejected with 403. A non-member receives 404. plan must be basic, business or enterprise and period must be month or year. Enterprise supports monthly billing only. The provider return URL is not accepted here. Installs with billing disabled answer 404. When payments are paused by the platform administrator, returns 503 with code payments_paused.\n","operationId":"PostAccountBillingCheckout","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}},"description":"Checkout accepted. confirmation_url is null when the browser can stay on the site."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/BadGateway"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Start or change a paid plan","tags":["billing"]}},"/a/{account}/channels":{"get":{"description":"Returns the account's contact channels, oldest first. group_id limits the list to one group. An unknown group returns an empty list. Config is redacted. Requires view. A non-member receives 404.\n","operationId":"GetAccountChannels","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ChannelGroupID"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContactChannel"},"type":"array"}}},"description":"Contact channels"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List contact channels","tags":["notifications"]},"post":{"description":"Creates an email, Slack, webhook, or Telegram channel. The response config is redacted and never contains a secret or a v1: ciphertext. Email channels are unverified until the mailed link is confirmed. Slack and webhook channels are verified when the URL is accepted. Requires resources.manage. A channel past the plan limit is 403 plan_limit_exceeded. A non-member receives 404. Request and response bodies are not logged.\n","operationId":"PostAccountChannels","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactChannelCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactChannel"}}},"description":"Created contact channel"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Create a contact channel","tags":["notifications"]}},"/a/{account}/channels/max/link":{"post":{"description":"Creates an unverified MAX channel and returns a one-time code. The code is shown once and is not logged. Requires resources.manage. When the bot token or webhook secret is not configured the response is 422 field type code invalid and nothing is stored. A non-member receives 404.\n","operationId":"PostAccountMAXLink","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MAXLinkRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MAXLink"}}},"description":"Channel and one-time code"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Start a MAX link","tags":["notifications"]}},"/a/{account}/channels/telegram/link":{"post":{"description":"Creates an unverified Telegram channel and returns a one-time code. The code is shown once and is not logged. Requires resources.manage. When the bot token is not configured the response is 422 field type code invalid and nothing is stored. A non-member receives 404.\n","operationId":"PostAccountTelegramLink","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramLinkRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramLink"}}},"description":"Channel and one-time code"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Start a Telegram link","tags":["notifications"]}},"/a/{account}/channels/{id}":{"delete":{"description":"Deletes a contact channel. Requires resources.manage. A channel in another account is 404.","operationId":"DeleteAccountChannel","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ChannelID"}],"responses":{"204":{"description":"Contact channel deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Delete a contact channel","tags":["notifications"]},"get":{"description":"Returns one contact channel. Config is redacted. Requires view. A channel in another account is 404.","operationId":"GetAccountChannel","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ChannelID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactChannel"}}},"description":"Contact channel"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get a contact channel","tags":["notifications"]},"patch":{"description":"Updates the name, enabled flag, group, or config. An omitted secret or URL keeps the stored value. An empty secret clears it. The response config is redacted. Requires resources.manage. A channel in another account is 404.\n","operationId":"PatchAccountChannel","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ChannelID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactChannelUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactChannel"}}},"description":"Updated contact channel"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Update a contact channel","tags":["notifications"]}},"/a/{account}/channels/{id}/deliveries":{"get":{"description":"Returns delivery attempts for one channel, newest first. The page is items and next_cursor. next_cursor is absent on the last page. The outbox payload is not included. Requires view. A channel in another account is 404. An invalid cursor is 422.\n","operationId":"GetAccountChannelDeliveries","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ChannelID"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelDeliveryPage"}}},"description":"Delivery page"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List channel deliveries","tags":["notifications"]}},"/a/{account}/channels/{id}/resend":{"post":{"description":"Sends a fresh confirmation link for an unverified email channel. An already verified channel is 409. Requires resources.manage. A channel in another account is 404. The token is not logged.\n","operationId":"PostAccountChannelResend","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ChannelID"}],"responses":{"204":{"description":"Confirmation sent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Resend an email confirmation","tags":["notifications"]}},"/a/{account}/channels/{id}/test":{"post":{"description":"Sends one test through the channel and returns status and error. error is an empty string when the send succeeds. An unverified or disabled channel is 409. A second test within 30 seconds is 429 too_many_requests with Retry-After. Requires resources.manage. A channel in another account is 404. The request body is not logged.\n","operationId":"PostAccountChannelTest","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ChannelID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTestResult"}}},"description":"Test result"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Send a test notification","tags":["notifications"]}},"/a/{account}/checks":{"get":{"description":"Returns checks newest first, plus state counts for the whole account. Counts ignore the list filters. Requires view. A non-member receives 404. An invalid cursor is 422 field cursor. A location that is not a UUID is 422 field location.\n","operationId":"GetAccountChecks","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"},{"description":"Case-insensitive substring of the check name.","in":"query","name":"q","schema":{"maxLength":200,"type":"string"}},{"description":"Probe type.","in":"query","name":"type","schema":{"type":"string"}},{"description":"Check state.","in":"query","name":"state","schema":{"type":"string"}},{"description":"Tag the check must carry.","in":"query","name":"tag","schema":{"maxLength":30,"type":"string"}},{"description":"Location identifier. A value that is not a UUID is 422.","in":"query","name":"location","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPage"}}},"description":"One page of checks and account-wide state counts"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List checks","tags":["checks"]},"post":{"description":"Creates a check. Requires resources.manage. A read token is 403. The 11th check on the free plan is 403 plan_limit_exceeded. A non-member receives 404. Secrets in the spec are stored encrypted and are not returned.\n","operationId":"PostAccountChecks","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}},"description":"Created check. Spec secrets are redacted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Create a check","tags":["checks"]}},"/a/{account}/checks/{id}":{"delete":{"description":"Deletes a check. Requires resources.manage. A check in another account is 404.","operationId":"DeleteAccountCheck","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"}],"responses":{"204":{"description":"Check deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Delete a check","tags":["checks"]},"get":{"description":"Returns one check. Spec secrets are redacted. Requires view. A check in another account is 404.","operationId":"GetAccountCheck","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}},"description":"Check"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get a check","tags":["checks"]},"patch":{"description":"Updates a check. Every field is optional. A present spec replaces the write document. A present empty location_ids, tags, or contact_group_ids clears them. Requires resources.manage. A check in another account is 404.\n","operationId":"PatchAccountCheck","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCheckRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}},"description":"Updated check. Spec secrets are redacted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Update a check","tags":["checks"]}},"/a/{account}/checks/{id}/incidents":{"get":{"description":"Returns incidents for one check, open incidents first across pages, then newest start. Requires view. An invalid cursor is 422.\n","operationId":"GetAccountCheckIncidents","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentPage"}}},"description":"One page of incidents"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List incidents for a check","tags":["incidents"]}},"/a/{account}/checks/{id}/locations":{"get":{"description":"Returns one object per assigned location, ordered by slug. Requires view. A check in another account is 404. A viewer can read. Consecutive failures are 0 when the location has no state row. Error fields are empty when there is no last result or that result succeeded. This array is not part of the check list payload.\n","operationId":"GetAccountCheckLocations","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CheckLocationState"},"type":"array"}}},"description":"Assigned locations"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List check location state","tags":["checks"]}},"/a/{account}/checks/{id}/pause":{"post":{"description":"Pauses a check. Requires resources.manage. An empty body, or a body that omits until, pauses until an explicit resume. A past until is 422 field until code invalid.\n","operationId":"PostAccountCheckPause","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PauseCheckRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}},"description":"Paused check"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Pause a check","tags":["checks"]}},"/a/{account}/checks/{id}/results":{"get":{"description":"Returns probe results newest first. Requires view. An invalid cursor is 422. Optional from and to bound started_at with a half-open interval: started_at \u003e= from AND started_at \u003c to. Omitted bounds keep the unbounded page. An invalid timestamp is 422 field from or to, code invalid.\n","operationId":"GetAccountCheckResults","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"},{"description":"Inclusive started_at bound, RFC3339. Omitted means no lower bound. Invalid is 422 field from code invalid.","in":"query","name":"from","schema":{"type":"string"}},{"description":"Exclusive started_at bound, RFC3339. Omitted means no upper bound. Invalid is 422 field to code invalid.","in":"query","name":"to","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultPage"}}},"description":"One page of results"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List check results","tags":["checks"]}},"/a/{account}/checks/{id}/resume":{"post":{"description":"Resumes a paused check and schedules it immediately. Requires resources.manage. There is no body.","operationId":"PostAccountCheckResume","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}},"description":"Resumed check"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Resume a check","tags":["checks"]}},"/a/{account}/checks/{id}/run":{"post":{"description":"Queues a manual run. Requires resources.manage. A second run within 10 seconds is 429 too_many_requests with Retry-After. A check with no builtin location is 422 field locations code empty.\n","operationId":"PostAccountCheckRun","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRun"}}},"description":"Queued manual run"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Run a check now","tags":["checks"]}},"/a/{account}/checks/{id}/runs/{run_id}":{"get":{"description":"Returns one run, its jobs, and any stored result. Requires view. A run for another check is 404.","operationId":"GetAccountCheckRun","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"},{"$ref":"#/components/parameters/RunID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRun"}}},"description":"Run"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get a run","tags":["checks"]}},"/a/{account}/checks/{id}/stats":{"get":{"description":"Returns stored aggregate buckets for a range. range is required; a missing range is 400. An unknown range is 422 field range. Buckets are only stored rows. Requires view.\n","operationId":"GetAccountCheckStats","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/CheckID"},{"description":"Window. One of 24h, 7d, 30d, 90d. An unknown value is 422.","in":"query","name":"range","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStats"}}},"description":"Stored buckets and uptime"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Check stats","tags":["checks"]}},"/a/{account}/contact-groups":{"get":{"description":"Returns the account's contact groups, ordered by name. Requires view. A non-member receives 404.","operationId":"GetAccountContactGroups","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContactGroup"},"type":"array"}}},"description":"Contact groups"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List contact groups","tags":["notifications"]},"post":{"description":"Creates a contact group. Omitted events select check.down and check.up. Omitted remind_minutes selects 0. Requires resources.manage. A non-member receives 404.\n","operationId":"PostAccountContactGroups","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactGroupCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactGroup"}}},"description":"Created contact group"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Create a contact group","tags":["notifications"]}},"/a/{account}/contact-groups/{id}":{"delete":{"description":"Deletes a contact group and removes it from check audiences. Channels of the group are deleted with it. Requires resources.manage. A group in another account is 404.\n","operationId":"DeleteAccountContactGroup","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ContactGroupID"}],"responses":{"204":{"description":"Contact group deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Delete a contact group","tags":["notifications"]},"get":{"description":"Returns one contact group. Requires view. A group in another account is 404.","operationId":"GetAccountContactGroup","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ContactGroupID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactGroup"}}},"description":"Contact group"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get a contact group","tags":["notifications"]},"patch":{"description":"Updates the name, events, or reminder. Omitted fields stay as they are. Requires resources.manage. A group in another account is 404.\n","operationId":"PatchAccountContactGroup","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/ContactGroupID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactGroupUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactGroup"}}},"description":"Updated contact group"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Update a contact group","tags":["notifications"]}},"/a/{account}/incidents":{"get":{"description":"Returns incidents for the account, open incidents first across pages, then newest start. Requires view. An invalid cursor is 422. A non-member receives 404.\n","operationId":"GetAccountIncidents","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentPage"}}},"description":"One page of incidents"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List incidents","tags":["incidents"]}},"/a/{account}/incidents/{id}":{"get":{"description":"Returns one incident in this account. An incident from another account is 404. Requires view.","operationId":"GetAccountIncident","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/IncidentID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incident"}}},"description":"Incident"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get an incident","tags":["incidents"]}},"/a/{account}/incidents/{id}/ack":{"post":{"description":"Acknowledges an open or resolved incident. Requires resources.manage. A viewer is 403. A write token whose creator is still a member can acknowledge. A second acknowledgement returns the incident unchanged. An incident from another account is 404.\n","operationId":"PostAccountIncidentAck","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/IncidentID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incident"}}},"description":"Acknowledged incident"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Acknowledge an incident","tags":["incidents"]}},"/a/{account}/invitations":{"get":{"description":"Returns pending, unexpired invitations. Requires members.manage. API tokens are rejected with 403. A personal account is 409. A non-member receives 404. The invitation token is never included.","operationId":"GetAccountInvitations","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Invitation"},"type":"array"}}},"description":"Pending invitations"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"List pending invitations","tags":["members"]},"post":{"description":"Creates an invitation and emails the token. Requires members.manage. Inviting an owner also requires owners.manage. The token is only in the email. API tokens are rejected with 403. A personal account is 409. Exceeding the plan member limit is 403 plan_limit_exceeded. A non-member receives 404.\n","operationId":"PostAccountInvitations","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invitation"}}},"description":"Created invitation. The token is not included."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Invite a member","tags":["members"]}},"/a/{account}/invitations/{id}":{"delete":{"description":"Deletes a pending invitation. Requires members.manage. Revoking an owner invitation also requires owners.manage. API tokens are rejected with 403. A personal account is 409. An invitation from another organisation is 404.","operationId":"DeleteAccountInvitation","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/InvitationID"}],"responses":{"204":{"description":"Invitation revoked"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Revoke an invitation","tags":["members"]}},"/a/{account}/maintenance":{"get":{"description":"Returns the account's maintenance windows, newest start first. The page is items and next_cursor. next_cursor is absent on the last page. Requires view. An invalid cursor is 422. A non-member receives 404.\n","operationId":"GetAccountMaintenance","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowPage"}}},"description":"Maintenance window page"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List maintenance windows","tags":["maintenance"]},"post":{"description":"Creates a maintenance window. Requires resources.manage. A non-member receives 404.","operationId":"PostAccountMaintenance","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}},"description":"Created maintenance window"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Create a maintenance window","tags":["maintenance"]}},"/a/{account}/maintenance/{id}":{"delete":{"description":"Deletes a maintenance window. Requires resources.manage. A missing window is 404.","operationId":"DeleteAccountMaintenanceWindow","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/MaintenanceWindowID"}],"responses":{"204":{"description":"Maintenance window deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Delete a maintenance window","tags":["maintenance"]},"get":{"description":"Returns one maintenance window. Requires view. A missing window is 404.","operationId":"GetAccountMaintenanceWindow","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/MaintenanceWindowID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}},"description":"Maintenance window"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get a maintenance window","tags":["maintenance"]},"patch":{"description":"Replaces a maintenance window. Requires resources.manage. A missing window is 404.","operationId":"PatchAccountMaintenanceWindow","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/MaintenanceWindowID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}},"description":"Updated maintenance window"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Replace a maintenance window","tags":["maintenance"]}},"/a/{account}/members":{"get":{"description":"Returns members, oldest join first. Requires view. A personal account is 409. A non-member receives 404.","operationId":"GetAccountMembers","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Member"},"type":"array"}}},"description":"Members"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List organisation members","tags":["members"]}},"/a/{account}/members/{user_id}":{"delete":{"description":"Any member may remove themselves. Removing someone else requires members.manage. Removing an owner requires owners.manage. The last owner cannot be removed. A personal account is 409. A non-member receives 404. API tokens are rejected with 403.\n","operationId":"DeleteAccountMember","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/UserID"}],"responses":{"204":{"description":"Member removed"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Remove a member","tags":["members"]},"patch":{"description":"Requires members.manage. Granting or revoking owner also requires owners.manage. API tokens are rejected with 403. A personal account is 409. A non-member receives 404.","operationId":"PatchAccountMember","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/UserID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRoleRequest"}}},"required":true},"responses":{"204":{"description":"Role updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Change a member's role","tags":["members"]}},"/a/{account}/status-pages":{"get":{"description":"Returns the account's status pages, newest first. Requires view. A non-member receives 404.","operationId":"GetAccountStatusPages","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StatusPage"},"type":"array"}}},"description":"Status pages"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List status pages","tags":["status-pages"]},"post":{"description":"Creates a status page. An empty locale selects en and an empty timezone selects UTC. published and indexable default to false when sent as false. Requires resources.manage. A page past the plan limit is 403 plan_limit_exceeded. A custom domain on a plan that disallows it is the same limit error. A non-member receives 404.\n","operationId":"PostAccountStatusPages","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPage"}}},"description":"Created status page"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Create a status page","tags":["status-pages"]}},"/a/{account}/status-pages/{id}":{"delete":{"description":"Deletes a status page. Requires resources.manage. A page in another account is 404.","operationId":"DeleteAccountStatusPage","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"responses":{"204":{"description":"Status page deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Delete a status page","tags":["status-pages"]},"get":{"description":"Returns one status page and its components, ordered by position then id. Requires view. A page in another account is 404.\n","operationId":"GetAccountStatusPage","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPage"}}},"description":"Status page"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get a status page","tags":["status-pages"]},"patch":{"description":"Replaces the page fields. Omitted booleans are false and omitted text is empty. Requires resources.manage. A page in another account is 404.\n","operationId":"PatchAccountStatusPage","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPage"}}},"description":"Updated status page"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Replace a status page","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/components":{"post":{"description":"Adds a component at the next position. Requires resources.manage. A missing page is 404. A check the account does not own is 422.\n","operationId":"PostAccountStatusPageComponents","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusComponentInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusComponent"}}},"description":"Created component"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Add a component","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/components/reorder":{"post":{"description":"Sets positions from ids. ids must be exactly the page's component ids. A partial list is 422 field ids code invalid. Requires resources.manage.\n","operationId":"PostAccountStatusPageComponentsReorder","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderComponentsRequest"}}},"required":true},"responses":{"204":{"description":"Components reordered"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Reorder components","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/components/{component_id}":{"delete":{"description":"Deletes a component. Requires resources.manage. A missing component is 404.","operationId":"DeleteAccountStatusPageComponent","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"},{"$ref":"#/components/parameters/StatusComponentID"}],"responses":{"204":{"description":"Component deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Delete a component","tags":["status-pages"]},"patch":{"description":"Replaces a component's check and text. Position stays as it is. Requires resources.manage. A missing component is 404.\n","operationId":"PatchAccountStatusPageComponent","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"},{"$ref":"#/components/parameters/StatusComponentID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusComponentInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusComponent"}}},"description":"Updated component"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Replace a component","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/domain/verify":{"post":{"description":"Checks the page custom domain and marks it verified on success. domain_token in the response is empty once the domain is verified. Requires resources.manage. A failed check is 422 field custom_domain code invalid. A page in another account is 404.\n","operationId":"PostAccountStatusPageDomainVerify","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPage"}}},"description":"Verified status page"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Verify a custom domain","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/incidents":{"get":{"description":"Returns the page's editorial incidents, newest start first. The page is items and next_cursor. next_cursor is absent on the last page. Requires view. An invalid cursor is 422. A missing page is 404.\n","operationId":"GetAccountStatusPageIncidents","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"},{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncidentPage"}}},"description":"Incident page"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List editorial incidents","tags":["status-pages"]},"post":{"description":"Creates an incident and its first note. Requires resources.manage. A missing page is 404.\n","operationId":"PostAccountStatusPageIncidents","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncidentInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncident"}}},"description":"Created incident"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Create an editorial incident","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/incidents/{incident_id}":{"get":{"description":"Returns one editorial incident. Requires view. A missing incident is 404.","operationId":"GetAccountStatusPageIncident","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"},{"$ref":"#/components/parameters/StatusIncidentID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncident"}}},"description":"Editorial incident"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Get an editorial incident","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/incidents/{incident_id}/updates":{"post":{"description":"Adds a note and returns the incident. Requires resources.manage. A missing incident is 404.\n","operationId":"PostAccountStatusPageIncidentUpdates","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"},{"$ref":"#/components/parameters/StatusIncidentID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncidentUpdateInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncident"}}},"description":"Updated incident"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Add an incident update","tags":["status-pages"]}},"/a/{account}/status-pages/{id}/preview":{"get":{"description":"Returns the public status document, including when the page is unpublished. Requires view. A page in another account is 404. The same document is served at GET /s/{slug}/api/status once the page is published.\n","operationId":"GetAccountStatusPagePreview","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/StatusPageID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicStatus"}}},"description":"Public status document"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Preview a status page","tags":["status-pages"]}},"/a/{account}/tokens":{"get":{"description":"Returns the account's API tokens, newest first, including revoked tokens. The secret is never included. Requires tokens.manage. API tokens are rejected with 403. A non-member receives 404. A personal account may have tokens; its owner is the user.","operationId":"GetAccountTokens","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/APIToken"},"type":"array"}}},"description":"API tokens, without secrets"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"List API tokens","tags":["tokens"]},"post":{"description":"Creates an API token and returns the secret once. Requires tokens.manage. API tokens are rejected with 403. A non-member receives 404. A personal account may have tokens; its owner is the user.","operationId":"PostAccountTokens","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedToken"}}},"description":"Created token and its secret"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Create an API token","tags":["tokens"]}},"/a/{account}/tokens/{id}":{"delete":{"description":"Revokes an API token in this account. A missing token, a token from another account, and an already revoked token are 404. Requires tokens.manage. API tokens are rejected with 403. A non-member receives 404.","operationId":"DeleteAccountToken","parameters":[{"$ref":"#/components/parameters/AccountSlug"},{"$ref":"#/components/parameters/TokenID"}],"responses":{"204":{"description":"Token revoked"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Revoke an API token","tags":["tokens"]}},"/a/{account}/usage":{"get":{"description":"Returns the account's plan limits and current consumption. Requires view. A non-member receives 404.","operationId":"GetAccountUsage","parameters":[{"$ref":"#/components/parameters/AccountSlug"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}},"description":"Limits and usage"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Plan limits and usage","tags":["accounts"]}},"/admin/accounts":{"get":{"description":"Returns every account, oldest first, for a platform administrator. Requires a session whose user is a platform admin. API tokens are rejected with 403. An anonymous caller is 401. An invalid cursor is 422.","operationId":"GetAdminAccounts","parameters":[{"$ref":"#/components/parameters/PageCursor"},{"$ref":"#/components/parameters/PageLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAccountPage"}}},"description":"One page of accounts"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"List accounts","tags":["admin"]}},"/admin/accounts/{id}/plan":{"patch":{"description":"Moves the account onto the named plan and audits admin.plan_set on that account. Requires a platform-admin session. API tokens are rejected with 403. An unknown plan is 422. An unknown account is 404.","operationId":"PatchAdminAccountPlan","parameters":[{"$ref":"#/components/parameters/AccountID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPlanRequest"}}},"required":true},"responses":{"204":{"description":"Plan updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Set an account plan","tags":["admin"]}},"/admin/agents":{"get":{"description":"Shared agent management. Requires a platform-admin session. Region is required for shared agents.","operationId":"GetAdminAgents","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentPage"}}},"description":"Agents on the account"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"List agents","tags":["agents"]},"post":{"description":"Shared agent management. Requires a platform-admin session. Region is required for shared agents.","operationId":"PostAdminAgents","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedAgentCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCreated"}}},"description":"Created agent and its one-time key"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Register an agent","tags":["agents"]}},"/admin/agents/{id}":{"delete":{"description":"Shared agent management. Requires a platform-admin session. Region is required for shared agents.","operationId":"DeleteAdminAgent","parameters":[{"$ref":"#/components/parameters/AgentID"}],"responses":{"204":{"description":"Agent deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Delete an agent","tags":["agents"]},"get":{"description":"Shared agent management. Requires a platform-admin session. Region is required for shared agents.","operationId":"GetAdminAgent","parameters":[{"$ref":"#/components/parameters/AgentID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}},"description":"Agent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Get an agent","tags":["agents"]},"patch":{"description":"Shared agent management. Requires a platform-admin session. Region is required for shared agents.","operationId":"PatchAdminAgent","parameters":[{"$ref":"#/components/parameters/AgentID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}},"description":"Updated agent. The key is not included."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Update an agent","tags":["agents"]}},"/admin/agents/{id}/rotate-key":{"post":{"description":"Shared agent management. Requires a platform-admin session. Region is required for shared agents.","operationId":"PostAdminAgentRotateKey","parameters":[{"$ref":"#/components/parameters/AgentID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentKey"}}},"description":"New one-time key"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Rotate an agent key","tags":["agents"]}},"/admin/payments":{"get":{"operationId":"GetAdminPayments","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsSettings"}}},"description":"Payment availability"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Get platform payment availability","tags":["admin"]},"put":{"operationId":"PutAdminPayments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsSettings"}}},"required":true},"responses":{"204":{"description":"Payment setting saved"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Enable or disable checkout and automatic charges","tags":["admin"]}},"/admin/plans":{"get":{"description":"Returns every plan's limits. Requires a platform-admin session. API tokens are rejected with 403. An anonymous caller is 401.","operationId":"GetAdminPlans","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Limits"},"type":"array"}}},"description":"Plans"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"List plans","tags":["admin"]}},"/admin/registration":{"put":{"operationId":"PutAdminRegistration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationSettings"}}},"required":true},"responses":{"204":{"description":"Registration setting saved"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Enable or disable new user registration","tags":["admin"]}},"/admin/users/{id}/disable":{"post":{"description":"Sets disabled_at, deletes the user's sessions, and audits admin.user_disabled on the user's personal account. Requires a platform-admin session. API tokens are rejected with 403. Disabling oneself is 409. Disabling a platform admin is 409. An unknown user is 404. A user who is already disabled is 204 and writes no audit.","operationId":"PostAdminUserDisable","parameters":[{"$ref":"#/components/parameters/AdminUserID"}],"responses":{"204":{"description":"User disabled"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Disable a user","tags":["admin"]}},"/admin/users/{id}/enable":{"post":{"description":"Clears disabled_at, deletes the user's sessions, and audits admin.user_enabled on the user's personal account. Requires a platform-admin session. API tokens are rejected with 403. An unknown user is 404. A user who is already enabled is 204 and writes no audit.","operationId":"PostAdminUserEnable","parameters":[{"$ref":"#/components/parameters/AdminUserID"}],"responses":{"204":{"description":"User enabled"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Enable a user","tags":["admin"]}},"/auth/channel-verify":{"post":{"description":"Consumes the token from the channel verification message. No session is required. A missing, used, or expired token is 404. The token is not logged.\n","operationId":"PostAuthChannelVerify","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelVerifyRequest"}}},"required":true},"responses":{"204":{"description":"Channel confirmed"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Confirm an email channel","tags":["notifications"]}},"/auth/login":{"post":{"description":"Opens a browser session and sets the ks_session cookie. A captcha is required after the first failure for this email or client address.","operationId":"PostAuthLogin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}},"description":"Signed in. The response sets the session cookie.","headers":{"Set-Cookie":{"description":"Session cookie ks_session. HttpOnly, SameSite=Lax, Path=/.","schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"423":{"$ref":"#/components/responses/Locked"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Sign in","tags":["auth"]}},"/auth/login/requirements":{"get":{"description":"Reports whether the next password attempt from this client must include a captcha. The result does not depend on whether an account exists for the address.","operationId":"GetAuthLoginRequirements","parameters":[{"description":"Address the user is about to submit.","in":"query","name":"email","required":true,"schema":{"format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequirements"}}},"description":"Requirements for the next sign-in attempt"},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Sign-in requirements","tags":["auth"]}},"/auth/logout":{"post":{"description":"Deletes the current browser session and clears the ks_session cookie.","operationId":"PostAuthLogout","responses":{"204":{"description":"Signed out. The response clears the session cookie.","headers":{"Set-Cookie":{"description":"Clears the ks_session cookie.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Sign out","tags":["auth"]}},"/auth/me":{"get":{"description":"Returns the user resolved from the session cookie or the bearer token. No second lookup is performed.","operationId":"GetAuthMe","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Authenticated user"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"Current user","tags":["auth"]}},"/auth/password/forgot":{"post":{"description":"Always responds 204 after a valid captcha. Unknown addresses and cooldown windows are indistinguishable.","operationId":"PostAuthPasswordForgot","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgotPasswordRequest"}}},"required":true},"responses":{"204":{"description":"Accepted"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Request a password reset","tags":["auth"]}},"/auth/password/reset":{"post":{"description":"Consumes a reset token, stores the new password, and deletes every session for that user.","operationId":"PostAuthPasswordReset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"}}},"required":true},"responses":{"204":{"description":"Password updated"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Reset a password","tags":["auth"]}},"/auth/register":{"post":{"description":"Creates an unverified user and emails a confirmation link. A valid captcha is required.","operationId":"PostAuthRegister","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User created. The address is not verified yet."},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Register a personal account","tags":["auth"]}},"/auth/registration":{"get":{"operationId":"GetRegistration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationSettings"}}},"description":"Registration availability"},"default":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Get registration availability","tags":["auth"]}},"/auth/resend-verification":{"post":{"description":"Always responds 204. Unknown addresses, already verified users, and cooldown windows are indistinguishable. The response does not depend on whether an account exists.","operationId":"PostAuthResendVerification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailRequest"}}},"required":true},"responses":{"204":{"description":"Accepted"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Resend the verification email","tags":["auth"]}},"/auth/verify-email":{"post":{"description":"Consumes a verification or email-change token from the link in the message.","operationId":"PostAuthVerifyEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyEmailRequest"}}},"required":true},"responses":{"204":{"description":"Address confirmed"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Confirm an email address","tags":["auth"]}},"/billing/yookassa":{"post":{"description":"Accepts a YooKassa notification. The body does not change billing state by itself. payment.succeeded and payment.canceled are fetched from YooKassa and applied. Any other event is acknowledged. An unknown payment is acknowledged. A failure talking to YooKassa is 500 so the notification is retried. On-premise installs answer 404.\n","operationId":"PostBillingYookassa","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YooKassaNotification"}}},"required":true},"responses":{"200":{"description":"Notification accepted. The body is empty."},"400":{"$ref":"#/components/responses/BadRequest"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"YooKassa payment notification","tags":["billing"]}},"/captcha/challenge":{"get":{"description":"Returns a fresh ALTCHA challenge. The solution is single-use and expires after five minutes.","operationId":"GetCaptchaChallenge","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptchaChallenge"}}},"description":"Challenge for the client widget"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"ALTCHA challenge","tags":["captcha"]}},"/invitations/accept":{"post":{"description":"Accepts the invitation identified by the token from the email link. The signed-in user's email must match the invitation. API tokens are rejected with 403.","operationId":"PostInvitationsAccept","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptInvitationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountWithRole"}}},"description":"Organisation the caller joined, with their new role"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Accept an invitation by token","tags":["invitations"]}},"/locations":{"get":{"description":"Returns builtins plus the caller's agents for any authenticated session or API token. An anonymous caller is 401.","operationId":"GetLocations","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Location"},"type":"array"}}},"description":"Builtins plus the caller's agents"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]},{"bearerAuth":[]}],"summary":"List visible locations","tags":["locations"]}},"/me":{"get":{"description":"Returns the signed-in user. API tokens are rejected with 403 because they act for an account, not a person.","operationId":"GetMe","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Current user"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Current profile","tags":["me"]},"patch":{"description":"Changes the display name, the locale, or both. Omitted fields stay as they are. API tokens are rejected with 403.","operationId":"PatchMe","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Updated user"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Update the current profile","tags":["me"]}},"/me/accounts":{"get":{"description":"Returns the personal account and every organisation the signed-in user belongs to. API tokens are rejected with 403.","operationId":"GetMeAccounts","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Membership"},"type":"array"}}},"description":"Memberships"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Accounts of the current user","tags":["me"]}},"/me/email":{"put":{"description":"Checks the current password and sends a confirmation link to the new address. The address changes only after that link is opened. The response has no body. API tokens are rejected with 403.","operationId":"PutMeEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeEmailRequest"}}},"required":true},"responses":{"202":{"description":"Confirmation was sent to the new address"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"423":{"$ref":"#/components/responses/Locked"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Request an email change","tags":["me"]}},"/me/invitations":{"get":{"description":"Lists pending invitations addressed to the signed-in user's email. API tokens are rejected with 403.","operationId":"GetMeInvitations","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InvitationForMe"},"type":"array"}}},"description":"Pending invitations"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Invitations for the current user","tags":["me"]}},"/me/invitations/{id}/accept":{"post":{"description":"Adds the signed-in user to the organisation when the invitation was sent to their email. A different address is 403. API tokens are rejected with 403.","operationId":"PostMeInvitationAccept","parameters":[{"$ref":"#/components/parameters/InvitationID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountWithRole"}}},"description":"Organisation the caller joined, with their new role"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Accept an invitation by id","tags":["me"]}},"/me/password":{"put":{"description":"Checks the current password, stores the new one, and deletes every other session. The session that made the request stays signed in. API tokens are rejected with 403.","operationId":"PutMePassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordRequest"}}},"required":true},"responses":{"204":{"description":"Password updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"423":{"$ref":"#/components/responses/Locked"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Change the current password","tags":["me"]}},"/me/sessions":{"get":{"description":"Returns the signed-in user's sessions, newest first. current is true only for the session that made the request. API tokens are rejected with 403.","operationId":"GetMeSessions","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Session"},"type":"array"}}},"description":"Browser sessions"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"List browser sessions","tags":["me"]}},"/me/sessions/{id}":{"delete":{"description":"Deletes one of the signed-in user's sessions. Revoking the session that made the request also clears the ks_session cookie. API tokens are rejected with 403.","operationId":"DeleteMeSession","parameters":[{"$ref":"#/components/parameters/SessionID"}],"responses":{"204":{"description":"Session revoked. The current session's response also clears the cookie.","headers":{"Set-Cookie":{"description":"Present when the revoked session is the caller. Clears ks_session.","schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Revoke a browser session","tags":["me"]}},"/meta":{"get":{"description":"Build version and the built-in probe location, when this process serves one.","operationId":"GetMeta","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meta"}}},"description":"Metadata"},"default":{"$ref":"#/components/responses/Problem"}},"summary":"Service metadata","tags":["meta"]}},"/orgs":{"post":{"description":"Creates an organisation on the free plan and makes the signed-in user its owner. API tokens are rejected with 403.","operationId":"PostOrgs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrgRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Created organisation"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"security":[{"cookieAuth":[]}],"summary":"Create an organisation","tags":["accounts"]}}},"servers":[{"url":"/api/v1"}]}