Repository Public
1// GENERATED by `pnpm gen:api` from packages/api-contracts/openapi.yaml — do not edit.2/**3 * This file was auto-generated by openapi-typescript.4 * Do not make direct changes to the file.5 */67export interface paths {8 "/action-types": {9 parameters: {10 query?: never;11 header?: never;12 path?: never;13 cookie?: never;14 };15 /**16 * Action catalog17 * @description Every action type with the JSON Schema of its parameters, criticality, required permission and flags. Types with `available=false` are listed but cannot be run (`422 action_unavailable`).18 */19 get: operations["listActionTypes"];20 put?: never;21 post?: never;22 delete?: never;23 options?: never;24 head?: never;25 patch?: never;26 trace?: never;27 };28 "/actions": {29 parameters: {30 query?: never;31 header?: never;32 path?: never;33 cookie?: never;34 };35 /** List actions */36 get: operations["listActions"];37 put?: never;38 /**39 * Request an action40 * @description Requests a typed action on a target. The permission depends on the criticality of the type:41 * `actions.run.low|medium|high|critical` (plus `logs.read` for `service.logs.tail`). `high` and `critical`42 * types require a step-up (`403 step_up_required`). Depending on the type flags the request must carry43 * `confirm` (exact alias of the target, checked by the server, else `422 confirmation_mismatch`) and44 * `justification` (`422 justification_required`).45 *46 * Server pre-checks: known target, agent online and not revoked, capability declared by the agent, node not in47 * maintenance (except maintenance actions), `params` valid against the schema of the type. A failed pre-check48 * is `422` and creates no action.49 *50 * Types with `requires_approval` start in `pending_approval` and need a second person51 * (`POST /actions/{id}/approve`); the others start `queued`.52 *53 * **Idempotency**: `Idempotency-Key` is required. Same key and same body returns the original action with54 * `200`; same key with a different body is `409 idempotency_conflict`. One lock per target: a concurrent55 * action on the same target is `409 target_locked`. While the emergency stop is engaged the answer is56 * `503 orchestrator_frozen`. Rate limit: 30 requests per minute per user.57 */58 post: operations["createAction"];59 delete?: never;60 options?: never;61 head?: never;62 patch?: never;63 trace?: never;64 };65 "/actions/{id}": {66 parameters: {67 query?: never;68 header?: never;69 path: {70 id: components["parameters"]["Id"];71 };72 cookie?: never;73 };74 /**75 * Get an action with its events76 * @description Lifecycle events only (state changes, approvals); the output stream is served by `GET /actions/{id}/output`.77 */78 get: operations["getAction"];79 put?: never;80 post?: never;81 delete?: never;82 options?: never;83 head?: never;84 patch?: never;85 trace?: never;86 };87 "/actions/{id}/approve": {88 parameters: {89 query?: never;90 header?: never;91 path: {92 id: components["parameters"]["Id"];93 };94 cookie?: never;95 };96 get?: never;97 put?: never;98 /**99 * Approve an action pending approval100 * @description The approver must be a different person than the requester (`403 forbidden` otherwise). The action moves to `queued`. `409 conflict` when not `pending_approval`.101 */102 post: operations["approveAction"];103 delete?: never;104 options?: never;105 head?: never;106 patch?: never;107 trace?: never;108 };109 "/actions/{id}/cancel": {110 parameters: {111 query?: never;112 header?: never;113 path: {114 id: components["parameters"]["Id"];115 };116 cookie?: never;117 };118 get?: never;119 put?: never;120 /**121 * Cancel an action122 * @description Allowed to the requester, or to anyone holding the run permission of the action criticality. Before dispatch the action is cancelled at once; afterwards cancellation is requested from the agent (best effort). `409 conflict` when already finished.123 */124 post: operations["cancelAction"];125 delete?: never;126 options?: never;127 head?: never;128 patch?: never;129 trace?: never;130 };131 "/actions/{id}/output": {132 parameters: {133 query?: never;134 header?: never;135 path: {136 id: components["parameters"]["Id"];137 };138 cookie?: never;139 };140 /**141 * Redacted output of an action142 * @description Output chunks (stdout / stderr), redacted by the agent and by the server. Poll with `after` = last `next_after`, or follow the `action.output` events. Output of `service.logs.tail` also requires `logs.read`.143 */144 get: operations["getActionOutput"];145 put?: never;146 post?: never;147 delete?: never;148 options?: never;149 head?: never;150 patch?: never;151 trace?: never;152 };153 "/actions/{id}/reject": {154 parameters: {155 query?: never;156 header?: never;157 path: {158 id: components["parameters"]["Id"];159 };160 cookie?: never;161 };162 get?: never;163 put?: never;164 /** Reject an action pending approval */165 post: operations["rejectAction"];166 delete?: never;167 options?: never;168 head?: never;169 patch?: never;170 trace?: never;171 };172 "/activity": {173 parameters: {174 query?: never;175 header?: never;176 path?: never;177 cookie?: never;178 };179 /**180 * Recent operator-visible activity181 * @description Redacted subset of what happened recently (actions, acknowledgements, maintenance, sign-ins), for users182 * without `audit.read`: no IP, no device, no session, no parameters. Each item is only returned when the183 * caller can read the underlying resource.184 */185 get: operations["listActivity"];186 put?: never;187 post?: never;188 delete?: never;189 options?: never;190 head?: never;191 patch?: never;192 trace?: never;193 };194 "/admin/status": {195 parameters: {196 query?: never;197 header?: never;198 path?: never;199 cookie?: never;200 };201 /**202 * Backend health203 * @description Database, ingest and orchestrator heartbeats, last successful backup, version and frozen flag.204 */205 get: operations["getAdminStatus"];206 put?: never;207 post?: never;208 delete?: never;209 options?: never;210 head?: never;211 patch?: never;212 trace?: never;213 };214 "/agents": {215 parameters: {216 query?: never;217 header?: never;218 path?: never;219 cookie?: never;220 };221 /** List enrolled agents */222 get: operations["listAgents"];223 put?: never;224 post?: never;225 delete?: never;226 options?: never;227 head?: never;228 patch?: never;229 trace?: never;230 };231 "/agents/{id}/revoke": {232 parameters: {233 query?: never;234 header?: never;235 path: {236 id: components["parameters"]["Id"];237 };238 cookie?: never;239 };240 get?: never;241 put?: never;242 /**243 * Revoke an agent certificate244 * @description The agent can no longer report nor receive commands; a new enrollment is required.245 */246 post: operations["revokeAgent"];247 delete?: never;248 options?: never;249 head?: never;250 patch?: never;251 trace?: never;252 };253 "/agents/enrollment-tokens": {254 parameters: {255 query?: never;256 header?: never;257 path?: never;258 cookie?: never;259 };260 /**261 * List agent enrollment tokens262 * @description Never returns the token value.263 */264 get: operations["listEnrollmentTokens"];265 put?: never;266 /**267 * Create a single-use agent enrollment token268 * @description The token is returned **once**, with an install hint. Default TTL 15 minutes.269 */270 post: operations["createEnrollmentToken"];271 delete?: never;272 options?: never;273 head?: never;274 patch?: never;275 trace?: never;276 };277 "/agents/enrollment-tokens/{id}": {278 parameters: {279 query?: never;280 header?: never;281 path: {282 id: components["parameters"]["Id"];283 };284 cookie?: never;285 };286 get?: never;287 put?: never;288 post?: never;289 /** Revoke an unused enrollment token */290 delete: operations["revokeEnrollmentToken"];291 options?: never;292 head?: never;293 patch?: never;294 trace?: never;295 };296 "/alert-rules": {297 parameters: {298 query?: never;299 header?: never;300 path?: never;301 cookie?: never;302 };303 /** List alert rules */304 get: operations["listAlertRules"];305 put?: never;306 /** Create an alert rule */307 post: operations["createAlertRule"];308 delete?: never;309 options?: never;310 head?: never;311 patch?: never;312 trace?: never;313 };314 "/alert-rules/{id}": {315 parameters: {316 query?: never;317 header?: never;318 path: {319 id: components["parameters"]["Id"];320 };321 cookie?: never;322 };323 /** Get an alert rule */324 get: operations["getAlertRule"];325 put?: never;326 post?: never;327 /**328 * Delete an alert rule329 * @description Built-in rules cannot be deleted (`409 conflict`); disable them instead. Open alerts of the rule are resolved.330 */331 delete: operations["deleteAlertRule"];332 options?: never;333 head?: never;334 /**335 * Update an alert rule336 * @description Built-in rules accept changes to `enabled`, thresholds, durations, severity, scope and `notify` only.337 */338 patch: operations["updateAlertRule"];339 trace?: never;340 };341 "/alert-rules/validate": {342 parameters: {343 query?: never;344 header?: never;345 path?: never;346 cookie?: never;347 };348 get?: never;349 put?: never;350 /**351 * Evaluate a draft rule against historical data352 * @description Dry run: nothing is stored and no alert is opened. Returns the intervals during which the rule would have fired (default window: the last 7 days).353 */354 post: operations["validateAlertRule"];355 delete?: never;356 options?: never;357 head?: never;358 patch?: never;359 trace?: never;360 };361 "/alerts": {362 parameters: {363 query?: never;364 header?: never;365 path?: never;366 cookie?: never;367 };368 /** List alerts */369 get: operations["listAlerts"];370 put?: never;371 post?: never;372 delete?: never;373 options?: never;374 head?: never;375 patch?: never;376 trace?: never;377 };378 "/alerts/{id}": {379 parameters: {380 query?: never;381 header?: never;382 path: {383 id: components["parameters"]["Id"];384 };385 cookie?: never;386 };387 /** Get an alert with its timeline */388 get: operations["getAlert"];389 put?: never;390 post?: never;391 delete?: never;392 options?: never;393 head?: never;394 patch?: never;395 trace?: never;396 };397 "/alerts/{id}/acknowledge": {398 parameters: {399 query?: never;400 header?: never;401 path: {402 id: components["parameters"]["Id"];403 };404 cookie?: never;405 };406 get?: never;407 put?: never;408 /** Acknowledge a firing alert */409 post: operations["acknowledgeAlert"];410 delete?: never;411 options?: never;412 head?: never;413 patch?: never;414 trace?: never;415 };416 "/alerts/{id}/comments": {417 parameters: {418 query?: never;419 header?: never;420 path: {421 id: components["parameters"]["Id"];422 };423 cookie?: never;424 };425 get?: never;426 put?: never;427 /** Add a comment to the timeline of an alert */428 post: operations["commentAlert"];429 delete?: never;430 options?: never;431 head?: never;432 patch?: never;433 trace?: never;434 };435 "/alerts/{id}/resolve": {436 parameters: {437 query?: never;438 header?: never;439 path: {440 id: components["parameters"]["Id"];441 };442 cookie?: never;443 };444 get?: never;445 put?: never;446 /**447 * Resolve an alert manually448 * @description If the condition still holds the rule opens a new alert at its next evaluation.449 */450 post: operations["resolveAlert"];451 delete?: never;452 options?: never;453 head?: never;454 patch?: never;455 trace?: never;456 };457 "/audit": {458 parameters: {459 query?: never;460 header?: never;461 path?: never;462 cookie?: never;463 };464 /**465 * Query the audit log466 * @description Most recent first. Entries only contain allowlisted, non-sensitive parameters.467 */468 get: operations["listAudit"];469 put?: never;470 post?: never;471 delete?: never;472 options?: never;473 head?: never;474 patch?: never;475 trace?: never;476 };477 "/audit/export": {478 parameters: {479 query?: never;480 header?: never;481 path?: never;482 cookie?: never;483 };484 /**485 * Export a range of the audit log486 * @description Returns the file itself: JSON Lines, one `AuditEntry` per line, ascending `seq`, followed by ONE final line487 * `{"manifest": {...}, "signature": "<key_id>:<base64>"}`. The manifest states the range, the entry count, the488 * first and last `seq`, the head hash and the SHA-256 of every byte that precedes the manifest line; it is489 * signed with Ed25519, so the file alone can be verified offline (`mccctl audit-verify-export <file>`), and490 * any changed byte is detected. The response headers repeat the hash of the last exported entry and carry a491 * detached signature of that hash. Maximum range: 366 days. The public key is given by `GET /audit/verify`.492 * The export itself is audited.493 */494 get: operations["exportAudit"];495 put?: never;496 post?: never;497 delete?: never;498 options?: never;499 head?: never;500 patch?: never;501 trace?: never;502 };503 "/audit/verify": {504 parameters: {505 query?: never;506 header?: never;507 path?: never;508 cookie?: never;509 };510 /**511 * Verify the audit hash chain512 * @description Recomputes the chain over the whole log (or from `from_seq`) and reports the first broken link, if any.513 */514 get: operations["verifyAudit"];515 put?: never;516 post?: never;517 delete?: never;518 options?: never;519 head?: never;520 patch?: never;521 trace?: never;522 };523 "/auth/logout": {524 parameters: {525 query?: never;526 header?: never;527 path?: never;528 cookie?: never;529 };530 get?: never;531 put?: never;532 /**533 * Revoke the current session534 * @description Revokes the current session (and its refresh tokens) and clears the session cookie.535 */536 post: operations["logout"];537 delete?: never;538 options?: never;539 head?: never;540 patch?: never;541 trace?: never;542 };543 "/auth/refresh": {544 parameters: {545 query?: never;546 header?: never;547 path?: never;548 cookie?: never;549 };550 get?: never;551 put?: never;552 /**553 * Rotate the refresh token of a native session554 * @description Native clients only. The presented refresh token is consumed and a new access + refresh pair is returned.555 * Presenting an already rotated token revokes the session (`401 refresh_reuse_detected`) and is audited.556 * Rate limit: 30 requests per minute per IP.557 */558 post: operations["refreshSession"];559 delete?: never;560 options?: never;561 head?: never;562 patch?: never;563 trace?: never;564 };565 "/auth/stepup/begin": {566 parameters: {567 query?: never;568 header?: never;569 path?: never;570 cookie?: never;571 };572 get?: never;573 put?: never;574 /**575 * Begin a step-up passkey ceremony for the current session576 * @description The challenge only accepts passkeys of the current user. Rate limit: 10 requests per minute per session.577 */578 post: operations["beginStepUp"];579 delete?: never;580 options?: never;581 head?: never;582 patch?: never;583 trace?: never;584 };585 "/auth/stepup/finish": {586 parameters: {587 query?: never;588 header?: never;589 path?: never;590 cookie?: never;591 };592 get?: never;593 put?: never;594 /**595 * Finish a step-up ceremony596 * @description Refreshes `authenticated_at` of the session; step-up is then valid for 5 minutes. Rate limit: 10 requests per minute per session.597 */598 post: operations["finishStepUp"];599 delete?: never;600 options?: never;601 head?: never;602 patch?: never;603 trace?: never;604 };605 "/auth/webauthn/authentication/begin": {606 parameters: {607 query?: never;608 header?: never;609 path?: never;610 cookie?: never;611 };612 get?: never;613 put?: never;614 /**615 * Begin a passkey authentication ceremony616 * @description Returns a single-use challenge (32 bytes, valid 5 minutes) for a discoverable-credential (usernameless)617 * ceremony. `userVerification` is `required`. Rate limit: 10 requests per minute per IP.618 */619 post: operations["beginAuthentication"];620 delete?: never;621 options?: never;622 head?: never;623 patch?: never;624 trace?: never;625 };626 "/auth/webauthn/authentication/finish": {627 parameters: {628 query?: never;629 header?: never;630 path?: never;631 cookie?: never;632 };633 get?: never;634 put?: never;635 /**636 * Finish a passkey authentication ceremony and open a session637 * @description Verifies the assertion (origin, RP ID, user verification, signature counter) and opens a session bound to a638 * device. `client.kind=web`: sets the cookie `__Host-mcc_session` (Secure, HttpOnly, SameSite=Strict, Path=/)639 * and returns `csrf_token`. `client.kind=macos|ios`: returns `access_token`, `access_expires_at` and640 * `refresh_token` instead, and sets no cookie. Rate limit: 10 requests per minute per IP.641 */642 post: operations["finishAuthentication"];643 delete?: never;644 options?: never;645 head?: never;646 patch?: never;647 trace?: never;648 };649 "/auth/webauthn/registration/begin": {650 parameters: {651 query?: never;652 header?: never;653 path?: never;654 cookie?: never;655 };656 get?: never;657 put?: never;658 /**659 * Begin a passkey registration ceremony660 * @description Two contexts: (1) **add a passkey to the current account** - requires a session and a step-up;661 * (2) **complete an invitation** - authenticated by the setup transaction (cookie `__Host-mcc_setup` or header662 * `X-MCC-Setup-Transaction`); the transaction must have a handle and display name663 * (see `POST /invitations/transaction/profile`). `residentKey=required`, `userVerification=required`,664 * attestation `none`, algorithms ES256 and RS256. Rate limit: 10 requests per minute per IP.665 */666 post: operations["beginRegistration"];667 delete?: never;668 options?: never;669 head?: never;670 patch?: never;671 trace?: never;672 };673 "/auth/webauthn/registration/finish": {674 parameters: {675 query?: never;676 header?: never;677 path?: never;678 cookie?: never;679 };680 get?: never;681 put?: never;682 /**683 * Finish a passkey registration ceremony684 * @description Stores the new passkey. In the invitation context this creates the account, completes the invitation, opens685 * a session and returns it in `auth` (cookie set for web clients, tokens for native clients; `client` is then686 * required). In the add-a-passkey context `auth` is absent. Rate limit: 10 requests per minute per IP.687 */688 post: operations["finishRegistration"];689 delete?: never;690 options?: never;691 head?: never;692 patch?: never;693 trace?: never;694 };695 "/cluster/overview": {696 parameters: {697 query?: never;698 header?: never;699 path?: never;700 cookie?: never;701 };702 /**703 * Cluster overview704 * @description Aggregated snapshot. Capacity totals only sum what agents actually report: `coverage` is the number of nodes705 * contributing to each total, to be compared with `nodes.total`. Sections the caller cannot read706 * (for example `recent_actions` without `actions.read`) are omitted.707 */708 get: operations["getClusterOverview"];709 put?: never;710 post?: never;711 delete?: never;712 options?: never;713 head?: never;714 patch?: never;715 trace?: never;716 };717 "/cluster/trends": {718 parameters: {719 query?: never;720 header?: never;721 path?: never;722 cookie?: never;723 };724 /**725 * Aggregated metric trend726 * @description Aggregates one metric across nodes over a range. Resolution is chosen by the server (1h: raw 10 s buckets; 24h: 1 min; 7d and 30d: 1 h).727 */728 get: operations["getClusterTrends"];729 put?: never;730 post?: never;731 delete?: never;732 options?: never;733 head?: never;734 patch?: never;735 trace?: never;736 };737 "/devices/{id}": {738 parameters: {739 query?: never;740 header?: never;741 path: {742 id: components["parameters"]["Id"];743 };744 cookie?: never;745 };746 get?: never;747 put?: never;748 post?: never;749 /** Revoke any device and all its sessions */750 delete: operations["revokeDevice"];751 options?: never;752 head?: never;753 patch?: never;754 trace?: never;755 };756 "/events": {757 parameters: {758 query?: never;759 header?: never;760 path?: never;761 cookie?: never;762 };763 /**764 * Real-time event stream (Server-Sent Events)765 * @description `text/event-stream`. Each frame is766 *767 * ```768 * id: <seq>769 * event: <topic>770 * data: <json>771 * ```772 *773 * where `<seq>` is a monotonic sequence and `<json>` is, on one line, the payload schema of the topic:774 *775 * | `event` | `data` schema | Visible with |776 * |---|---|---|777 * | `node.state` | `NodeStateEvent` | `nodes.read` |778 * | `node.updated` | `NodeUpdatedEvent` | `nodes.read` |779 * | `alert.changed` | `AlertChangedEvent` | `alerts.read` |780 * | `incident.changed` | `IncidentChangedEvent` | `alerts.read` |781 * | `action.changed` | `ActionChangedEvent` | `actions.read` |782 * | `action.output` | `ActionOutputEvent` | `actions.read` (and `logs.read` for log tails) |783 * | `service.changed` | `ServiceChangedEvent` | `services.read` |784 * | `job.changed` | `JobChangedEvent` | `jobs.read` |785 * | `maintenance.changed` | `MaintenanceChangedEvent` | `maintenance.read` |786 * | `audit.appended` | `AuditAppendedEvent` | `audit.read` |787 * | `resync` | `ResyncEvent` | always |788 *789 * Events are filtered by permission on the server. A comment line `: ping` is sent every 15 seconds.790 * **Resume**: reconnect with `Last-Event-ID` (set automatically by EventSource) or `last_event_id`; missed791 * events are replayed. When the requested sequence is no longer retained (more than 1 hour old) the server792 * sends a single `resync` event and continues live: the client must reload its state through the REST API.793 * Events are notifications: payloads are small and the REST resource remains the source of truth.794 *795 * The schema `EventStreamFrame` attached to this response describes one **decoded** frame for code generators;796 * the body on the wire is the SSE text format above.797 */798 get: operations["streamEvents"];799 put?: never;800 post?: never;801 delete?: never;802 options?: never;803 head?: never;804 patch?: never;805 trace?: never;806 };807 "/health/live": {808 parameters: {809 query?: never;810 header?: never;811 path?: never;812 cookie?: never;813 };814 /**815 * Liveness probe816 * @description Unauthenticated and minimal; the process answers.817 */818 get: operations["getLiveness"];819 put?: never;820 post?: never;821 delete?: never;822 options?: never;823 head?: never;824 patch?: never;825 trace?: never;826 };827 "/health/ready": {828 parameters: {829 query?: never;830 header?: never;831 path?: never;832 cookie?: never;833 };834 /**835 * Readiness probe836 * @description Unauthenticated and minimal; `503` when the database is unreachable. No detail is disclosed (see `GET /admin/status`).837 */838 get: operations["getReadiness"];839 put?: never;840 post?: never;841 delete?: never;842 options?: never;843 head?: never;844 patch?: never;845 trace?: never;846 };847 "/incidents": {848 parameters: {849 query?: never;850 header?: never;851 path?: never;852 cookie?: never;853 };854 /** List incidents */855 get: operations["listIncidents"];856 put?: never;857 /** Open an incident */858 post: operations["createIncident"];859 delete?: never;860 options?: never;861 head?: never;862 patch?: never;863 trace?: never;864 };865 "/incidents/{id}": {866 parameters: {867 query?: never;868 header?: never;869 path: {870 id: components["parameters"]["Id"];871 };872 cookie?: never;873 };874 /** Get an incident with its timeline and alerts */875 get: operations["getIncident"];876 put?: never;877 post?: never;878 delete?: never;879 options?: never;880 head?: never;881 /**882 * Update an incident883 * @description Title, severity, state, summary, owner, and attached alerts.884 */885 patch: operations["updateIncident"];886 trace?: never;887 };888 "/incidents/{id}/comments": {889 parameters: {890 query?: never;891 header?: never;892 path: {893 id: components["parameters"]["Id"];894 };895 cookie?: never;896 };897 get?: never;898 put?: never;899 /** Add a comment to the timeline of an incident */900 post: operations["commentIncident"];901 delete?: never;902 options?: never;903 head?: never;904 patch?: never;905 trace?: never;906 };907 "/invitations": {908 parameters: {909 query?: never;910 header?: never;911 path?: never;912 cookie?: never;913 };914 /**915 * List invitations916 * @description Never returns the token (only its SHA-256 hash is stored).917 */918 get: operations["listInvitations"];919 put?: never;920 /**921 * Create a single-use invitation922 * @description The token and `setup_url` are returned **once** and cannot be retrieved later. An admin can neither create923 * nor target an `owner`. With `target_user_id` the invitation links to an existing account924 * (see `POST /invitations/transaction/link`); `handle` and `display_name` are then ignored.925 */926 post: operations["createInvitation"];927 delete?: never;928 options?: never;929 head?: never;930 patch?: never;931 trace?: never;932 };933 "/invitations/{id}": {934 parameters: {935 query?: never;936 header?: never;937 path: {938 id: components["parameters"]["Id"];939 };940 cookie?: never;941 };942 get?: never;943 put?: never;944 post?: never;945 /**946 * Revoke an invitation947 * @description Also invalidates an open setup transaction of this invitation.948 */949 delete: operations["revokeInvitation"];950 options?: never;951 head?: never;952 patch?: never;953 trace?: never;954 };955 "/invitations/exchange": {956 parameters: {957 query?: never;958 header?: never;959 path?: never;960 cookie?: never;961 };962 get?: never;963 put?: never;964 /**965 * Exchange an invitation token for a setup transaction966 * @description Unauthenticated. Consumes the token **atomically** and opens a 10-minute setup transaction. Web clients967 * receive the cookie `__Host-mcc_setup`; native clients (`client.kind` other than `web`) receive968 * `transaction_token`, to be sent in the header `X-MCC-Setup-Transaction`. Unknown, expired, consumed or969 * revoked tokens all answer `410 gone`. Five failed attempts revoke the invitation.970 * Rate limit: 5 requests per minute per IP.971 */972 post: operations["exchangeInvitation"];973 delete?: never;974 options?: never;975 head?: never;976 patch?: never;977 trace?: never;978 };979 "/invitations/transaction": {980 parameters: {981 query?: never;982 header?: never;983 path?: never;984 cookie?: never;985 };986 /** Current setup transaction */987 get: operations["getInvitationTransaction"];988 put?: never;989 post?: never;990 /**991 * Abandon the setup transaction992 * @description The invitation stays consumed; a new invitation is needed.993 */994 delete: operations["abandonInvitationTransaction"];995 options?: never;996 head?: never;997 patch?: never;998 trace?: never;999 };1000 "/invitations/transaction/link": {1001 parameters: {1002 query?: never;1003 header?: never;1004 path?: never;1005 cookie?: never;1006 };1007 get?: never;1008 put?: never;1009 /**1010 * Apply the invitation to the existing target account1011 * @description Only for invitations created with `target_user_id` (`requires_existing_account=true`). Requires **both** the1012 * setup transaction and an authenticated session **of the target account** with a valid step-up, plus the1013 * explicit confirmation in the body. Applies the invited role to the account and completes the invitation.1014 * There is never an implicit merge by handle: a session of another account is `403 forbidden`.1015 */1016 post: operations["linkInvitationToAccount"];1017 delete?: never;1018 options?: never;1019 head?: never;1020 patch?: never;1021 trace?: never;1022 };1023 "/invitations/transaction/profile": {1024 parameters: {1025 query?: never;1026 header?: never;1027 path?: never;1028 cookie?: never;1029 };1030 get?: never;1031 put?: never;1032 /**1033 * Choose handle and display name for the new account1034 * @description Only accepted for the fields the invitation left open. `409 conflict` when the handle is taken.1035 */1036 post: operations["setInvitationProfile"];1037 delete?: never;1038 options?: never;1039 head?: never;1040 patch?: never;1041 trace?: never;1042 };1043 "/job-schedules": {1044 parameters: {1045 query?: never;1046 header?: never;1047 path?: never;1048 cookie?: never;1049 };1050 /** List job schedules */1051 get: operations["listJobSchedules"];1052 put?: never;1053 /** Create a recurring job schedule */1054 post: operations["createJobSchedule"];1055 delete?: never;1056 options?: never;1057 head?: never;1058 patch?: never;1059 trace?: never;1060 };1061 "/job-schedules/{id}": {1062 parameters: {1063 query?: never;1064 header?: never;1065 path: {1066 id: components["parameters"]["Id"];1067 };1068 cookie?: never;1069 };1070 get?: never;1071 put?: never;1072 post?: never;1073 /** Delete a job schedule */1074 delete: operations["deleteJobSchedule"];1075 options?: never;1076 head?: never;1077 /** Update a job schedule */1078 patch: operations["updateJobSchedule"];1079 trace?: never;1080 };1081 "/job-templates": {1082 parameters: {1083 query?: never;1084 header?: never;1085 path?: never;1086 cookie?: never;1087 };1088 /**1089 * List job templates1090 * @description Templates are declared in the local allowlist of the agents; there is no free-form job.1091 */1092 get: operations["listJobTemplates"];1093 put?: never;1094 post?: never;1095 delete?: never;1096 options?: never;1097 head?: never;1098 patch?: never;1099 trace?: never;1100 };1101 "/jobs": {1102 parameters: {1103 query?: never;1104 header?: never;1105 path?: never;1106 cookie?: never;1107 };1108 /** List jobs */1109 get: operations["listJobs"];1110 put?: never;1111 /**1112 * Submit a job1113 * @description Creates a job from a template; the run itself is carried by a `job.run` action (criticality medium, so `actions.run.medium` is also required). Idempotent through `Idempotency-Key`.1114 */1115 post: operations["createJob"];1116 delete?: never;1117 options?: never;1118 head?: never;1119 patch?: never;1120 trace?: never;1121 };1122 "/jobs/{id}": {1123 parameters: {1124 query?: never;1125 header?: never;1126 path: {1127 id: components["parameters"]["Id"];1128 };1129 cookie?: never;1130 };1131 /** Get a job */1132 get: operations["getJob"];1133 put?: never;1134 post?: never;1135 delete?: never;1136 options?: never;1137 head?: never;1138 patch?: never;1139 trace?: never;1140 };1141 "/jobs/{id}/cancel": {1142 parameters: {1143 query?: never;1144 header?: never;1145 path: {1146 id: components["parameters"]["Id"];1147 };1148 cookie?: never;1149 };1150 get?: never;1151 put?: never;1152 /**1153 * Cancel a job1154 * @description Queued jobs are cancelled immediately; running jobs get a `job.cancel` command. `409 conflict` when the job is already finished.1155 */1156 post: operations["cancelJob"];1157 delete?: never;1158 options?: never;1159 head?: never;1160 patch?: never;1161 trace?: never;1162 };1163 "/maintenance/calendar.ics": {1164 parameters: {1165 query?: never;1166 header?: never;1167 path?: never;1168 cookie?: never;1169 };1170 /**1171 * iCalendar export of the maintenance calendar1172 * @description RFC 5545 calendar (one VEVENT per window, RRULE for recurring ones). Cancelled windows are exported with `STATUS:CANCELLED`. Default range: 30 days back to 400 days ahead.1173 */1174 get: operations["exportMaintenanceCalendar"];1175 put?: never;1176 post?: never;1177 delete?: never;1178 options?: never;1179 head?: never;1180 patch?: never;1181 trace?: never;1182 };1183 "/maintenance/notes": {1184 parameters: {1185 query?: never;1186 header?: never;1187 path?: never;1188 cookie?: never;1189 };1190 /**1191 * List maintenance notes1192 * @description Pinned notes first, then most recent first. Deleted notes are never returned.1193 */1194 get: operations["listMaintenanceNotes"];1195 put?: never;1196 /**1197 * Write a maintenance note1198 * @description At least one of `window_id` and `node_id` is required. `occurrence` attaches the note to one occurrence of a recurring window.1199 */1200 post: operations["createMaintenanceNote"];1201 delete?: never;1202 options?: never;1203 head?: never;1204 patch?: never;1205 trace?: never;1206 };1207 "/maintenance/notes/{id}": {1208 parameters: {1209 query?: never;1210 header?: never;1211 path: {1212 id: components["parameters"]["Id"];1213 };1214 cookie?: never;1215 };1216 get?: never;1217 put?: never;1218 post?: never;1219 /**1220 * Delete a maintenance note1221 * @description Soft delete. Allowed to the author, or to anyone with `alerts.manage`.1222 */1223 delete: operations["deleteMaintenanceNote"];1224 options?: never;1225 head?: never;1226 /**1227 * Edit or pin a maintenance note1228 * @description Only the author can edit the body; `pinned` can be changed by anyone with `maintenance.write`.1229 */1230 patch: operations["updateMaintenanceNote"];1231 trace?: never;1232 };1233 "/maintenance/windows": {1234 parameters: {1235 query?: never;1236 header?: never;1237 path?: never;1238 cookie?: never;1239 };1240 /**1241 * Maintenance calendar for a time range1242 * @description Returns the **occurrences** intersecting `[from, to)`: recurring windows are expanded by the server (in the1243 * time zone of the window, so local wall-clock time is kept across DST changes), one item per occurrence with1244 * `occurrence_start` / `occurrence_end`. A non-recurring window yields one item. Default range: now to now + 301245 * days; maximum span 400 days. Not cursor-paginated: at most 1000 occurrences, `truncated=true` beyond.1246 */1247 get: operations["listMaintenanceWindows"];1248 put?: never;1249 /**1250 * Schedule a maintenance window1251 * @description While an occurrence is active the scheduler sets maintenance mode on the nodes in scope (`set_maintenance_mode`) and creates a linked silence (`silence_alerts`).1252 */1253 post: operations["createMaintenanceWindow"];1254 delete?: never;1255 options?: never;1256 head?: never;1257 patch?: never;1258 trace?: never;1259 };1260 "/maintenance/windows/{id}": {1261 parameters: {1262 query?: never;1263 header?: never;1264 path: {1265 id: components["parameters"]["Id"];1266 };1267 cookie?: never;1268 };1269 /** Get a maintenance window */1270 get: operations["getMaintenanceWindow"];1271 put?: never;1272 post?: never;1273 /**1274 * Cancel a maintenance window1275 * @description Sets `status=cancelled` (the window and its notes are kept). An active occurrence is ended: maintenance mode and the linked silence are lifted.1276 */1277 delete: operations["cancelMaintenanceWindow"];1278 options?: never;1279 head?: never;1280 /**1281 * Update a maintenance window1282 * @description Completed or cancelled windows cannot be modified (`409 conflict`).1283 */1284 patch: operations["updateMaintenanceWindow"];1285 trace?: never;1286 };1287 "/maintenance/windows/{id}/complete": {1288 parameters: {1289 query?: never;1290 header?: never;1291 path: {1292 id: components["parameters"]["Id"];1293 };1294 cookie?: never;1295 };1296 get?: never;1297 put?: never;1298 /**1299 * Mark a maintenance window (or its current occurrence) as done1300 * @description Ends the active occurrence early: maintenance mode and the linked silence are lifted. A non-recurring window1301 * becomes `completed`; a recurring window returns to `scheduled` for its next occurrence. An optional closing1302 * note is stored as a maintenance note on the occurrence.1303 */1304 post: operations["completeMaintenanceWindow"];1305 delete?: never;1306 options?: never;1307 head?: never;1308 patch?: never;1309 trace?: never;1310 };1311 "/me": {1312 parameters: {1313 query?: never;1314 header?: never;1315 path?: never;1316 cookie?: never;1317 };1318 /**1319 * Current user, effective permissions and session1320 * @description Also delivers the CSRF token of a cookie session (absent for bearer sessions).1321 */1322 get: operations["getMe"];1323 put?: never;1324 post?: never;1325 delete?: never;1326 options?: never;1327 head?: never;1328 /** Update the display name or locale of the current user */1329 patch: operations["updateMe"];1330 trace?: never;1331 };1332 "/me/dashboards": {1333 parameters: {1334 query?: never;1335 header?: never;1336 path?: never;1337 cookie?: never;1338 };1339 /** Dashboards of the current user */1340 get: operations["listMyDashboards"];1341 put?: never;1342 post?: never;1343 delete?: never;1344 options?: never;1345 head?: never;1346 patch?: never;1347 trace?: never;1348 };1349 "/me/dashboards/{name}": {1350 parameters: {1351 query?: never;1352 header?: never;1353 path: {1354 /** @description Dashboard name; `default` is the home dashboard. */1355 name: string;1356 };1357 cookie?: never;1358 };1359 get?: never;1360 /** Create or replace a dashboard layout */1361 put: operations["putMyDashboard"];1362 post?: never;1363 /**1364 * Delete a dashboard1365 * @description Deleting `default` restores the built-in layout.1366 */1367 delete: operations["deleteMyDashboard"];1368 options?: never;1369 head?: never;1370 patch?: never;1371 trace?: never;1372 };1373 "/me/devices": {1374 parameters: {1375 query?: never;1376 header?: never;1377 path?: never;1378 cookie?: never;1379 };1380 /** List the devices of the current user */1381 get: operations["listMyDevices"];1382 put?: never;1383 post?: never;1384 delete?: never;1385 options?: never;1386 head?: never;1387 patch?: never;1388 trace?: never;1389 };1390 "/me/devices/{id}": {1391 parameters: {1392 query?: never;1393 header?: never;1394 path: {1395 id: components["parameters"]["Id"];1396 };1397 cookie?: never;1398 };1399 get?: never;1400 put?: never;1401 post?: never;1402 /** Revoke a device and all its sessions */1403 delete: operations["revokeMyDevice"];1404 options?: never;1405 head?: never;1406 patch?: never;1407 trace?: never;1408 };1409 "/me/devices/current/push-token": {1410 parameters: {1411 query?: never;1412 header?: never;1413 path?: never;1414 cookie?: never;1415 };1416 get?: never;1417 /**1418 * Register the APNs token of the current device1419 * @description Native clients only. The token is never logged nor returned.1420 */1421 put: operations["putMyPushToken"];1422 post?: never;1423 delete?: never;1424 options?: never;1425 head?: never;1426 patch?: never;1427 trace?: never;1428 };1429 "/me/passkeys": {1430 parameters: {1431 query?: never;1432 header?: never;1433 path?: never;1434 cookie?: never;1435 };1436 /** List the passkeys of the current user */1437 get: operations["listMyPasskeys"];1438 put?: never;1439 post?: never;1440 delete?: never;1441 options?: never;1442 head?: never;1443 patch?: never;1444 trace?: never;1445 };1446 "/me/passkeys/{id}": {1447 parameters: {1448 query?: never;1449 header?: never;1450 path: {1451 id: components["parameters"]["Id"];1452 };1453 cookie?: never;1454 };1455 get?: never;1456 put?: never;1457 post?: never;1458 /**1459 * Revoke a passkey of the current user1460 * @description Refuses to delete the last active passkey of the account (`409 last_passkey`).1461 */1462 delete: operations["deleteMyPasskey"];1463 options?: never;1464 head?: never;1465 /** Rename a passkey of the current user */1466 patch: operations["updateMyPasskey"];1467 trace?: never;1468 };1469 "/me/sessions": {1470 parameters: {1471 query?: never;1472 header?: never;1473 path?: never;1474 cookie?: never;1475 };1476 /** List the active sessions of the current user */1477 get: operations["listMySessions"];1478 put?: never;1479 post?: never;1480 delete?: never;1481 options?: never;1482 head?: never;1483 patch?: never;1484 trace?: never;1485 };1486 "/me/sessions/{id}": {1487 parameters: {1488 query?: never;1489 header?: never;1490 path: {1491 id: components["parameters"]["Id"];1492 };1493 cookie?: never;1494 };1495 get?: never;1496 put?: never;1497 post?: never;1498 /** Revoke one of the sessions of the current user */1499 delete: operations["revokeMySession"];1500 options?: never;1501 head?: never;1502 patch?: never;1503 trace?: never;1504 };1505 "/metrics/catalog": {1506 parameters: {1507 query?: never;1508 header?: never;1509 path?: never;1510 cookie?: never;1511 };1512 /** Metric catalog */1513 get: operations["getMetricCatalog"];1514 put?: never;1515 post?: never;1516 delete?: never;1517 options?: never;1518 head?: never;1519 patch?: never;1520 trace?: never;1521 };1522 "/metrics/compare": {1523 parameters: {1524 query?: never;1525 header?: never;1526 path?: never;1527 cookie?: never;1528 };1529 /** Compare one metric across several nodes */1530 get: operations["compareMetrics"];1531 put?: never;1532 post?: never;1533 delete?: never;1534 options?: never;1535 head?: never;1536 patch?: never;1537 trace?: never;1538 };1539 "/models": {1540 parameters: {1541 query?: never;1542 header?: never;1543 path?: never;1544 cookie?: never;1545 };1546 /**1547 * List inference servers1548 * @description Only what is observable is reported: process (RSS, uptime), port, health of `GET /v1/models`, model of the1549 * command line, size of the model cache. `metrics_support` states explicitly, per metric family, whether the1550 * server exposes it; for `mlx_lm.server` requests, tokens per second, TTFT, latency and queue are all1551 * `unsupported` with a reason.1552 */1553 get: operations["listInferenceServers"];1554 put?: never;1555 post?: never;1556 delete?: never;1557 options?: never;1558 head?: never;1559 patch?: never;1560 trace?: never;1561 };1562 "/models/{id}": {1563 parameters: {1564 query?: never;1565 header?: never;1566 path: {1567 id: components["parameters"]["Id"];1568 };1569 cookie?: never;1570 };1571 /** Get an inference server */1572 get: operations["getInferenceServer"];1573 put?: never;1574 post?: never;1575 delete?: never;1576 options?: never;1577 head?: never;1578 patch?: never;1579 trace?: never;1580 };1581 "/network/interfaces": {1582 parameters: {1583 query?: never;1584 header?: never;1585 path?: never;1586 cookie?: never;1587 };1588 /**1589 * Network interfaces across nodes1590 * @description Addresses and MAC require `nodes.private.read`. At most 8 interfaces per node.1591 */1592 get: operations["listNetworkInterfaces"];1593 put?: never;1594 post?: never;1595 delete?: never;1596 options?: never;1597 head?: never;1598 patch?: never;1599 trace?: never;1600 };1601 "/network/topology": {1602 parameters: {1603 query?: never;1604 header?: never;1605 path?: never;1606 cookie?: never;1607 };1608 /**1609 * Observed network topology1610 * @description Vertices: cluster nodes, the LAN gateway and the WireGuard hub. Links: node to LAN gateway and node to1611 * WireGuard hub, each with the latency and loss measured by the agent of the node, or an availability flag1612 * when not measured. Nothing is inferred: a node without a WireGuard interface has no hub link.1613 * Addresses require `nodes.private.read`.1614 */1615 get: operations["getNetworkTopology"];1616 put?: never;1617 post?: never;1618 delete?: never;1619 options?: never;1620 head?: never;1621 patch?: never;1622 trace?: never;1623 };1624 "/nodes": {1625 parameters: {1626 query?: never;1627 header?: never;1628 path?: never;1629 cookie?: never;1630 };1631 /**1632 * List nodes1633 * @description Private fields (`primary_ip`) are only present with `nodes.private.read`. Retired nodes are excluded unless `retired=true`.1634 */1635 get: operations["listNodes"];1636 put?: never;1637 /**1638 * Register a node manually1639 * @description Creates a node with `registered_via=manual`, before any agent has spoken (`freshness=offline`). Expected1640 * hardware is informative and is replaced by the first agent inventory. `409 conflict` when the alias exists.1641 */1642 post: operations["createNode"];1643 delete?: never;1644 options?: never;1645 head?: never;1646 patch?: never;1647 trace?: never;1648 };1649 "/nodes/{id}": {1650 parameters: {1651 query?: never;1652 header?: never;1653 path: {1654 id: components["parameters"]["Id"];1655 };1656 cookie?: never;1657 };1658 /**1659 * Node detail1660 * @description Inventory (interfaces, volumes, CPU performance levels), agent and latest values with per-metric availability. Addresses, MAC, serial number and hardware UUID require `nodes.private.read`.1661 */1662 get: operations["getNode"];1663 put?: never;1664 post?: never;1665 /**1666 * Retire a node1667 * @description Sets `retired_at`, revokes the agent of the node and resolves its open alerts. History is kept.1668 */1669 delete: operations["retireNode"];1670 options?: never;1671 head?: never;1672 /**1673 * Update the alias, site, role, environment or tags of a node1674 * @description Maintenance mode is not set here: use the action `node.maintenance.set` or a maintenance window.1675 */1676 patch: operations["updateNode"];1677 trace?: never;1678 };1679 "/nodes/{id}/health-history": {1680 parameters: {1681 query?: never;1682 header?: never;1683 path: {1684 id: components["parameters"]["Id"];1685 };1686 cookie?: never;1687 };1688 /**1689 * Health history of a node1690 * @description Buckets of reachability (derived from received reports), maintenance and firing alerts.1691 */1692 get: operations["getNodeHealthHistory"];1693 put?: never;1694 post?: never;1695 delete?: never;1696 options?: never;1697 head?: never;1698 patch?: never;1699 trace?: never;1700 };1701 "/nodes/{id}/metrics": {1702 parameters: {1703 query?: never;1704 header?: never;1705 path: {1706 id: components["parameters"]["Id"];1707 };1708 cookie?: never;1709 };1710 /**1711 * Metric series of a node1712 * @description `resolution=auto` picks raw (10 s) up to 2 h, 1 min up to 48 h, 1 h beyond, within retention (raw 7 days,1713 * 1 min 30 days, 1 h 400 days). Points are `[ts_ms, avg, min, max]`; at raw resolution avg = min = max.1714 * Gaps are real gaps (no interpolation, no zero fill). At most 12 metrics and 5000 points per series.1715 */1716 get: operations["getNodeMetrics"];1717 put?: never;1718 post?: never;1719 delete?: never;1720 options?: never;1721 head?: never;1722 patch?: never;1723 trace?: never;1724 };1725 "/nodes/{id}/processes": {1726 parameters: {1727 query?: never;1728 header?: never;1729 path: {1730 id: components["parameters"]["Id"];1731 };1732 cookie?: never;1733 };1734 /**1735 * Top processes of a node1736 * @description Last top-N snapshot reported by the agent (at most 15 processes). Command lines are redacted by the agent.1737 */1738 get: operations["listNodeProcesses"];1739 put?: never;1740 post?: never;1741 delete?: never;1742 options?: never;1743 head?: never;1744 patch?: never;1745 trace?: never;1746 };1747 "/nodes/{id}/services": {1748 parameters: {1749 query?: never;1750 header?: never;1751 path: {1752 id: components["parameters"]["Id"];1753 };1754 cookie?: never;1755 };1756 /** Services of a node */1757 get: operations["listNodeServices"];1758 put?: never;1759 post?: never;1760 delete?: never;1761 options?: never;1762 head?: never;1763 patch?: never;1764 trace?: never;1765 };1766 "/permissions": {1767 parameters: {1768 query?: never;1769 header?: never;1770 path?: never;1771 cookie?: never;1772 };1773 /** Permission catalog and role defaults */1774 get: operations["getPermissionCatalog"];1775 put?: never;1776 post?: never;1777 delete?: never;1778 options?: never;1779 head?: never;1780 patch?: never;1781 trace?: never;1782 };1783 "/policy-grants": {1784 parameters: {1785 query?: never;1786 header?: never;1787 path?: never;1788 cookie?: never;1789 };1790 /** List policy grants */1791 get: operations["listPolicyGrants"];1792 put?: never;1793 /**1794 * Create an allow / deny grant1795 * @description Deny wins over allow. An admin cannot grant a permission it does not hold itself, nor target an owner.1796 */1797 post: operations["createPolicyGrant"];1798 delete?: never;1799 options?: never;1800 head?: never;1801 patch?: never;1802 trace?: never;1803 };1804 "/policy-grants/{id}": {1805 parameters: {1806 query?: never;1807 header?: never;1808 path: {1809 id: components["parameters"]["Id"];1810 };1811 cookie?: never;1812 };1813 get?: never;1814 put?: never;1815 post?: never;1816 /** Delete a grant */1817 delete: operations["deletePolicyGrant"];1818 options?: never;1819 head?: never;1820 patch?: never;1821 trace?: never;1822 };1823 "/search": {1824 parameters: {1825 query?: never;1826 header?: never;1827 path?: never;1828 cookie?: never;1829 };1830 /**1831 * Universal search1832 * @description Searches nodes, services, alerts, actions, incidents, jobs, inference servers, maintenance windows and notes. Only kinds the caller can read are searched.1833 */1834 get: operations["search"];1835 put?: never;1836 post?: never;1837 delete?: never;1838 options?: never;1839 head?: never;1840 patch?: never;1841 trace?: never;1842 };1843 "/services": {1844 parameters: {1845 query?: never;1846 header?: never;1847 path?: never;1848 cookie?: never;1849 };1850 /** List services */1851 get: operations["listServices"];1852 put?: never;1853 post?: never;1854 delete?: never;1855 options?: never;1856 head?: never;1857 patch?: never;1858 trace?: never;1859 };1860 "/services/{id}": {1861 parameters: {1862 query?: never;1863 header?: never;1864 path: {1865 id: components["parameters"]["Id"];1866 };1867 cookie?: never;1868 };1869 /** Get a service */1870 get: operations["getService"];1871 put?: never;1872 post?: never;1873 delete?: never;1874 options?: never;1875 head?: never;1876 /**1877 * Set the managed flag or the public URL of a service1878 * @description `managed=true` puts the service on the server allowlist for start / stop / restart actions; the agent must also allow it locally.1879 */1880 patch: operations["updateService"];1881 trace?: never;1882 };1883 "/services/{id}/history": {1884 parameters: {1885 query?: never;1886 header?: never;1887 path: {1888 id: components["parameters"]["Id"];1889 };1890 cookie?: never;1891 };1892 /**1893 * Timeline of a service1894 * @description Restarts, state changes, actions and deployments, most recent first.1895 */1896 get: operations["getServiceHistory"];1897 put?: never;1898 post?: never;1899 delete?: never;1900 options?: never;1901 head?: never;1902 patch?: never;1903 trace?: never;1904 };1905 "/sessions/{id}": {1906 parameters: {1907 query?: never;1908 header?: never;1909 path: {1910 id: components["parameters"]["Id"];1911 };1912 cookie?: never;1913 };1914 get?: never;1915 put?: never;1916 post?: never;1917 /** Revoke any session */1918 delete: operations["revokeSession"];1919 options?: never;1920 head?: never;1921 patch?: never;1922 trace?: never;1923 };1924 "/settings": {1925 parameters: {1926 query?: never;1927 header?: never;1928 path?: never;1929 cookie?: never;1930 };1931 /** List settings */1932 get: operations["listSettings"];1933 put?: never;1934 post?: never;1935 delete?: never;1936 options?: never;1937 head?: never;1938 patch?: never;1939 trace?: never;1940 };1941 "/settings/{key}": {1942 parameters: {1943 query?: never;1944 header?: never;1945 path: {1946 /** @description Setting key, for example `retention.raw_days`. */1947 key: string;1948 };1949 cookie?: never;1950 };1951 get?: never;1952 /**1953 * Set a setting1954 * @description Unknown keys are `404`. The key `orchestrator.frozen` (emergency stop) can only be changed by an owner.1955 */1956 put: operations["putSetting"];1957 post?: never;1958 delete?: never;1959 options?: never;1960 head?: never;1961 patch?: never;1962 trace?: never;1963 };1964 "/silences": {1965 parameters: {1966 query?: never;1967 header?: never;1968 path?: never;1969 cookie?: never;1970 };1971 /** List silences */1972 get: operations["listSilences"];1973 put?: never;1974 /**1975 * Create a silence1976 * @description A silence suppresses notifications; alerts are still evaluated and recorded with `suppressed_by=silence`.1977 */1978 post: operations["createSilence"];1979 delete?: never;1980 options?: never;1981 head?: never;1982 patch?: never;1983 trace?: never;1984 };1985 "/silences/{id}": {1986 parameters: {1987 query?: never;1988 header?: never;1989 path: {1990 id: components["parameters"]["Id"];1991 };1992 cookie?: never;1993 };1994 get?: never;1995 put?: never;1996 post?: never;1997 /**1998 * Delete (end) a silence1999 * @description Silences owned by a maintenance window cannot be deleted here (`409 conflict`).2000 */2001 delete: operations["deleteSilence"];2002 options?: never;2003 head?: never;2004 patch?: never;2005 trace?: never;2006 };2007 "/storage/backups": {2008 parameters: {2009 query?: never;2010 header?: never;2011 path?: never;2012 cookie?: never;2013 };2014 /**2015 * Observed backups2016 * @description A backup is never reported `ok` without evidence: `last_status` is `unknown` until an agent has observed a run.2017 */2018 get: operations["listBackups"];2019 put?: never;2020 post?: never;2021 delete?: never;2022 options?: never;2023 head?: never;2024 patch?: never;2025 trace?: never;2026 };2027 "/storage/nas": {2028 parameters: {2029 query?: never;2030 header?: never;2031 path?: never;2032 cookie?: never;2033 };2034 /**2035 * List NAS targets2036 * @description Registered manually; state is the one observed by the agents. Capacity is absent when not observed. `host` requires `nodes.private.read`.2037 */2038 get: operations["listNasTargets"];2039 put?: never;2040 /** Register a NAS target */2041 post: operations["createNasTarget"];2042 delete?: never;2043 options?: never;2044 head?: never;2045 patch?: never;2046 trace?: never;2047 };2048 "/storage/nas/{id}": {2049 parameters: {2050 query?: never;2051 header?: never;2052 path: {2053 id: components["parameters"]["Id"];2054 };2055 cookie?: never;2056 };2057 get?: never;2058 put?: never;2059 post?: never;2060 /** Remove a NAS target */2061 delete: operations["deleteNasTarget"];2062 options?: never;2063 head?: never;2064 patch?: never;2065 trace?: never;2066 };2067 "/storage/volumes": {2068 parameters: {2069 query?: never;2070 header?: never;2071 path?: never;2072 cookie?: never;2073 };2074 /** Volumes across nodes */2075 get: operations["listVolumes"];2076 put?: never;2077 post?: never;2078 delete?: never;2079 options?: never;2080 head?: never;2081 patch?: never;2082 trace?: never;2083 };2084 "/users": {2085 parameters: {2086 query?: never;2087 header?: never;2088 path?: never;2089 cookie?: never;2090 };2091 /** List users */2092 get: operations["listUsers"];2093 put?: never;2094 post?: never;2095 delete?: never;2096 options?: never;2097 head?: never;2098 patch?: never;2099 trace?: never;2100 };2101 "/users/{id}": {2102 parameters: {2103 query?: never;2104 header?: never;2105 path: {2106 id: components["parameters"]["Id"];2107 };2108 cookie?: never;2109 };2110 /** Get a user */2111 get: operations["getUser"];2112 put?: never;2113 post?: never;2114 delete?: never;2115 options?: never;2116 head?: never;2117 /**2118 * Change the role of a user, or disable / enable the account2119 * @description An admin can neither modify an owner nor grant the `owner` role. Disabling a user revokes all its sessions.2120 * Demoting or disabling the last enabled owner is `409 conflict`.2121 */2122 patch: operations["updateUser"];2123 trace?: never;2124 };2125 "/users/{id}/devices": {2126 parameters: {2127 query?: never;2128 header?: never;2129 path: {2130 id: components["parameters"]["Id"];2131 };2132 cookie?: never;2133 };2134 /** List the devices of a user */2135 get: operations["listUserDevices"];2136 put?: never;2137 post?: never;2138 delete?: never;2139 options?: never;2140 head?: never;2141 patch?: never;2142 trace?: never;2143 };2144 "/users/{id}/passkeys": {2145 parameters: {2146 query?: never;2147 header?: never;2148 path: {2149 id: components["parameters"]["Id"];2150 };2151 cookie?: never;2152 };2153 /** List the passkeys of a user */2154 get: operations["listUserPasskeys"];2155 put?: never;2156 post?: never;2157 delete?: never;2158 options?: never;2159 head?: never;2160 patch?: never;2161 trace?: never;2162 };2163 "/users/{id}/passkeys/{passkeyId}": {2164 parameters: {2165 query?: never;2166 header?: never;2167 path: {2168 id: components["parameters"]["Id"];2169 passkeyId: string;2170 };2171 cookie?: never;2172 };2173 get?: never;2174 put?: never;2175 post?: never;2176 /**2177 * Revoke a passkey of a user2178 * @description Refuses to revoke the last active passkey (`409 last_passkey`); disable the account instead.2179 */2180 delete: operations["revokeUserPasskey"];2181 options?: never;2182 head?: never;2183 patch?: never;2184 trace?: never;2185 };2186 "/users/{id}/sessions": {2187 parameters: {2188 query?: never;2189 header?: never;2190 path: {2191 id: components["parameters"]["Id"];2192 };2193 cookie?: never;2194 };2195 /** List the active sessions of a user */2196 get: operations["listUserSessions"];2197 put?: never;2198 post?: never;2199 delete?: never;2200 options?: never;2201 head?: never;2202 patch?: never;2203 trace?: never;2204 };2205 "/version": {2206 parameters: {2207 query?: never;2208 header?: never;2209 path?: never;2210 cookie?: never;2211 };2212 /**2213 * API and server version2214 * @description Unauthenticated, so that clients can check compatibility before signing in. Only version identifiers are disclosed.2215 */2216 get: operations["getVersion"];2217 put?: never;2218 post?: never;2219 delete?: never;2220 options?: never;2221 head?: never;2222 patch?: never;2223 trace?: never;2224 };2225}2226export type webhooks = Record<string, never>;2227export interface components {2228 schemas: {2229 Action: {2230 approval_required: boolean;2231 /** Format: date-time */2232 approved_at?: string;2233 /** Format: uuid */2234 approved_by?: string;2235 approved_by_display_name?: string;2236 /** Format: date-time */2237 cancel_requested_at?: string;2238 /** Format: uuid */2239 correlation_id: string;2240 /** Format: date-time */2241 created_at: string;2242 criticality: components["schemas"]["Criticality"];2243 /** Format: date-time */2244 deadline_at?: string;2245 error_code?: string;2246 error_message?: string;2247 /** Format: date-time */2248 finished_at?: string;2249 /** Format: uuid */2250 id: string;2251 /** Format: uuid */2252 job_id?: string;2253 justification: string;2254 node_alias?: string;2255 /** Format: uuid */2256 node_id?: string;2257 /** @description True when the command was delivered but no result came back before the deadline: the effect on the node is unknown and the command is never re-sent. */2258 outcome_unknown: boolean;2259 params: {2260 [key: string]: unknown;2261 };2262 /** Format: date-time */2263 queued_at?: string;2264 rejection_reason?: string;2265 /**2266 * Format: uuid2267 * @description Absent for actions created by the system (scheduler).2268 */2269 requested_by?: string;2270 requested_by_display_name?: string;2271 /** @description `api`, `scheduler` or `cli`. */2272 requested_via: string;2273 result?: {2274 [key: string]: unknown;2275 };2276 /** Format: date-time */2277 started_at?: string;2278 state: components["schemas"]["ActionState"];2279 target: components["schemas"]["ActionTarget"];2280 /** @description Alias or name of the target at request time. */2281 target_label?: string;2282 timeout_s: number;2283 type: string;2284 };2285 /** @description Topic `action.changed`: an action was created or changed state. */2286 ActionChangedEvent: {2287 /** Format: uuid */2288 action_id: string;2289 /** Format: uuid */2290 node_id?: string;2291 outcome_unknown: boolean;2292 /** Format: uuid */2293 requested_by?: string;2294 state: components["schemas"]["ActionState"];2295 target: components["schemas"]["ActionTarget"];2296 type: string;2297 };2298 ActionDetail: {2299 action: components["schemas"]["Action"];2300 events: components["schemas"]["ActionEvent"][];2301 };2302 ActionEvent: {2303 data: string;2304 /** Format: int64 */2305 id: number;2306 /** @description `state` (data = new state), `approval`, `precheck`, `output` (data = redacted text chunk) or `note` (open list). */2307 kind: string;2308 /**2309 * @description Output events only.2310 * @enum {string}2311 */2312 stream?: "stdout" | "stderr";2313 /** Format: date-time */2314 ts: string;2315 };2316 ActionList: {2317 items: components["schemas"]["Action"][];2318 next_cursor?: string;2319 };2320 ActionOutput: {2321 /** @description True when the action is finished and every chunk has been returned. */2322 complete: boolean;2323 items: components["schemas"]["ActionEvent"][];2324 /**2325 * Format: int642326 * @description Value to pass as `after` to get what follows.2327 */2328 next_after: number;2329 /** @description True when the agent stopped capturing output at its line or byte cap. */2330 truncated?: boolean;2331 };2332 /** @description Topic `action.output`: one redacted output chunk; `event_id` continues the `after` cursor of the output operation. */2333 ActionOutputEvent: {2334 /** Format: uuid */2335 action_id: string;2336 data: string;2337 /** Format: int64 */2338 event_id: number;2339 /** @enum {string} */2340 stream?: "stdout" | "stderr";2341 /** Format: date-time */2342 ts: string;2343 };2344 /** @enum {string} */2345 ActionState: "pending_approval" | "queued" | "dispatched" | "running" | "succeeded" | "failed" | "cancelled" | "timed_out" | "rejected" | "expired";2346 ActionTarget: {2347 /** Format: uuid */2348 id: string;2349 kind: components["schemas"]["ActionTargetKind"];2350 };2351 /** @enum {string} */2352 ActionTargetKind: "node" | "service" | "job" | "inference_server";2353 ActionType: {2354 /** @description False for types not enabled in this version. */2355 available: boolean;2356 criticality: components["schemas"]["Criticality"];2357 description: string;2358 /** @description Additional permissions, for example `logs.read` for `service.logs.tail`. */2359 extra_permissions?: string[];2360 /** @enum {string} */2361 lock_scope: "node" | "service" | "job" | "none";2362 /** @description JSON Schema (draft 2020-12) of `params`. */2363 params_schema: {2364 [key: string]: unknown;2365 };2366 /** @description Permission required to request the action. */2367 permission: string;2368 /** @description A second person holding `actions.approve` must approve. */2369 requires_approval: boolean;2370 /** @description The request must carry `confirm` = alias of the target node (or name of the target service). */2371 requires_confirmation: boolean;2372 requires_justification: boolean;2373 requires_step_up: boolean;2374 target_kinds: components["schemas"]["ActionTargetKind"][];2375 timeout_s: number;2376 title: string;2377 /** @description For example `service.restart`. */2378 type: string;2379 unavailable_reason?: string;2380 };2381 ActionTypeList: {2382 items: components["schemas"]["ActionType"][];2383 };2384 ActivityItem: {2385 actor_display_name?: string;2386 /** @description Opaque id of the item. */2387 id: string;2388 kind: components["schemas"]["ActivityKind"];2389 outcome?: components["schemas"]["AuditOutcome"];2390 summary: string;2391 target_id?: string;2392 target_kind?: string;2393 target_label?: string;2394 /** Format: date-time */2395 ts: string;2396 };2397 /** @enum {string} */2398 ActivityKind: "action" | "alert_ack" | "alert_resolve" | "incident" | "maintenance" | "maintenance_note" | "login";2399 ActivityList: {2400 items: components["schemas"]["ActivityItem"][];2401 next_cursor?: string;2402 };2403 AdminStatus: {2404 agents_connected?: number;2405 backup: components["schemas"]["BackupStatus"];2406 commit?: string;2407 database: components["schemas"]["ComponentStatus"];2408 /** @description Emergency stop engaged (`orchestrator.frozen`). */2409 frozen: boolean;2410 /** Format: date-time */2411 generated_at: string;2412 ingest: components["schemas"]["ComponentStatus"];2413 /**2414 * Format: date-time2415 * @description Last telemetry report ingested from any agent.2416 */2417 last_report_at?: string;2418 orchestrator: components["schemas"]["ComponentStatus"];2419 sse_clients?: number;2420 version: string;2421 };2422 Agent: {2423 /** @description Action types the agent accepts locally. */2424 capabilities: string[];2425 /** @description Hex SHA-256 of the client certificate. */2426 cert_fingerprint_sha256: string;2427 /** Format: date-time */2428 cert_not_after: string;2429 cert_serial: string;2430 /** Format: date-time */2431 enrolled_at: string;2432 freshness: components["schemas"]["Freshness"];2433 /** Format: uuid */2434 id: string;2435 /** Format: date-time */2436 last_seen_at?: string;2437 node_alias: string;2438 /** Format: uuid */2439 node_id: string;2440 os: string;2441 overhead?: components["schemas"]["AgentOverhead"];2442 /** Format: date-time */2443 revoked_at?: string;2444 revoked_reason?: string;2445 version: string;2446 };2447 AgentList: {2448 items: components["schemas"]["Agent"][];2449 next_cursor?: string;2450 };2451 /** @description Resource use of the agent process itself. */2452 AgentOverhead: {2453 cpu_pct?: number;2454 /** Format: int64 */2455 rss_bytes?: number;2456 };2457 Alert: {2458 /** Format: date-time */2459 acknowledged_at?: string;2460 /** Format: uuid */2461 acknowledged_by?: string;2462 acknowledged_by_display_name?: string;2463 fingerprint: string;2464 /** Format: date-time */2465 fired_at?: string;2466 flap_count: number;2467 /** Format: uuid */2468 id: string;2469 /** Format: uuid */2470 incident_id?: string;2471 label: string;2472 /** Format: date-time */2473 last_eval_at: string;2474 last_value?: number;2475 node_alias?: string;2476 /** Format: uuid */2477 node_id?: string;2478 /** Format: date-time */2479 resolved_at?: string;2480 /** Format: uuid */2481 rule_id: string;2482 rule_name: string;2483 severity: components["schemas"]["Severity"];2484 /** Format: date-time */2485 started_at: string;2486 state: components["schemas"]["AlertState"];2487 summary: string;2488 /**2489 * @description Present when notifications are suppressed.2490 * @enum {string}2491 */2492 suppressed_by?: "silence" | "maintenance";2493 };2494 /** @description Topic `alert.changed`. */2495 AlertChangedEvent: {2496 /** Format: uuid */2497 alert_id: string;2498 /** Format: uuid */2499 incident_id?: string;2500 /** Format: uuid */2501 node_id?: string;2502 /** Format: uuid */2503 rule_id: string;2504 severity: components["schemas"]["Severity"];2505 state: components["schemas"]["AlertState"];2506 summary: string;2507 suppressed?: boolean;2508 };2509 AlertDetail: {2510 alert: components["schemas"]["Alert"];2511 timeline: components["schemas"]["TimelineEvent"][];2512 };2513 AlertFiringInterval: {2514 /**2515 * Format: date-time2516 * @description Absent when the rule would still be firing at the end of the window.2517 */2518 ended_at?: string;2519 label: string;2520 node_alias: string;2521 /** Format: uuid */2522 node_id: string;2523 peak_value?: number;2524 /** Format: date-time */2525 started_at: string;2526 };2527 AlertList: {2528 items: components["schemas"]["Alert"][];2529 next_cursor?: string;2530 };2531 /**2532 * @description Comparison of the metric with the threshold: greater than, greater or equal, less than, less or equal.2533 * @enum {string}2534 */2535 AlertOp: "gt" | "gte" | "lt" | "lte";2536 AlertRule: {2537 builtin: boolean;2538 /** @description The condition must be clear this long before resolving. */2539 clear_seconds: number;2540 /** @description Hysteresis; defaults to `threshold`. */2541 clear_threshold?: number;2542 /** Format: date-time */2543 created_at: string;2544 /** Format: uuid */2545 created_by?: string;2546 description: string;2547 enabled: boolean;2548 /** @description The condition must hold this long before firing. */2549 for_seconds: number;2550 /** Format: uuid */2551 id: string;2552 kind: components["schemas"]["AlertRuleKind"];2553 /** @description Threshold rules on labeled metrics: exact label or `*`. */2554 label_match?: string;2555 /** @description Threshold rules. */2556 metric?: string;2557 name: string;2558 notify: boolean;2559 op?: components["schemas"]["AlertOp"];2560 scope: components["schemas"]["AlertScope"];2561 severity: components["schemas"]["Severity"];2562 threshold?: number;2563 /** Format: date-time */2564 updated_at: string;2565 };2566 /** @description `threshold` rules require `metric`, `op` and `threshold`; `metric` is a catalog metric, a server-derived one (`disk.used_pct`, `swap.used_pct`) or a server-computed one (`mcc.agent.cert_days_left`, `mcc.audit.denied_10m`, `mcc.auth.new_device_login`). `absence` rules fire when a node stops reporting for `for_seconds`. `service_state` rules fire when a managed service is `errored` or `stopped` (`metric` may restrict the states, for example `errored`; `label_match` may name one service as `manager:name`). */2567 AlertRuleInput: {2568 /** @default 120 */2569 clear_seconds: number;2570 clear_threshold?: number;2571 description?: string;2572 /** @default true */2573 enabled: boolean;2574 /** @default 300 */2575 for_seconds: number;2576 kind: components["schemas"]["AlertRuleKind"];2577 label_match?: string;2578 metric?: string;2579 name: string;2580 /** @default true */2581 notify: boolean;2582 op?: components["schemas"]["AlertOp"];2583 scope?: components["schemas"]["AlertScope"];2584 severity?: components["schemas"]["Severity"];2585 threshold?: number;2586 };2587 /** @enum {string} */2588 AlertRuleKind: "threshold" | "absence" | "service_state";2589 AlertRuleList: {2590 items: components["schemas"]["AlertRule"][];2591 next_cursor?: string;2592 };2593 AlertRuleValidation: {2594 /** Format: date-time */2595 evaluated_from: string;2596 /** Format: date-time */2597 evaluated_to: string;2598 intervals: components["schemas"]["AlertFiringInterval"][];2599 nodes_evaluated: number;2600 /** @description Nodes in scope for which the metric has no data in the window. */2601 nodes_without_data?: number;2602 resolution: components["schemas"]["Resolution"];2603 total_firings: number;2604 /** @description For example "evaluated on 1-minute aggregates: spikes shorter than a minute are not visible". */2605 warnings: string[];2606 };2607 /** @description Exactly one form: `{"all": true}`, `{"node_ids": [...]}` or `{"tags": [...]}`. */2608 AlertScope: {2609 all?: boolean;2610 node_ids?: string[];2611 tags?: string[];2612 };2613 /** @enum {string} */2614 AlertState: "pending" | "firing" | "acknowledged" | "resolved";2615 AlertTransitionRequest: {2616 comment?: string;2617 };2618 ApproveActionRequest: {2619 comment?: string;2620 };2621 /** @description Topic `audit.appended` (only with `audit.read`). */2622 AuditAppendedEvent: {2623 action: string;2624 actor_label: string;2625 outcome: components["schemas"]["AuditOutcome"];2626 /** Format: int64 */2627 seq: number;2628 target_id?: string;2629 target_kind?: string;2630 /** Format: date-time */2631 ts: string;2632 };2633 AuditEntry: {2634 /** @description For example `auth.login`, `action.create` or `invitation.create`. */2635 action: string;2636 /** Format: uuid */2637 actor_id?: string;2638 /** @enum {string} */2639 actor_kind: "user" | "agent" | "system" | "cli";2640 actor_label: string;2641 /** Format: uuid */2642 correlation_id: string;2643 detail: string;2644 /** Format: uuid */2645 device_id?: string;2646 /** @description Hex SHA-256 of this entry chained on `prev_hash`. */2647 hash: string;2648 ip?: string;2649 outcome: components["schemas"]["AuditOutcome"];2650 /** @description Allowlisted non-sensitive parameters only. */2651 params: {2652 [key: string]: unknown;2653 };2654 /** @description Hex SHA-256 of the previous entry. */2655 prev_hash: string;2656 /** Format: int64 */2657 seq: number;2658 /** Format: uuid */2659 session_id?: string;2660 target_id?: string;2661 target_kind?: string;2662 /** Format: date-time */2663 ts: string;2664 };2665 AuditList: {2666 items: components["schemas"]["AuditEntry"][];2667 next_cursor?: string;2668 };2669 /** @enum {string} */2670 AuditOutcome: "success" | "denied" | "failure";2671 AuditVerification: {2672 /** Format: int64 */2673 checked_entries: number;2674 /** @description Identifier of the key that signs audit exports. */2675 export_key_id?: string;2676 /** @description Base64 Ed25519 public key that signs audit exports (`mccctl audit-verify-export --pubkey`). */2677 export_public_key?: string;2678 /**2679 * Format: int642680 * @description Present when `ok` is false.2681 */2682 first_broken_seq?: number;2683 /** Format: int64 */2684 first_seq?: number;2685 /** @description Hex hash of the last entry. */2686 head_hash?: string;2687 /** Format: int64 */2688 last_seq?: number;2689 ok: boolean;2690 /** @description Present when `ok` is false. */2691 reason?: string;2692 /** Format: date-time */2693 verified_at: string;2694 };2695 AuthenticationFinishRequest: {2696 /** Format: uuid */2697 challenge_id: string;2698 client: components["schemas"]["ClientInfo"];2699 /** @description PublicKeyCredential JSON (assertion) produced by the platform API. */2700 credential: {2701 [key: string]: unknown;2702 };2703 };2704 AuthResult: {2705 /**2706 * Format: date-time2707 * @description Native clients only.2708 */2709 access_expires_at?: string;2710 /** @description Native clients only. Opaque; valid until `access_expires_at`. */2711 access_token?: string;2712 /** @description Web clients only. */2713 csrf_token?: string;2714 /**2715 * Format: uuid2716 * @description Device this session is bound to. Native clients store it and send it back as `client.device_id`.2717 */2718 device_id: string;2719 /**2720 * Format: date-time2721 * @description Native clients only.2722 */2723 refresh_expires_at?: string;2724 /** @description Native clients only. Rotating and device-bound; store in the Keychain. */2725 refresh_token?: string;2726 session: components["schemas"]["Session"];2727 user: components["schemas"]["User"];2728 };2729 /**2730 * @description State of a metric. `unsupported`: cannot be measured on this platform; `permission_denied`: needs a privilege the agent does not have; `unavailable`: temporarily not measurable; `stale` / `offline`: follows the freshness of the node.2731 * @enum {string}2732 */2733 Availability: "available" | "unavailable" | "unsupported" | "permission_denied" | "stale" | "offline";2734 Backup: {2735 detail: string;2736 /** Format: uuid */2737 id: string;2738 /** @description For example `postgres`, `app` or `mcc`. */2739 kind: string;2740 /** Format: date-time */2741 last_run_at?: string;2742 /** @enum {string} */2743 last_status: "ok" | "failed" | "unknown";2744 /** Format: date-time */2745 last_success_at?: string;2746 name: string;2747 node_alias?: string;2748 /** Format: uuid */2749 node_id?: string;2750 /** Format: date-time */2751 observed_at?: string;2752 /** Format: int64 */2753 size_bytes?: number;2754 };2755 BackupList: {2756 items: components["schemas"]["Backup"][];2757 };2758 BackupStatus: {2759 detail?: string;2760 /** Format: date-time */2761 last_run_at?: string;2762 /** Format: date-time */2763 last_success_at?: string;2764 /**2765 * @description `unknown` until a backup run has been observed.2766 * @enum {string}2767 */2768 status: "ok" | "failed" | "unknown";2769 };2770 BackupSummary: {2771 failed: number;2772 /** Format: date-time */2773 last_success_at?: string;2774 ok: number;2775 total: number;2776 unknown: number;2777 };2778 CapacityTotal: {2779 /** @description Number of nodes contributing to the total. */2780 coverage: number;2781 /**2782 * Format: int642783 * @description Sum over the reporting nodes (cores or bytes).2784 */2785 total: number;2786 /**2787 * Format: int642788 * @description Absent when not applicable (CPU cores) or when no node reports usage.2789 */2790 used?: number;2791 };2792 ClientInfo: {2793 app_version?: string;2794 /**2795 * Format: uuid2796 * @description Identifier returned as `AuthResult.device_id` by a previous sign-in on this device (native: kept in the Keychain; web: the server uses the `__Host-mcc_device` cookie instead). It is reused only if it belongs to the authenticated user, has the same kind and is not revoked; otherwise a new device is created.2797 */2798 device_id?: string;2799 kind: components["schemas"]["ClientKind"];2800 /** @description Device label shown in the device list, for example "MacBook Pro of Erika". */2801 label?: string;2802 model?: string;2803 os_version?: string;2804 };2805 /**2806 * @description Kind of client and of device.2807 * @enum {string}2808 */2809 ClientKind: "web" | "macos" | "ios";2810 ClusterCapacity: {2811 cpu_cores: components["schemas"]["CapacityTotal"];2812 memory: components["schemas"]["CapacityTotal"];2813 storage: components["schemas"]["CapacityTotal"];2814 };2815 ClusterOverview: {2816 alerts?: components["schemas"]["SeverityCounts"];2817 backups?: components["schemas"]["BackupSummary"];2818 capacity: components["schemas"]["ClusterCapacity"];2819 /** Format: date-time */2820 generated_at: string;2821 jobs?: components["schemas"]["JobCounts"];2822 models?: components["schemas"]["ModelCounts"];2823 nas?: components["schemas"]["NasSummary"];2824 nodes: components["schemas"]["NodeCounts"];2825 open_incidents?: number;2826 /** @description Last 10 actions; requires `actions.read`. */2827 recent_actions?: components["schemas"]["Action"][];2828 services?: components["schemas"]["ServiceCounts"];2829 };2830 CommentRequest: {2831 body: string;2832 };2833 CompleteMaintenanceWindowRequest: {2834 /** @description Closing note stored as a maintenance note. */2835 note?: string;2836 };2837 ComponentStatus: {2838 detail?: string;2839 /**2840 * Format: date-time2841 * @description Last heartbeat written by the component.2842 */2843 heartbeat_at?: string;2844 latency_ms?: number;2845 /** @enum {string} */2846 status: "ok" | "degraded" | "down" | "unknown";2847 };2848 CpuPerfLevel: {2849 cores: number;2850 /** @description Name reported by the system (`Performance`, `Efficiency`, `Super`...); never assumed. */2851 name: string;2852 };2853 CreateActionRequest: {2854 /** @description Confirmation text typed by the user; must equal the alias of the target. Checked by the server. */2855 confirm?: string;2856 justification?: string;2857 /**2858 * @description Explicitly run the action although the node is in maintenance mode (otherwise `422 node_in_maintenance`). Recorded in the audit log.2859 * @default false2860 */2861 override_maintenance: boolean;2862 /** @description Validated against `params_schema` of the type. Defaults to an empty object. */2863 params?: {2864 [key: string]: unknown;2865 };2866 target: components["schemas"]["ActionTarget"];2867 type: string;2868 };2869 CreateEnrollmentTokenRequest: {2870 /** @description Alias of the node; the node is created at enrollment when unknown. */2871 node_alias: string;2872 node_kind: components["schemas"]["NodeKind"];2873 /** @default 15 */2874 ttl_minutes: number;2875 };2876 CreateIncidentRequest: {2877 alert_ids?: string[];2878 /** Format: uuid */2879 owner_id?: string;2880 severity: components["schemas"]["Severity"];2881 summary?: string;2882 title: string;2883 };2884 CreateInvitationRequest: {2885 display_name?: string;2886 /** @description Proposed handle; left to the invitee when omitted. */2887 handle?: string;2888 note?: string;2889 role: components["schemas"]["UserRole"];2890 /**2891 * Format: uuid2892 * @description Existing account to link the invitation to.2893 */2894 target_user_id?: string;2895 /** @default 15 */2896 ttl_minutes: number;2897 };2898 CreateJobRequest: {2899 depends_on?: string[];2900 /** @default 1 */2901 max_attempts: number;2902 params?: {2903 [key: string]: unknown;2904 };2905 placement?: components["schemas"]["JobPlacement"];2906 template: string;2907 };2908 CreateJobScheduleRequest: {2909 /** @default true */2910 enabled: boolean;2911 every_seconds: number;2912 /**2913 * Format: date-time2914 * @description Defaults to now + `every_seconds`.2915 */2916 first_run_at?: string;2917 name: string;2918 params?: {2919 [key: string]: unknown;2920 };2921 placement?: components["schemas"]["JobPlacement"];2922 template: string;2923 };2924 CreateMaintenanceNoteRequest: {2925 body: string;2926 /** Format: uuid */2927 node_id?: string;2928 /** Format: date-time */2929 occurrence?: string;2930 /** @default false */2931 pinned: boolean;2932 /** Format: uuid */2933 window_id?: string;2934 };2935 CreateMaintenanceWindowRequest: {2936 category?: components["schemas"]["MaintenanceCategory"];2937 description?: string;2938 /** Format: date-time */2939 ends_at: string;2940 recurrence?: components["schemas"]["MaintenanceRecurrence"];2941 /** Format: date-time */2942 recurrence_until?: string;2943 scope: components["schemas"]["MaintenanceScope"];2944 /** @default true */2945 set_maintenance_mode: boolean;2946 /** @default true */2947 silence_alerts: boolean;2948 /** Format: date-time */2949 starts_at: string;2950 /** @default America/Toronto */2951 timezone: string;2952 title: string;2953 };2954 CreateNasTargetRequest: {2955 /** @description IPv4 or IPv6 address. */2956 host: string;2957 name: string;2958 note?: string;2959 /**2960 * @default smb2961 * @enum {string}2962 */2963 protocol: "smb" | "nfs" | "afp";2964 share?: string;2965 };2966 CreateNodeRequest: {2967 alias: string;2968 environment?: string;2969 expected?: components["schemas"]["ExpectedHardware"];2970 kind: components["schemas"]["NodeKind"];2971 role?: string;2972 site?: string;2973 tags?: string[];2974 };2975 CreatePolicyGrantRequest: {2976 effect: components["schemas"]["GrantEffect"];2977 permission: string;2978 resource_id?: string;2979 /** @enum {string} */2980 resource_kind?: "node" | "service" | "site" | "tag";2981 subject: string;2982 subject_kind: components["schemas"]["GrantSubjectKind"];2983 };2984 CreateSilenceRequest: {2985 /** Format: date-time */2986 ends_at: string;2987 reason: string;2988 /** Format: uuid */2989 rule_id?: string;2990 scope: components["schemas"]["AlertScope"];2991 /**2992 * Format: date-time2993 * @description Defaults to now.2994 */2995 starts_at?: string;2996 };2997 /** @enum {string} */2998 Criticality: "low" | "medium" | "high" | "critical";2999 Dashboard: {3000 layout: components["schemas"]["DashboardWidget"][];3001 name: string;3002 /** Format: date-time */3003 updated_at: string;3004 };3005 DashboardList: {3006 items: components["schemas"]["Dashboard"][];3007 };3008 DashboardWidget: {3009 config: {3010 [key: string]: unknown;3011 };3012 h: number;3013 id: string;3014 /** @description Widget type known to the clients, for example `metric.chart`. Unknown types are kept and rendered as a placeholder. */3015 type: string;3016 w: number;3017 x: number;3018 y: number;3019 };3020 Device: {3021 app_version: string;3022 /** Format: date-time */3023 created_at: string;3024 current: boolean;3025 /** Format: uuid */3026 id: string;3027 kind: components["schemas"]["ClientKind"];3028 label: string;3029 /** Format: date-time */3030 last_seen_at?: string;3031 model: string;3032 os_version: string;3033 /** @description True when a push token is registered. The token itself is never returned. */3034 push_enabled: boolean;3035 /** @enum {string} */3036 push_env?: "development" | "production";3037 /** Format: date-time */3038 revoked_at?: string;3039 /** Format: uuid */3040 user_id?: string;3041 };3042 DeviceList: {3043 items: components["schemas"]["Device"][];3044 next_cursor?: string;3045 };3046 EnrollmentToken: {3047 /** Format: date-time */3048 consumed_at?: string;3049 /** Format: date-time */3050 created_at: string;3051 /** Format: uuid */3052 created_by?: string;3053 /** Format: date-time */3054 expires_at: string;3055 /** Format: uuid */3056 id: string;3057 node_alias: string;3058 node_kind: components["schemas"]["NodeKind"];3059 /** Format: date-time */3060 revoked_at?: string;3061 /** @enum {string} */3062 status: "pending" | "consumed" | "expired" | "revoked";3063 };3064 EnrollmentTokenCreated: {3065 /** @description Hex SHA-256 of the ingest CA certificate the agent must pin. */3066 ca_fingerprint_sha256: string;3067 enrollment_token: components["schemas"]["EnrollmentToken"];3068 /** @description Command line to run on the node to install and enroll the agent. */3069 install_hint: string;3070 /** @description Enrollment token. Shown once. */3071 token: string;3072 };3073 EnrollmentTokenList: {3074 items: components["schemas"]["EnrollmentToken"][];3075 next_cursor?: string;3076 };3077 ErrorBody: {3078 /**3079 * @description Stable machine-readable code. Clients must tolerate unknown codes (fall back on the HTTP status). Known3080 * codes: `validation_failed`, `unauthenticated`, `session_expired`, `webauthn_failed`,3081 * `refresh_reuse_detected`, `forbidden`, `step_up_required`, `csrf_failed`, `not_found`, `conflict`,3082 * `idempotency_conflict`, `target_locked`, `last_passkey`, `gone`, `precheck_failed`,3083 * `confirmation_mismatch`, `justification_required`, `agent_offline`, `capability_missing`,3084 * `node_in_maintenance`, `action_unavailable`, `unprocessable`, `rate_limited`, `internal`,3085 * `unavailable`, `orchestrator_frozen`.3086 */3087 code: string;3088 /** Format: uuid */3089 correlation_id: string;3090 /** @description Code-specific details. Never contains secrets. */3091 details?: {3092 [key: string]: unknown;3093 };3094 /** @description Human-readable message in English; clients localize from `code`. */3095 message: string;3096 };3097 ErrorResponse: {3098 error: components["schemas"]["ErrorBody"];3099 };3100 /**3101 * @description Typing aid listing the payload schema of every topic. On the wire `data` is **directly** the payload object3102 * of the topic of the frame (not wrapped in this object). In a decoded frame exactly one property is set: the3103 * one matching `event`.3104 */3105 EventPayloads: {3106 action_changed?: components["schemas"]["ActionChangedEvent"];3107 action_output?: components["schemas"]["ActionOutputEvent"];3108 alert_changed?: components["schemas"]["AlertChangedEvent"];3109 audit_appended?: components["schemas"]["AuditAppendedEvent"];3110 incident_changed?: components["schemas"]["IncidentChangedEvent"];3111 job_changed?: components["schemas"]["JobChangedEvent"];3112 maintenance_changed?: components["schemas"]["MaintenanceChangedEvent"];3113 node_state?: components["schemas"]["NodeStateEvent"];3114 node_updated?: components["schemas"]["NodeUpdatedEvent"];3115 resync?: components["schemas"]["ResyncEvent"];3116 service_changed?: components["schemas"]["ServiceChangedEvent"];3117 };3118 /** @description One decoded SSE frame (see the description of the events operation). Not a JSON body. */3119 EventStreamFrame: {3120 data: components["schemas"]["EventPayloads"];3121 event: components["schemas"]["EventTopic"];3122 /** @description Monotonic sequence; send back as `Last-Event-ID` to resume. */3123 id: string;3124 };3125 /** @enum {string} */3126 EventTopic: "node.state" | "node.updated" | "alert.changed" | "incident.changed" | "action.changed" | "action.output" | "service.changed" | "job.changed" | "maintenance.changed" | "audit.appended" | "resync";3127 /** @description Declared (not measured) hardware of a manually registered node. */3128 ExpectedHardware: {3129 chip?: string;3130 cpu_cores?: number;3131 /** Format: int64 */3132 mem_bytes?: number;3133 model?: string;3134 /** Format: int64 */3135 storage_bytes?: number;3136 };3137 /**3138 * @description Computed by the server from the last report: `fresh` under 30 s, `stale` 30 to 120 s, `offline` beyond 120 s or never seen.3139 * @enum {string}3140 */3141 Freshness: "fresh" | "stale" | "offline";3142 /** @enum {string} */3143 GrantEffect: "allow" | "deny";3144 /** @enum {string} */3145 GrantSubjectKind: "user" | "role";3146 HealthBucket: {3147 alerts_firing: number;3148 /** Format: date-time */3149 end: string;3150 /** Format: date-time */3151 start: string;3152 /**3153 * @description `up`: reports received over the whole bucket; `degraded`: partial; `down`: none; `unknown`: before the first report.3154 * @enum {string}3155 */3156 state: "up" | "degraded" | "down" | "maintenance" | "unknown";3157 };3158 HealthHistory: {3159 bucket_seconds: number;3160 items: components["schemas"]["HealthBucket"][];3161 /** Format: uuid */3162 node_id: string;3163 range: components["schemas"]["TimeRange"];3164 /** @description Share of known buckets that are `up` or `degraded`. Absent when nothing is known. */3165 uptime_ratio?: number;3166 };3167 HealthStatus: {3168 /** @enum {string} */3169 status: "ok";3170 };3171 Incident: {3172 alert_count: number;3173 /** Format: uuid */3174 created_by?: string;3175 /** Format: uuid */3176 id: string;3177 /** Format: date-time */3178 opened_at: string;3179 owner_display_name?: string;3180 /** Format: uuid */3181 owner_id?: string;3182 /** Format: date-time */3183 resolved_at?: string;3184 severity: components["schemas"]["Severity"];3185 state: components["schemas"]["IncidentState"];3186 summary: string;3187 title: string;3188 };3189 /** @description Topic `incident.changed`. */3190 IncidentChangedEvent: {3191 /** Format: uuid */3192 incident_id: string;3193 severity: components["schemas"]["Severity"];3194 state: components["schemas"]["IncidentState"];3195 title: string;3196 };3197 IncidentDetail: {3198 alerts: components["schemas"]["Alert"][];3199 incident: components["schemas"]["Incident"];3200 timeline: components["schemas"]["TimelineEvent"][];3201 };3202 IncidentList: {3203 items: components["schemas"]["Incident"][];3204 next_cursor?: string;3205 };3206 /** @enum {string} */3207 IncidentState: "open" | "mitigated" | "resolved";3208 /** @enum {string} */3209 InferenceHealth: "ok" | "failing" | "unknown";3210 /** @description Explicit statement of what the inference server exposes. Nothing here is ever estimated. */3211 InferenceMetricsSupport: {3212 latency: components["schemas"]["MetricSupport"];3213 queue: components["schemas"]["MetricSupport"];3214 requests: components["schemas"]["MetricSupport"];3215 tokens_per_s: components["schemas"]["MetricSupport"];3216 ttft: components["schemas"]["MetricSupport"];3217 };3218 InferenceServer: {3219 /**3220 * Format: int643221 * @description Size on disk of the model cache.3222 */3223 disk_bytes?: number;3224 freshness: components["schemas"]["Freshness"];3225 /** Format: date-time */3226 gone_at?: string;3227 health: components["schemas"]["InferenceHealth"];3228 /** Format: date-time */3229 health_at?: string;3230 health_latency_ms?: number;3231 /** Format: uuid */3232 id: string;3233 /** @description Server software: `mlx_lm`, `ollama`, `llama.cpp`... */3234 kind: string;3235 /** Format: date-time */3236 last_seen_at: string;3237 /** @description Model ids returned by `GET /v1/models` of the server. */3238 listed_models: string[];3239 metrics_support: components["schemas"]["InferenceMetricsSupport"];3240 /** @description Model announced on the command line. */3241 model?: string;3242 node_alias: string;3243 /** Format: uuid */3244 node_id: string;3245 /** Format: date-time */3246 observed_at?: string;3247 pid?: number;3248 port: number;3249 quantization?: string;3250 /** Format: int64 */3251 rss_bytes?: number;3252 /** Format: int64 */3253 uptime_s?: number;3254 };3255 InferenceServerList: {3256 items: components["schemas"]["InferenceServer"][];3257 next_cursor?: string;3258 };3259 Invitation: {3260 /** Format: date-time */3261 completed_at?: string;3262 /** Format: date-time */3263 consumed_at?: string;3264 /** Format: date-time */3265 created_at: string;3266 /**3267 * Format: uuid3268 * @description Absent for out-of-band invitations created with `mccctl`.3269 */3270 created_by?: string;3271 created_by_display_name?: string;3272 display_name?: string;3273 /** Format: date-time */3274 expires_at: string;3275 failed_attempts: number;3276 handle?: string;3277 /** Format: uuid */3278 id: string;3279 note: string;3280 purpose: components["schemas"]["InvitationPurpose"];3281 /** Format: uuid */3282 resulting_user_id?: string;3283 /** Format: date-time */3284 revoked_at?: string;3285 role: components["schemas"]["UserRole"];3286 status: components["schemas"]["InvitationStatus"];3287 /** Format: uuid */3288 target_user_id?: string;3289 };3290 InvitationCreated: {3291 invitation: components["schemas"]["Invitation"];3292 /**3293 * Format: uri3294 * @description Link carrying the token in the URL fragment, which is never sent to the server. Shown once.3295 */3296 setup_url: string;3297 /** @description Invitation token (32 random bytes, base64url). Shown once. */3298 token: string;3299 };3300 InvitationExchangeRequest: {3301 client?: components["schemas"]["ClientInfo"];3302 token: string;3303 };3304 InvitationLinkRequest: {3305 /** @description Must be `true`; explicit confirmation by the account holder. */3306 confirm: boolean;3307 };3308 InvitationLinkResult: {3309 user: components["schemas"]["User"];3310 };3311 InvitationList: {3312 items: components["schemas"]["Invitation"][];3313 next_cursor?: string;3314 };3315 InvitationProfileRequest: {3316 display_name: string;3317 handle: string;3318 };3319 /**3320 * @description `new_account`: creates an account; `link`: applies to the existing account `target_user_id` (session of that account + step-up required); `recovery`: out-of-band (`mccctl recovery-invite`) registration of a new passkey on the existing account `target_user_id`. The API only creates `new_account` and `link` invitations.3321 * @enum {string}3322 */3323 InvitationPurpose: "new_account" | "link" | "recovery";3324 /**3325 * @description `pending`: token not used; `exchanged`: token consumed, setup transaction open or abandoned; `completed`: account created or linked.3326 * @enum {string}3327 */3328 InvitationStatus: "pending" | "exchanged" | "completed" | "expired" | "revoked";3329 InvitationTransaction: {3330 display_name?: string;3331 /** Format: date-time */3332 expires_at: string;3333 /** @description Handle fixed by the invitation or chosen through the profile step. */3334 handle?: string;3335 /** @description "mccctl" for out-of-band invitations. */3336 inviter_display_name: string;3337 /** @description True while handle or display name still has to be chosen. */3338 profile_required: boolean;3339 purpose: components["schemas"]["InvitationPurpose"];3340 /** @description True for an invitation targeting an existing account: sign in to that account, step up, then call the link operation. */3341 requires_existing_account: boolean;3342 role: components["schemas"]["UserRole"];3343 /** @description Only returned by the exchange, and only to native clients (`client.kind` other than `web`). */3344 transaction_token?: string;3345 };3346 Job: {3347 /**3348 * Format: uuid3349 * @description Current or last `job.run` action.3350 */3351 action_id?: string;3352 attempt: number;3353 /** Format: date-time */3354 created_at: string;3355 depends_on: string[];3356 error?: string;3357 /** Format: date-time */3358 finished_at?: string;3359 /** Format: uuid */3360 id: string;3361 max_attempts: number;3362 /** Format: date-time */3363 next_attempt_at?: string;3364 node_alias?: string;3365 /** Format: uuid */3366 node_id?: string;3367 owner_display_name?: string;3368 /** Format: uuid */3369 owner_id?: string;3370 params: {3371 [key: string]: unknown;3372 };3373 placement: components["schemas"]["JobPlacement"];3374 /** @description Absent when the template reports no progress. */3375 progress?: number;3376 result?: {3377 [key: string]: unknown;3378 };3379 /** Format: uuid */3380 schedule_id?: string;3381 /** Format: date-time */3382 started_at?: string;3383 state: components["schemas"]["JobState"];3384 template: string;3385 /** @description Measured resource usage (CPU seconds, peak RSS...) when reported. */3386 usage?: {3387 [key: string]: unknown;3388 };3389 };3390 /** @description Topic `job.changed`. */3391 JobChangedEvent: {3392 /** Format: uuid */3393 job_id: string;3394 /** Format: uuid */3395 node_id?: string;3396 progress?: number;3397 state: components["schemas"]["JobState"];3398 template: string;3399 };3400 JobCounts: {3401 queued: number;3402 running: number;3403 };3404 JobList: {3405 items: components["schemas"]["Job"][];3406 next_cursor?: string;3407 };3408 /** @description Placement constraints. With no field the scheduler picks any eligible node. */3409 JobPlacement: {3410 /** Format: uuid */3411 node_id?: string;3412 role?: string;3413 site?: string;3414 tags?: string[];3415 };3416 JobSchedule: {3417 /** Format: date-time */3418 created_at: string;3419 /** Format: uuid */3420 created_by?: string;3421 enabled: boolean;3422 every_seconds: number;3423 /** Format: uuid */3424 id: string;3425 /** Format: date-time */3426 last_run_at?: string;3427 name: string;3428 /** Format: date-time */3429 next_run_at: string;3430 params: {3431 [key: string]: unknown;3432 };3433 placement: components["schemas"]["JobPlacement"];3434 template: string;3435 };3436 JobScheduleList: {3437 items: components["schemas"]["JobSchedule"][];3438 next_cursor?: string;3439 };3440 /** @enum {string} */3441 JobState: "queued" | "running" | "succeeded" | "failed" | "cancelled" | "timed_out";3442 JobTemplate: {3443 /** @description True when at least one online agent declares the template. */3444 available: boolean;3445 description: string;3446 max_attempts: number;3447 name: string;3448 /** @description Nodes whose agent declares the template. */3449 node_ids?: string[];3450 /** @description JSON Schema of `params`. */3451 params_schema: {3452 [key: string]: unknown;3453 };3454 timeout_s: number;3455 title: string;3456 };3457 JobTemplateList: {3458 items: components["schemas"]["JobTemplate"][];3459 };3460 /** @enum {string} */3461 MaintenanceCategory: "planned" | "emergency" | "update" | "hardware" | "inspection";3462 /** @description Topic `maintenance.changed`: a window, an occurrence or a note changed. */3463 MaintenanceChangedEvent: {3464 /** @enum {string} */3465 change: "window_created" | "window_updated" | "window_cancelled" | "window_completed" | "occurrence_started" | "occurrence_ended" | "note_created" | "note_updated" | "note_deleted";3466 node_ids?: string[];3467 /** Format: uuid */3468 note_id?: string;3469 /** Format: date-time */3470 occurrence?: string;3471 /** Format: uuid */3472 window_id?: string;3473 };3474 MaintenanceNote: {3475 author_display_name: string;3476 /** Format: uuid */3477 author_id: string;3478 /** @description Plain text or Markdown; rendered sanitized by clients. */3479 body: string;3480 /** Format: date-time */3481 created_at: string;3482 /** Format: date-time */3483 edited_at?: string;3484 /** Format: uuid */3485 id: string;3486 node_alias?: string;3487 /** Format: uuid */3488 node_id?: string;3489 /**3490 * Format: date-time3491 * @description Start of the occurrence the note belongs to.3492 */3493 occurrence?: string;3494 pinned: boolean;3495 /** Format: uuid */3496 window_id?: string;3497 };3498 MaintenanceNoteList: {3499 items: components["schemas"]["MaintenanceNote"][];3500 next_cursor?: string;3501 };3502 MaintenanceOccurrence: {3503 /** @description True for the occurrence in progress. */3504 active?: boolean;3505 /** @description Notes attached to this occurrence (or to the window for non-recurring windows). */3506 note_count: number;3507 /** Format: date-time */3508 occurrence_end: string;3509 /** Format: date-time */3510 occurrence_start: string;3511 window: components["schemas"]["MaintenanceWindow"];3512 };3513 MaintenanceOccurrenceList: {3514 items: components["schemas"]["MaintenanceOccurrence"][];3515 truncated: boolean;3516 };3517 /** @enum {string} */3518 MaintenanceRecurrence: "none" | "daily" | "weekly" | "monthly";3519 MaintenanceScope: {3520 /** @description Nodes concerned. Empty = informational window touching no node (no maintenance mode, no silence). */3521 node_ids: string[];3522 };3523 /** @enum {string} */3524 MaintenanceStatus: "scheduled" | "in_progress" | "completed" | "cancelled";3525 MaintenanceWindow: {3526 /**3527 * Format: date-time3528 * @description Start of the occurrence currently applied by the scheduler.3529 */3530 activated_occurrence?: string;3531 category: components["schemas"]["MaintenanceCategory"];3532 /** Format: date-time */3533 created_at: string;3534 /** Format: uuid */3535 created_by?: string;3536 created_by_display_name?: string;3537 description: string;3538 /**3539 * Format: date-time3540 * @description End of the first occurrence.3541 */3542 ends_at: string;3543 /** Format: uuid */3544 id: string;3545 recurrence: components["schemas"]["MaintenanceRecurrence"];3546 /** Format: date-time */3547 recurrence_until?: string;3548 scope: components["schemas"]["MaintenanceScope"];3549 set_maintenance_mode: boolean;3550 silence_alerts: boolean;3551 /**3552 * Format: date-time3553 * @description Start of the first occurrence.3554 */3555 starts_at: string;3556 status: components["schemas"]["MaintenanceStatus"];3557 /** @description IANA time zone used to expand recurrences, for example `America/Toronto`. */3558 timezone: string;3559 title: string;3560 /** Format: date-time */3561 updated_at: string;3562 /** @description Only in the answers to create and update: non-blocking warnings, for example an overlap with another window on the same node. */3563 warnings?: string[];3564 };3565 Me: {3566 /** @description Cookie sessions only. */3567 csrf_token?: string;3568 /** @description Effective global permissions (role defaults and grants without resource). Resource-scoped grants are evaluated by the server per request. */3569 permissions: string[];3570 session: components["schemas"]["Session"];3571 user: components["schemas"]["User"];3572 };3573 MetricCatalog: {3574 items: components["schemas"]["MetricCatalogEntry"][];3575 };3576 MetricCatalogEntry: {3577 description: string;3578 interval_s: number;3579 /** @enum {string} */3580 kind: "gauge" | "counter_rate";3581 labeled: boolean;3582 name: string;3583 /** @description Provenance, for example `sysctl`, `ioreg` or `df`. */3584 source: string;3585 unit: string;3586 };3587 MetricCompareResponse: {3588 /** @description Current availability of the metric on each node, keyed by node id. */3589 availability: {3590 [key: string]: components["schemas"]["Availability"];3591 };3592 /** Format: date-time */3593 from: string;3594 metric: string;3595 resolution: components["schemas"]["Resolution"];3596 series: components["schemas"]["MetricSeries"][];3597 /** Format: date-time */3598 to: string;3599 unit: string;3600 };3601 /** @description Points as `[ts_ms, avg, min, max]` (Unix milliseconds UTC). At raw resolution avg = min = max. Missing buckets are omitted. */3602 MetricPoints: number[][];3603 MetricSeries: {3604 /** @description Empty for metrics without label. */3605 label: string;3606 metric: string;3607 /** @description Present in comparisons. */3608 node_alias?: string;3609 /**3610 * Format: uuid3611 * @description Present in comparisons.3612 */3613 node_id?: string;3614 points: components["schemas"]["MetricPoints"];3615 unit: string;3616 };3617 MetricSeriesResponse: {3618 /** @description Current availability of each requested metric, keyed by metric name. */3619 availability: {3620 [key: string]: components["schemas"]["Availability"];3621 };3622 /** Format: date-time */3623 from: string;3624 resolution: components["schemas"]["Resolution"];3625 series: components["schemas"]["MetricSeries"][];3626 /** Format: date-time */3627 to: string;3628 };3629 MetricSupport: {3630 availability: components["schemas"]["Availability"];3631 /** @description Why the metric family is not exposed by this kind of server. */3632 reason?: string;3633 };3634 MetricValue: {3635 availability: components["schemas"]["Availability"];3636 /** @description Why the metric is not available, for example "requires root (powermetrics)". */3637 reason?: string;3638 unit?: string;3639 /**3640 * Format: double3641 * @description Present only when `availability` is `available` or `stale`.3642 */3643 value?: number;3644 };3645 ModelCounts: {3646 /** @description Inference servers with health `ok` on a fresh node. */3647 online: number;3648 total: number;3649 };3650 NasSummary: {3651 offline: number;3652 online: number;3653 total: number;3654 unknown: number;3655 };3656 NasTarget: {3657 /** @description IP address. Requires `nodes.private.read`. */3658 host?: string;3659 /** Format: uuid */3660 id: string;3661 latency_ms?: number;3662 /** @description Number of nodes with the share mounted. */3663 mounted_on: number;3664 name: string;3665 note: string;3666 /**3667 * Format: uuid3668 * @description Node whose agent made the observation.3669 */3670 observed_by?: string;3671 /** @enum {string} */3672 protocol: "smb" | "nfs" | "afp";3673 share: string;3674 /** @enum {string} */3675 state: "online" | "offline" | "unknown";3676 /**3677 * Format: date-time3678 * @description When the state was last observed.3679 */3680 state_at?: string;3681 /**3682 * Format: int643683 * @description Absent when not observed.3684 */3685 total_bytes?: number;3686 /**3687 * Format: int643688 * @description Absent when not observed.3689 */3690 used_bytes?: number;3691 };3692 NasTargetList: {3693 items: components["schemas"]["NasTarget"][];3694 };3695 NetworkInterface: {3696 freshness: components["schemas"]["Freshness"];3697 /** @description Requires `nodes.private.read` (empty otherwise). */3698 ipv4: string[];3699 /** @description Requires `nodes.private.read` (empty otherwise). */3700 ipv6: string[];3701 /** @enum {string} */3702 kind: "ethernet" | "wifi" | "wireguard" | "tailscale" | "loopback" | "other";3703 link_speed_mbps?: number;3704 /** @description Requires `nodes.private.read`. */3705 mac?: string;3706 /** @description System name, for example `en0` or `wg1`. */3707 name: string;3708 node_alias: string;3709 /** Format: uuid */3710 node_id: string;3711 /** Format: date-time */3712 observed_at?: string;3713 rx_bytes_per_s?: number;3714 rx_errors_per_s?: number;3715 tx_bytes_per_s?: number;3716 tx_errors_per_s?: number;3717 up: boolean;3718 };3719 NetworkInterfaceList: {3720 items: components["schemas"]["NetworkInterface"][];3721 next_cursor?: string;3722 };3723 NetworkTopology: {3724 /** Format: date-time */3725 generated_at: string;3726 links: components["schemas"]["TopologyLink"][];3727 nodes: components["schemas"]["TopologyNode"][];3728 };3729 Node: {3730 agent_version?: string;3731 alias: string;3732 arch?: string;3733 chip?: string;3734 cpu_cores?: number;3735 /** Format: date-time */3736 created_at: string;3737 environment: string;3738 freshness: components["schemas"]["Freshness"];3739 gpu_cores?: number;3740 headline?: components["schemas"]["NodeHeadline"];3741 hostname: string;3742 /** Format: uuid */3743 id: string;3744 kind: components["schemas"]["NodeKind"];3745 /** Format: date-time */3746 last_seen_at?: string;3747 maintenance: boolean;3748 maintenance_reason: string;3749 /** Format: int64 */3750 mem_bytes?: number;3751 model?: string;3752 /**3753 * Format: date-time3754 * @description Agent-side timestamp of the latest report. Absent when the node never reported.3755 */3756 observed_at?: string;3757 open_alerts?: number;3758 os_name?: string;3759 os_version?: string;3760 /** @description Requires `nodes.private.read`. An address is not an identifier (DHCP). */3761 primary_ip?: string;3762 /** @enum {string} */3763 registered_via: "manual" | "agent";3764 /** Format: date-time */3765 retired_at?: string;3766 role: string;3767 site: string;3768 /** Format: int64 */3769 storage_bytes?: number;3770 tags: string[];3771 };3772 NodeCounts: {3773 fresh: number;3774 /** @description Nodes in maintenance mode (also counted in their freshness bucket). */3775 maintenance: number;3776 offline: number;3777 stale: number;3778 /** @description Non-retired nodes. */3779 total: number;3780 };3781 NodeDetail: {3782 /** Format: uuid */3783 active_maintenance_window_id?: string;3784 agent?: components["schemas"]["Agent"];3785 cpu_levels: components["schemas"]["CpuPerfLevel"][];3786 /** @description Stable hardware identifier. Requires `nodes.private.read`. */3787 hardware_uuid?: string;3788 interfaces: components["schemas"]["NetworkInterface"][];3789 /** Format: date-time */3790 inventory_at?: string;3791 /** @description Latest value of every catalog metric without label, keyed by metric name (for example `cpu.usage`). Metrics that cannot be measured are present with their availability and no value. */3792 latest: {3793 [key: string]: components["schemas"]["MetricValue"];3794 };3795 node: components["schemas"]["Node"];3796 os_build?: string;3797 /** @description Requires `nodes.private.read`. */3798 serial_number?: string;3799 volumes: components["schemas"]["Volume"][];3800 };3801 /** @description Headline values of the latest report. A field is absent when the metric is not available. */3802 NodeHeadline: {3803 cpu_usage_pct?: number;3804 /** @description Fullest internal volume. */3805 disk_used_pct?: number;3806 load1?: number;3807 mem_used_pct?: number;3808 };3809 /** @enum {string} */3810 NodeKind: "mac" | "linux" | "nas";3811 NodeList: {3812 items: components["schemas"]["Node"][];3813 next_cursor?: string;3814 };3815 /** @description Topic `node.state`: freshness, maintenance or headline values of a node changed. Emitted at most once per report per node. */3816 NodeStateEvent: {3817 alias: string;3818 freshness: components["schemas"]["Freshness"];3819 headline?: components["schemas"]["NodeHeadline"];3820 maintenance: boolean;3821 /** Format: uuid */3822 node_id: string;3823 /** Format: date-time */3824 observed_at?: string;3825 };3826 /** @description Topic `node.updated`: the node resource changed; reload it. */3827 NodeUpdatedEvent: {3828 /** @enum {string} */3829 change: "created" | "updated" | "inventory" | "agent" | "retired";3830 /** Format: uuid */3831 node_id: string;3832 };3833 Passkey: {3834 /** @description Hex AAGUID of the authenticator when known. */3835 aaguid?: string;3836 backup_eligible: boolean;3837 /** @description True for a synced (multi-device) passkey. */3838 backup_state: boolean;3839 /** Format: date-time */3840 created_at: string;3841 /** Format: uuid */3842 id: string;3843 label: string;3844 /** Format: date-time */3845 last_used_at?: string;3846 /** Format: date-time */3847 revoked_at?: string;3848 transports: string[];3849 };3850 PasskeyList: {3851 items: components["schemas"]["Passkey"][];3852 next_cursor?: string;3853 };3854 PermissionCatalog: {3855 permissions: components["schemas"]["PermissionInfo"][];3856 role_defaults: components["schemas"]["RolePermissions"][];3857 };3858 PermissionInfo: {3859 description: string;3860 name: string;3861 /** @description True when exercising the permission always requires a step-up. */3862 step_up: boolean;3863 };3864 PolicyGrant: {3865 /** Format: date-time */3866 created_at: string;3867 /** Format: uuid */3868 created_by?: string;3869 effect: components["schemas"]["GrantEffect"];3870 /** Format: uuid */3871 id: string;3872 permission: string;3873 resource_id?: string;3874 /** @description Absent = every resource. Otherwise `node`, `service`, `site` or `tag`. */3875 resource_kind?: string;3876 /** @description User id or role name. */3877 subject: string;3878 subject_kind: components["schemas"]["GrantSubjectKind"];3879 };3880 PolicyGrantList: {3881 items: components["schemas"]["PolicyGrant"][];3882 next_cursor?: string;3883 };3884 Process: {3885 /** @description Redacted command line; requires `nodes.private.read`. */3886 command?: string;3887 cpu_pct?: number;3888 /** Format: int64 */3889 mem_bytes?: number;3890 name: string;3891 pid: number;3892 user?: string;3893 };3894 ProcessList: {3895 availability: components["schemas"]["Availability"];3896 freshness: components["schemas"]["Freshness"];3897 items: components["schemas"]["Process"][];3898 /** Format: uuid */3899 node_id: string;3900 /** Format: date-time */3901 observed_at?: string;3902 };3903 PushTokenRequest: {3904 /** @enum {string} */3905 environment: "development" | "production";3906 /** @description APNs device token (hex). */3907 token: string;3908 };3909 PutDashboardRequest: {3910 layout: components["schemas"]["DashboardWidget"][];3911 };3912 PutSettingRequest: {3913 /** @description Any JSON value valid for the key. */3914 value: unknown;3915 };3916 RefreshRequest: {3917 refresh_token: string;3918 };3919 RegistrationBeginRequest: {3920 /** @description Label proposed for the new passkey. */3921 label?: string;3922 };3923 RegistrationFinishRequest: {3924 /** Format: uuid */3925 challenge_id: string;3926 client?: components["schemas"]["ClientInfo"];3927 /** @description PublicKeyCredential JSON (attestation) produced by the platform API. */3928 credential: {3929 [key: string]: unknown;3930 };3931 label?: string;3932 };3933 RegistrationResult: {3934 auth?: components["schemas"]["AuthResult"];3935 passkey: components["schemas"]["Passkey"];3936 };3937 RejectActionRequest: {3938 reason: string;3939 };3940 /**3941 * @default auto3942 * @enum {string}3943 */3944 Resolution: "auto" | "raw" | "1m" | "1h";3945 /** @description Event `resync`: the requested sequence is no longer retained; reload state through the REST API. */3946 ResyncEvent: {3947 /** Format: int64 */3948 oldest_available_seq?: number;3949 /** @enum {string} */3950 reason: "retention_exceeded" | "server_restart";3951 };3952 RevokeAgentRequest: {3953 reason: string;3954 };3955 RolePermissions: {3956 permissions: string[];3957 role: components["schemas"]["UserRole"];3958 };3959 SearchResult: {3960 freshness?: components["schemas"]["Freshness"];3961 /** Format: uuid */3962 id: string;3963 kind: components["schemas"]["SearchResultKind"];3964 /**3965 * Format: uuid3966 * @description Node the result belongs to when relevant.3967 */3968 node_id?: string;3969 score: number;3970 /** @description State of the resource in its own vocabulary (alert state or service state for example). */3971 state?: string;3972 subtitle?: string;3973 title: string;3974 };3975 /** @enum {string} */3976 SearchResultKind: "node" | "service" | "alert" | "action" | "incident" | "job" | "inference_server" | "maintenance_window" | "maintenance_note";3977 SearchResults: {3978 items: components["schemas"]["SearchResult"][];3979 query: string;3980 };3981 Service: {3982 /** @description Logical application when known. */3983 app?: string;3984 cpu_pct?: number;3985 /** Format: date-time */3986 first_seen_at: string;3987 freshness: components["schemas"]["Freshness"];3988 /**3989 * Format: date-time3990 * @description Set when the manager no longer lists the service.3991 */3992 gone_at?: string;3993 health?: components["schemas"]["ServiceHealth"];3994 /** Format: uuid */3995 id: string;3996 /** Format: date-time */3997 last_seen_at: string;3998 /** @description True when start / stop / restart actions are allowed on the server side. */3999 managed: boolean;4000 manager: components["schemas"]["ServiceManager"];4001 /** Format: int64 */4002 mem_bytes?: number;4003 /** @description Raw manager details (redacted). Only in the single-service view. */4004 meta?: {4005 [key: string]: unknown;4006 };4007 name: string;4008 node_alias: string;4009 /** Format: uuid */4010 node_id: string;4011 /** Format: date-time */4012 observed_at?: string;4013 pid?: number;4014 ports: number[];4015 public_url?: string;4016 restarts?: number;4017 state: components["schemas"]["ServiceState"];4018 /** Format: int64 */4019 uptime_s?: number;4020 version?: string;4021 };4022 /** @description Topic `service.changed`: state, restart count, managed flag or presence of a service changed. */4023 ServiceChangedEvent: {4024 gone?: boolean;4025 manager: components["schemas"]["ServiceManager"];4026 name: string;4027 /** Format: uuid */4028 node_id: string;4029 previous_state?: components["schemas"]["ServiceState"];4030 /** Format: uuid */4031 service_id: string;4032 state: components["schemas"]["ServiceState"];4033 };4034 ServiceCounts: {4035 errored: number;4036 online: number;4037 stopped: number;4038 unknown: number;4039 };4040 ServiceHealth: {4041 /** Format: date-time */4042 checked_at?: string;4043 detail?: string;4044 latency_ms?: number;4045 /** @enum {string} */4046 status: "ok" | "failing" | "unknown";4047 };4048 ServiceHistory: {4049 items: components["schemas"]["ServiceHistoryEntry"][];4050 next_cursor?: string;4051 };4052 ServiceHistoryEntry: {4053 /** Format: uuid */4054 action_id?: string;4055 actor_display_name?: string;4056 from_state?: components["schemas"]["ServiceState"];4057 /** @enum {string} */4058 kind: "restart" | "state_change" | "action" | "deploy" | "appeared" | "disappeared";4059 summary: string;4060 to_state?: components["schemas"]["ServiceState"];4061 /** Format: date-time */4062 ts: string;4063 version?: string;4064 };4065 ServiceList: {4066 items: components["schemas"]["Service"][];4067 next_cursor?: string;4068 };4069 /** @enum {string} */4070 ServiceManager: "pm2" | "launchd" | "systemd" | "docker";4071 /**4072 * @description Normalized state; the raw manager state is in `meta`.4073 * @enum {string}4074 */4075 ServiceState: "online" | "stopped" | "errored" | "unknown";4076 Session: {4077 /** Format: date-time */4078 absolute_expires_at: string;4079 /**4080 * Format: date-time4081 * @description Last passkey ceremony of the session.4082 */4083 authenticated_at: string;4084 /** Format: date-time */4085 created_at: string;4086 /** @description True for the session making the request. */4087 current: boolean;4088 /** Format: uuid */4089 device_id: string;4090 device_label?: string;4091 /** Format: uuid */4092 id: string;4093 /** Format: date-time */4094 idle_expires_at: string;4095 /** @description Last client address. */4096 ip?: string;4097 kind: components["schemas"]["SessionKind"];4098 /** Format: date-time */4099 last_seen_at: string;4100 /** Format: uuid */4101 passkey_id?: string;4102 /**4103 * Format: date-time4104 * @description `authenticated_at` + 5 minutes; step-up operations are accepted until then.4105 */4106 step_up_valid_until: string;4107 user_agent?: string;4108 /** Format: uuid */4109 user_id?: string;4110 };4111 /** @enum {string} */4112 SessionKind: "cookie" | "bearer";4113 SessionList: {4114 items: components["schemas"]["Session"][];4115 next_cursor?: string;4116 };4117 Setting: {4118 description?: string;4119 key: string;4120 /** Format: date-time */4121 updated_at: string;4122 /** Format: uuid */4123 updated_by?: string;4124 /** @description Any JSON value (boolean, number, string, array or object) valid for the key. */4125 value: unknown;4126 };4127 SettingList: {4128 items: components["schemas"]["Setting"][];4129 };4130 /** @enum {string} */4131 Severity: "info" | "warning" | "critical";4132 SeverityCounts: {4133 critical: number;4134 info: number;4135 warning: number;4136 };4137 Silence: {4138 active: boolean;4139 /** Format: date-time */4140 created_at: string;4141 /** Format: uuid */4142 created_by?: string;4143 /** Format: date-time */4144 ends_at: string;4145 /** Format: uuid */4146 id: string;4147 /**4148 * Format: uuid4149 * @description Set for silences owned by a maintenance window.4150 */4151 maintenance_window_id?: string;4152 reason: string;4153 /**4154 * Format: uuid4155 * @description Limits the silence to one rule.4156 */4157 rule_id?: string;4158 scope: components["schemas"]["AlertScope"];4159 /** Format: date-time */4160 starts_at: string;4161 };4162 SilenceList: {4163 items: components["schemas"]["Silence"][];4164 next_cursor?: string;4165 };4166 StepUpFinishRequest: {4167 /** Format: uuid */4168 challenge_id: string;4169 /** @description PublicKeyCredential JSON (assertion). */4170 credential: {4171 [key: string]: unknown;4172 };4173 };4174 StepUpResult: {4175 /** Format: date-time */4176 authenticated_at: string;4177 /** Format: date-time */4178 step_up_valid_until: string;4179 };4180 TimelineEvent: {4181 actor_display_name?: string;4182 /**4183 * Format: uuid4184 * @description Absent for system events.4185 */4186 actor_id?: string;4187 body: string;4188 /** Format: uuid */4189 id: string;4190 /** @description One of `opened`, `fired`, `acknowledged`, `resolved`, `reopened`, `comment`, `suppressed`, `notified`, `state_changed`, `alert_linked`, `alert_unlinked`, `owner_changed` (open list). */4191 kind: string;4192 /** Format: date-time */4193 ts: string;4194 };4195 /**4196 * @default 24h4197 * @enum {string}4198 */4199 TimeRange: "1h" | "24h" | "7d" | "30d";4200 TokenPair: {4201 /** Format: date-time */4202 access_expires_at: string;4203 access_token: string;4204 /** Format: date-time */4205 refresh_expires_at: string;4206 refresh_token: string;4207 };4208 TopologyLink: {4209 freshness: components["schemas"]["Freshness"];4210 id: string;4211 /** @description Interface carrying the link on the source node. */4212 interface?: string;4213 /** @enum {string} */4214 kind: "lan" | "wireguard";4215 latency_availability: components["schemas"]["Availability"];4216 /** @description Present only when `latency_availability` is `available` or `stale`. */4217 latency_ms?: number;4218 loss_availability: components["schemas"]["Availability"];4219 /** @description Present only when `loss_availability` is `available` or `stale`. */4220 loss_pct?: number;4221 /** Format: date-time */4222 observed_at?: string;4223 /** @description Vertex id of the node that measures the link. */4224 source: string;4225 /** @enum {string} */4226 state: "up" | "down" | "unknown";4227 target: string;4228 };4229 TopologyNode: {4230 /** @description Requires `nodes.private.read`. */4231 address?: string;4232 freshness?: components["schemas"]["Freshness"];4233 /** @description Vertex id: the node id for cluster nodes, `lan-gateway` or `wg-hub` for infrastructure vertices. */4234 id: string;4235 /** @enum {string} */4236 kind: "node" | "lan_gateway" | "wg_hub";4237 label: string;4238 /**4239 * Format: uuid4240 * @description Cluster node behind the vertex (also set for the hub when it is itself a node).4241 */4242 node_id?: string;4243 };4244 /**4245 * @default cluster4246 * @enum {string}4247 */4248 TrendGroupBy: "cluster" | "site" | "role" | "tag";4249 TrendSeries: {4250 /** @description Number of nodes contributing to the series. */4251 coverage: number;4252 /** @description Group value (`cluster`, a site, a role or a tag). */4253 group: string;4254 points: components["schemas"]["MetricPoints"];4255 };4256 TrendsResponse: {4257 /**4258 * @description How nodes are combined: `mean` for ratios and gauges in percent, `sum` for additive quantities.4259 * @enum {string}4260 */4261 aggregation: "mean" | "sum";4262 /** Format: date-time */4263 generated_at: string;4264 group_by: components["schemas"]["TrendGroupBy"];4265 metric: string;4266 range: components["schemas"]["TimeRange"];4267 resolution: components["schemas"]["Resolution"];4268 series: components["schemas"]["TrendSeries"][];4269 unit: string;4270 };4271 UpdateAlertRuleRequest: {4272 clear_seconds?: number;4273 clear_threshold?: number;4274 description?: string;4275 enabled?: boolean;4276 for_seconds?: number;4277 label_match?: string;4278 metric?: string;4279 name?: string;4280 notify?: boolean;4281 op?: components["schemas"]["AlertOp"];4282 scope?: components["schemas"]["AlertScope"];4283 severity?: components["schemas"]["Severity"];4284 threshold?: number;4285 };4286 UpdateIncidentRequest: {4287 add_alert_ids?: string[];4288 /** Format: uuid */4289 owner_id?: string;4290 remove_alert_ids?: string[];4291 severity?: components["schemas"]["Severity"];4292 state?: components["schemas"]["IncidentState"];4293 summary?: string;4294 title?: string;4295 };4296 UpdateJobScheduleRequest: {4297 enabled?: boolean;4298 every_seconds?: number;4299 name?: string;4300 params?: {4301 [key: string]: unknown;4302 };4303 placement?: components["schemas"]["JobPlacement"];4304 };4305 UpdateMaintenanceNoteRequest: {4306 body?: string;4307 pinned?: boolean;4308 };4309 UpdateMaintenanceWindowRequest: {4310 category?: components["schemas"]["MaintenanceCategory"];4311 description?: string;4312 /** Format: date-time */4313 ends_at?: string;4314 recurrence?: components["schemas"]["MaintenanceRecurrence"];4315 /** Format: date-time */4316 recurrence_until?: string;4317 scope?: components["schemas"]["MaintenanceScope"];4318 set_maintenance_mode?: boolean;4319 silence_alerts?: boolean;4320 /** Format: date-time */4321 starts_at?: string;4322 timezone?: string;4323 title?: string;4324 };4325 UpdateMeRequest: {4326 display_name?: string;4327 /** @enum {string} */4328 locale?: "fr" | "en";4329 };4330 UpdateNodeRequest: {4331 alias?: string;4332 environment?: string;4333 role?: string;4334 site?: string;4335 tags?: string[];4336 };4337 UpdatePasskeyRequest: {4338 label: string;4339 };4340 UpdateServiceRequest: {4341 managed?: boolean;4342 /** @description Empty string clears the URL. */4343 public_url?: string;4344 };4345 UpdateUserRequest: {4346 disabled?: boolean;4347 role?: components["schemas"]["UserRole"];4348 };4349 User: {4350 /** Format: date-time */4351 created_at: string;4352 disabled: boolean;4353 /** Format: date-time */4354 disabled_at?: string;4355 display_name: string;4356 handle: string;4357 /** Format: uuid */4358 id: string;4359 /**4360 * Format: date-time4361 * @description Admin views only; last activity of any session.4362 */4363 last_seen_at?: string;4364 /** @enum {string} */4365 locale: "fr" | "en";4366 /** @description Admin views only. */4367 passkey_count?: number;4368 role: components["schemas"]["UserRole"];4369 };4370 UserList: {4371 items: components["schemas"]["User"][];4372 next_cursor?: string;4373 };4374 /** @enum {string} */4375 UserRole: "owner" | "admin" | "operator" | "viewer";4376 ValidateAlertRuleRequest: {4377 /**4378 * Format: date-time4379 * @description Defaults to 7 days ago.4380 */4381 from?: string;4382 rule: components["schemas"]["AlertRuleInput"];4383 /**4384 * Format: date-time4385 * @description Defaults to now.4386 */4387 to?: string;4388 };4389 VersionInfo: {4390 /** @description Always `v1` for this contract. */4391 api_version: string;4392 /** Format: date-time */4393 built_at?: string;4394 commit?: string;4395 /** @description Oldest native app version the server accepts. */4396 min_app_version?: string;4397 /** @description Server version (semver). */4398 version: string;4399 };4400 Volume: {4401 device?: string;4402 freshness: components["schemas"]["Freshness"];4403 fs?: string;4404 /** Format: date-time */4405 gone_at?: string;4406 /** Format: uuid */4407 id: string;4408 kind: components["schemas"]["VolumeKind"];4409 /** Format: date-time */4410 last_seen_at: string;4411 mount: string;4412 node_alias: string;4413 /** Format: uuid */4414 node_id: string;4415 /** Format: date-time */4416 observed_at?: string;4417 /** @description Remote of a network volume; requires `nodes.private.read`. */4418 remote?: string;4419 /** @description Summary status as reported by the system (for example `Verified`). Absent when not observable. */4420 smart_status?: string;4421 /** Format: int64 */4422 total_bytes?: number;4423 /** Format: int64 */4424 used_bytes?: number;4425 };4426 /** @enum {string} */4427 VolumeKind: "internal" | "external" | "network";4428 VolumeList: {4429 items: components["schemas"]["Volume"][];4430 next_cursor?: string;4431 };4432 WebAuthnChallenge: {4433 /** Format: uuid */4434 challenge_id: string;4435 /** Format: date-time */4436 expires_at: string;4437 /** @description WebAuthn options JSON to pass to the platform API: PublicKeyCredentialRequestOptions (authentication, step-up) or PublicKeyCredentialCreationOptions (registration). Binary members are base64url. */4438 public_key: {4439 [key: string]: unknown;4440 };4441 };4442 };4443 responses: {4444 /** @description `validation_failed` - malformed body, parameter or header. */4445 BadRequest: {4446 headers: {4447 "X-Correlation-Id": components["headers"]["CorrelationId"];4448 [name: string]: unknown;4449 };4450 content: {4451 /**4452 * @example {4453 * "error": {4454 * "code": "validation_failed",4455 * "message": "Invalid request.",4456 * "details": {4457 * "fields": {4458 * "ttl_minutes": "must be between 1 and 1440"4459 * }4460 * },4461 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4462 * }4463 * }4464 */4465 "application/json": components["schemas"]["ErrorResponse"];4466 };4467 };4468 /** @description `conflict`, `idempotency_conflict`, `target_locked` or `last_passkey`. */4469 Conflict: {4470 headers: {4471 "X-Correlation-Id": components["headers"]["CorrelationId"];4472 [name: string]: unknown;4473 };4474 content: {4475 "application/json": components["schemas"]["ErrorResponse"];4476 };4477 };4478 /** @description `forbidden` (missing permission or deny grant), `step_up_required` (passkey ceremony older than 5 minutes) or `csrf_failed`. */4479 Forbidden: {4480 headers: {4481 "X-Correlation-Id": components["headers"]["CorrelationId"];4482 [name: string]: unknown;4483 };4484 content: {4485 "application/json": components["schemas"]["ErrorResponse"];4486 };4487 };4488 /** @description `gone` - invitation or setup transaction expired, consumed or revoked. The cause is deliberately not disclosed. */4489 Gone: {4490 headers: {4491 "X-Correlation-Id": components["headers"]["CorrelationId"];4492 [name: string]: unknown;4493 };4494 content: {4495 /**4496 * @example {4497 * "error": {4498 * "code": "gone",4499 * "message": "This invitation is no longer valid.",4500 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4501 * }4502 * }4503 */4504 "application/json": components["schemas"]["ErrorResponse"];4505 };4506 };4507 /** @description `not_found` - unknown resource, or resource hidden from the caller. */4508 NotFound: {4509 headers: {4510 "X-Correlation-Id": components["headers"]["CorrelationId"];4511 [name: string]: unknown;4512 };4513 content: {4514 /**4515 * @example {4516 * "error": {4517 * "code": "not_found",4518 * "message": "Resource not found.",4519 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4520 * }4521 * }4522 */4523 "application/json": components["schemas"]["ErrorResponse"];4524 };4525 };4526 /** @description `rate_limited` - too many requests. */4527 RateLimited: {4528 headers: {4529 "Retry-After": components["headers"]["RetryAfter"];4530 "X-Correlation-Id": components["headers"]["CorrelationId"];4531 [name: string]: unknown;4532 };4533 content: {4534 /**4535 * @example {4536 * "error": {4537 * "code": "rate_limited",4538 * "message": "Too many requests.",4539 * "details": {4540 * "retry_after_seconds": 424541 * },4542 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4543 * }4544 * }4545 */4546 "application/json": components["schemas"]["ErrorResponse"];4547 };4548 };4549 /** @description `unauthenticated`, `session_expired`, `webauthn_failed` or `refresh_reuse_detected`. */4550 Unauthenticated: {4551 headers: {4552 "X-Correlation-Id": components["headers"]["CorrelationId"];4553 [name: string]: unknown;4554 };4555 content: {4556 /**4557 * @example {4558 * "error": {4559 * "code": "unauthenticated",4560 * "message": "Authentication required.",4561 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4562 * }4563 * }4564 */4565 "application/json": components["schemas"]["ErrorResponse"];4566 };4567 };4568 /** @description `unavailable` (a dependency is down) or `orchestrator_frozen` (emergency stop engaged). */4569 Unavailable: {4570 headers: {4571 "Retry-After": components["headers"]["RetryAfter"];4572 "X-Correlation-Id": components["headers"]["CorrelationId"];4573 [name: string]: unknown;4574 };4575 content: {4576 /**4577 * @example {4578 * "error": {4579 * "code": "unavailable",4580 * "message": "Service temporarily unavailable.",4581 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4582 * }4583 * }4584 */4585 "application/json": components["schemas"]["ErrorResponse"];4586 };4587 };4588 /** @description `precheck_failed`, `confirmation_mismatch`, `justification_required`, `agent_offline`, `capability_missing`, `node_in_maintenance`, `action_unavailable` or `unprocessable`. */4589 Unprocessable: {4590 headers: {4591 "X-Correlation-Id": components["headers"]["CorrelationId"];4592 [name: string]: unknown;4593 };4594 content: {4595 /**4596 * @example {4597 * "error": {4598 * "code": "agent_offline",4599 * "message": "The agent of M4BP36 is offline.",4600 * "details": {4601 * "check": "agent_online",4602 * "node_id": "019a9b10-0000-7000-8000-000000000a09"4603 * },4604 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4605 * }4606 * }4607 */4608 "application/json": components["schemas"]["ErrorResponse"];4609 };4610 };4611 };4612 parameters: {4613 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */4614 Csrf: string;4615 /** @description Opaque cursor taken from `next_cursor` of the previous page. */4616 Cursor: string;4617 /** @description Start of the time range (inclusive, UTC). */4618 From: string;4619 Id: string;4620 /** @description Client-generated key (a UUID is recommended), unique per user. Same key and same body returns the original resource; same key with another body is `409 idempotency_conflict`. */4621 IdempotencyKey: string;4622 /** @description Page size. */4623 Limit: number;4624 /** @description Sort direction. */4625 Order: "asc" | "desc";4626 /** @description Free-text filter (case-insensitive substring). */4627 Q: string;4628 /** @description End of the time range (exclusive, UTC). Defaults to now. */4629 To: string;4630 };4631 requestBodies: never;4632 headers: {4633 /** @description Correlation id of the request; also present in error bodies and in the audit log. */4634 CorrelationId: string;4635 /** @description Number of seconds to wait before retrying. */4636 RetryAfter: number;4637 };4638 pathItems: never;4639}4640export type $defs = Record<string, never>;4641export interface operations {4642 listActionTypes: {4643 parameters: {4644 query?: never;4645 header?: never;4646 path?: never;4647 cookie?: never;4648 };4649 requestBody?: never;4650 responses: {4651 /** @description Catalog. */4652 200: {4653 headers: {4654 "X-Correlation-Id": components["headers"]["CorrelationId"];4655 [name: string]: unknown;4656 };4657 content: {4658 /**4659 * @example {4660 * "items": [4661 * {4662 * "type": "service.restart",4663 * "title": "Restart service",4664 * "description": "Restarts a managed service through its manager.",4665 * "criticality": "medium",4666 * "permission": "actions.run.medium",4667 * "target_kinds": [4668 * "service"4669 * ],4670 * "params_schema": {4671 * "type": "object",4672 * "additionalProperties": false4673 * },4674 * "requires_step_up": false,4675 * "requires_justification": false,4676 * "requires_confirmation": false,4677 * "requires_approval": false,4678 * "timeout_s": 120,4679 * "lock_scope": "service",4680 * "available": true4681 * },4682 * {4683 * "type": "system.reboot",4684 * "title": "Reboot node",4685 * "description": "Reboots the node. Disabled locally on agents by default.",4686 * "criticality": "critical",4687 * "permission": "actions.run.critical",4688 * "target_kinds": [4689 * "node"4690 * ],4691 * "params_schema": {4692 * "type": "object",4693 * "additionalProperties": false4694 * },4695 * "requires_step_up": true,4696 * "requires_justification": true,4697 * "requires_confirmation": true,4698 * "requires_approval": true,4699 * "timeout_s": 600,4700 * "lock_scope": "node",4701 * "available": true4702 * }4703 * ]4704 * }4705 */4706 "application/json": components["schemas"]["ActionTypeList"];4707 };4708 };4709 401: components["responses"]["Unauthenticated"];4710 403: components["responses"]["Forbidden"];4711 };4712 };4713 listActions: {4714 parameters: {4715 query?: {4716 criticality?: components["schemas"]["Criticality"];4717 /** @description Opaque cursor taken from `next_cursor` of the previous page. */4718 cursor?: components["parameters"]["Cursor"];4719 /** @description Start of the time range (inclusive, UTC). */4720 from?: components["parameters"]["From"];4721 /** @description Page size. */4722 limit?: components["parameters"]["Limit"];4723 node_id?: string;4724 requested_by?: string;4725 state?: components["schemas"]["ActionState"];4726 target_id?: string;4727 target_kind?: components["schemas"]["ActionTargetKind"];4728 /** @description End of the time range (exclusive, UTC). Defaults to now. */4729 to?: components["parameters"]["To"];4730 type?: string;4731 };4732 header?: never;4733 path?: never;4734 cookie?: never;4735 };4736 requestBody?: never;4737 responses: {4738 /** @description Actions, most recent first. */4739 200: {4740 headers: {4741 "X-Correlation-Id": components["headers"]["CorrelationId"];4742 [name: string]: unknown;4743 };4744 content: {4745 "application/json": components["schemas"]["ActionList"];4746 };4747 };4748 400: components["responses"]["BadRequest"];4749 401: components["responses"]["Unauthenticated"];4750 403: components["responses"]["Forbidden"];4751 };4752 };4753 createAction: {4754 parameters: {4755 query?: never;4756 header: {4757 /** @description Client-generated key (a UUID is recommended), unique per user. Same key and same body returns the original resource; same key with another body is `409 idempotency_conflict`. */4758 "Idempotency-Key": components["parameters"]["IdempotencyKey"];4759 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */4760 "X-MCC-CSRF"?: components["parameters"]["Csrf"];4761 };4762 path?: never;4763 cookie?: never;4764 };4765 requestBody: {4766 content: {4767 "application/json": components["schemas"]["CreateActionRequest"];4768 };4769 };4770 responses: {4771 /** @description Replay of an identical request; the original action is returned. */4772 200: {4773 headers: {4774 "X-Correlation-Id": components["headers"]["CorrelationId"];4775 [name: string]: unknown;4776 };4777 content: {4778 "application/json": components["schemas"]["Action"];4779 };4780 };4781 /** @description Action created. */4782 201: {4783 headers: {4784 "X-Correlation-Id": components["headers"]["CorrelationId"];4785 [name: string]: unknown;4786 };4787 content: {4788 /**4789 * @example {4790 * "id": "019a9c50-0000-7000-8000-00000000b001",4791 * "type": "service.restart",4792 * "criticality": "medium",4793 * "target": {4794 * "kind": "service",4795 * "id": "019a9b20-0000-7000-8000-00000000c001"4796 * },4797 * "target_label": "pm2:wp-web",4798 * "node_id": "019a9b10-0000-7000-8000-000000000a02",4799 * "node_alias": "M3U96b",4800 * "params": {},4801 * "state": "queued",4802 * "requested_by": "019a9b00-1111-7aaa-8bbb-000000000001",4803 * "requested_by_display_name": "Simon-Pierre",4804 * "requested_via": "api",4805 * "justification": "",4806 * "approval_required": false,4807 * "outcome_unknown": false,4808 * "created_at": "2026-11-18T21:30:00Z",4809 * "queued_at": "2026-11-18T21:30:00Z",4810 * "timeout_s": 120,4811 * "correlation_id": "019a9c50-0000-7000-8000-00000000cc01"4812 * }4813 */4814 "application/json": components["schemas"]["Action"];4815 };4816 };4817 400: components["responses"]["BadRequest"];4818 401: components["responses"]["Unauthenticated"];4819 403: components["responses"]["Forbidden"];4820 404: components["responses"]["NotFound"];4821 409: components["responses"]["Conflict"];4822 422: components["responses"]["Unprocessable"];4823 429: components["responses"]["RateLimited"];4824 503: components["responses"]["Unavailable"];4825 };4826 };4827 getAction: {4828 parameters: {4829 query?: never;4830 header?: never;4831 path: {4832 id: components["parameters"]["Id"];4833 };4834 cookie?: never;4835 };4836 requestBody?: never;4837 responses: {4838 /** @description Action detail. */4839 200: {4840 headers: {4841 "X-Correlation-Id": components["headers"]["CorrelationId"];4842 [name: string]: unknown;4843 };4844 content: {4845 "application/json": components["schemas"]["ActionDetail"];4846 };4847 };4848 401: components["responses"]["Unauthenticated"];4849 403: components["responses"]["Forbidden"];4850 404: components["responses"]["NotFound"];4851 };4852 };4853 approveAction: {4854 parameters: {4855 query?: never;4856 header?: {4857 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */4858 "X-MCC-CSRF"?: components["parameters"]["Csrf"];4859 };4860 path: {4861 id: components["parameters"]["Id"];4862 };4863 cookie?: never;4864 };4865 requestBody?: {4866 content: {4867 "application/json": components["schemas"]["ApproveActionRequest"];4868 };4869 };4870 responses: {4871 /** @description Approved action. */4872 200: {4873 headers: {4874 "X-Correlation-Id": components["headers"]["CorrelationId"];4875 [name: string]: unknown;4876 };4877 content: {4878 "application/json": components["schemas"]["Action"];4879 };4880 };4881 400: components["responses"]["BadRequest"];4882 401: components["responses"]["Unauthenticated"];4883 403: components["responses"]["Forbidden"];4884 404: components["responses"]["NotFound"];4885 409: components["responses"]["Conflict"];4886 503: components["responses"]["Unavailable"];4887 };4888 };4889 cancelAction: {4890 parameters: {4891 query?: never;4892 header?: {4893 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */4894 "X-MCC-CSRF"?: components["parameters"]["Csrf"];4895 };4896 path: {4897 id: components["parameters"]["Id"];4898 };4899 cookie?: never;4900 };4901 requestBody?: never;4902 responses: {4903 /** @description Action, cancelled or with cancellation requested. */4904 200: {4905 headers: {4906 "X-Correlation-Id": components["headers"]["CorrelationId"];4907 [name: string]: unknown;4908 };4909 content: {4910 "application/json": components["schemas"]["Action"];4911 };4912 };4913 401: components["responses"]["Unauthenticated"];4914 403: components["responses"]["Forbidden"];4915 404: components["responses"]["NotFound"];4916 409: components["responses"]["Conflict"];4917 };4918 };4919 getActionOutput: {4920 parameters: {4921 query?: {4922 /** @description Return events with an id strictly greater than this value. */4923 after?: number;4924 limit?: number;4925 };4926 header?: never;4927 path: {4928 id: components["parameters"]["Id"];4929 };4930 cookie?: never;4931 };4932 requestBody?: never;4933 responses: {4934 /** @description Output chunks in order. */4935 200: {4936 headers: {4937 "X-Correlation-Id": components["headers"]["CorrelationId"];4938 [name: string]: unknown;4939 };4940 content: {4941 "application/json": components["schemas"]["ActionOutput"];4942 };4943 };4944 400: components["responses"]["BadRequest"];4945 401: components["responses"]["Unauthenticated"];4946 403: components["responses"]["Forbidden"];4947 404: components["responses"]["NotFound"];4948 };4949 };4950 rejectAction: {4951 parameters: {4952 query?: never;4953 header?: {4954 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */4955 "X-MCC-CSRF"?: components["parameters"]["Csrf"];4956 };4957 path: {4958 id: components["parameters"]["Id"];4959 };4960 cookie?: never;4961 };4962 requestBody: {4963 content: {4964 "application/json": components["schemas"]["RejectActionRequest"];4965 };4966 };4967 responses: {4968 /** @description Rejected action. */4969 200: {4970 headers: {4971 "X-Correlation-Id": components["headers"]["CorrelationId"];4972 [name: string]: unknown;4973 };4974 content: {4975 "application/json": components["schemas"]["Action"];4976 };4977 };4978 400: components["responses"]["BadRequest"];4979 401: components["responses"]["Unauthenticated"];4980 403: components["responses"]["Forbidden"];4981 404: components["responses"]["NotFound"];4982 409: components["responses"]["Conflict"];4983 };4984 };4985 listActivity: {4986 parameters: {4987 query?: {4988 /** @description Opaque cursor taken from `next_cursor` of the previous page. */4989 cursor?: components["parameters"]["Cursor"];4990 kind?: components["schemas"]["ActivityKind"];4991 /** @description Page size. */4992 limit?: components["parameters"]["Limit"];4993 node_id?: string;4994 };4995 header?: never;4996 path?: never;4997 cookie?: never;4998 };4999 requestBody?: never;5000 responses: {5001 /** @description Activity items, most recent first. */5002 200: {5003 headers: {5004 "X-Correlation-Id": components["headers"]["CorrelationId"];5005 [name: string]: unknown;5006 };5007 content: {5008 "application/json": components["schemas"]["ActivityList"];5009 };5010 };5011 400: components["responses"]["BadRequest"];5012 401: components["responses"]["Unauthenticated"];5013 403: components["responses"]["Forbidden"];5014 };5015 };5016 getAdminStatus: {5017 parameters: {5018 query?: never;5019 header?: never;5020 path?: never;5021 cookie?: never;5022 };5023 requestBody?: never;5024 responses: {5025 /** @description Backend status. */5026 200: {5027 headers: {5028 "X-Correlation-Id": components["headers"]["CorrelationId"];5029 [name: string]: unknown;5030 };5031 content: {5032 "application/json": components["schemas"]["AdminStatus"];5033 };5034 };5035 401: components["responses"]["Unauthenticated"];5036 403: components["responses"]["Forbidden"];5037 };5038 };5039 listAgents: {5040 parameters: {5041 query?: {5042 /** @description Opaque cursor taken from `next_cursor` of the previous page. */5043 cursor?: components["parameters"]["Cursor"];5044 /** @description Page size. */5045 limit?: components["parameters"]["Limit"];5046 node_id?: string;5047 /** @description Include revoked agents (default false). */5048 revoked?: boolean;5049 };5050 header?: never;5051 path?: never;5052 cookie?: never;5053 };5054 requestBody?: never;5055 responses: {5056 /** @description Agents. */5057 200: {5058 headers: {5059 "X-Correlation-Id": components["headers"]["CorrelationId"];5060 [name: string]: unknown;5061 };5062 content: {5063 "application/json": components["schemas"]["AgentList"];5064 };5065 };5066 400: components["responses"]["BadRequest"];5067 401: components["responses"]["Unauthenticated"];5068 403: components["responses"]["Forbidden"];5069 };5070 };5071 revokeAgent: {5072 parameters: {5073 query?: never;5074 header?: {5075 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5076 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5077 };5078 path: {5079 id: components["parameters"]["Id"];5080 };5081 cookie?: never;5082 };5083 requestBody: {5084 content: {5085 "application/json": components["schemas"]["RevokeAgentRequest"];5086 };5087 };5088 responses: {5089 /** @description Revoked agent. */5090 200: {5091 headers: {5092 "X-Correlation-Id": components["headers"]["CorrelationId"];5093 [name: string]: unknown;5094 };5095 content: {5096 "application/json": components["schemas"]["Agent"];5097 };5098 };5099 400: components["responses"]["BadRequest"];5100 401: components["responses"]["Unauthenticated"];5101 403: components["responses"]["Forbidden"];5102 404: components["responses"]["NotFound"];5103 409: components["responses"]["Conflict"];5104 };5105 };5106 listEnrollmentTokens: {5107 parameters: {5108 query?: {5109 /** @description Opaque cursor taken from `next_cursor` of the previous page. */5110 cursor?: components["parameters"]["Cursor"];5111 /** @description Page size. */5112 limit?: components["parameters"]["Limit"];5113 };5114 header?: never;5115 path?: never;5116 cookie?: never;5117 };5118 requestBody?: never;5119 responses: {5120 /** @description Enrollment tokens, most recent first. */5121 200: {5122 headers: {5123 "X-Correlation-Id": components["headers"]["CorrelationId"];5124 [name: string]: unknown;5125 };5126 content: {5127 "application/json": components["schemas"]["EnrollmentTokenList"];5128 };5129 };5130 400: components["responses"]["BadRequest"];5131 401: components["responses"]["Unauthenticated"];5132 403: components["responses"]["Forbidden"];5133 };5134 };5135 createEnrollmentToken: {5136 parameters: {5137 query?: never;5138 header?: {5139 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5140 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5141 };5142 path?: never;5143 cookie?: never;5144 };5145 requestBody: {5146 content: {5147 /**5148 * @example {5149 * "node_alias": "m4mn",5150 * "node_kind": "mac",5151 * "ttl_minutes": 155152 * }5153 */5154 "application/json": components["schemas"]["CreateEnrollmentTokenRequest"];5155 };5156 };5157 responses: {5158 /** @description Token created; shown once. */5159 201: {5160 headers: {5161 "X-Correlation-Id": components["headers"]["CorrelationId"];5162 [name: string]: unknown;5163 };5164 content: {5165 "application/json": components["schemas"]["EnrollmentTokenCreated"];5166 };5167 };5168 400: components["responses"]["BadRequest"];5169 401: components["responses"]["Unauthenticated"];5170 403: components["responses"]["Forbidden"];5171 409: components["responses"]["Conflict"];5172 };5173 };5174 revokeEnrollmentToken: {5175 parameters: {5176 query?: never;5177 header?: {5178 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5179 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5180 };5181 path: {5182 id: components["parameters"]["Id"];5183 };5184 cookie?: never;5185 };5186 requestBody?: never;5187 responses: {5188 /** @description Token revoked. */5189 204: {5190 headers: {5191 "X-Correlation-Id": components["headers"]["CorrelationId"];5192 [name: string]: unknown;5193 };5194 content?: never;5195 };5196 401: components["responses"]["Unauthenticated"];5197 403: components["responses"]["Forbidden"];5198 404: components["responses"]["NotFound"];5199 };5200 };5201 listAlertRules: {5202 parameters: {5203 query?: {5204 /** @description Opaque cursor taken from `next_cursor` of the previous page. */5205 cursor?: components["parameters"]["Cursor"];5206 enabled?: boolean;5207 /** @description Page size. */5208 limit?: components["parameters"]["Limit"];5209 };5210 header?: never;5211 path?: never;5212 cookie?: never;5213 };5214 requestBody?: never;5215 responses: {5216 /** @description Rules. */5217 200: {5218 headers: {5219 "X-Correlation-Id": components["headers"]["CorrelationId"];5220 [name: string]: unknown;5221 };5222 content: {5223 "application/json": components["schemas"]["AlertRuleList"];5224 };5225 };5226 400: components["responses"]["BadRequest"];5227 401: components["responses"]["Unauthenticated"];5228 403: components["responses"]["Forbidden"];5229 };5230 };5231 createAlertRule: {5232 parameters: {5233 query?: never;5234 header?: {5235 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5236 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5237 };5238 path?: never;5239 cookie?: never;5240 };5241 requestBody: {5242 content: {5243 /**5244 * @example {5245 * "name": "Disk almost full",5246 * "kind": "threshold",5247 * "metric": "disk.used_pct",5248 * "op": "gte",5249 * "threshold": 95,5250 * "clear_threshold": 92,5251 * "for_seconds": 300,5252 * "clear_seconds": 120,5253 * "severity": "critical",5254 * "scope": {5255 * "all": true5256 * }5257 * }5258 */5259 "application/json": components["schemas"]["AlertRuleInput"];5260 };5261 };5262 responses: {5263 /** @description Rule created. */5264 201: {5265 headers: {5266 "X-Correlation-Id": components["headers"]["CorrelationId"];5267 [name: string]: unknown;5268 };5269 content: {5270 "application/json": components["schemas"]["AlertRule"];5271 };5272 };5273 400: components["responses"]["BadRequest"];5274 401: components["responses"]["Unauthenticated"];5275 403: components["responses"]["Forbidden"];5276 409: components["responses"]["Conflict"];5277 };5278 };5279 getAlertRule: {5280 parameters: {5281 query?: never;5282 header?: never;5283 path: {5284 id: components["parameters"]["Id"];5285 };5286 cookie?: never;5287 };5288 requestBody?: never;5289 responses: {5290 /** @description Rule. */5291 200: {5292 headers: {5293 "X-Correlation-Id": components["headers"]["CorrelationId"];5294 [name: string]: unknown;5295 };5296 content: {5297 "application/json": components["schemas"]["AlertRule"];5298 };5299 };5300 401: components["responses"]["Unauthenticated"];5301 403: components["responses"]["Forbidden"];5302 404: components["responses"]["NotFound"];5303 };5304 };5305 deleteAlertRule: {5306 parameters: {5307 query?: never;5308 header?: {5309 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5310 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5311 };5312 path: {5313 id: components["parameters"]["Id"];5314 };5315 cookie?: never;5316 };5317 requestBody?: never;5318 responses: {5319 /** @description Rule deleted. */5320 204: {5321 headers: {5322 "X-Correlation-Id": components["headers"]["CorrelationId"];5323 [name: string]: unknown;5324 };5325 content?: never;5326 };5327 401: components["responses"]["Unauthenticated"];5328 403: components["responses"]["Forbidden"];5329 404: components["responses"]["NotFound"];5330 409: components["responses"]["Conflict"];5331 };5332 };5333 updateAlertRule: {5334 parameters: {5335 query?: never;5336 header?: {5337 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5338 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5339 };5340 path: {5341 id: components["parameters"]["Id"];5342 };5343 cookie?: never;5344 };5345 requestBody: {5346 content: {5347 "application/json": components["schemas"]["UpdateAlertRuleRequest"];5348 };5349 };5350 responses: {5351 /** @description Updated rule. */5352 200: {5353 headers: {5354 "X-Correlation-Id": components["headers"]["CorrelationId"];5355 [name: string]: unknown;5356 };5357 content: {5358 "application/json": components["schemas"]["AlertRule"];5359 };5360 };5361 400: components["responses"]["BadRequest"];5362 401: components["responses"]["Unauthenticated"];5363 403: components["responses"]["Forbidden"];5364 404: components["responses"]["NotFound"];5365 409: components["responses"]["Conflict"];5366 };5367 };5368 validateAlertRule: {5369 parameters: {5370 query?: never;5371 header?: {5372 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5373 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5374 };5375 path?: never;5376 cookie?: never;5377 };5378 requestBody: {5379 content: {5380 "application/json": components["schemas"]["ValidateAlertRuleRequest"];5381 };5382 };5383 responses: {5384 /** @description Would-have-fired intervals. */5385 200: {5386 headers: {5387 "X-Correlation-Id": components["headers"]["CorrelationId"];5388 [name: string]: unknown;5389 };5390 content: {5391 "application/json": components["schemas"]["AlertRuleValidation"];5392 };5393 };5394 400: components["responses"]["BadRequest"];5395 401: components["responses"]["Unauthenticated"];5396 403: components["responses"]["Forbidden"];5397 422: components["responses"]["Unprocessable"];5398 };5399 };5400 listAlerts: {5401 parameters: {5402 query?: {5403 /** @description Opaque cursor taken from `next_cursor` of the previous page. */5404 cursor?: components["parameters"]["Cursor"];5405 incident_id?: string;5406 /** @description Page size. */5407 limit?: components["parameters"]["Limit"];5408 node_id?: string;5409 /** @description true = every state except `resolved`. */5410 open?: boolean;5411 rule_id?: string;5412 severity?: components["schemas"]["Severity"];5413 state?: components["schemas"]["AlertState"];5414 };5415 header?: never;5416 path?: never;5417 cookie?: never;5418 };5419 requestBody?: never;5420 responses: {5421 /** @description Alerts, most recent first. */5422 200: {5423 headers: {5424 "X-Correlation-Id": components["headers"]["CorrelationId"];5425 [name: string]: unknown;5426 };5427 content: {5428 "application/json": components["schemas"]["AlertList"];5429 };5430 };5431 400: components["responses"]["BadRequest"];5432 401: components["responses"]["Unauthenticated"];5433 403: components["responses"]["Forbidden"];5434 };5435 };5436 getAlert: {5437 parameters: {5438 query?: never;5439 header?: never;5440 path: {5441 id: components["parameters"]["Id"];5442 };5443 cookie?: never;5444 };5445 requestBody?: never;5446 responses: {5447 /** @description Alert and timeline. */5448 200: {5449 headers: {5450 "X-Correlation-Id": components["headers"]["CorrelationId"];5451 [name: string]: unknown;5452 };5453 content: {5454 "application/json": components["schemas"]["AlertDetail"];5455 };5456 };5457 401: components["responses"]["Unauthenticated"];5458 403: components["responses"]["Forbidden"];5459 404: components["responses"]["NotFound"];5460 };5461 };5462 acknowledgeAlert: {5463 parameters: {5464 query?: never;5465 header?: {5466 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5467 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5468 };5469 path: {5470 id: components["parameters"]["Id"];5471 };5472 cookie?: never;5473 };5474 requestBody?: {5475 content: {5476 "application/json": components["schemas"]["AlertTransitionRequest"];5477 };5478 };5479 responses: {5480 /** @description Acknowledged alert. */5481 200: {5482 headers: {5483 "X-Correlation-Id": components["headers"]["CorrelationId"];5484 [name: string]: unknown;5485 };5486 content: {5487 "application/json": components["schemas"]["Alert"];5488 };5489 };5490 400: components["responses"]["BadRequest"];5491 401: components["responses"]["Unauthenticated"];5492 403: components["responses"]["Forbidden"];5493 404: components["responses"]["NotFound"];5494 409: components["responses"]["Conflict"];5495 };5496 };5497 commentAlert: {5498 parameters: {5499 query?: never;5500 header?: {5501 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5502 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5503 };5504 path: {5505 id: components["parameters"]["Id"];5506 };5507 cookie?: never;5508 };5509 requestBody: {5510 content: {5511 "application/json": components["schemas"]["CommentRequest"];5512 };5513 };5514 responses: {5515 /** @description Timeline event created. */5516 201: {5517 headers: {5518 "X-Correlation-Id": components["headers"]["CorrelationId"];5519 [name: string]: unknown;5520 };5521 content: {5522 "application/json": components["schemas"]["TimelineEvent"];5523 };5524 };5525 400: components["responses"]["BadRequest"];5526 401: components["responses"]["Unauthenticated"];5527 403: components["responses"]["Forbidden"];5528 404: components["responses"]["NotFound"];5529 };5530 };5531 resolveAlert: {5532 parameters: {5533 query?: never;5534 header?: {5535 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5536 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5537 };5538 path: {5539 id: components["parameters"]["Id"];5540 };5541 cookie?: never;5542 };5543 requestBody?: {5544 content: {5545 "application/json": components["schemas"]["AlertTransitionRequest"];5546 };5547 };5548 responses: {5549 /** @description Resolved alert. */5550 200: {5551 headers: {5552 "X-Correlation-Id": components["headers"]["CorrelationId"];5553 [name: string]: unknown;5554 };5555 content: {5556 "application/json": components["schemas"]["Alert"];5557 };5558 };5559 400: components["responses"]["BadRequest"];5560 401: components["responses"]["Unauthenticated"];5561 403: components["responses"]["Forbidden"];5562 404: components["responses"]["NotFound"];5563 409: components["responses"]["Conflict"];5564 };5565 };5566 listAudit: {5567 parameters: {5568 query?: {5569 /** @description Exact action name, or a prefix ending with `*` (for example `auth.*`). */5570 action?: string;5571 actor_id?: string;5572 correlation_id?: string;5573 /** @description Opaque cursor taken from `next_cursor` of the previous page. */5574 cursor?: components["parameters"]["Cursor"];5575 /** @description Start of the time range (inclusive, UTC). */5576 from?: components["parameters"]["From"];5577 /** @description Page size. */5578 limit?: components["parameters"]["Limit"];5579 outcome?: components["schemas"]["AuditOutcome"];5580 target_id?: string;5581 target_kind?: string;5582 /** @description End of the time range (exclusive, UTC). Defaults to now. */5583 to?: components["parameters"]["To"];5584 };5585 header?: never;5586 path?: never;5587 cookie?: never;5588 };5589 requestBody?: never;5590 responses: {5591 /** @description Audit entries. */5592 200: {5593 headers: {5594 "X-Correlation-Id": components["headers"]["CorrelationId"];5595 [name: string]: unknown;5596 };5597 content: {5598 "application/json": components["schemas"]["AuditList"];5599 };5600 };5601 400: components["responses"]["BadRequest"];5602 401: components["responses"]["Unauthenticated"];5603 403: components["responses"]["Forbidden"];5604 };5605 };5606 exportAudit: {5607 parameters: {5608 query: {5609 format?: "jsonl";5610 from: string;5611 to: string;5612 };5613 header?: never;5614 path?: never;5615 cookie?: never;5616 };5617 requestBody?: never;5618 responses: {5619 /** @description Audit export file. */5620 200: {5621 headers: {5622 /** @description `attachment; filename="mcc-audit-<from>-<to>.jsonl"` */5623 "Content-Disposition"?: string;5624 "X-Correlation-Id": components["headers"]["CorrelationId"];5625 /** @description Hex SHA-256 chain hash of the last exported entry. */5626 "X-MCC-Audit-Head-Hash"?: string;5627 /** @description Base64 Ed25519 signature of the head hash; the key id is the prefix before the colon (`<key_id>:<signature>`). */5628 "X-MCC-Audit-Signature"?: string;5629 [name: string]: unknown;5630 };5631 content: {5632 "application/x-ndjson": string;5633 };5634 };5635 400: components["responses"]["BadRequest"];5636 401: components["responses"]["Unauthenticated"];5637 403: components["responses"]["Forbidden"];5638 };5639 };5640 verifyAudit: {5641 parameters: {5642 query?: {5643 from_seq?: number;5644 };5645 header?: never;5646 path?: never;5647 cookie?: never;5648 };5649 requestBody?: never;5650 responses: {5651 /** @description Verification result (`ok=false` is a successful verification that found a break). */5652 200: {5653 headers: {5654 "X-Correlation-Id": components["headers"]["CorrelationId"];5655 [name: string]: unknown;5656 };5657 content: {5658 "application/json": components["schemas"]["AuditVerification"];5659 };5660 };5661 400: components["responses"]["BadRequest"];5662 401: components["responses"]["Unauthenticated"];5663 403: components["responses"]["Forbidden"];5664 };5665 };5666 logout: {5667 parameters: {5668 query?: never;5669 header?: {5670 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5671 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5672 };5673 path?: never;5674 cookie?: never;5675 };5676 requestBody?: never;5677 responses: {5678 /** @description Session revoked. */5679 204: {5680 headers: {5681 "X-Correlation-Id": components["headers"]["CorrelationId"];5682 [name: string]: unknown;5683 };5684 content?: never;5685 };5686 401: components["responses"]["Unauthenticated"];5687 403: components["responses"]["Forbidden"];5688 };5689 };5690 refreshSession: {5691 parameters: {5692 query?: never;5693 header?: never;5694 path?: never;5695 cookie?: never;5696 };5697 requestBody: {5698 content: {5699 "application/json": components["schemas"]["RefreshRequest"];5700 };5701 };5702 responses: {5703 /** @description New token pair. */5704 200: {5705 headers: {5706 "X-Correlation-Id": components["headers"]["CorrelationId"];5707 [name: string]: unknown;5708 };5709 content: {5710 "application/json": components["schemas"]["TokenPair"];5711 };5712 };5713 400: components["responses"]["BadRequest"];5714 401: components["responses"]["Unauthenticated"];5715 429: components["responses"]["RateLimited"];5716 };5717 };5718 beginStepUp: {5719 parameters: {5720 query?: never;5721 header?: {5722 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5723 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5724 };5725 path?: never;5726 cookie?: never;5727 };5728 requestBody?: never;5729 responses: {5730 /** @description Challenge created. */5731 200: {5732 headers: {5733 "X-Correlation-Id": components["headers"]["CorrelationId"];5734 [name: string]: unknown;5735 };5736 content: {5737 "application/json": components["schemas"]["WebAuthnChallenge"];5738 };5739 };5740 401: components["responses"]["Unauthenticated"];5741 403: components["responses"]["Forbidden"];5742 429: components["responses"]["RateLimited"];5743 };5744 };5745 finishStepUp: {5746 parameters: {5747 query?: never;5748 header?: {5749 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5750 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5751 };5752 path?: never;5753 cookie?: never;5754 };5755 requestBody: {5756 content: {5757 "application/json": components["schemas"]["StepUpFinishRequest"];5758 };5759 };5760 responses: {5761 /** @description Step-up accepted. */5762 200: {5763 headers: {5764 "X-Correlation-Id": components["headers"]["CorrelationId"];5765 [name: string]: unknown;5766 };5767 content: {5768 "application/json": components["schemas"]["StepUpResult"];5769 };5770 };5771 400: components["responses"]["BadRequest"];5772 401: components["responses"]["Unauthenticated"];5773 403: components["responses"]["Forbidden"];5774 429: components["responses"]["RateLimited"];5775 };5776 };5777 beginAuthentication: {5778 parameters: {5779 query?: never;5780 header?: never;5781 path?: never;5782 cookie?: never;5783 };5784 requestBody?: never;5785 responses: {5786 /** @description Challenge created. */5787 200: {5788 headers: {5789 "X-Correlation-Id": components["headers"]["CorrelationId"];5790 [name: string]: unknown;5791 };5792 content: {5793 /**5794 * @example {5795 * "challenge_id": "019a9c1e-7b10-7c3a-9d54-2f6f1f0f3a11",5796 * "expires_at": "2026-11-18T21:05:00Z",5797 * "public_key": {5798 * "challenge": "3q2-7wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",5799 * "rpId": "clustr.spboucher.ai",5800 * "timeout": 300000,5801 * "userVerification": "required"5802 * }5803 * }5804 */5805 "application/json": components["schemas"]["WebAuthnChallenge"];5806 };5807 };5808 429: components["responses"]["RateLimited"];5809 503: components["responses"]["Unavailable"];5810 };5811 };5812 finishAuthentication: {5813 parameters: {5814 query?: never;5815 header?: never;5816 path?: never;5817 cookie?: never;5818 };5819 requestBody: {5820 content: {5821 /**5822 * @example {5823 * "challenge_id": "019a9c1e-7b10-7c3a-9d54-2f6f1f0f3a11",5824 * "credential": {5825 * "id": "Xk3f0Jm2Qy8",5826 * "rawId": "Xk3f0Jm2Qy8",5827 * "type": "public-key",5828 * "response": {5829 * "clientDataJSON": "eyJ0eXBlIjoid2ViYXV0aG4uZ2V0In0",5830 * "authenticatorData": "SZYN5YgO",5831 * "signature": "MEUCIQ",5832 * "userHandle": "q83vEjRWeJA"5833 * }5834 * },5835 * "client": {5836 * "kind": "web",5837 * "label": "Safari on MacBook Pro"5838 * }5839 * }5840 */5841 "application/json": components["schemas"]["AuthenticationFinishRequest"];5842 };5843 };5844 responses: {5845 /** @description Authenticated. For web clients the session cookie is set. */5846 200: {5847 headers: {5848 /** @description `__Host-mcc_session=<opaque>; Secure; HttpOnly; SameSite=Strict; Path=/` (web clients only). */5849 "Set-Cookie"?: string;5850 "X-Correlation-Id": components["headers"]["CorrelationId"];5851 [name: string]: unknown;5852 };5853 content: {5854 /**5855 * @example {5856 * "user": {5857 * "id": "019a9b00-1111-7aaa-8bbb-000000000001",5858 * "handle": "spb",5859 * "display_name": "Simon-Pierre",5860 * "role": "owner",5861 * "locale": "fr",5862 * "disabled": false,5863 * "created_at": "2026-11-18T20:40:00Z"5864 * },5865 * "session": {5866 * "id": "019a9c1e-9000-7000-8000-00000000a001",5867 * "kind": "cookie",5868 * "device_id": "019a9c1e-9000-7000-8000-00000000d001",5869 * "current": true,5870 * "created_at": "2026-11-18T21:00:12Z",5871 * "last_seen_at": "2026-11-18T21:00:12Z",5872 * "authenticated_at": "2026-11-18T21:00:12Z",5873 * "step_up_valid_until": "2026-11-18T21:05:12Z",5874 * "idle_expires_at": "2026-11-18T21:30:12Z",5875 * "absolute_expires_at": "2026-11-19T09:00:12Z"5876 * },5877 * "csrf_token": "6fJmC0n1x1c0u0S7wq5a8nq3mVbYb1pZ5nq2dX0v9Qk"5878 * }5879 */5880 "application/json": components["schemas"]["AuthResult"];5881 };5882 };5883 400: components["responses"]["BadRequest"];5884 401: components["responses"]["Unauthenticated"];5885 403: components["responses"]["Forbidden"];5886 429: components["responses"]["RateLimited"];5887 503: components["responses"]["Unavailable"];5888 };5889 };5890 beginRegistration: {5891 parameters: {5892 query?: never;5893 header?: {5894 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5895 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5896 };5897 path?: never;5898 cookie?: never;5899 };5900 requestBody?: {5901 content: {5902 "application/json": components["schemas"]["RegistrationBeginRequest"];5903 };5904 };5905 responses: {5906 /** @description Challenge created. `public_key` is the PublicKeyCredentialCreationOptions JSON. */5907 200: {5908 headers: {5909 "X-Correlation-Id": components["headers"]["CorrelationId"];5910 [name: string]: unknown;5911 };5912 content: {5913 "application/json": components["schemas"]["WebAuthnChallenge"];5914 };5915 };5916 400: components["responses"]["BadRequest"];5917 401: components["responses"]["Unauthenticated"];5918 403: components["responses"]["Forbidden"];5919 410: components["responses"]["Gone"];5920 429: components["responses"]["RateLimited"];5921 };5922 };5923 finishRegistration: {5924 parameters: {5925 query?: never;5926 header?: {5927 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */5928 "X-MCC-CSRF"?: components["parameters"]["Csrf"];5929 };5930 path?: never;5931 cookie?: never;5932 };5933 requestBody: {5934 content: {5935 "application/json": components["schemas"]["RegistrationFinishRequest"];5936 };5937 };5938 responses: {5939 /** @description Passkey registered. */5940 200: {5941 headers: {5942 /** @description Session cookie, only when an invitation is completed by a web client. */5943 "Set-Cookie"?: string;5944 "X-Correlation-Id": components["headers"]["CorrelationId"];5945 [name: string]: unknown;5946 };5947 content: {5948 "application/json": components["schemas"]["RegistrationResult"];5949 };5950 };5951 400: components["responses"]["BadRequest"];5952 401: components["responses"]["Unauthenticated"];5953 403: components["responses"]["Forbidden"];5954 409: components["responses"]["Conflict"];5955 410: components["responses"]["Gone"];5956 429: components["responses"]["RateLimited"];5957 };5958 };5959 getClusterOverview: {5960 parameters: {5961 query?: never;5962 header?: never;5963 path?: never;5964 cookie?: never;5965 };5966 requestBody?: never;5967 responses: {5968 /** @description Overview. */5969 200: {5970 headers: {5971 "X-Correlation-Id": components["headers"]["CorrelationId"];5972 [name: string]: unknown;5973 };5974 content: {5975 /**5976 * @example {5977 * "generated_at": "2026-11-18T21:15:00Z",5978 * "nodes": {5979 * "total": 30,5980 * "fresh": 27,5981 * "stale": 1,5982 * "offline": 2,5983 * "maintenance": 15984 * },5985 * "capacity": {5986 * "cpu_cores": {5987 * "total": 379,5988 * "coverage": 285989 * },5990 * "memory": {5991 * "total": 1108101562368,5992 * "used": 402122547200,5993 * "coverage": 285994 * },5995 * "storage": {5996 * "total": 14629000000000,5997 * "used": 5310000000000,5998 * "coverage": 285999 * }6000 * },6001 * "alerts": {6002 * "info": 0,6003 * "warning": 3,6004 * "critical": 16005 * },6006 * "open_incidents": 1,6007 * "jobs": {6008 * "queued": 0,6009 * "running": 26010 * },6011 * "services": {6012 * "online": 93,6013 * "stopped": 4,6014 * "errored": 7,6015 * "unknown": 06016 * },6017 * "models": {6018 * "total": 2,6019 * "online": 26020 * },6021 * "nas": {6022 * "total": 2,6023 * "online": 1,6024 * "offline": 1,6025 * "unknown": 06026 * },6027 * "backups": {6028 * "total": 6,6029 * "ok": 4,6030 * "failed": 1,6031 * "unknown": 1,6032 * "last_success_at": "2026-11-18T08:00:11Z"6033 * },6034 * "recent_actions": []6035 * }6036 */6037 "application/json": components["schemas"]["ClusterOverview"];6038 };6039 };6040 401: components["responses"]["Unauthenticated"];6041 403: components["responses"]["Forbidden"];6042 };6043 };6044 getClusterTrends: {6045 parameters: {6046 query: {6047 group_by?: components["schemas"]["TrendGroupBy"];6048 /** @description Metric name from `GET /metrics/catalog`, for example `cpu.usage`. */6049 metric: string;6050 range?: components["schemas"]["TimeRange"];6051 };6052 header?: never;6053 path?: never;6054 cookie?: never;6055 };6056 requestBody?: never;6057 responses: {6058 /** @description Aggregated series. */6059 200: {6060 headers: {6061 "X-Correlation-Id": components["headers"]["CorrelationId"];6062 [name: string]: unknown;6063 };6064 content: {6065 "application/json": components["schemas"]["TrendsResponse"];6066 };6067 };6068 400: components["responses"]["BadRequest"];6069 401: components["responses"]["Unauthenticated"];6070 403: components["responses"]["Forbidden"];6071 };6072 };6073 revokeDevice: {6074 parameters: {6075 query?: never;6076 header?: {6077 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6078 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6079 };6080 path: {6081 id: components["parameters"]["Id"];6082 };6083 cookie?: never;6084 };6085 requestBody?: never;6086 responses: {6087 /** @description Device and sessions revoked. */6088 204: {6089 headers: {6090 "X-Correlation-Id": components["headers"]["CorrelationId"];6091 [name: string]: unknown;6092 };6093 content?: never;6094 };6095 401: components["responses"]["Unauthenticated"];6096 403: components["responses"]["Forbidden"];6097 404: components["responses"]["NotFound"];6098 };6099 };6100 streamEvents: {6101 parameters: {6102 query?: {6103 /** @description Same as the `Last-Event-ID` header, for clients that cannot set headers. */6104 last_event_id?: string;6105 /** @description Comma-separated topics to receive (all permitted topics when omitted). */6106 topics?: components["schemas"]["EventTopic"][];6107 };6108 header?: {6109 /** @description Sequence of the last event received; the stream resumes after it. */6110 "Last-Event-ID"?: string;6111 };6112 path?: never;6113 cookie?: never;6114 };6115 requestBody?: never;6116 responses: {6117 /** @description Event stream; stays open. */6118 200: {6119 headers: {6120 /** @description Always `no-store`. */6121 "Cache-Control"?: string;6122 "X-Correlation-Id": components["headers"]["CorrelationId"];6123 [name: string]: unknown;6124 };6125 content: {6126 "text/event-stream": components["schemas"]["EventStreamFrame"];6127 };6128 };6129 400: components["responses"]["BadRequest"];6130 401: components["responses"]["Unauthenticated"];6131 403: components["responses"]["Forbidden"];6132 429: components["responses"]["RateLimited"];6133 503: components["responses"]["Unavailable"];6134 };6135 };6136 getLiveness: {6137 parameters: {6138 query?: never;6139 header?: never;6140 path?: never;6141 cookie?: never;6142 };6143 requestBody?: never;6144 responses: {6145 /** @description Alive. */6146 200: {6147 headers: {6148 "X-Correlation-Id": components["headers"]["CorrelationId"];6149 [name: string]: unknown;6150 };6151 content: {6152 "application/json": components["schemas"]["HealthStatus"];6153 };6154 };6155 };6156 };6157 getReadiness: {6158 parameters: {6159 query?: never;6160 header?: never;6161 path?: never;6162 cookie?: never;6163 };6164 requestBody?: never;6165 responses: {6166 /** @description Ready. */6167 200: {6168 headers: {6169 "X-Correlation-Id": components["headers"]["CorrelationId"];6170 [name: string]: unknown;6171 };6172 content: {6173 "application/json": components["schemas"]["HealthStatus"];6174 };6175 };6176 503: components["responses"]["Unavailable"];6177 };6178 };6179 listIncidents: {6180 parameters: {6181 query?: {6182 /** @description Opaque cursor taken from `next_cursor` of the previous page. */6183 cursor?: components["parameters"]["Cursor"];6184 /** @description Page size. */6185 limit?: components["parameters"]["Limit"];6186 severity?: components["schemas"]["Severity"];6187 state?: components["schemas"]["IncidentState"];6188 };6189 header?: never;6190 path?: never;6191 cookie?: never;6192 };6193 requestBody?: never;6194 responses: {6195 /** @description Incidents, most recent first. */6196 200: {6197 headers: {6198 "X-Correlation-Id": components["headers"]["CorrelationId"];6199 [name: string]: unknown;6200 };6201 content: {6202 "application/json": components["schemas"]["IncidentList"];6203 };6204 };6205 400: components["responses"]["BadRequest"];6206 401: components["responses"]["Unauthenticated"];6207 403: components["responses"]["Forbidden"];6208 };6209 };6210 createIncident: {6211 parameters: {6212 query?: never;6213 header?: {6214 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6215 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6216 };6217 path?: never;6218 cookie?: never;6219 };6220 requestBody: {6221 content: {6222 "application/json": components["schemas"]["CreateIncidentRequest"];6223 };6224 };6225 responses: {6226 /** @description Incident opened. */6227 201: {6228 headers: {6229 "X-Correlation-Id": components["headers"]["CorrelationId"];6230 [name: string]: unknown;6231 };6232 content: {6233 "application/json": components["schemas"]["Incident"];6234 };6235 };6236 400: components["responses"]["BadRequest"];6237 401: components["responses"]["Unauthenticated"];6238 403: components["responses"]["Forbidden"];6239 404: components["responses"]["NotFound"];6240 };6241 };6242 getIncident: {6243 parameters: {6244 query?: never;6245 header?: never;6246 path: {6247 id: components["parameters"]["Id"];6248 };6249 cookie?: never;6250 };6251 requestBody?: never;6252 responses: {6253 /** @description Incident detail. */6254 200: {6255 headers: {6256 "X-Correlation-Id": components["headers"]["CorrelationId"];6257 [name: string]: unknown;6258 };6259 content: {6260 "application/json": components["schemas"]["IncidentDetail"];6261 };6262 };6263 401: components["responses"]["Unauthenticated"];6264 403: components["responses"]["Forbidden"];6265 404: components["responses"]["NotFound"];6266 };6267 };6268 updateIncident: {6269 parameters: {6270 query?: never;6271 header?: {6272 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6273 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6274 };6275 path: {6276 id: components["parameters"]["Id"];6277 };6278 cookie?: never;6279 };6280 requestBody: {6281 content: {6282 "application/json": components["schemas"]["UpdateIncidentRequest"];6283 };6284 };6285 responses: {6286 /** @description Updated incident. */6287 200: {6288 headers: {6289 "X-Correlation-Id": components["headers"]["CorrelationId"];6290 [name: string]: unknown;6291 };6292 content: {6293 "application/json": components["schemas"]["Incident"];6294 };6295 };6296 400: components["responses"]["BadRequest"];6297 401: components["responses"]["Unauthenticated"];6298 403: components["responses"]["Forbidden"];6299 404: components["responses"]["NotFound"];6300 409: components["responses"]["Conflict"];6301 };6302 };6303 commentIncident: {6304 parameters: {6305 query?: never;6306 header?: {6307 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6308 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6309 };6310 path: {6311 id: components["parameters"]["Id"];6312 };6313 cookie?: never;6314 };6315 requestBody: {6316 content: {6317 "application/json": components["schemas"]["CommentRequest"];6318 };6319 };6320 responses: {6321 /** @description Timeline event created. */6322 201: {6323 headers: {6324 "X-Correlation-Id": components["headers"]["CorrelationId"];6325 [name: string]: unknown;6326 };6327 content: {6328 "application/json": components["schemas"]["TimelineEvent"];6329 };6330 };6331 400: components["responses"]["BadRequest"];6332 401: components["responses"]["Unauthenticated"];6333 403: components["responses"]["Forbidden"];6334 404: components["responses"]["NotFound"];6335 };6336 };6337 listInvitations: {6338 parameters: {6339 query?: {6340 /** @description Opaque cursor taken from `next_cursor` of the previous page. */6341 cursor?: components["parameters"]["Cursor"];6342 /** @description Page size. */6343 limit?: components["parameters"]["Limit"];6344 status?: components["schemas"]["InvitationStatus"];6345 };6346 header?: never;6347 path?: never;6348 cookie?: never;6349 };6350 requestBody?: never;6351 responses: {6352 /** @description Invitations, most recent first. */6353 200: {6354 headers: {6355 "X-Correlation-Id": components["headers"]["CorrelationId"];6356 [name: string]: unknown;6357 };6358 content: {6359 "application/json": components["schemas"]["InvitationList"];6360 };6361 };6362 400: components["responses"]["BadRequest"];6363 401: components["responses"]["Unauthenticated"];6364 403: components["responses"]["Forbidden"];6365 };6366 };6367 createInvitation: {6368 parameters: {6369 query?: never;6370 header?: {6371 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6372 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6373 };6374 path?: never;6375 cookie?: never;6376 };6377 requestBody: {6378 content: {6379 /**6380 * @example {6381 * "role": "operator",6382 * "handle": "erika",6383 * "display_name": "Erika",6384 * "ttl_minutes": 15,6385 * "note": "Night shift operator"6386 * }6387 */6388 "application/json": components["schemas"]["CreateInvitationRequest"];6389 };6390 };6391 responses: {6392 /** @description Invitation created; token shown once. */6393 201: {6394 headers: {6395 "X-Correlation-Id": components["headers"]["CorrelationId"];6396 [name: string]: unknown;6397 };6398 content: {6399 /**6400 * @example {6401 * "invitation": {6402 * "id": "019a9c20-0000-7000-8000-0000000000e1",6403 * "purpose": "new_account",6404 * "role": "operator",6405 * "handle": "erika",6406 * "display_name": "Erika",6407 * "note": "Night shift operator",6408 * "status": "pending",6409 * "failed_attempts": 0,6410 * "created_by": "019a9b00-1111-7aaa-8bbb-000000000001",6411 * "created_by_display_name": "Simon-Pierre",6412 * "created_at": "2026-11-18T21:10:00Z",6413 * "expires_at": "2026-11-18T21:25:00Z"6414 * },6415 * "token": "3Jm0b0y9i2mXw1o0mWm3d8l3bq6mV1r8kq2o7x9A5cE",6416 * "setup_url": "https://clustr.spboucher.ai/setup#3Jm0b0y9i2mXw1o0mWm3d8l3bq6mV1r8kq2o7x9A5cE"6417 * }6418 */6419 "application/json": components["schemas"]["InvitationCreated"];6420 };6421 };6422 400: components["responses"]["BadRequest"];6423 401: components["responses"]["Unauthenticated"];6424 403: components["responses"]["Forbidden"];6425 404: components["responses"]["NotFound"];6426 409: components["responses"]["Conflict"];6427 };6428 };6429 revokeInvitation: {6430 parameters: {6431 query?: never;6432 header?: {6433 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6434 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6435 };6436 path: {6437 id: components["parameters"]["Id"];6438 };6439 cookie?: never;6440 };6441 requestBody?: never;6442 responses: {6443 /** @description Invitation revoked. */6444 204: {6445 headers: {6446 "X-Correlation-Id": components["headers"]["CorrelationId"];6447 [name: string]: unknown;6448 };6449 content?: never;6450 };6451 401: components["responses"]["Unauthenticated"];6452 403: components["responses"]["Forbidden"];6453 404: components["responses"]["NotFound"];6454 409: components["responses"]["Conflict"];6455 };6456 };6457 exchangeInvitation: {6458 parameters: {6459 query?: never;6460 header?: never;6461 path?: never;6462 cookie?: never;6463 };6464 requestBody: {6465 content: {6466 "application/json": components["schemas"]["InvitationExchangeRequest"];6467 };6468 };6469 responses: {6470 /** @description Transaction opened. */6471 200: {6472 headers: {6473 /** @description `__Host-mcc_setup=<opaque>; Secure; HttpOnly; SameSite=Strict; Path=/; Max-Age=600` (web clients only). */6474 "Set-Cookie"?: string;6475 "X-Correlation-Id": components["headers"]["CorrelationId"];6476 [name: string]: unknown;6477 };6478 content: {6479 "application/json": components["schemas"]["InvitationTransaction"];6480 };6481 };6482 400: components["responses"]["BadRequest"];6483 410: components["responses"]["Gone"];6484 429: components["responses"]["RateLimited"];6485 };6486 };6487 getInvitationTransaction: {6488 parameters: {6489 query?: never;6490 header?: never;6491 path?: never;6492 cookie?: never;6493 };6494 requestBody?: never;6495 responses: {6496 /** @description Transaction (never includes `transaction_token`). */6497 200: {6498 headers: {6499 "X-Correlation-Id": components["headers"]["CorrelationId"];6500 [name: string]: unknown;6501 };6502 content: {6503 "application/json": components["schemas"]["InvitationTransaction"];6504 };6505 };6506 401: components["responses"]["Unauthenticated"];6507 410: components["responses"]["Gone"];6508 };6509 };6510 abandonInvitationTransaction: {6511 parameters: {6512 query?: never;6513 header?: never;6514 path?: never;6515 cookie?: never;6516 };6517 requestBody?: never;6518 responses: {6519 /** @description Transaction closed; setup cookie cleared. */6520 204: {6521 headers: {6522 "X-Correlation-Id": components["headers"]["CorrelationId"];6523 [name: string]: unknown;6524 };6525 content?: never;6526 };6527 401: components["responses"]["Unauthenticated"];6528 };6529 };6530 linkInvitationToAccount: {6531 parameters: {6532 query?: never;6533 header?: {6534 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6535 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6536 };6537 path?: never;6538 cookie?: never;6539 };6540 requestBody: {6541 content: {6542 "application/json": components["schemas"]["InvitationLinkRequest"];6543 };6544 };6545 responses: {6546 /** @description Invitation applied to the account. */6547 200: {6548 headers: {6549 "X-Correlation-Id": components["headers"]["CorrelationId"];6550 [name: string]: unknown;6551 };6552 content: {6553 "application/json": components["schemas"]["InvitationLinkResult"];6554 };6555 };6556 400: components["responses"]["BadRequest"];6557 401: components["responses"]["Unauthenticated"];6558 403: components["responses"]["Forbidden"];6559 409: components["responses"]["Conflict"];6560 410: components["responses"]["Gone"];6561 };6562 };6563 setInvitationProfile: {6564 parameters: {6565 query?: never;6566 header?: never;6567 path?: never;6568 cookie?: never;6569 };6570 requestBody: {6571 content: {6572 "application/json": components["schemas"]["InvitationProfileRequest"];6573 };6574 };6575 responses: {6576 /** @description Updated transaction. */6577 200: {6578 headers: {6579 "X-Correlation-Id": components["headers"]["CorrelationId"];6580 [name: string]: unknown;6581 };6582 content: {6583 "application/json": components["schemas"]["InvitationTransaction"];6584 };6585 };6586 400: components["responses"]["BadRequest"];6587 401: components["responses"]["Unauthenticated"];6588 409: components["responses"]["Conflict"];6589 410: components["responses"]["Gone"];6590 };6591 };6592 listJobSchedules: {6593 parameters: {6594 query?: {6595 /** @description Opaque cursor taken from `next_cursor` of the previous page. */6596 cursor?: components["parameters"]["Cursor"];6597 /** @description Page size. */6598 limit?: components["parameters"]["Limit"];6599 };6600 header?: never;6601 path?: never;6602 cookie?: never;6603 };6604 requestBody?: never;6605 responses: {6606 /** @description Schedules. */6607 200: {6608 headers: {6609 "X-Correlation-Id": components["headers"]["CorrelationId"];6610 [name: string]: unknown;6611 };6612 content: {6613 "application/json": components["schemas"]["JobScheduleList"];6614 };6615 };6616 400: components["responses"]["BadRequest"];6617 401: components["responses"]["Unauthenticated"];6618 403: components["responses"]["Forbidden"];6619 };6620 };6621 createJobSchedule: {6622 parameters: {6623 query?: never;6624 header?: {6625 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6626 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6627 };6628 path?: never;6629 cookie?: never;6630 };6631 requestBody: {6632 content: {6633 "application/json": components["schemas"]["CreateJobScheduleRequest"];6634 };6635 };6636 responses: {6637 /** @description Schedule created. */6638 201: {6639 headers: {6640 "X-Correlation-Id": components["headers"]["CorrelationId"];6641 [name: string]: unknown;6642 };6643 content: {6644 "application/json": components["schemas"]["JobSchedule"];6645 };6646 };6647 400: components["responses"]["BadRequest"];6648 401: components["responses"]["Unauthenticated"];6649 403: components["responses"]["Forbidden"];6650 409: components["responses"]["Conflict"];6651 422: components["responses"]["Unprocessable"];6652 };6653 };6654 deleteJobSchedule: {6655 parameters: {6656 query?: never;6657 header?: {6658 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6659 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6660 };6661 path: {6662 id: components["parameters"]["Id"];6663 };6664 cookie?: never;6665 };6666 requestBody?: never;6667 responses: {6668 /** @description Schedule deleted. Jobs already created are kept. */6669 204: {6670 headers: {6671 "X-Correlation-Id": components["headers"]["CorrelationId"];6672 [name: string]: unknown;6673 };6674 content?: never;6675 };6676 401: components["responses"]["Unauthenticated"];6677 403: components["responses"]["Forbidden"];6678 404: components["responses"]["NotFound"];6679 };6680 };6681 updateJobSchedule: {6682 parameters: {6683 query?: never;6684 header?: {6685 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6686 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6687 };6688 path: {6689 id: components["parameters"]["Id"];6690 };6691 cookie?: never;6692 };6693 requestBody: {6694 content: {6695 "application/json": components["schemas"]["UpdateJobScheduleRequest"];6696 };6697 };6698 responses: {6699 /** @description Updated schedule. */6700 200: {6701 headers: {6702 "X-Correlation-Id": components["headers"]["CorrelationId"];6703 [name: string]: unknown;6704 };6705 content: {6706 "application/json": components["schemas"]["JobSchedule"];6707 };6708 };6709 400: components["responses"]["BadRequest"];6710 401: components["responses"]["Unauthenticated"];6711 403: components["responses"]["Forbidden"];6712 404: components["responses"]["NotFound"];6713 409: components["responses"]["Conflict"];6714 };6715 };6716 listJobTemplates: {6717 parameters: {6718 query?: never;6719 header?: never;6720 path?: never;6721 cookie?: never;6722 };6723 requestBody?: never;6724 responses: {6725 /** @description Templates. */6726 200: {6727 headers: {6728 "X-Correlation-Id": components["headers"]["CorrelationId"];6729 [name: string]: unknown;6730 };6731 content: {6732 "application/json": components["schemas"]["JobTemplateList"];6733 };6734 };6735 401: components["responses"]["Unauthenticated"];6736 403: components["responses"]["Forbidden"];6737 };6738 };6739 listJobs: {6740 parameters: {6741 query?: {6742 /** @description Opaque cursor taken from `next_cursor` of the previous page. */6743 cursor?: components["parameters"]["Cursor"];6744 /** @description Page size. */6745 limit?: components["parameters"]["Limit"];6746 node_id?: string;6747 owner_id?: string;6748 schedule_id?: string;6749 state?: components["schemas"]["JobState"];6750 template?: string;6751 };6752 header?: never;6753 path?: never;6754 cookie?: never;6755 };6756 requestBody?: never;6757 responses: {6758 /** @description Jobs, most recent first. */6759 200: {6760 headers: {6761 "X-Correlation-Id": components["headers"]["CorrelationId"];6762 [name: string]: unknown;6763 };6764 content: {6765 "application/json": components["schemas"]["JobList"];6766 };6767 };6768 400: components["responses"]["BadRequest"];6769 401: components["responses"]["Unauthenticated"];6770 403: components["responses"]["Forbidden"];6771 };6772 };6773 createJob: {6774 parameters: {6775 query?: never;6776 header: {6777 /** @description Client-generated key (a UUID is recommended), unique per user. Same key and same body returns the original resource; same key with another body is `409 idempotency_conflict`. */6778 "Idempotency-Key": components["parameters"]["IdempotencyKey"];6779 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6780 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6781 };6782 path?: never;6783 cookie?: never;6784 };6785 requestBody: {6786 content: {6787 /**6788 * @example {6789 * "template": "disk.usage.report",6790 * "params": {6791 * "path_alias": "home"6792 * },6793 * "placement": {6794 * "node_id": "019a9b10-0000-7000-8000-000000000a01"6795 * }6796 * }6797 */6798 "application/json": components["schemas"]["CreateJobRequest"];6799 };6800 };6801 responses: {6802 /** @description Replay of an identical request; the original job is returned. */6803 200: {6804 headers: {6805 "X-Correlation-Id": components["headers"]["CorrelationId"];6806 [name: string]: unknown;6807 };6808 content: {6809 "application/json": components["schemas"]["Job"];6810 };6811 };6812 /** @description Job created. */6813 201: {6814 headers: {6815 "X-Correlation-Id": components["headers"]["CorrelationId"];6816 [name: string]: unknown;6817 };6818 content: {6819 "application/json": components["schemas"]["Job"];6820 };6821 };6822 400: components["responses"]["BadRequest"];6823 401: components["responses"]["Unauthenticated"];6824 403: components["responses"]["Forbidden"];6825 409: components["responses"]["Conflict"];6826 422: components["responses"]["Unprocessable"];6827 503: components["responses"]["Unavailable"];6828 };6829 };6830 getJob: {6831 parameters: {6832 query?: never;6833 header?: never;6834 path: {6835 id: components["parameters"]["Id"];6836 };6837 cookie?: never;6838 };6839 requestBody?: never;6840 responses: {6841 /** @description Job. */6842 200: {6843 headers: {6844 "X-Correlation-Id": components["headers"]["CorrelationId"];6845 [name: string]: unknown;6846 };6847 content: {6848 "application/json": components["schemas"]["Job"];6849 };6850 };6851 401: components["responses"]["Unauthenticated"];6852 403: components["responses"]["Forbidden"];6853 404: components["responses"]["NotFound"];6854 };6855 };6856 cancelJob: {6857 parameters: {6858 query?: never;6859 header?: {6860 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6861 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6862 };6863 path: {6864 id: components["parameters"]["Id"];6865 };6866 cookie?: never;6867 };6868 requestBody?: never;6869 responses: {6870 /** @description Job with cancellation requested or done. */6871 200: {6872 headers: {6873 "X-Correlation-Id": components["headers"]["CorrelationId"];6874 [name: string]: unknown;6875 };6876 content: {6877 "application/json": components["schemas"]["Job"];6878 };6879 };6880 401: components["responses"]["Unauthenticated"];6881 403: components["responses"]["Forbidden"];6882 404: components["responses"]["NotFound"];6883 409: components["responses"]["Conflict"];6884 };6885 };6886 exportMaintenanceCalendar: {6887 parameters: {6888 query?: {6889 /** @description Start of the time range (inclusive, UTC). */6890 from?: components["parameters"]["From"];6891 node_id?: string;6892 /** @description End of the time range (exclusive, UTC). Defaults to now. */6893 to?: components["parameters"]["To"];6894 };6895 header?: never;6896 path?: never;6897 cookie?: never;6898 };6899 requestBody?: never;6900 responses: {6901 /** @description iCalendar document. */6902 200: {6903 headers: {6904 /** @description `attachment; filename="mcc-maintenance.ics"` */6905 "Content-Disposition"?: string;6906 "X-Correlation-Id": components["headers"]["CorrelationId"];6907 [name: string]: unknown;6908 };6909 content: {6910 "text/calendar": string;6911 };6912 };6913 400: components["responses"]["BadRequest"];6914 401: components["responses"]["Unauthenticated"];6915 403: components["responses"]["Forbidden"];6916 };6917 };6918 listMaintenanceNotes: {6919 parameters: {6920 query?: {6921 /** @description Opaque cursor taken from `next_cursor` of the previous page. */6922 cursor?: components["parameters"]["Cursor"];6923 /** @description Page size. */6924 limit?: components["parameters"]["Limit"];6925 node_id?: string;6926 /** @description Start of a specific occurrence of the window. */6927 occurrence?: string;6928 /** @description Free-text filter (case-insensitive substring). */6929 q?: components["parameters"]["Q"];6930 window_id?: string;6931 };6932 header?: never;6933 path?: never;6934 cookie?: never;6935 };6936 requestBody?: never;6937 responses: {6938 /** @description Notes. */6939 200: {6940 headers: {6941 "X-Correlation-Id": components["headers"]["CorrelationId"];6942 [name: string]: unknown;6943 };6944 content: {6945 "application/json": components["schemas"]["MaintenanceNoteList"];6946 };6947 };6948 400: components["responses"]["BadRequest"];6949 401: components["responses"]["Unauthenticated"];6950 403: components["responses"]["Forbidden"];6951 };6952 };6953 createMaintenanceNote: {6954 parameters: {6955 query?: never;6956 header?: {6957 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6958 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6959 };6960 path?: never;6961 cookie?: never;6962 };6963 requestBody: {6964 content: {6965 /**6966 * @example {6967 * "node_id": "019a9b10-0000-7000-8000-000000000a05",6968 * "body": "Internal disk at 3 GB free out of 926; cleanup planned on Sunday.",6969 * "pinned": true6970 * }6971 */6972 "application/json": components["schemas"]["CreateMaintenanceNoteRequest"];6973 };6974 };6975 responses: {6976 /** @description Note created. */6977 201: {6978 headers: {6979 "X-Correlation-Id": components["headers"]["CorrelationId"];6980 [name: string]: unknown;6981 };6982 content: {6983 "application/json": components["schemas"]["MaintenanceNote"];6984 };6985 };6986 400: components["responses"]["BadRequest"];6987 401: components["responses"]["Unauthenticated"];6988 403: components["responses"]["Forbidden"];6989 404: components["responses"]["NotFound"];6990 };6991 };6992 deleteMaintenanceNote: {6993 parameters: {6994 query?: never;6995 header?: {6996 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */6997 "X-MCC-CSRF"?: components["parameters"]["Csrf"];6998 };6999 path: {7000 id: components["parameters"]["Id"];7001 };7002 cookie?: never;7003 };7004 requestBody?: never;7005 responses: {7006 /** @description Note deleted. */7007 204: {7008 headers: {7009 "X-Correlation-Id": components["headers"]["CorrelationId"];7010 [name: string]: unknown;7011 };7012 content?: never;7013 };7014 401: components["responses"]["Unauthenticated"];7015 403: components["responses"]["Forbidden"];7016 404: components["responses"]["NotFound"];7017 };7018 };7019 updateMaintenanceNote: {7020 parameters: {7021 query?: never;7022 header?: {7023 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7024 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7025 };7026 path: {7027 id: components["parameters"]["Id"];7028 };7029 cookie?: never;7030 };7031 requestBody: {7032 content: {7033 "application/json": components["schemas"]["UpdateMaintenanceNoteRequest"];7034 };7035 };7036 responses: {7037 /** @description Updated note. */7038 200: {7039 headers: {7040 "X-Correlation-Id": components["headers"]["CorrelationId"];7041 [name: string]: unknown;7042 };7043 content: {7044 "application/json": components["schemas"]["MaintenanceNote"];7045 };7046 };7047 400: components["responses"]["BadRequest"];7048 401: components["responses"]["Unauthenticated"];7049 403: components["responses"]["Forbidden"];7050 404: components["responses"]["NotFound"];7051 };7052 };7053 listMaintenanceWindows: {7054 parameters: {7055 query?: {7056 /** @description Start of the time range (inclusive, UTC). */7057 from?: components["parameters"]["From"];7058 /** @description Only windows whose scope includes this node. */7059 node_id?: string;7060 status?: components["schemas"]["MaintenanceStatus"];7061 /** @description End of the time range (exclusive, UTC). Defaults to now. */7062 to?: components["parameters"]["To"];7063 };7064 header?: never;7065 path?: never;7066 cookie?: never;7067 };7068 requestBody?: never;7069 responses: {7070 /** @description Occurrences ordered by `occurrence_start`. */7071 200: {7072 headers: {7073 "X-Correlation-Id": components["headers"]["CorrelationId"];7074 [name: string]: unknown;7075 };7076 content: {7077 /**7078 * @example {7079 * "truncated": false,7080 * "items": [7081 * {7082 * "occurrence_start": "2026-11-22T07:00:00Z",7083 * "occurrence_end": "2026-11-22T08:00:00Z",7084 * "note_count": 1,7085 * "window": {7086 * "id": "019a9c40-0000-7000-8000-0000000000f1",7087 * "title": "Weekly macOS updates - studios",7088 * "description": "",7089 * "category": "update",7090 * "starts_at": "2026-11-22T07:00:00Z",7091 * "ends_at": "2026-11-22T08:00:00Z",7092 * "timezone": "America/Toronto",7093 * "recurrence": "weekly",7094 * "scope": {7095 * "node_ids": [7096 * "019a9b10-0000-7000-8000-000000000a01"7097 * ]7098 * },7099 * "set_maintenance_mode": true,7100 * "silence_alerts": true,7101 * "status": "scheduled",7102 * "created_at": "2026-11-18T21:20:00Z",7103 * "updated_at": "2026-11-18T21:20:00Z"7104 * }7105 * }7106 * ]7107 * }7108 */7109 "application/json": components["schemas"]["MaintenanceOccurrenceList"];7110 };7111 };7112 400: components["responses"]["BadRequest"];7113 401: components["responses"]["Unauthenticated"];7114 403: components["responses"]["Forbidden"];7115 };7116 };7117 createMaintenanceWindow: {7118 parameters: {7119 query?: never;7120 header?: {7121 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7122 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7123 };7124 path?: never;7125 cookie?: never;7126 };7127 requestBody: {7128 content: {7129 /**7130 * @example {7131 * "title": "Weekly macOS updates - studios",7132 * "category": "update",7133 * "starts_at": "2026-11-22T07:00:00Z",7134 * "ends_at": "2026-11-22T08:00:00Z",7135 * "timezone": "America/Toronto",7136 * "recurrence": "weekly",7137 * "scope": {7138 * "node_ids": [7139 * "019a9b10-0000-7000-8000-000000000a01"7140 * ]7141 * }7142 * }7143 */7144 "application/json": components["schemas"]["CreateMaintenanceWindowRequest"];7145 };7146 };7147 responses: {7148 /** @description Window created. */7149 201: {7150 headers: {7151 "X-Correlation-Id": components["headers"]["CorrelationId"];7152 [name: string]: unknown;7153 };7154 content: {7155 "application/json": components["schemas"]["MaintenanceWindow"];7156 };7157 };7158 400: components["responses"]["BadRequest"];7159 401: components["responses"]["Unauthenticated"];7160 403: components["responses"]["Forbidden"];7161 404: components["responses"]["NotFound"];7162 };7163 };7164 getMaintenanceWindow: {7165 parameters: {7166 query?: never;7167 header?: never;7168 path: {7169 id: components["parameters"]["Id"];7170 };7171 cookie?: never;7172 };7173 requestBody?: never;7174 responses: {7175 /** @description Window. */7176 200: {7177 headers: {7178 "X-Correlation-Id": components["headers"]["CorrelationId"];7179 [name: string]: unknown;7180 };7181 content: {7182 "application/json": components["schemas"]["MaintenanceWindow"];7183 };7184 };7185 401: components["responses"]["Unauthenticated"];7186 403: components["responses"]["Forbidden"];7187 404: components["responses"]["NotFound"];7188 };7189 };7190 cancelMaintenanceWindow: {7191 parameters: {7192 query?: never;7193 header?: {7194 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7195 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7196 };7197 path: {7198 id: components["parameters"]["Id"];7199 };7200 cookie?: never;7201 };7202 requestBody?: never;7203 responses: {7204 /** @description Window cancelled. */7205 204: {7206 headers: {7207 "X-Correlation-Id": components["headers"]["CorrelationId"];7208 [name: string]: unknown;7209 };7210 content?: never;7211 };7212 401: components["responses"]["Unauthenticated"];7213 403: components["responses"]["Forbidden"];7214 404: components["responses"]["NotFound"];7215 409: components["responses"]["Conflict"];7216 };7217 };7218 updateMaintenanceWindow: {7219 parameters: {7220 query?: never;7221 header?: {7222 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7223 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7224 };7225 path: {7226 id: components["parameters"]["Id"];7227 };7228 cookie?: never;7229 };7230 requestBody: {7231 content: {7232 "application/json": components["schemas"]["UpdateMaintenanceWindowRequest"];7233 };7234 };7235 responses: {7236 /** @description Updated window. */7237 200: {7238 headers: {7239 "X-Correlation-Id": components["headers"]["CorrelationId"];7240 [name: string]: unknown;7241 };7242 content: {7243 "application/json": components["schemas"]["MaintenanceWindow"];7244 };7245 };7246 400: components["responses"]["BadRequest"];7247 401: components["responses"]["Unauthenticated"];7248 403: components["responses"]["Forbidden"];7249 404: components["responses"]["NotFound"];7250 409: components["responses"]["Conflict"];7251 };7252 };7253 completeMaintenanceWindow: {7254 parameters: {7255 query?: never;7256 header?: {7257 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7258 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7259 };7260 path: {7261 id: components["parameters"]["Id"];7262 };7263 cookie?: never;7264 };7265 requestBody?: {7266 content: {7267 "application/json": components["schemas"]["CompleteMaintenanceWindowRequest"];7268 };7269 };7270 responses: {7271 /** @description Updated window. */7272 200: {7273 headers: {7274 "X-Correlation-Id": components["headers"]["CorrelationId"];7275 [name: string]: unknown;7276 };7277 content: {7278 "application/json": components["schemas"]["MaintenanceWindow"];7279 };7280 };7281 400: components["responses"]["BadRequest"];7282 401: components["responses"]["Unauthenticated"];7283 403: components["responses"]["Forbidden"];7284 404: components["responses"]["NotFound"];7285 409: components["responses"]["Conflict"];7286 };7287 };7288 getMe: {7289 parameters: {7290 query?: never;7291 header?: never;7292 path?: never;7293 cookie?: never;7294 };7295 requestBody?: never;7296 responses: {7297 /** @description Current account. */7298 200: {7299 headers: {7300 "X-Correlation-Id": components["headers"]["CorrelationId"];7301 [name: string]: unknown;7302 };7303 content: {7304 /**7305 * @example {7306 * "user": {7307 * "id": "019a9b00-1111-7aaa-8bbb-000000000001",7308 * "handle": "spb",7309 * "display_name": "Simon-Pierre",7310 * "role": "owner",7311 * "locale": "fr",7312 * "disabled": false,7313 * "created_at": "2026-11-18T20:40:00Z"7314 * },7315 * "permissions": [7316 * "cluster.read",7317 * "nodes.read",7318 * "nodes.private.read",7319 * "actions.run.low",7320 * "actions.run.medium"7321 * ],7322 * "session": {7323 * "id": "019a9c1e-9000-7000-8000-00000000a001",7324 * "kind": "cookie",7325 * "device_id": "019a9c1e-9000-7000-8000-00000000d001",7326 * "current": true,7327 * "created_at": "2026-11-18T21:00:12Z",7328 * "last_seen_at": "2026-11-18T21:03:40Z",7329 * "authenticated_at": "2026-11-18T21:00:12Z",7330 * "step_up_valid_until": "2026-11-18T21:05:12Z",7331 * "idle_expires_at": "2026-11-18T21:33:40Z",7332 * "absolute_expires_at": "2026-11-19T09:00:12Z"7333 * },7334 * "csrf_token": "6fJmC0n1x1c0u0S7wq5a8nq3mVbYb1pZ5nq2dX0v9Qk"7335 * }7336 */7337 "application/json": components["schemas"]["Me"];7338 };7339 };7340 401: components["responses"]["Unauthenticated"];7341 };7342 };7343 updateMe: {7344 parameters: {7345 query?: never;7346 header?: {7347 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7348 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7349 };7350 path?: never;7351 cookie?: never;7352 };7353 requestBody: {7354 content: {7355 "application/json": components["schemas"]["UpdateMeRequest"];7356 };7357 };7358 responses: {7359 /** @description Updated user. */7360 200: {7361 headers: {7362 "X-Correlation-Id": components["headers"]["CorrelationId"];7363 [name: string]: unknown;7364 };7365 content: {7366 "application/json": components["schemas"]["User"];7367 };7368 };7369 400: components["responses"]["BadRequest"];7370 401: components["responses"]["Unauthenticated"];7371 403: components["responses"]["Forbidden"];7372 };7373 };7374 listMyDashboards: {7375 parameters: {7376 query?: never;7377 header?: never;7378 path?: never;7379 cookie?: never;7380 };7381 requestBody?: never;7382 responses: {7383 /** @description Dashboards. */7384 200: {7385 headers: {7386 "X-Correlation-Id": components["headers"]["CorrelationId"];7387 [name: string]: unknown;7388 };7389 content: {7390 "application/json": components["schemas"]["DashboardList"];7391 };7392 };7393 401: components["responses"]["Unauthenticated"];7394 };7395 };7396 putMyDashboard: {7397 parameters: {7398 query?: never;7399 header?: {7400 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7401 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7402 };7403 path: {7404 /** @description Dashboard name; `default` is the home dashboard. */7405 name: string;7406 };7407 cookie?: never;7408 };7409 requestBody: {7410 content: {7411 /**7412 * @example {7413 * "layout": [7414 * {7415 * "id": "w1",7416 * "type": "cluster.capacity",7417 * "x": 0,7418 * "y": 0,7419 * "w": 6,7420 * "h": 2,7421 * "config": {}7422 * },7423 * {7424 * "id": "w2",7425 * "type": "metric.chart",7426 * "x": 6,7427 * "y": 0,7428 * "w": 6,7429 * "h": 4,7430 * "config": {7431 * "metric": "cpu.usage",7432 * "range": "24h"7433 * }7434 * }7435 * ]7436 * }7437 */7438 "application/json": components["schemas"]["PutDashboardRequest"];7439 };7440 };7441 responses: {7442 /** @description Stored dashboard. */7443 200: {7444 headers: {7445 "X-Correlation-Id": components["headers"]["CorrelationId"];7446 [name: string]: unknown;7447 };7448 content: {7449 "application/json": components["schemas"]["Dashboard"];7450 };7451 };7452 400: components["responses"]["BadRequest"];7453 401: components["responses"]["Unauthenticated"];7454 403: components["responses"]["Forbidden"];7455 };7456 };7457 deleteMyDashboard: {7458 parameters: {7459 query?: never;7460 header?: {7461 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7462 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7463 };7464 path: {7465 /** @description Dashboard name; `default` is the home dashboard. */7466 name: string;7467 };7468 cookie?: never;7469 };7470 requestBody?: never;7471 responses: {7472 /** @description Dashboard deleted. */7473 204: {7474 headers: {7475 "X-Correlation-Id": components["headers"]["CorrelationId"];7476 [name: string]: unknown;7477 };7478 content?: never;7479 };7480 401: components["responses"]["Unauthenticated"];7481 403: components["responses"]["Forbidden"];7482 404: components["responses"]["NotFound"];7483 };7484 };7485 listMyDevices: {7486 parameters: {7487 query?: never;7488 header?: never;7489 path?: never;7490 cookie?: never;7491 };7492 requestBody?: never;7493 responses: {7494 /** @description Devices. */7495 200: {7496 headers: {7497 "X-Correlation-Id": components["headers"]["CorrelationId"];7498 [name: string]: unknown;7499 };7500 content: {7501 "application/json": components["schemas"]["DeviceList"];7502 };7503 };7504 401: components["responses"]["Unauthenticated"];7505 };7506 };7507 revokeMyDevice: {7508 parameters: {7509 query?: never;7510 header?: {7511 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7512 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7513 };7514 path: {7515 id: components["parameters"]["Id"];7516 };7517 cookie?: never;7518 };7519 requestBody?: never;7520 responses: {7521 /** @description Device and sessions revoked. */7522 204: {7523 headers: {7524 "X-Correlation-Id": components["headers"]["CorrelationId"];7525 [name: string]: unknown;7526 };7527 content?: never;7528 };7529 401: components["responses"]["Unauthenticated"];7530 403: components["responses"]["Forbidden"];7531 404: components["responses"]["NotFound"];7532 };7533 };7534 putMyPushToken: {7535 parameters: {7536 query?: never;7537 header?: {7538 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7539 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7540 };7541 path?: never;7542 cookie?: never;7543 };7544 requestBody: {7545 content: {7546 "application/json": components["schemas"]["PushTokenRequest"];7547 };7548 };7549 responses: {7550 /** @description Updated device. */7551 200: {7552 headers: {7553 "X-Correlation-Id": components["headers"]["CorrelationId"];7554 [name: string]: unknown;7555 };7556 content: {7557 "application/json": components["schemas"]["Device"];7558 };7559 };7560 400: components["responses"]["BadRequest"];7561 401: components["responses"]["Unauthenticated"];7562 403: components["responses"]["Forbidden"];7563 };7564 };7565 listMyPasskeys: {7566 parameters: {7567 query?: never;7568 header?: never;7569 path?: never;7570 cookie?: never;7571 };7572 requestBody?: never;7573 responses: {7574 /** @description Passkeys (active ones only). */7575 200: {7576 headers: {7577 "X-Correlation-Id": components["headers"]["CorrelationId"];7578 [name: string]: unknown;7579 };7580 content: {7581 "application/json": components["schemas"]["PasskeyList"];7582 };7583 };7584 401: components["responses"]["Unauthenticated"];7585 };7586 };7587 deleteMyPasskey: {7588 parameters: {7589 query?: never;7590 header?: {7591 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7592 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7593 };7594 path: {7595 id: components["parameters"]["Id"];7596 };7597 cookie?: never;7598 };7599 requestBody?: never;7600 responses: {7601 /** @description Passkey revoked. */7602 204: {7603 headers: {7604 "X-Correlation-Id": components["headers"]["CorrelationId"];7605 [name: string]: unknown;7606 };7607 content?: never;7608 };7609 401: components["responses"]["Unauthenticated"];7610 403: components["responses"]["Forbidden"];7611 404: components["responses"]["NotFound"];7612 409: components["responses"]["Conflict"];7613 };7614 };7615 updateMyPasskey: {7616 parameters: {7617 query?: never;7618 header?: {7619 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7620 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7621 };7622 path: {7623 id: components["parameters"]["Id"];7624 };7625 cookie?: never;7626 };7627 requestBody: {7628 content: {7629 "application/json": components["schemas"]["UpdatePasskeyRequest"];7630 };7631 };7632 responses: {7633 /** @description Updated passkey. */7634 200: {7635 headers: {7636 "X-Correlation-Id": components["headers"]["CorrelationId"];7637 [name: string]: unknown;7638 };7639 content: {7640 "application/json": components["schemas"]["Passkey"];7641 };7642 };7643 400: components["responses"]["BadRequest"];7644 401: components["responses"]["Unauthenticated"];7645 403: components["responses"]["Forbidden"];7646 404: components["responses"]["NotFound"];7647 };7648 };7649 listMySessions: {7650 parameters: {7651 query?: never;7652 header?: never;7653 path?: never;7654 cookie?: never;7655 };7656 requestBody?: never;7657 responses: {7658 /** @description Sessions. */7659 200: {7660 headers: {7661 "X-Correlation-Id": components["headers"]["CorrelationId"];7662 [name: string]: unknown;7663 };7664 content: {7665 "application/json": components["schemas"]["SessionList"];7666 };7667 };7668 401: components["responses"]["Unauthenticated"];7669 };7670 };7671 revokeMySession: {7672 parameters: {7673 query?: never;7674 header?: {7675 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */7676 "X-MCC-CSRF"?: components["parameters"]["Csrf"];7677 };7678 path: {7679 id: components["parameters"]["Id"];7680 };7681 cookie?: never;7682 };7683 requestBody?: never;7684 responses: {7685 /** @description Session revoked. */7686 204: {7687 headers: {7688 "X-Correlation-Id": components["headers"]["CorrelationId"];7689 [name: string]: unknown;7690 };7691 content?: never;7692 };7693 401: components["responses"]["Unauthenticated"];7694 403: components["responses"]["Forbidden"];7695 404: components["responses"]["NotFound"];7696 };7697 };7698 getMetricCatalog: {7699 parameters: {7700 query?: never;7701 header?: never;7702 path?: never;7703 cookie?: never;7704 };7705 requestBody?: never;7706 responses: {7707 /** @description Every metric with unit, interval and provenance. */7708 200: {7709 headers: {7710 "X-Correlation-Id": components["headers"]["CorrelationId"];7711 [name: string]: unknown;7712 };7713 content: {7714 "application/json": components["schemas"]["MetricCatalog"];7715 };7716 };7717 401: components["responses"]["Unauthenticated"];7718 403: components["responses"]["Forbidden"];7719 };7720 };7721 compareMetrics: {7722 parameters: {7723 query: {7724 /** @description Start of the time range (inclusive, UTC). */7725 from?: components["parameters"]["From"];7726 label?: string;7727 metric: string;7728 /** @description Comma-separated node ids (2 to 12). */7729 node_ids: string[];7730 resolution?: components["schemas"]["Resolution"];7731 /** @description End of the time range (exclusive, UTC). Defaults to now. */7732 to?: components["parameters"]["To"];7733 };7734 header?: never;7735 path?: never;7736 cookie?: never;7737 };7738 requestBody?: never;7739 responses: {7740 /** @description One series per node (and per label). */7741 200: {7742 headers: {7743 "X-Correlation-Id": components["headers"]["CorrelationId"];7744 [name: string]: unknown;7745 };7746 content: {7747 "application/json": components["schemas"]["MetricCompareResponse"];7748 };7749 };7750 400: components["responses"]["BadRequest"];7751 401: components["responses"]["Unauthenticated"];7752 403: components["responses"]["Forbidden"];7753 };7754 };7755 listInferenceServers: {7756 parameters: {7757 query?: {7758 /** @description Opaque cursor taken from `next_cursor` of the previous page. */7759 cursor?: components["parameters"]["Cursor"];7760 health?: components["schemas"]["InferenceHealth"];7761 /** @description Page size. */7762 limit?: components["parameters"]["Limit"];7763 node_id?: string;7764 };7765 header?: never;7766 path?: never;7767 cookie?: never;7768 };7769 requestBody?: never;7770 responses: {7771 /** @description Inference servers. */7772 200: {7773 headers: {7774 "X-Correlation-Id": components["headers"]["CorrelationId"];7775 [name: string]: unknown;7776 };7777 content: {7778 /**7779 * @example {7780 * "items": [7781 * {7782 * "id": "019a9b30-0000-7000-8000-00000000e001",7783 * "node_id": "019a9b10-0000-7000-8000-000000000a01",7784 * "node_alias": "M3U96a",7785 * "kind": "mlx_lm",7786 * "port": 8081,7787 * "model": "mlx-community/Qwen2.5-7B-Instruct-4bit",7788 * "quantization": "4bit",7789 * "pid": 51234,7790 * "rss_bytes": 5368709120,7791 * "uptime_s": 86400,7792 * "disk_bytes": 4612345678,7793 * "health": "ok",7794 * "health_at": "2026-11-18T21:14:50Z",7795 * "health_latency_ms": 4.2,7796 * "listed_models": [7797 * "mlx-community/Qwen2.5-7B-Instruct-4bit"7798 * ],7799 * "metrics_support": {7800 * "requests": {7801 * "availability": "unsupported",7802 * "reason": "mlx_lm.server exposes no request counter"7803 * },7804 * "tokens_per_s": {7805 * "availability": "unsupported",7806 * "reason": "mlx_lm.server exposes no throughput metric"7807 * },7808 * "ttft": {7809 * "availability": "unsupported",7810 * "reason": "mlx_lm.server exposes no latency metric"7811 * },7812 * "latency": {7813 * "availability": "unsupported",7814 * "reason": "mlx_lm.server exposes no latency metric"7815 * },7816 * "queue": {7817 * "availability": "unsupported",7818 * "reason": "mlx_lm.server has no observable queue"7819 * }7820 * },7821 * "last_seen_at": "2026-11-18T21:14:55Z",7822 * "observed_at": "2026-11-18T21:14:55Z",7823 * "freshness": "fresh"7824 * }7825 * ]7826 * }7827 */7828 "application/json": components["schemas"]["InferenceServerList"];7829 };7830 };7831 400: components["responses"]["BadRequest"];7832 401: components["responses"]["Unauthenticated"];7833 403: components["responses"]["Forbidden"];7834 };7835 };7836 getInferenceServer: {7837 parameters: {7838 query?: never;7839 header?: never;7840 path: {7841 id: components["parameters"]["Id"];7842 };7843 cookie?: never;7844 };7845 requestBody?: never;7846 responses: {7847 /** @description Inference server. */7848 200: {7849 headers: {7850 "X-Correlation-Id": components["headers"]["CorrelationId"];7851 [name: string]: unknown;7852 };7853 content: {7854 "application/json": components["schemas"]["InferenceServer"];7855 };7856 };7857 401: components["responses"]["Unauthenticated"];7858 403: components["responses"]["Forbidden"];7859 404: components["responses"]["NotFound"];7860 };7861 };7862 listNetworkInterfaces: {7863 parameters: {7864 query?: {7865 /** @description Opaque cursor taken from `next_cursor` of the previous page. */7866 cursor?: components["parameters"]["Cursor"];7867 /** @description Page size. */7868 limit?: components["parameters"]["Limit"];7869 node_id?: string;7870 };7871 header?: never;7872 path?: never;7873 cookie?: never;7874 };7875 requestBody?: never;7876 responses: {7877 /** @description Interfaces. */7878 200: {7879 headers: {7880 "X-Correlation-Id": components["headers"]["CorrelationId"];7881 [name: string]: unknown;7882 };7883 content: {7884 "application/json": components["schemas"]["NetworkInterfaceList"];7885 };7886 };7887 400: components["responses"]["BadRequest"];7888 401: components["responses"]["Unauthenticated"];7889 403: components["responses"]["Forbidden"];7890 };7891 };7892 getNetworkTopology: {7893 parameters: {7894 query?: never;7895 header?: never;7896 path?: never;7897 cookie?: never;7898 };7899 requestBody?: never;7900 responses: {7901 /** @description Topology. */7902 200: {7903 headers: {7904 "X-Correlation-Id": components["headers"]["CorrelationId"];7905 [name: string]: unknown;7906 };7907 content: {7908 "application/json": components["schemas"]["NetworkTopology"];7909 };7910 };7911 401: components["responses"]["Unauthenticated"];7912 403: components["responses"]["Forbidden"];7913 };7914 };7915 listNodes: {7916 parameters: {7917 query?: {7918 /** @description Opaque cursor taken from `next_cursor` of the previous page. */7919 cursor?: components["parameters"]["Cursor"];7920 freshness?: components["schemas"]["Freshness"];7921 kind?: components["schemas"]["NodeKind"];7922 /** @description Page size. */7923 limit?: components["parameters"]["Limit"];7924 maintenance?: boolean;7925 /** @description Sort direction. */7926 order?: components["parameters"]["Order"];7927 /** @description Free-text filter (case-insensitive substring). */7928 q?: components["parameters"]["Q"];7929 retired?: boolean;7930 role?: string;7931 site?: string;7932 sort?: "alias" | "site" | "role" | "last_seen" | "cpu" | "memory" | "disk";7933 tag?: string;7934 };7935 header?: never;7936 path?: never;7937 cookie?: never;7938 };7939 requestBody?: never;7940 responses: {7941 /** @description Nodes. */7942 200: {7943 headers: {7944 "X-Correlation-Id": components["headers"]["CorrelationId"];7945 [name: string]: unknown;7946 };7947 content: {7948 /**7949 * @example {7950 * "items": [7951 * {7952 * "id": "019a9b10-0000-7000-8000-000000000a01",7953 * "alias": "M3U96a",7954 * "kind": "mac",7955 * "hostname": "MacStudio-de-simon-pierre-2",7956 * "site": "default",7957 * "role": "worker",7958 * "environment": "production",7959 * "tags": [7960 * "studio",7961 * "inference"7962 * ],7963 * "model": "Mac15,14",7964 * "chip": "Apple M3 Ultra",7965 * "arch": "arm64",7966 * "cpu_cores": 28,7967 * "gpu_cores": 60,7968 * "mem_bytes": 103079215104,7969 * "storage_bytes": 994662584320,7970 * "os_name": "macOS",7971 * "os_version": "26.6",7972 * "registered_via": "agent",7973 * "maintenance": false,7974 * "maintenance_reason": "",7975 * "created_at": "2026-11-18T20:45:00Z",7976 * "last_seen_at": "2026-11-18T21:14:55Z",7977 * "observed_at": "2026-11-18T21:14:55Z",7978 * "freshness": "fresh",7979 * "agent_version": "1.0.0",7980 * "headline": {7981 * "cpu_usage_pct": 12.4,7982 * "mem_used_pct": 41.8,7983 * "disk_used_pct": 78.3,7984 * "load1": 3.17985 * }7986 * },7987 * {7988 * "id": "019a9b10-0000-7000-8000-000000000a09",7989 * "alias": "M4BP36",7990 * "kind": "mac",7991 * "hostname": "",7992 * "site": "default",7993 * "role": "worker",7994 * "environment": "production",7995 * "tags": [7996 * "laptop"7997 * ],7998 * "registered_via": "manual",7999 * "maintenance": false,8000 * "maintenance_reason": "",8001 * "created_at": "2026-11-18T20:45:00Z",8002 * "freshness": "offline"8003 * }8004 * ]8005 * }8006 */8007 "application/json": components["schemas"]["NodeList"];8008 };8009 };8010 400: components["responses"]["BadRequest"];8011 401: components["responses"]["Unauthenticated"];8012 403: components["responses"]["Forbidden"];8013 };8014 };8015 createNode: {8016 parameters: {8017 query?: never;8018 header?: {8019 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8020 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8021 };8022 path?: never;8023 cookie?: never;8024 };8025 requestBody: {8026 content: {8027 /**8028 * @example {8029 * "alias": "M4BP36",8030 * "kind": "mac",8031 * "site": "default",8032 * "role": "worker",8033 * "tags": [8034 * "laptop"8035 * ],8036 * "expected": {8037 * "model": "MacBook Pro",8038 * "cpu_cores": 14,8039 * "mem_bytes": 386547056648040 * }8041 * }8042 */8043 "application/json": components["schemas"]["CreateNodeRequest"];8044 };8045 };8046 responses: {8047 /** @description Node created. */8048 201: {8049 headers: {8050 "X-Correlation-Id": components["headers"]["CorrelationId"];8051 [name: string]: unknown;8052 };8053 content: {8054 "application/json": components["schemas"]["Node"];8055 };8056 };8057 400: components["responses"]["BadRequest"];8058 401: components["responses"]["Unauthenticated"];8059 403: components["responses"]["Forbidden"];8060 409: components["responses"]["Conflict"];8061 };8062 };8063 getNode: {8064 parameters: {8065 query?: never;8066 header?: never;8067 path: {8068 id: components["parameters"]["Id"];8069 };8070 cookie?: never;8071 };8072 requestBody?: never;8073 responses: {8074 /** @description Node detail. */8075 200: {8076 headers: {8077 "X-Correlation-Id": components["headers"]["CorrelationId"];8078 [name: string]: unknown;8079 };8080 content: {8081 "application/json": components["schemas"]["NodeDetail"];8082 };8083 };8084 401: components["responses"]["Unauthenticated"];8085 403: components["responses"]["Forbidden"];8086 404: components["responses"]["NotFound"];8087 };8088 };8089 retireNode: {8090 parameters: {8091 query?: never;8092 header?: {8093 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8094 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8095 };8096 path: {8097 id: components["parameters"]["Id"];8098 };8099 cookie?: never;8100 };8101 requestBody?: never;8102 responses: {8103 /** @description Node retired. */8104 204: {8105 headers: {8106 "X-Correlation-Id": components["headers"]["CorrelationId"];8107 [name: string]: unknown;8108 };8109 content?: never;8110 };8111 401: components["responses"]["Unauthenticated"];8112 403: components["responses"]["Forbidden"];8113 404: components["responses"]["NotFound"];8114 409: components["responses"]["Conflict"];8115 };8116 };8117 updateNode: {8118 parameters: {8119 query?: never;8120 header?: {8121 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8122 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8123 };8124 path: {8125 id: components["parameters"]["Id"];8126 };8127 cookie?: never;8128 };8129 requestBody: {8130 content: {8131 "application/json": components["schemas"]["UpdateNodeRequest"];8132 };8133 };8134 responses: {8135 /** @description Updated node. */8136 200: {8137 headers: {8138 "X-Correlation-Id": components["headers"]["CorrelationId"];8139 [name: string]: unknown;8140 };8141 content: {8142 "application/json": components["schemas"]["Node"];8143 };8144 };8145 400: components["responses"]["BadRequest"];8146 401: components["responses"]["Unauthenticated"];8147 403: components["responses"]["Forbidden"];8148 404: components["responses"]["NotFound"];8149 409: components["responses"]["Conflict"];8150 };8151 };8152 getNodeHealthHistory: {8153 parameters: {8154 query?: {8155 range?: components["schemas"]["TimeRange"];8156 };8157 header?: never;8158 path: {8159 id: components["parameters"]["Id"];8160 };8161 cookie?: never;8162 };8163 requestBody?: never;8164 responses: {8165 /** @description Health buckets, oldest first. */8166 200: {8167 headers: {8168 "X-Correlation-Id": components["headers"]["CorrelationId"];8169 [name: string]: unknown;8170 };8171 content: {8172 "application/json": components["schemas"]["HealthHistory"];8173 };8174 };8175 400: components["responses"]["BadRequest"];8176 401: components["responses"]["Unauthenticated"];8177 403: components["responses"]["Forbidden"];8178 404: components["responses"]["NotFound"];8179 };8180 };8181 getNodeMetrics: {8182 parameters: {8183 query: {8184 /** @description Start of the time range (inclusive, UTC). */8185 from?: components["parameters"]["From"];8186 /** @description Label filter for labeled metrics (interface name, mount point...). All labels when omitted. */8187 label?: string;8188 /** @description Comma-separated metric names. */8189 metrics: string[];8190 resolution?: components["schemas"]["Resolution"];8191 /** @description End of the time range (exclusive, UTC). Defaults to now. */8192 to?: components["parameters"]["To"];8193 };8194 header?: never;8195 path: {8196 id: components["parameters"]["Id"];8197 };8198 cookie?: never;8199 };8200 requestBody?: never;8201 responses: {8202 /** @description Series. */8203 200: {8204 headers: {8205 "X-Correlation-Id": components["headers"]["CorrelationId"];8206 [name: string]: unknown;8207 };8208 content: {8209 /**8210 * @example {8211 * "resolution": "1m",8212 * "from": "2026-11-18T20:15:00Z",8213 * "to": "2026-11-18T21:15:00Z",8214 * "series": [8215 * {8216 * "metric": "cpu.usage",8217 * "unit": "percent",8218 * "label": "",8219 * "points": [8220 * [8221 * 1795033200000,8222 * 12.4,8223 * 8.1,8224 * 19.78225 * ],8226 * [8227 * 1795033260000,8228 * 14,8229 * 9.3,8230 * 22.58231 * ]8232 * ]8233 * }8234 * ],8235 * "availability": {8236 * "cpu.usage": "available",8237 * "thermal.temp": "permission_denied"8238 * }8239 * }8240 */8241 "application/json": components["schemas"]["MetricSeriesResponse"];8242 };8243 };8244 400: components["responses"]["BadRequest"];8245 401: components["responses"]["Unauthenticated"];8246 403: components["responses"]["Forbidden"];8247 404: components["responses"]["NotFound"];8248 };8249 };8250 listNodeProcesses: {8251 parameters: {8252 query?: never;8253 header?: never;8254 path: {8255 id: components["parameters"]["Id"];8256 };8257 cookie?: never;8258 };8259 requestBody?: never;8260 responses: {8261 /** @description Processes. */8262 200: {8263 headers: {8264 "X-Correlation-Id": components["headers"]["CorrelationId"];8265 [name: string]: unknown;8266 };8267 content: {8268 "application/json": components["schemas"]["ProcessList"];8269 };8270 };8271 401: components["responses"]["Unauthenticated"];8272 403: components["responses"]["Forbidden"];8273 404: components["responses"]["NotFound"];8274 };8275 };8276 listNodeServices: {8277 parameters: {8278 query?: {8279 /** @description Opaque cursor taken from `next_cursor` of the previous page. */8280 cursor?: components["parameters"]["Cursor"];8281 /** @description Page size. */8282 limit?: components["parameters"]["Limit"];8283 };8284 header?: never;8285 path: {8286 id: components["parameters"]["Id"];8287 };8288 cookie?: never;8289 };8290 requestBody?: never;8291 responses: {8292 /** @description Services. */8293 200: {8294 headers: {8295 "X-Correlation-Id": components["headers"]["CorrelationId"];8296 [name: string]: unknown;8297 };8298 content: {8299 "application/json": components["schemas"]["ServiceList"];8300 };8301 };8302 400: components["responses"]["BadRequest"];8303 401: components["responses"]["Unauthenticated"];8304 403: components["responses"]["Forbidden"];8305 404: components["responses"]["NotFound"];8306 };8307 };8308 getPermissionCatalog: {8309 parameters: {8310 query?: never;8311 header?: never;8312 path?: never;8313 cookie?: never;8314 };8315 requestBody?: never;8316 responses: {8317 /** @description Catalog. */8318 200: {8319 headers: {8320 "X-Correlation-Id": components["headers"]["CorrelationId"];8321 [name: string]: unknown;8322 };8323 content: {8324 "application/json": components["schemas"]["PermissionCatalog"];8325 };8326 };8327 401: components["responses"]["Unauthenticated"];8328 };8329 };8330 listPolicyGrants: {8331 parameters: {8332 query?: {8333 /** @description Opaque cursor taken from `next_cursor` of the previous page. */8334 cursor?: components["parameters"]["Cursor"];8335 /** @description Page size. */8336 limit?: components["parameters"]["Limit"];8337 permission?: string;8338 subject?: string;8339 subject_kind?: components["schemas"]["GrantSubjectKind"];8340 };8341 header?: never;8342 path?: never;8343 cookie?: never;8344 };8345 requestBody?: never;8346 responses: {8347 /** @description Grants. */8348 200: {8349 headers: {8350 "X-Correlation-Id": components["headers"]["CorrelationId"];8351 [name: string]: unknown;8352 };8353 content: {8354 "application/json": components["schemas"]["PolicyGrantList"];8355 };8356 };8357 400: components["responses"]["BadRequest"];8358 401: components["responses"]["Unauthenticated"];8359 403: components["responses"]["Forbidden"];8360 };8361 };8362 createPolicyGrant: {8363 parameters: {8364 query?: never;8365 header?: {8366 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8367 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8368 };8369 path?: never;8370 cookie?: never;8371 };8372 requestBody: {8373 content: {8374 /**8375 * @example {8376 * "subject_kind": "role",8377 * "subject": "operator",8378 * "permission": "actions.run.medium",8379 * "resource_kind": "node",8380 * "resource_id": "019a9b10-0000-7000-8000-000000000a01",8381 * "effect": "deny"8382 * }8383 */8384 "application/json": components["schemas"]["CreatePolicyGrantRequest"];8385 };8386 };8387 responses: {8388 /** @description Grant created. */8389 201: {8390 headers: {8391 "X-Correlation-Id": components["headers"]["CorrelationId"];8392 [name: string]: unknown;8393 };8394 content: {8395 "application/json": components["schemas"]["PolicyGrant"];8396 };8397 };8398 400: components["responses"]["BadRequest"];8399 401: components["responses"]["Unauthenticated"];8400 403: components["responses"]["Forbidden"];8401 409: components["responses"]["Conflict"];8402 };8403 };8404 deletePolicyGrant: {8405 parameters: {8406 query?: never;8407 header?: {8408 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8409 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8410 };8411 path: {8412 id: components["parameters"]["Id"];8413 };8414 cookie?: never;8415 };8416 requestBody?: never;8417 responses: {8418 /** @description Grant deleted. */8419 204: {8420 headers: {8421 "X-Correlation-Id": components["headers"]["CorrelationId"];8422 [name: string]: unknown;8423 };8424 content?: never;8425 };8426 401: components["responses"]["Unauthenticated"];8427 403: components["responses"]["Forbidden"];8428 404: components["responses"]["NotFound"];8429 };8430 };8431 search: {8432 parameters: {8433 query: {8434 /** @description Comma-separated kinds to search (all when omitted). */8435 kinds?: components["schemas"]["SearchResultKind"][];8436 limit?: number;8437 q: string;8438 };8439 header?: never;8440 path?: never;8441 cookie?: never;8442 };8443 requestBody?: never;8444 responses: {8445 /** @description Results ordered by relevance. */8446 200: {8447 headers: {8448 "X-Correlation-Id": components["headers"]["CorrelationId"];8449 [name: string]: unknown;8450 };8451 content: {8452 "application/json": components["schemas"]["SearchResults"];8453 };8454 };8455 400: components["responses"]["BadRequest"];8456 401: components["responses"]["Unauthenticated"];8457 };8458 };8459 listServices: {8460 parameters: {8461 query?: {8462 /** @description Logical application name. */8463 app?: string;8464 /** @description Opaque cursor taken from `next_cursor` of the previous page. */8465 cursor?: components["parameters"]["Cursor"];8466 /** @description Page size. */8467 limit?: components["parameters"]["Limit"];8468 managed?: boolean;8469 manager?: components["schemas"]["ServiceManager"];8470 node_id?: string;8471 /** @description Free-text filter (case-insensitive substring). */8472 q?: components["parameters"]["Q"];8473 state?: components["schemas"]["ServiceState"];8474 };8475 header?: never;8476 path?: never;8477 cookie?: never;8478 };8479 requestBody?: never;8480 responses: {8481 /** @description Services. */8482 200: {8483 headers: {8484 "X-Correlation-Id": components["headers"]["CorrelationId"];8485 [name: string]: unknown;8486 };8487 content: {8488 "application/json": components["schemas"]["ServiceList"];8489 };8490 };8491 400: components["responses"]["BadRequest"];8492 401: components["responses"]["Unauthenticated"];8493 403: components["responses"]["Forbidden"];8494 };8495 };8496 getService: {8497 parameters: {8498 query?: never;8499 header?: never;8500 path: {8501 id: components["parameters"]["Id"];8502 };8503 cookie?: never;8504 };8505 requestBody?: never;8506 responses: {8507 /** @description Service. */8508 200: {8509 headers: {8510 "X-Correlation-Id": components["headers"]["CorrelationId"];8511 [name: string]: unknown;8512 };8513 content: {8514 "application/json": components["schemas"]["Service"];8515 };8516 };8517 401: components["responses"]["Unauthenticated"];8518 403: components["responses"]["Forbidden"];8519 404: components["responses"]["NotFound"];8520 };8521 };8522 updateService: {8523 parameters: {8524 query?: never;8525 header?: {8526 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8527 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8528 };8529 path: {8530 id: components["parameters"]["Id"];8531 };8532 cookie?: never;8533 };8534 requestBody: {8535 content: {8536 "application/json": components["schemas"]["UpdateServiceRequest"];8537 };8538 };8539 responses: {8540 /** @description Updated service. */8541 200: {8542 headers: {8543 "X-Correlation-Id": components["headers"]["CorrelationId"];8544 [name: string]: unknown;8545 };8546 content: {8547 "application/json": components["schemas"]["Service"];8548 };8549 };8550 400: components["responses"]["BadRequest"];8551 401: components["responses"]["Unauthenticated"];8552 403: components["responses"]["Forbidden"];8553 404: components["responses"]["NotFound"];8554 };8555 };8556 getServiceHistory: {8557 parameters: {8558 query?: {8559 /** @description Opaque cursor taken from `next_cursor` of the previous page. */8560 cursor?: components["parameters"]["Cursor"];8561 /** @description Page size. */8562 limit?: components["parameters"]["Limit"];8563 };8564 header?: never;8565 path: {8566 id: components["parameters"]["Id"];8567 };8568 cookie?: never;8569 };8570 requestBody?: never;8571 responses: {8572 /** @description Timeline. */8573 200: {8574 headers: {8575 "X-Correlation-Id": components["headers"]["CorrelationId"];8576 [name: string]: unknown;8577 };8578 content: {8579 "application/json": components["schemas"]["ServiceHistory"];8580 };8581 };8582 400: components["responses"]["BadRequest"];8583 401: components["responses"]["Unauthenticated"];8584 403: components["responses"]["Forbidden"];8585 404: components["responses"]["NotFound"];8586 };8587 };8588 revokeSession: {8589 parameters: {8590 query?: never;8591 header?: {8592 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8593 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8594 };8595 path: {8596 id: components["parameters"]["Id"];8597 };8598 cookie?: never;8599 };8600 requestBody?: never;8601 responses: {8602 /** @description Session revoked. */8603 204: {8604 headers: {8605 "X-Correlation-Id": components["headers"]["CorrelationId"];8606 [name: string]: unknown;8607 };8608 content?: never;8609 };8610 401: components["responses"]["Unauthenticated"];8611 403: components["responses"]["Forbidden"];8612 404: components["responses"]["NotFound"];8613 };8614 };8615 listSettings: {8616 parameters: {8617 query?: never;8618 header?: never;8619 path?: never;8620 cookie?: never;8621 };8622 requestBody?: never;8623 responses: {8624 /** @description All settings (retention, thresholds, `orchestrator.frozen`...). */8625 200: {8626 headers: {8627 "X-Correlation-Id": components["headers"]["CorrelationId"];8628 [name: string]: unknown;8629 };8630 content: {8631 "application/json": components["schemas"]["SettingList"];8632 };8633 };8634 401: components["responses"]["Unauthenticated"];8635 403: components["responses"]["Forbidden"];8636 };8637 };8638 putSetting: {8639 parameters: {8640 query?: never;8641 header?: {8642 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8643 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8644 };8645 path: {8646 /** @description Setting key, for example `retention.raw_days`. */8647 key: string;8648 };8649 cookie?: never;8650 };8651 requestBody: {8652 content: {8653 /**8654 * @example {8655 * "value": 78656 * }8657 */8658 "application/json": components["schemas"]["PutSettingRequest"];8659 };8660 };8661 responses: {8662 /** @description Updated setting. */8663 200: {8664 headers: {8665 "X-Correlation-Id": components["headers"]["CorrelationId"];8666 [name: string]: unknown;8667 };8668 content: {8669 "application/json": components["schemas"]["Setting"];8670 };8671 };8672 400: components["responses"]["BadRequest"];8673 401: components["responses"]["Unauthenticated"];8674 403: components["responses"]["Forbidden"];8675 404: components["responses"]["NotFound"];8676 };8677 };8678 listSilences: {8679 parameters: {8680 query?: {8681 /** @description Only silences in effect now. */8682 active?: boolean;8683 /** @description Opaque cursor taken from `next_cursor` of the previous page. */8684 cursor?: components["parameters"]["Cursor"];8685 /** @description Page size. */8686 limit?: components["parameters"]["Limit"];8687 };8688 header?: never;8689 path?: never;8690 cookie?: never;8691 };8692 requestBody?: never;8693 responses: {8694 /** @description Silences. */8695 200: {8696 headers: {8697 "X-Correlation-Id": components["headers"]["CorrelationId"];8698 [name: string]: unknown;8699 };8700 content: {8701 "application/json": components["schemas"]["SilenceList"];8702 };8703 };8704 400: components["responses"]["BadRequest"];8705 401: components["responses"]["Unauthenticated"];8706 403: components["responses"]["Forbidden"];8707 };8708 };8709 createSilence: {8710 parameters: {8711 query?: never;8712 header?: {8713 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8714 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8715 };8716 path?: never;8717 cookie?: never;8718 };8719 requestBody: {8720 content: {8721 "application/json": components["schemas"]["CreateSilenceRequest"];8722 };8723 };8724 responses: {8725 /** @description Silence created. */8726 201: {8727 headers: {8728 "X-Correlation-Id": components["headers"]["CorrelationId"];8729 [name: string]: unknown;8730 };8731 content: {8732 "application/json": components["schemas"]["Silence"];8733 };8734 };8735 400: components["responses"]["BadRequest"];8736 401: components["responses"]["Unauthenticated"];8737 403: components["responses"]["Forbidden"];8738 };8739 };8740 deleteSilence: {8741 parameters: {8742 query?: never;8743 header?: {8744 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8745 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8746 };8747 path: {8748 id: components["parameters"]["Id"];8749 };8750 cookie?: never;8751 };8752 requestBody?: never;8753 responses: {8754 /** @description Silence deleted. */8755 204: {8756 headers: {8757 "X-Correlation-Id": components["headers"]["CorrelationId"];8758 [name: string]: unknown;8759 };8760 content?: never;8761 };8762 401: components["responses"]["Unauthenticated"];8763 403: components["responses"]["Forbidden"];8764 404: components["responses"]["NotFound"];8765 409: components["responses"]["Conflict"];8766 };8767 };8768 listBackups: {8769 parameters: {8770 query?: never;8771 header?: never;8772 path?: never;8773 cookie?: never;8774 };8775 requestBody?: never;8776 responses: {8777 /** @description Backups. */8778 200: {8779 headers: {8780 "X-Correlation-Id": components["headers"]["CorrelationId"];8781 [name: string]: unknown;8782 };8783 content: {8784 "application/json": components["schemas"]["BackupList"];8785 };8786 };8787 401: components["responses"]["Unauthenticated"];8788 403: components["responses"]["Forbidden"];8789 };8790 };8791 listNasTargets: {8792 parameters: {8793 query?: never;8794 header?: never;8795 path?: never;8796 cookie?: never;8797 };8798 requestBody?: never;8799 responses: {8800 /** @description NAS targets. */8801 200: {8802 headers: {8803 "X-Correlation-Id": components["headers"]["CorrelationId"];8804 [name: string]: unknown;8805 };8806 content: {8807 "application/json": components["schemas"]["NasTargetList"];8808 };8809 };8810 401: components["responses"]["Unauthenticated"];8811 403: components["responses"]["Forbidden"];8812 };8813 };8814 createNasTarget: {8815 parameters: {8816 query?: never;8817 header?: {8818 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8819 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8820 };8821 path?: never;8822 cookie?: never;8823 };8824 requestBody: {8825 content: {8826 /**8827 * @example {8828 * "name": "nas-1",8829 * "host": "192.168.2.173",8830 * "share": "clustr",8831 * "protocol": "smb"8832 * }8833 */8834 "application/json": components["schemas"]["CreateNasTargetRequest"];8835 };8836 };8837 responses: {8838 /** @description NAS target registered with state `unknown` until observed. */8839 201: {8840 headers: {8841 "X-Correlation-Id": components["headers"]["CorrelationId"];8842 [name: string]: unknown;8843 };8844 content: {8845 "application/json": components["schemas"]["NasTarget"];8846 };8847 };8848 400: components["responses"]["BadRequest"];8849 401: components["responses"]["Unauthenticated"];8850 403: components["responses"]["Forbidden"];8851 409: components["responses"]["Conflict"];8852 };8853 };8854 deleteNasTarget: {8855 parameters: {8856 query?: never;8857 header?: {8858 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8859 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8860 };8861 path: {8862 id: components["parameters"]["Id"];8863 };8864 cookie?: never;8865 };8866 requestBody?: never;8867 responses: {8868 /** @description NAS target removed. */8869 204: {8870 headers: {8871 "X-Correlation-Id": components["headers"]["CorrelationId"];8872 [name: string]: unknown;8873 };8874 content?: never;8875 };8876 401: components["responses"]["Unauthenticated"];8877 403: components["responses"]["Forbidden"];8878 404: components["responses"]["NotFound"];8879 };8880 };8881 listVolumes: {8882 parameters: {8883 query?: {8884 /** @description Opaque cursor taken from `next_cursor` of the previous page. */8885 cursor?: components["parameters"]["Cursor"];8886 kind?: components["schemas"]["VolumeKind"];8887 /** @description Page size. */8888 limit?: components["parameters"]["Limit"];8889 /** @description Only volumes at least this full. */8890 min_used_pct?: number;8891 node_id?: string;8892 };8893 header?: never;8894 path?: never;8895 cookie?: never;8896 };8897 requestBody?: never;8898 responses: {8899 /** @description Volumes. */8900 200: {8901 headers: {8902 "X-Correlation-Id": components["headers"]["CorrelationId"];8903 [name: string]: unknown;8904 };8905 content: {8906 "application/json": components["schemas"]["VolumeList"];8907 };8908 };8909 400: components["responses"]["BadRequest"];8910 401: components["responses"]["Unauthenticated"];8911 403: components["responses"]["Forbidden"];8912 };8913 };8914 listUsers: {8915 parameters: {8916 query?: {8917 /** @description Opaque cursor taken from `next_cursor` of the previous page. */8918 cursor?: components["parameters"]["Cursor"];8919 disabled?: boolean;8920 /** @description Page size. */8921 limit?: components["parameters"]["Limit"];8922 /** @description Free-text filter (case-insensitive substring). */8923 q?: components["parameters"]["Q"];8924 role?: components["schemas"]["UserRole"];8925 };8926 header?: never;8927 path?: never;8928 cookie?: never;8929 };8930 requestBody?: never;8931 responses: {8932 /** @description Users. */8933 200: {8934 headers: {8935 "X-Correlation-Id": components["headers"]["CorrelationId"];8936 [name: string]: unknown;8937 };8938 content: {8939 "application/json": components["schemas"]["UserList"];8940 };8941 };8942 400: components["responses"]["BadRequest"];8943 401: components["responses"]["Unauthenticated"];8944 403: components["responses"]["Forbidden"];8945 };8946 };8947 getUser: {8948 parameters: {8949 query?: never;8950 header?: never;8951 path: {8952 id: components["parameters"]["Id"];8953 };8954 cookie?: never;8955 };8956 requestBody?: never;8957 responses: {8958 /** @description User. */8959 200: {8960 headers: {8961 "X-Correlation-Id": components["headers"]["CorrelationId"];8962 [name: string]: unknown;8963 };8964 content: {8965 "application/json": components["schemas"]["User"];8966 };8967 };8968 401: components["responses"]["Unauthenticated"];8969 403: components["responses"]["Forbidden"];8970 404: components["responses"]["NotFound"];8971 };8972 };8973 updateUser: {8974 parameters: {8975 query?: never;8976 header?: {8977 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */8978 "X-MCC-CSRF"?: components["parameters"]["Csrf"];8979 };8980 path: {8981 id: components["parameters"]["Id"];8982 };8983 cookie?: never;8984 };8985 requestBody: {8986 content: {8987 "application/json": components["schemas"]["UpdateUserRequest"];8988 };8989 };8990 responses: {8991 /** @description Updated user. */8992 200: {8993 headers: {8994 "X-Correlation-Id": components["headers"]["CorrelationId"];8995 [name: string]: unknown;8996 };8997 content: {8998 "application/json": components["schemas"]["User"];8999 };9000 };9001 400: components["responses"]["BadRequest"];9002 401: components["responses"]["Unauthenticated"];9003 403: components["responses"]["Forbidden"];9004 404: components["responses"]["NotFound"];9005 409: components["responses"]["Conflict"];9006 };9007 };9008 listUserDevices: {9009 parameters: {9010 query?: never;9011 header?: never;9012 path: {9013 id: components["parameters"]["Id"];9014 };9015 cookie?: never;9016 };9017 requestBody?: never;9018 responses: {9019 /** @description Devices. */9020 200: {9021 headers: {9022 "X-Correlation-Id": components["headers"]["CorrelationId"];9023 [name: string]: unknown;9024 };9025 content: {9026 "application/json": components["schemas"]["DeviceList"];9027 };9028 };9029 401: components["responses"]["Unauthenticated"];9030 403: components["responses"]["Forbidden"];9031 404: components["responses"]["NotFound"];9032 };9033 };9034 listUserPasskeys: {9035 parameters: {9036 query?: never;9037 header?: never;9038 path: {9039 id: components["parameters"]["Id"];9040 };9041 cookie?: never;9042 };9043 requestBody?: never;9044 responses: {9045 /** @description Passkeys, revoked ones included. */9046 200: {9047 headers: {9048 "X-Correlation-Id": components["headers"]["CorrelationId"];9049 [name: string]: unknown;9050 };9051 content: {9052 "application/json": components["schemas"]["PasskeyList"];9053 };9054 };9055 401: components["responses"]["Unauthenticated"];9056 403: components["responses"]["Forbidden"];9057 404: components["responses"]["NotFound"];9058 };9059 };9060 revokeUserPasskey: {9061 parameters: {9062 query?: never;9063 header?: {9064 /** @description CSRF token of the session. **Required for cookie sessions** on every non-safe method (`403 csrf_failed` otherwise); ignored for bearer sessions. */9065 "X-MCC-CSRF"?: components["parameters"]["Csrf"];9066 };9067 path: {9068 id: components["parameters"]["Id"];9069 passkeyId: string;9070 };9071 cookie?: never;9072 };9073 requestBody?: never;9074 responses: {9075 /** @description Passkey revoked. */9076 204: {9077 headers: {9078 "X-Correlation-Id": components["headers"]["CorrelationId"];9079 [name: string]: unknown;9080 };9081 content?: never;9082 };9083 401: components["responses"]["Unauthenticated"];9084 403: components["responses"]["Forbidden"];9085 404: components["responses"]["NotFound"];9086 409: components["responses"]["Conflict"];9087 };9088 };9089 listUserSessions: {9090 parameters: {9091 query?: never;9092 header?: never;9093 path: {9094 id: components["parameters"]["Id"];9095 };9096 cookie?: never;9097 };9098 requestBody?: never;9099 responses: {9100 /** @description Sessions. */9101 200: {9102 headers: {9103 "X-Correlation-Id": components["headers"]["CorrelationId"];9104 [name: string]: unknown;9105 };9106 content: {9107 "application/json": components["schemas"]["SessionList"];9108 };9109 };9110 401: components["responses"]["Unauthenticated"];9111 403: components["responses"]["Forbidden"];9112 404: components["responses"]["NotFound"];9113 };9114 };9115 getVersion: {9116 parameters: {9117 query?: never;9118 header?: never;9119 path?: never;9120 cookie?: never;9121 };9122 requestBody?: never;9123 responses: {9124 /** @description Version. */9125 200: {9126 headers: {9127 "X-Correlation-Id": components["headers"]["CorrelationId"];9128 [name: string]: unknown;9129 };9130 content: {9131 "application/json": components["schemas"]["VersionInfo"];9132 };9133 };9134 };9135 };9136}9137