{ "openapi": "3.0.3", "info": { "title": "InfraNest API", "description": "Infrastructure management platform. Manage domains, DNS, cloud servers, and monitoring from one place.", "version": "1.0.0", "x-logo": { "url": "https://developers.infranest.io/logo.svg", "altText": "InfraNest" }, "contact": { "name": "InfraNest", "url": "https://developers.infranest.io" } }, "servers": [ { "url": "https://api.infranest.io" } ], "tags": [ { "name": "Authentication", "description": "" }, { "name": "Organizations", "description": "" }, { "name": "Domains", "description": "" }, { "name": "DNS", "description": "" }, { "name": "Cloud", "description": "" }, { "name": "Monitoring", "description": "" }, { "name": "Drop Catch", "description": "\nThe catch attempt log for a watched domain (#28 Phase 20g): every registration try, per registrar,\nsuccess or failure — powering the watch-detail \"Registration attempts\" panel." }, { "name": "Notifications", "description": "" }, { "name": "API Tokens", "description": "" }, { "name": "Audit Log", "description": "" }, { "name": "Billing", "description": "" }, { "name": "Public", "description": "\nThe customer-facing slice of the entitlement catalog (#322 D3) — presentation metadata only\n(`label_key`, `format`, `highlight`, `sort`, `type`, `default`), filtered to `public` entries. Powers\nthe registry-driven plan specs on the pricing / subscription page. Enforcement lives server-side in\n{@see Entitlements}; nothing here is authoritative." }, { "name": "Analytics", "description": "" }, { "name": "Auth", "description": "" }, { "name": "Automations", "description": "" }, { "name": "Bulk operations", "description": "\nAdd/remove a tag on many taggable resources at once (Bulk Operations, #69, Phase A).\nOne shared endpoint for every org-scoped taggable model — no per-resource bulk code." }, { "name": "Certificates", "description": "" }, { "name": "Cost", "description": "" }, { "name": "Cost reporting", "description": "" }, { "name": "Custom fields", "description": "" }, { "name": "Dashboard", "description": "\nBatched, per-block data feed for the graphical dashboard widgets (Dashboard 2.0, Phase 4).\nGET /organizations/{org}/dashboard/data?blocks=drop_catch,domains,entitlements\nEach block is computed on demand and cached briefly per org so many widgets share one query." }, { "name": "Dynamic IP", "description": "" }, { "name": "Endpoints", "description": "" }, { "name": "Firewalls", "description": "" }, { "name": "Integration Logs", "description": "" }, { "name": "Integrations", "description": "" }, { "name": "Onboarding", "description": "" }, { "name": "Reporting", "description": "" }, { "name": "Reports", "description": "" }, { "name": "Security advisor", "description": "" }, { "name": "Webhooks", "description": "\nOutbound webhook endpoints (#30) — org members subscribe an external URL to InfraNest events and\nreceive signed POSTs. The signing secret is returned only on create / rotate." } ], "components": { "securitySchemes": { "default": { "type": "http", "scheme": "bearer", "description": "Create a token in the app under My account → Developer. Tokens are managed in the app only, never through the API." } }, "schemas": { "Error": { "type": "object", "required": [ "code", "message", "hint", "retryable" ], "properties": { "code": { "type": "string", "enum": [ "unauthenticated", "scope_missing", "session_only", "not_token_writable", "write_disabled", "wrong_organization", "token_ip_not_allowed", "test_token_required", "test_token_sandbox_only", "api_token_required", "sandbox_personal", "sandbox_needs_organization", "organization_offline", "permission_denied", "forbidden", "organization_suspended", "read_only_session", "sso_required", "two_factor_setup_required", "password_reset_required", "email_verification_required", "plan_limit", "not_found", "method_not_allowed", "conflict", "validation_failed", "unprocessable", "range_too_large", "rate_limited", "idempotency_key_reused", "idempotency_in_progress", "provider_refused", "provider_rate_limited", "provider_unavailable", "maintenance", "server_error" ], "description": "What kind of error this is. Stable: codes are added, never renamed or removed." }, "message": { "type": "string", "description": "A sentence for people. May be reworded." }, "hint": { "type": "string", "description": "What to do about it." }, "retryable": { "type": "boolean", "description": "Whether the same request can succeed later unchanged." }, "docs_url": { "type": "string", "format": "uri" }, "reference": { "type": "string", "description": "The request ID; also the X-Request-Id header." }, "retry_after": { "type": "integer", "description": "Seconds to wait before retrying." }, "required": { "type": "string", "description": "The missing token scope (scope_missing)." }, "required_permission": { "type": "string", "description": "The missing role permission (permission_denied)." }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "responses": { "Error401": { "description": "The token is missing, wrong, expired or revoked. The body is an Error; its `code` says which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error403": { "description": "The token or your role may not do this here. The body is an Error; its `code` says which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error404": { "description": "Nothing exists at this address, or you cannot see it. The body is an Error; its `code` says which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error409": { "description": "A conflict: the same request is still being handled, or the current state does not allow it. The body is an Error; its `code` says which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error422": { "description": "The request was understood but cannot be done as sent. The body is an Error; its `code` says which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error429": { "description": "Too many requests: wait the seconds in Retry-After. The body is an Error; its `code` says which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "security": [ { "default": [] } ], "paths": { "/api/auth/logout": { "post": { "summary": "Revoke the current token", "operationId": "postApiAuthLogout", "description": "Deletes the token that authenticated this request, so it stops working immediately. Other tokens on your account are not affected.", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Logged out successfully." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Authentication" ], "x-infranest-scope": null, "x-infranest-token-writable": true, "x-infranest-module": "account", "x-infranest-errors": [ "unauthenticated", "write_disabled", "organization_suspended", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/auth/me": { "get": { "summary": "Get the signed-in user", "operationId": "getApiAuthMe", "description": "Your user profile, the organizations you belong to with your role in each, and the state of your account security (two-factor, passkeys, password). A token bound to one organization lists only that organization.", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "user": { "id": 1, "name": "Alex Rivera", "email": "demo@example.com", "email_verified_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "is_super_admin": false, "blocked_at": null, "block_reason": null, "locked_until": null, "notification_preferences": { "quiet_hours": { "from": "22:00", "to": "07:00", "tz": "Europe/Amsterdam" } }, "two_factor_confirmed_at": null, "first_name": null, "last_name": null, "language": "en", "avatar_url": "http://localhost/storage/avatars/docs-demo-alex.svg", "dashboard_layout": null, "platform_role": "user", "email_format": "html", "onboarding": null, "password_changed_at": "2026-01-15T12:00:00.000000Z", "pending_email": null, "pending_email_sent_at": null, "terms_accepted_at": null, "terms_version": null, "marketing_consent_at": null, "timezone": null, "time_format": "auto", "force_password_reset": false, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "anonymized_at": null, "analytics_opt_out": false, "open_on_dashboard_id": null, "default_organization_id": null, "analytics_id": "api.infranest.io-4200017", "organizations": [ { "id": 1, "name": "Northwind Cloud", "slug": "northwind-demo", "country": null, "avatar_url": null, "base_currency": "EUR", "timezone": null, "price_display": "net", "vat_rate": "21.00", "require_reauth_destructive": false, "require_reauth_power": false, "require_2fa": false, "password_min_length": null, "password_require_symbols": null, "password_max_age_days": null, "dynamic_ip_default_strict": false, "dynamic_ip_default_fail_closed": false, "recap_cadence": "monthly", "sso_required": false, "sso_required_since": null, "is_demo": true, "is_sandbox": false, "users_count": 4, "org_role": { "id": 1, "organization_id": null, "name": "Owner", "slug": "owner", "is_system": true, "permissions": { "dns.read": true, "dns.write": true, "cloud.read": true, "cloud.write": true, "billing.read": true, "domains.read": true, "roles.manage": true, "billing.write": true, "domains.write": true, "domains.delete": true, "members.manage": true, "monitoring.read": true, "monitoring.write": true }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null }, "sso_admitted": true, "effective_timezone": "UTC", "managed_by": [ "Sam Okoye" ], "analytics_id": null, "pivot": { "user_id": 1, "organization_id": 1, "org_role_id": 1, "sso_external": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } } ] }, "unread_notifications": 3, "is_impersonated": false, "is_standing_in": false, "impersonated_by": null, "session_country_code": null, "session_region_code": null, "two_factor_setup_required": false, "password_reset_required": false, "email_verification_required": false, "email_undeliverable": false, "email_security_phrase": null, "has_passkeys": false, "passkey_count": 0, "has_password": true, "sso_only": null, "can_go_passwordless": false, "recovery_codes_left": null, "gravatar_enabled": false, "gravatar_default": "mp", "avatar_sources": [ "google", "github" ], "oauth_avatars": [], "stripe_enabled": false, "stripe_publishable_key": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Authentication" ], "x-infranest-scope": null, "x-infranest-token-writable": false, "x-infranest-module": "account", "x-infranest-errors": [ "unauthenticated", "rate_limited" ] } }, "/api/organizations": { "get": { "summary": "List your organizations", "operationId": "getApiOrganizations", "description": "Every organization you are a member of, with your role and its member count. An organization that requires its own single sign-on, which this session has not used, is listed by name only.", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "name": "Northwind Cloud", "slug": "northwind-demo", "deleted_at": null, "created_at": "2025-10-17T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "avatar_url": null, "reseller_id": null, "entitlement_overrides": { "api": true, "cloud": true, "api.mcp": true, "domains": null, "servers": null, "api.read": true, "monitors": null, "webhooks": true, "api.write": true, "dns.drift": true, "dns_zones": null, "drop_catch": true, "module.api": true, "module.dns": true, "automations": null, "data_import": true, "dynamic_ips": null, "white_label": true, "certificates": null, "module.cloud": true, "security.sso": true, "status_pages": null, "team_members": null, "cloud.backups": true, "cloud.volumes": true, "custom_fields": true, "dns.templates": true, "organizations": null, "security.scim": true, "api.tokens_max": null, "cloud.networks": true, "cost_reporting": true, "email_branding": true, "module.domains": true, "cloud.firewalls": true, "cloud.providers": "all", "cloud.snapshots": true, "monitor_regions": true, "watched_domains": null, "module.dropcatch": true, "cloud.volumes_max": null, "external_monitors": null, "module.monitoring": true, "monitored_servers": null, "cloud.networks_max": null, "dropcatch.register": true, "module.automations": true, "monitoring.regions": "all", "cloud.firewalls_max": null, "dropcatch.backorder": true, "module.certificates": true, "module.integrations": true, "module.status_pages": true, "status_page_private": true, "cloud.load_balancers": true, "data_export_advanced": true, "domains.registration": true, "monitoring.incidents": true, "security.ip_allowlist": true, "integrations.providers": "all", "monitoring.check_types": "all", "monitoring.maintenance": true, "status_page_whitelabel": true, "dropcatch.parallel_race": true, "automations.action_types": "all", "cloud.load_balancers_max": null, "monitoring.calendar_feed": true, "status_page_custom_domain": true, "automations.premium_actions": true, "integrations.connections_max": null, "integrations.chat_destinations": null }, "stripe_customer_id": null, "require_reauth_destructive": false, "require_reauth_power": false, "dynamic_ip_default_strict": false, "dynamic_ip_default_fail_closed": false, "require_2fa": false, "password_min_length": null, "password_require_symbols": null, "password_max_age_days": null, "entitlement_overrides_meta": null, "base_currency": "EUR", "price_display": "net", "vat_rate": "21.00", "country": null, "is_demo": true, "timezone": null, "sso_required": false, "suspended_at": null, "suspended_reason": null, "ip_allowlist": null, "session_lifetime_days": null, "pagerduty_webhook_token": null, "vat_number": null, "vat_status": null, "vat_trader_name": null, "vat_country": null, "vat_consultation_number": null, "vat_checked_at": null, "billing_email": null, "billing_cc": null, "billing_reference": null, "purge_after": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "purge_reminder_sent_at": null, "alerts_quiet_until": null, "billing_country": null, "trial_used_at": null, "recap_cadence": "monthly", "brand_logo_url": "http://localhost/storage/org-brand-logos/docs-demo-northwind.svg", "brand_accent_color": "#0F766E", "brand_email_from_name": "Northwind Cloud", "acquisition_src": null, "acquisition_plan": null, "acquisition_cadence": null, "acquisition_code": null, "customer_number": "4200017", "size_band": null, "presignup_first_page": null, "presignup_sessions": null, "presignup_days": null, "sso_required_since": null, "is_internal": false, "client_field_id": null, "onboarding_report_sent_at": null, "notification_defaults": null, "api_writes_enabled_at": null, "is_sandbox": false, "referral_code": "northwind-cloud", "acquisition_ref": null, "users_count": 4, "analytics_id": "api.infranest.io-4200017", "pivot": { "user_id": 1, "organization_id": 1, "org_role_id": 1, "sso_external": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Organizations" ], "x-infranest-scope": "members.read", "x-infranest-token-writable": false, "x-infranest-module": "organization", "x-infranest-errors": [ "unauthenticated", "scope_missing", "rate_limited" ] } }, "/api/organizations/{id}": { "get": { "summary": "Get an organization", "operationId": "getApiOrganizationsId", "description": "The organization’s settings, with the name and email address of each member.", "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "name": "Northwind Cloud", "slug": "northwind-demo", "deleted_at": null, "created_at": "2025-10-17T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "avatar_url": null, "reseller_id": null, "entitlement_overrides": { "api": true, "cloud": true, "api.mcp": true, "domains": null, "servers": null, "api.read": true, "monitors": null, "webhooks": true, "api.write": true, "dns.drift": true, "dns_zones": null, "drop_catch": true, "module.api": true, "module.dns": true, "automations": null, "data_import": true, "dynamic_ips": null, "white_label": true, "certificates": null, "module.cloud": true, "security.sso": true, "status_pages": null, "team_members": null, "cloud.backups": true, "cloud.volumes": true, "custom_fields": true, "dns.templates": true, "organizations": null, "security.scim": true, "api.tokens_max": null, "cloud.networks": true, "cost_reporting": true, "email_branding": true, "module.domains": true, "cloud.firewalls": true, "cloud.providers": "all", "cloud.snapshots": true, "monitor_regions": true, "watched_domains": null, "module.dropcatch": true, "cloud.volumes_max": null, "external_monitors": null, "module.monitoring": true, "monitored_servers": null, "cloud.networks_max": null, "dropcatch.register": true, "module.automations": true, "monitoring.regions": "all", "cloud.firewalls_max": null, "dropcatch.backorder": true, "module.certificates": true, "module.integrations": true, "module.status_pages": true, "status_page_private": true, "cloud.load_balancers": true, "data_export_advanced": true, "domains.registration": true, "monitoring.incidents": true, "security.ip_allowlist": true, "integrations.providers": "all", "monitoring.check_types": "all", "monitoring.maintenance": true, "status_page_whitelabel": true, "dropcatch.parallel_race": true, "automations.action_types": "all", "cloud.load_balancers_max": null, "monitoring.calendar_feed": true, "status_page_custom_domain": true, "automations.premium_actions": true, "integrations.connections_max": null, "integrations.chat_destinations": null }, "stripe_customer_id": null, "require_reauth_destructive": false, "require_reauth_power": false, "dynamic_ip_default_strict": false, "dynamic_ip_default_fail_closed": false, "require_2fa": false, "password_min_length": null, "password_require_symbols": null, "password_max_age_days": null, "entitlement_overrides_meta": null, "base_currency": "EUR", "price_display": "net", "vat_rate": "21.00", "country": null, "is_demo": true, "timezone": null, "sso_required": false, "suspended_at": null, "suspended_reason": null, "ip_allowlist": null, "session_lifetime_days": null, "pagerduty_webhook_token": null, "vat_number": null, "vat_status": null, "vat_trader_name": null, "vat_country": null, "vat_consultation_number": null, "vat_checked_at": null, "billing_email": null, "billing_cc": null, "billing_reference": null, "purge_after": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "purge_reminder_sent_at": null, "alerts_quiet_until": null, "billing_country": null, "trial_used_at": null, "recap_cadence": "monthly", "brand_logo_url": "http://localhost/storage/org-brand-logos/docs-demo-northwind.svg", "brand_accent_color": "#0F766E", "brand_email_from_name": "Northwind Cloud", "acquisition_src": null, "acquisition_plan": null, "acquisition_cadence": null, "acquisition_code": null, "customer_number": "4200017", "size_band": null, "presignup_first_page": null, "presignup_sessions": null, "presignup_days": null, "sso_required_since": null, "is_internal": false, "client_field_id": null, "onboarding_report_sent_at": null, "notification_defaults": null, "api_writes_enabled_at": null, "is_sandbox": false, "referral_code": "northwind-cloud", "acquisition_ref": null, "analytics_id": "api.infranest.io-4200017", "subscription": { "id": 1, "organization_id": 1, "plan_id": 2, "status": "active", "provider": "stripe", "provider_subscription_id": "sub_demo_northwind", "trial_ends_at": null, "current_period_start": "2026-01-01T00:00:00.000000Z", "current_period_end": "2026-02-15T12:00:00.000000Z", "canceled_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "cancel_at_period_end": false, "stripe_price_id": null, "currency": "eur", "trial_reminder_sent_at": null, "renewal_reminder_sent_at": null, "card_expiry_reminder_sent_at": null, "addons": [], "card_on_file": false, "trial_recap_sent_at": null, "trial_last_call_sent_at": null, "trial_first_steps_sent_at": null, "trial_ended_at": null, "trial_reactivation_sent_at": null, "recap_period_start": null, "renewal_recap_sent_for": null, "discount_code": null, "discount_percent": null, "discount_amount_off": null, "discount_duration": null, "discount_starts_at": null, "discount_ends_at": null, "discount_label": null, "plan": { "id": 2, "name": "Pro", "slug": "pro", "description": "For freelancers & solo devs — faster checks, cloud, API and automations.", "limits": { "api": true, "rate": { "manual_sync_per_hour": 30, "domain_checks_per_hour": 100, "monitor_checks_per_hour": 120, "provider_api_per_minute": 300 }, "cloud": true, "api.mcp": true, "domains": 100, "servers": 10, "api.read": true, "monitors": 50, "webhooks": true, "api.write": true, "dns.drift": true, "dns_zones": 100, "drop_catch": true, "automations": 25, "data_import": true, "dynamic_ips": 10, "certificates": 100, "status_pages": 3, "team_members": 3, "cloud.backups": true, "cloud.volumes": true, "dns.templates": true, "organizations": 1, "api.tokens_max": 5, "cloud.firewalls": true, "cloud.snapshots": true, "watched_domains": 50, "cloud.volumes_max": 10, "external_monitors": 5, "dropcatch.register": true, "cloud.firewalls_max": 5, "audit.retention_days": 30, "domains.registration": true, "monitor_min_interval": 60, "monitoring.incidents": true, "monitoring.maintenance": true, "cloud.load_balancers_max": 0, "monitoring.calendar_feed": true, "monitoring.retention_days": 90, "status_page_custom_domain": true, "dns.history_retention_days": 90, "automations.premium_actions": true, "integrations.connections_max": 5 }, "price_monthly": 2250, "price_yearly": 22800, "active": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "is_public": true, "sort_order": 2, "stripe_product_id": null, "stripe_prices": null, "prices": { "eur": { "yearly": 22800, "monthly": 2250 } }, "trial_days": 0, "recommended": false, "name_i18n": null, "description_i18n": null, "badge": null, "tagline_i18n": { "de": "Freelancer & Solo-Entwickler", "en": "Freelancers & solo devs", "fr": "Freelances & développeurs solo", "nl": "Freelancers & solo-ontwikkelaars" }, "highlights_i18n": { "de": [ "Alles in Free", "100 Domains" ], "en": [ "Everything in Free", "100 domains" ], "fr": [ "Tout dans Free", "100 domaines" ], "nl": [ "Alles in Free", "100 domeinen" ] }, "contact_sales": false, "contact_url": null } }, "users": [ { "id": 2, "name": "Sam Okoye", "email": "sam@example.com", "analytics_id": null, "pivot": { "organization_id": 1, "user_id": 2, "org_role_id": 2, "sso_role_managed": false, "sso_external": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } }, { "id": 3, "name": "Priya Raghunathan", "email": "priya@example.com", "analytics_id": null, "pivot": { "organization_id": 1, "user_id": 3, "org_role_id": 3, "sso_role_managed": false, "sso_external": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Organizations" ], "x-infranest-scope": "members.read", "x-infranest-token-writable": false, "x-infranest-module": "organization", "x-infranest-errors": [ "unauthenticated", "scope_missing", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/members": { "get": { "summary": "List members", "operationId": "getApiOrganizationsOrganization_idMembers", "description": "Every member of the organization with their role. `email_undeliverable` is true when email to that address can no longer be delivered.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 2, "name": "Sam Okoye", "email": "sam@example.com", "email_undeliverable": false, "org_role": { "id": 2, "organization_id": null, "name": "Admin", "slug": "admin", "is_system": true, "permissions": { "dns.read": true, "dns.write": true, "cloud.read": true, "cloud.write": true, "billing.read": true, "domains.read": true, "roles.manage": false, "billing.write": false, "domains.write": true, "domains.delete": false, "members.manage": true, "monitoring.read": true, "monitoring.write": true }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null }, "sso_external": false }, { "id": 3, "name": "Priya Raghunathan", "email": "priya@example.com", "email_undeliverable": false, "org_role": { "id": 3, "organization_id": null, "name": "Member", "slug": "member", "is_system": true, "permissions": { "dns.read": true, "dns.write": false, "cloud.read": true, "cloud.write": false, "billing.read": false, "domains.read": true, "roles.manage": false, "billing.write": false, "domains.write": false, "domains.delete": false, "members.manage": false, "monitoring.read": true, "monitoring.write": false }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null }, "sso_external": false } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Organizations" ], "x-infranest-scope": "members.read", "x-infranest-token-writable": false, "x-infranest-module": "organization", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/invitations": { "get": { "summary": "List pending invitations", "operationId": "getApiOrganizationsOrganization_idInvitations", "description": "Invitations that have not been accepted yet, with who sent each one and the role it grants.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "organization_id": 1, "email": "newcolleague@northwind.example", "invited_by": 1, "accepted_at": null, "expires_at": "2026-01-20T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "org_role_id": 3, "origin": null, "inviter": { "id": 1, "name": "Alex Rivera", "email": "demo@example.com", "analytics_id": null }, "org_role": { "id": 3, "organization_id": null, "name": "Member", "slug": "member", "is_system": true, "permissions": { "dns.read": true, "dns.write": false, "cloud.read": true, "cloud.write": false, "billing.read": false, "domains.read": true, "roles.manage": false, "billing.write": false, "domains.write": false, "domains.delete": false, "members.manage": false, "monitoring.read": true, "monitoring.write": false }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null } } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Organizations" ], "x-infranest-scope": "members.read", "x-infranest-token-writable": false, "x-infranest-module": "organization", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/registration-fields": { "get": { "summary": "Get registration requirements for an extension", "operationId": "gETorganizationsorgdomainsregistrationFieldscredentialIdtldExtraFieldsextendedAttributesTheRegistrarTLDRequiresAtRegistrationEgusNexuspurposeeucaAgreementsGenericAcrossRegistrarsViaMethodExists", "description": "The extra fields a registrar needs to register a domain under `tld` (for example the nexus details some country extensions ask for) and the registration periods it offers. `credential_id` and `tld` are required; `unknown` is true when the registrar could not be asked, in which case it may still refuse.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "fields": [], "unknown": true, "periods": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credential_id": { "type": "integer", "description": "Must match an existing stored value.", "example": 16 }, "tld": { "type": "string", "description": "" } }, "required": [ "credential_id" ] } } } }, "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/transfer-preflight": { "get": { "summary": "Check a domain before transferring it in", "operationId": "gETorganizationsorgdomainstransferPreflightnametldTheHandfulOfReasonsAnInboundTransferUsuallyFailsCheckedBeforeSubmitInsteadOfDiscoveredFiveDaysLaterReadOnlyRegistrationDataTheDomainIsntInTheOrgYet", "description": "Checks the usual reasons an inbound transfer fails for the domain given by `name` and `tld`, before you submit it. Optionally pass `credential_id` for the registrar that would receive it; counts toward your plan’s hourly domain-check limit.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "domain": "northwind.com", "registrar": "Namecheap", "expires_at": "2026-02-02", "source": "fixture", "checks": [ { "key": "not_locked", "status": "warn", "detail": [] }, { "key": "sixty_day_rule", "status": "pass", "detail": { "days": 749, "free_on": "2024-02-26", "since": "registration" } } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "b" }, "tld": { "type": "string", "description": "Must not be greater than 30 characters.", "example": "n" }, "credential_id": { "type": "integer", "description": "Which of the org's registrars the transfer would go to. Optional: the registry checks below\nare about the losing side and run without it. Scoped to the org rather than taken on trust —\na credential id from another tenant would otherwise make one API call on their key (#597).", "example": 16, "nullable": true } }, "required": [ "name", "tld" ] } } } }, "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domain-findings": { "get": { "summary": "List domain findings", "operationId": "gETdomainFindingsTheAdvisorAcrossTheOrganisation3935OnlyWhatCountsRankedMostUrgentFirstAndOneFindingPerCauseSoARefusedRegistrarKeyIsOneItemNamingItsDomains", "description": "Advisor findings across all your domains, most urgent first, with one finding per cause naming every domain it affects.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "key": "expiry", "check": "expiry", "status": "error", "variant": "lapsed", "params": { "days": -6, "expires_at": "2026-01-09" }, "action": "renew", "cause": "domain:18:expiry", "rank": 390, "home": { "source": "domain_expiring", "key": "domain:18", "fingerprint": "2026-01-09" }, "snoozed": false, "domains": [ { "id": 18, "name": "nwcloud.app" } ] }, { "key": "dnssec", "check": "dnssec", "status": "error", "variant": "notValidating", "params": { "since": "2026-01-13T12:00:00.000000Z" }, "action": null, "cause": "domain:9:dnssec", "rank": 350, "home": { "source": "dnssec_broken", "key": "dnssec_broken:9", "fingerprint": "" }, "snoozed": false, "domains": [ { "id": 9, "name": "northwind.de" } ] } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/overview": { "get": { "summary": "Get the domains overview", "operationId": "gETdomainsoverviewTheDomainsOverviewTab3936SeeDomainOverview", "description": "A summary of your domains: what needs your attention, what the next year of renewals costs in your base currency, and how the portfolio is protected.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "summary": { "total": 20, "fine": 16, "need_you": 4, "this_week": 2, "registrars": 7, "renewal_cost": 327.5, "currency": "EUR", "auto_renewing": 0, "synced_at": null, "next_renewal": { "domain_id": 14, "name": "northwind-labs.com", "expires_at": "2026-01-24", "auto_renew": false } }, "needs_you": [ { "key": "expiry", "check": "expiry", "status": "error", "variant": "lapsed", "params": { "days": -6, "expires_at": "2026-01-09" }, "action": "renew", "cause": "domain:18:expiry", "rank": 390, "home": { "source": "domain_expiring", "key": "domain:18", "fingerprint": "2026-01-09" }, "snoozed": false, "domains": [ { "id": 18, "name": "nwcloud.app" } ], "attention_keys": [ "domain:18" ], "due_in_days": 0, "renewal": null, "evidence": [ { "source": "registrar", "state": "auto_renew_off", "tone": "bad" } ], "prevention": { "template": "auto_renew_expiring_domains", "active": false } }, { "key": "dnssec", "check": "dnssec", "status": "error", "variant": "notValidating", "params": { "since": "2026-01-13T12:00:00.000000Z" }, "action": null, "cause": "domain:9:dnssec", "rank": 350, "home": { "source": "dnssec_broken", "key": "dnssec_broken:9", "fingerprint": "" }, "snoozed": false, "domains": [ { "id": 9, "name": "northwind.de" } ], "attention_keys": [ "dnssec_broken:9" ], "due_in_days": 0, "renewal": null, "evidence": [], "prevention": null } ], "decided": [], "renewals": { "currency": "EUR", "priced": true, "total": 327.5, "items": 18, "unpriced": 0, "months": [ { "month": "2026-01", "cost": 44.5, "items": 2, "unpriced": 0, "decide_cost": 44.5, "decide_items": 2, "domains": [ { "id": 10, "name": "northwind.shop", "cost": 32, "decide": true }, { "id": 14, "name": "northwind-labs.com", "cost": 12.5, "decide": true } ], "more": 0 }, { "month": "2026-02", "cost": 12.5, "items": 1, "unpriced": 0, "decide_cost": 12.5, "decide_items": 1, "domains": [ { "id": 1, "name": "northwind.com", "cost": 12.5, "decide": true } ], "more": 0 } ], "savings": { "unused": [], "total": 0 } }, "protection": [ { "setting": "transfer_lock", "on": 14, "applicable": 16, "off": [ 14, 18 ], "applies": true, "here": [], "reconnect": [], "elsewhere": [ { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/", "ids": [ 14, 18 ] } ], "unknown": 0, "none": 3 }, { "setting": "auto_renew", "on": 0, "applicable": 5, "off": [ 4, 10 ], "applies": true, "here": [], "reconnect": [], "elsewhere": [ { "label": "Cloudflare", "url": "https://dash.cloudflare.com/?to=/:account/domains", "ids": [ 4 ] }, { "label": "Porkbun", "url": "https://porkbun.com/account/domainsSpeedy", "ids": [ 10 ] } ], "unknown": 14, "none": 0 } ], "stale": [], "found_elsewhere": [], "cheaper_registrar": { "groups": [], "set_aside": [] }, "setup": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/settings-plan": { "get": { "summary": "Plan a settings change across domains", "operationId": "gETdomainssettingsPlanPerDomainWhoDoesWhatBeforeABulkSettingsChange3939AReadTheChangeItselfGoesThroughEachSettingsOwnEndpointWhichAuditsItPerDomain", "description": "For each domain in `ids` (up to 500), who would carry out turning `setting` on or off (`value`, default true). Changes nothing; each setting is changed through its own endpoint.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "setting": "auto_renew", "value": true, "applies": true, "domains": [ { "id": 1, "name": "northwind.com", "state": "unknown", "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" }, "dnssec": null, "zone_id": null } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "setting": { "type": "string", "description": "", "example": "architecto" }, "value": { "type": "boolean", "description": "", "example": true }, "ids": { "type": "array", "description": "", "example": [ 16 ], "items": { "type": "integer" } } }, "required": [ "setting" ] } } } }, "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/email-protection-plan": { "get": { "summary": "Plan email protection across domains", "operationId": "gETdomainsemailProtectionPlanEmailProtectionForSeveralDomainsAtOnceFromTheOverview3946AReadLikeTheSettingsPlanEachDomainsPlanIsEmailProtectionsAndTheApplyIsTheZonesOwnEmailProtectionEndpointOncePerZoneSoEveryWriteIsPreviewedAndAuditedPerDomain", "description": "For each domain in `ids` (up to 200), the email protection plan for `mode` (`protect` or `no_mail`) and its `route`: `here`, `elsewhere` (records to copy to your DNS host), `reconnect`, `unchanged`, `refused` or `none` (no zone held). Changes nothing; apply it through each zone’s email protection endpoint.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "mode": "no_mail", "domains": [ { "id": 1, "name": "northwind.com", "zone_id": 1, "route": "refused", "plan": { "zone_id": 1, "zone": "northwind.com", "mode": "no_mail", "route": "here", "where": { "label": "Cloudflare", "url": null }, "provider": null, "providers": [], "records": [], "refusals": [ { "key": "mode", "reason": "receives_mail", "params": [] } ], "lookups": null, "dkim": null } } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "description": "", "example": "architecto" }, "ids": { "type": "array", "description": "", "example": [ 16 ], "items": { "type": "integer" } } }, "required": [ "mode" ] } } } }, "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/caa-protection-plan": { "get": { "summary": "Plan CAA protection across domains", "operationId": "gETdomainscaaProtectionPlanCAAForSeveralDomainsAtOnceFromTheOverviewsCAALine3946AReadTheApplyIsEachZonesOwnCaaProtectionEndpointSoEveryWriteIsPreviewedCheckedAgainstItsCertificatesAndAuditedPerDomainRoutesAsemailProtectionPlan", "description": "For each domain in `ids` (up to 200), the CAA plan and its `route`, as for the email protection plan. Changes nothing; apply it through each zone’s CAA protection endpoint, which checks the zone’s certificates first.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "domains": [ { "id": 1, "name": "northwind.com", "zone_id": 1, "route": "here", "plan": { "zone_id": 1, "zone": "northwind.com", "route": "here", "where": { "label": "Cloudflare", "url": null }, "records": [ { "key": "kept:7", "action": "none", "type": "CAA", "name": "@", "value": "0 issue \"letsencrypt.org\"", "current": null, "record_id": null, "reason": "caa_kept", "params": [] }, { "key": "issue:globalsign.com", "action": "create", "type": "CAA", "name": "@", "value": "0 issue \"globalsign.com\"", "current": null, "record_id": null, "reason": "caa_cert", "params": { "subject": "shop.northwind.com" } } ], "refusals": [], "certificates": [ { "id": 1, "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "ca": "letsencrypt.org", "wildcard": false, "state": "stays_renewable" }, { "id": 13, "subject": "cdn.northwind.com", "issuer": "Let's Encrypt (R3)", "ca": "letsencrypt.org", "wildcard": false, "state": "stays_renewable" } ], "fronts": [ { "label": "Cloudflare", "ids": [ "letsencrypt.org", "pki.goog" ], "publishes_own": true } ] } } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "", "example": [ 16 ], "items": { "type": "integer" } } } } } } }, "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/track": { "post": { "summary": "Track a domain by name", "operationId": "pOSTdomainstrackAddATrackedDomainByName3940ItsRegistrationFactsComeFromTheRegistryNeverFromThisRequestTheOnlyInputIsTheName", "description": "Adds a domain held at a registrar InfraNest is not connected to; its registrar, dates, status and nameservers are read from the public registry, now and daily. Only `name` is accepted; it counts toward your plan’s domain limit, and a domain already in your organization is refused with 422.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "id": 21, "organization_id": 1, "name": "northwind-studio", "tld": "com", "registrar": null, "registered_at": null, "expires_at": null, "auto_renew": true, "status": "active", "notes": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": null, "nameservers": null, "transfer_lock": null, "whois_privacy": null, "registrar_contacts": null, "dnssec_entries": null, "has_dnssec": null, "renewal_price": null, "renewal_price_currency": null, "pricing_cached_at": null, "last_details_synced_at": null, "status_message": null, "expected_issuers": null, "renewal_price_source": "api", "purchase_price": null, "purchase_price_currency": null, "registrar_price": null, "registrar_price_currency": null, "registrar_flags": null, "requested_whois_privacy": null, "requested_auto_renew": null, "archived_at": null, "requested_nameservers": null, "missing_since": null, "serves_website": null, "billing_interval": "yearly", "interval_count": 1, "dnssec_state": null, "dnssec_checked_at": null, "dnssec_broken_since": null, "requested_dns_credential_id": null, "requested_dns_template": null, "status_detail": null, "ordered_by_user_id": null, "ns_health": null, "ns_health_checked_at": null, "unused_since": null, "registry_statuses": null, "registry_checked_at": null, "registry_dnssec": null, "full_name": "northwind-studio.com", "archivable": true, "dns_host": null, "management": "tracked", "sync_halt": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 253 characters.", "example": "b" } }, "required": [ "name" ] }, "example": { "name": "northwind-studio.com" } } } }, "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains": { "get": { "summary": "List domains", "operationId": "getApiOrganizationsOrganization_idDomains", "description": "Your domains, paginated with `page` and `per_page` (up to 200), each with its tags, advisor issue count and who hosts its website and mail. Filter with `search`, `credential`, `tag`, `active`, `expiring_soon`, `autorenew_off`, `website`, `mail` or `archived` (archived domains are left out unless asked for). Registration orders that failed are not domains you hold and are left out too; pass `include_failed=1` to list them, and `meta.counts.failed` says how many there are. Sort with `sort` (`domain`, `registrar`, `expires`) and `dir`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 11, "organization_id": 1, "name": "northwind", "tld": "cloud", "registrar": "Porkbun", "registered_at": "2024-01-14T00:00:00.000000Z", "expires_at": "2026-11-12T00:00:00.000000Z", "auto_renew": true, "status": "active", "notes": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": null, "nameservers": [ "hydrogen.ns.hetzner.com", "oxygen.ns.hetzner.com" ], "transfer_lock": true, "whois_privacy": true, "registrar_contacts": null, "dnssec_entries": null, "has_dnssec": null, "renewal_price": "22.00", "renewal_price_currency": "EUR", "pricing_cached_at": null, "last_details_synced_at": null, "status_message": null, "expected_issuers": null, "renewal_price_source": "manual", "purchase_price": null, "purchase_price_currency": null, "registrar_price": null, "registrar_price_currency": null, "registrar_flags": null, "requested_whois_privacy": null, "requested_auto_renew": null, "archived_at": null, "requested_nameservers": null, "missing_since": null, "serves_website": null, "billing_interval": "yearly", "interval_count": 1, "dnssec_state": null, "dnssec_checked_at": null, "dnssec_broken_since": null, "requested_dns_credential_id": null, "requested_dns_template": null, "status_detail": null, "ordered_by_user_id": null, "ns_health": null, "ns_health_checked_at": null, "unused_since": null, "registry_statuses": null, "registry_checked_at": null, "registry_dnssec": null, "custom_fields": { "1": "Marketing" }, "advisor_issues": 0, "uses": { "website": { "kind": "server", "label": "web-01", "url": "/servers/1", "flagged": false, "since": null, "provider": "Hetzner", "note": null, "ours": false }, "site": { "key": "host:hetzner", "label": "Hetzner" }, "mail": { "key": "none", "label": null }, "no_zone": null }, "full_name": "northwind.cloud", "archivable": true, "dns_host": "hetzner", "management": "tracked", "sync_halt": null, "provider_credential": null, "tags": [ { "id": 4, "name": "Internal", "color": "#8b5cf6", "pivot": { "taggable_type": "App\\Models\\Domain", "taggable_id": 11, "tag_id": 4 } } ] }, { "id": 1, "organization_id": 1, "name": "northwind", "tld": "com", "registrar": "Namecheap", "registered_at": "2023-12-28T00:00:00.000000Z", "expires_at": "2026-02-02T00:00:00.000000Z", "auto_renew": true, "status": "active", "notes": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": null, "nameservers": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "transfer_lock": true, "whois_privacy": true, "registrar_contacts": null, "dnssec_entries": [ { "key_tag": 62949, "algorithm": 13, "digest_type": 2, "digest": "FBF66B8D019C1EEC1E1A0B5A9D3C2E7F4A8B60D5C93E71F2A6B8D04C7E19A35B" } ], "has_dnssec": true, "renewal_price": "12.50", "renewal_price_currency": "EUR", "pricing_cached_at": null, "last_details_synced_at": null, "status_message": null, "expected_issuers": null, "renewal_price_source": "manual", "purchase_price": null, "purchase_price_currency": null, "registrar_price": null, "registrar_price_currency": null, "registrar_flags": null, "requested_whois_privacy": null, "requested_auto_renew": null, "archived_at": null, "requested_nameservers": null, "missing_since": null, "serves_website": null, "billing_interval": "yearly", "interval_count": 1, "dnssec_state": "signed", "dnssec_checked_at": "2026-01-15T11:25:00.000000Z", "dnssec_broken_since": null, "requested_dns_credential_id": null, "requested_dns_template": null, "status_detail": null, "ordered_by_user_id": null, "ns_health": null, "ns_health_checked_at": null, "unused_since": null, "registry_statuses": null, "registry_checked_at": null, "registry_dnssec": null, "custom_fields": { "1": "Marketing" }, "advisor_issues": 0, "uses": { "website": { "kind": "server", "label": "web-01", "url": "/servers/1", "flagged": false, "since": null, "provider": "Hetzner", "note": { "key": "proxied", "params": { "provider": "Cloudflare" } }, "ours": false }, "site": { "key": "host:hetzner", "label": "Hetzner" }, "mail": { "key": "other", "label": "mx.northwind.com" }, "no_zone": null }, "full_name": "northwind.com", "archivable": true, "dns_host": "cloudflare", "management": "tracked", "sync_halt": null, "provider_credential": null, "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\Domain", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\Domain", "taggable_id": 1, "tag_id": 5 } } ] } ], "first_page_url": "http://localhost/api/organizations/1/domains?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/domains?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/domains?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/domains", "per_page": 25, "prev_page_url": null, "to": 20, "total": 20, "meta": { "locked_ids": [], "expiry_window_days": 60, "counts": { "total": 20, "active": 19, "expiring_soon": 3, "autorenew_off": 5, "failed": 0, "archived": 0 }, "integrations": [], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6" }, { "id": 4, "name": "Internal", "color": "#8b5cf6" } ], "uses": { "sites": [ { "key": "host:hetzner", "label": "Hetzner", "count": 12 }, { "key": "none", "label": null, "count": 1 } ], "mail": [ { "key": "other", "label": null, "count": 7 }, { "key": "none", "label": null, "count": 6 } ] }, "custom_fields": [ { "id": 1, "key": "cost_centre", "label": "Cost centre", "type": "select", "options": [ "Platform", "Marketing" ] } ] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{id}": { "get": { "summary": "Get a domain", "operationId": "getApiOrganizationsOrganization_idDomainsId", "description": "One domain with its full details. A domain over your plan’s domain limit is locked and cannot be opened; stale renewal pricing is refreshed in the background.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "northwind", "tld": "com", "registrar": "Namecheap", "registered_at": "2023-12-28T00:00:00.000000Z", "expires_at": "2026-02-02T00:00:00.000000Z", "auto_renew": true, "status": "active", "notes": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": null, "nameservers": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "transfer_lock": true, "whois_privacy": true, "registrar_contacts": null, "dnssec_entries": [ { "key_tag": 62949, "algorithm": 13, "digest_type": 2, "digest": "FBF66B8D019C1EEC1E1A0B5A9D3C2E7F4A8B60D5C93E71F2A6B8D04C7E19A35B" } ], "has_dnssec": true, "renewal_price": "12.50", "renewal_price_currency": "EUR", "pricing_cached_at": null, "last_details_synced_at": null, "status_message": null, "expected_issuers": null, "renewal_price_source": "manual", "purchase_price": null, "purchase_price_currency": null, "registrar_price": null, "registrar_price_currency": null, "registrar_flags": null, "requested_whois_privacy": null, "requested_auto_renew": null, "archived_at": null, "requested_nameservers": null, "missing_since": null, "serves_website": null, "billing_interval": "yearly", "interval_count": 1, "dnssec_state": "signed", "dnssec_checked_at": "2026-01-15T11:25:00.000000Z", "dnssec_broken_since": null, "requested_dns_credential_id": null, "requested_dns_template": null, "status_detail": null, "ordered_by_user_id": null, "ns_health": null, "ns_health_checked_at": null, "unused_since": null, "registry_statuses": null, "registry_checked_at": null, "registry_dnssec": null, "full_name": "northwind.com", "archivable": true, "dns_host": "cloudflare", "management": "tracked", "sync_halt": null, "contacts": [], "provider_credential": null, "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\Domain", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\Domain", "taggable_id": 1, "tag_id": 5 } } ], "dns_zone": { "id": 1, "name": "northwind.com", "provider": "cloudflare", "provider_label": "Cloudflare", "points_here": true, "can_sign": true }, "tracked": { "registrar": "Namecheap", "provider": { "key": "namecheap", "label": "Namecheap", "integrable": true }, "connected": true, "checked_at": null }, "capabilities": { "nameservers": false, "contacts": false, "dnssec": false, "transfer_lock": false, "whois_privacy": false, "auto_renew": false, "auto_renew_reenable": false, "complete_domain_list": false, "epp_code": false, "register": false, "transfer": false, "renew": false }, "capabilities_reason": "no_registrar_credential", "registry_withheld": [], "contact_roles": [ "registrant", "admin" ], "settings": { "transfer_lock": { "state": "on", "source": "registry", "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "auto_renew": { "state": "unknown", "source": null, "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "whois_privacy": { "state": "on", "source": "registrar", "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "dnssec": { "state": "unknown", "source": null, "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "caa": { "state": "off", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "spf": { "state": "on", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "dmarc": { "state": "on", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "email": { "state": "on", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "dkim": { "state": "off", "source": "zone", "route": "elsewhere", "where": null }, "no_mail": { "state": "none", "source": null, "route": null, "where": null } }, "advisor": { "expiry_window_days": 60, "findings": [ { "key": "expiry", "check": "expiry", "status": "info", "variant": "renewalUnknown", "params": { "days": 18, "expires_at": "2026-02-02", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "action": null, "cause": "domain:1:expiry", "rank": 222, "home": { "source": "domain_finding", "key": "domain_finding:domain:1:expiry", "fingerprint": "" }, "snoozed": false }, { "key": "auto_renew", "check": "auto_renew", "status": "info", "variant": "unknown", "params": { "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "action": null, "cause": "portfolio:auto_renew", "rank": 150, "home": { "source": "domain_finding", "key": "domain_finding:portfolio:auto_renew", "fingerprint": "" }, "snoozed": false } ] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "put": { "summary": "Update a domain", "operationId": "putApiOrganizationsOrganization_idDomainsId", "description": "Updates what InfraNest keeps for the domain: `notes`, `serves_website`, `expected_issuers`, `nameservers`, `registrar_contacts`, pricing and `tag_ids`. Registration data such as the expiry date and auto-renew is not accepted here; returns the domain’s full details.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "northwind", "tld": "com", "registrar": "Namecheap", "registered_at": "2023-12-28T00:00:00.000000Z", "expires_at": "2026-02-02T00:00:00.000000Z", "auto_renew": true, "status": "active", "notes": "Main brand domain. Renew three years ahead.", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": null, "nameservers": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "transfer_lock": true, "whois_privacy": true, "registrar_contacts": null, "dnssec_entries": [ { "key_tag": 62949, "algorithm": 13, "digest_type": 2, "digest": "FBF66B8D019C1EEC1E1A0B5A9D3C2E7F4A8B60D5C93E71F2A6B8D04C7E19A35B" } ], "has_dnssec": true, "renewal_price": "12.50", "renewal_price_currency": "EUR", "pricing_cached_at": null, "last_details_synced_at": null, "status_message": null, "expected_issuers": null, "renewal_price_source": "manual", "purchase_price": null, "purchase_price_currency": null, "registrar_price": null, "registrar_price_currency": null, "registrar_flags": null, "requested_whois_privacy": null, "requested_auto_renew": null, "archived_at": null, "requested_nameservers": null, "missing_since": null, "serves_website": null, "billing_interval": "yearly", "interval_count": 1, "dnssec_state": "signed", "dnssec_checked_at": "2026-01-15T11:25:00.000000Z", "dnssec_broken_since": null, "requested_dns_credential_id": null, "requested_dns_template": null, "status_detail": null, "ordered_by_user_id": null, "ns_health": null, "ns_health_checked_at": null, "unused_since": null, "registry_statuses": null, "registry_checked_at": null, "registry_dnssec": null, "full_name": "northwind.com", "archivable": true, "dns_host": "cloudflare", "management": "tracked", "sync_halt": null, "contacts": [ { "id": 1, "organization_id": 1, "first_name": "Alex", "last_name": "Rivera", "company": "Northwind Cloud", "email": "domains@northwind.example", "phone": "+31 20 555 0123", "address": "Keizersgracht", "city": "Amsterdam", "state": null, "zip": "1015 CJ", "country": "NL", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "house_number": "123", "vat_number": null, "company_number": null, "missing_for_registration": [], "pivot": { "domain_id": 1, "contact_id": 1, "type": "tech", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } } ], "provider_credential": null, "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\Domain", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\Domain", "taggable_id": 1, "tag_id": 5 } } ], "dns_zone": { "id": 1, "name": "northwind.com", "provider": "cloudflare", "provider_label": "Cloudflare", "points_here": true, "can_sign": true }, "tracked": { "registrar": "Namecheap", "provider": { "key": "namecheap", "label": "Namecheap", "integrable": true }, "connected": true, "checked_at": null }, "capabilities": { "nameservers": false, "contacts": false, "dnssec": false, "transfer_lock": false, "whois_privacy": false, "auto_renew": false, "auto_renew_reenable": false, "complete_domain_list": false, "epp_code": false, "register": false, "transfer": false, "renew": false }, "capabilities_reason": "no_registrar_credential", "registry_withheld": [], "contact_roles": [ "registrant", "admin" ], "settings": { "transfer_lock": { "state": "on", "source": "registry", "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "auto_renew": { "state": "unknown", "source": null, "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "whois_privacy": { "state": "on", "source": "registrar", "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "dnssec": { "state": "unknown", "source": null, "route": "elsewhere", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "caa": { "state": "off", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "spf": { "state": "on", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "dmarc": { "state": "on", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "email": { "state": "on", "source": "zone", "route": "here", "where": { "label": "Cloudflare", "url": null } }, "dkim": { "state": "off", "source": "zone", "route": "elsewhere", "where": null }, "no_mail": { "state": "none", "source": null, "route": null, "where": null } }, "advisor": { "expiry_window_days": 60, "findings": [ { "key": "expiry", "check": "expiry", "status": "info", "variant": "renewalUnknown", "params": { "days": 18, "expires_at": "2026-02-02", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "action": null, "cause": "domain:1:expiry", "rank": 222, "home": { "source": "domain_finding", "key": "domain_finding:domain:1:expiry", "fingerprint": "" }, "snoozed": false }, { "key": "auto_renew", "check": "auto_renew", "status": "info", "variant": "unknown", "params": { "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "action": null, "cause": "portfolio:auto_renew", "rank": 150, "home": { "source": "domain_finding", "key": "domain_finding:portfolio:auto_renew", "fingerprint": "" }, "snoozed": false } ] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string", "description": "Must not be greater than 10000 characters.", "example": "b", "nullable": true }, "tag_ids": { "type": "array", "description": "", "example": [ 16 ], "items": { "type": "integer" } }, "serves_website": { "type": "boolean", "description": "", "example": true, "nullable": true }, "expected_issuers": { "type": "array", "description": "Must not be greater than 100 characters.", "example": [ "n" ], "items": { "type": "string" } }, "nameservers": { "type": "array", "description": "Must not be greater than 253 characters.", "example": [ "g" ], "items": { "type": "string" } }, "registrar_contacts": { "type": "object", "description": "", "example": null, "properties": {}, "nullable": true }, "renewal_price": { "type": "number", "description": "Must be at least 0. Must not be greater than 9999999.99.", "example": 16, "nullable": true }, "renewal_price_currency": { "type": "string", "description": "Must be 3 characters.", "example": "miy", "nullable": true }, "billing_interval": { "type": "string", "description": "", "example": "hourly", "enum": [ "hourly", "daily", "weekly", "monthly", "quarterly", "yearly" ] }, "interval_count": { "type": "integer", "description": "Must be at least 1. Must not be greater than 120.", "example": 1 }, "purchase_price": { "type": "number", "description": "Must be at least 0. Must not be greater than 9999999.99.", "example": 1, "nullable": true }, "purchase_price_currency": { "type": "string", "description": "Must be 3 characters.", "example": "ljn", "nullable": true } } }, "example": { "notes": "Main brand domain. Renew three years ahead." } } } }, "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/archive": { "post": { "summary": "Archive a domain", "operationId": "archiveADomainKeepTheRowStopShowingItInTheList588", "description": "Takes the domain out of your working list while keeping it, its costs and its links; it keeps syncing and stops counting toward your plan’s domain limit. Refused with 422 while the domain is still active at a connected registrar.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "northwind", "tld": "com", "registrar": "Namecheap", "registered_at": "2023-12-28T00:00:00.000000Z", "expires_at": "2026-02-02T00:00:00.000000Z", "auto_renew": true, "status": "active", "notes": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": null, "nameservers": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "transfer_lock": true, "whois_privacy": true, "registrar_contacts": null, "dnssec_entries": [ { "key_tag": 62949, "algorithm": 13, "digest_type": 2, "digest": "FBF66B8D019C1EEC1E1A0B5A9D3C2E7F4A8B60D5C93E71F2A6B8D04C7E19A35B" } ], "has_dnssec": true, "renewal_price": "12.50", "renewal_price_currency": "EUR", "pricing_cached_at": null, "last_details_synced_at": null, "status_message": null, "expected_issuers": null, "renewal_price_source": "manual", "purchase_price": null, "purchase_price_currency": null, "registrar_price": null, "registrar_price_currency": null, "registrar_flags": null, "requested_whois_privacy": null, "requested_auto_renew": null, "archived_at": "2026-01-15T12:00:00.000000Z", "requested_nameservers": null, "missing_since": null, "serves_website": null, "billing_interval": "yearly", "interval_count": 1, "dnssec_state": "signed", "dnssec_checked_at": "2026-01-15T11:25:00.000000Z", "dnssec_broken_since": null, "requested_dns_credential_id": null, "requested_dns_template": null, "status_detail": null, "ordered_by_user_id": null, "ns_health": null, "ns_health_checked_at": null, "unused_since": null, "registry_statuses": null, "registry_checked_at": null, "registry_dnssec": null, "full_name": "northwind.com", "archivable": true, "dns_host": "cloudflare", "management": "tracked", "sync_halt": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/unarchive": { "post": { "summary": "Unarchive a domain", "operationId": "bringAnArchivedDomainBackIntoTheWorkingList", "description": "Brings an archived domain back into your working list, where it counts toward your plan’s domain limit again. A domain that is not archived is returned unchanged.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "northwind", "tld": "com", "registrar": "Namecheap", "registered_at": "2023-12-28T00:00:00.000000Z", "expires_at": "2026-02-02T00:00:00.000000Z", "auto_renew": true, "status": "active", "notes": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": null, "nameservers": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "transfer_lock": true, "whois_privacy": true, "registrar_contacts": null, "dnssec_entries": [ { "key_tag": 62949, "algorithm": 13, "digest_type": 2, "digest": "FBF66B8D019C1EEC1E1A0B5A9D3C2E7F4A8B60D5C93E71F2A6B8D04C7E19A35B" } ], "has_dnssec": true, "renewal_price": "12.50", "renewal_price_currency": "EUR", "pricing_cached_at": null, "last_details_synced_at": null, "status_message": null, "expected_issuers": null, "renewal_price_source": "manual", "purchase_price": null, "purchase_price_currency": null, "registrar_price": null, "registrar_price_currency": null, "registrar_flags": null, "requested_whois_privacy": null, "requested_auto_renew": null, "archived_at": null, "requested_nameservers": null, "missing_since": null, "serves_website": null, "billing_interval": "yearly", "interval_count": 1, "dnssec_state": "signed", "dnssec_checked_at": "2026-01-15T11:25:00.000000Z", "dnssec_broken_since": null, "requested_dns_credential_id": null, "requested_dns_template": null, "status_detail": null, "ordered_by_user_id": null, "ns_health": null, "ns_health_checked_at": null, "unused_since": null, "registry_statuses": null, "registry_checked_at": null, "registry_dnssec": null, "full_name": "northwind.com", "archivable": true, "dns_host": "cloudflare", "management": "tracked", "sync_halt": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/contacts": { "get": { "summary": "List a domain’s contacts", "operationId": "getApiOrganizationsOrganization_idDomainsDomain_idContacts", "description": "The contacts assigned to the domain, each with its role in `pivot.type`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Assign a contact to a domain", "operationId": "postApiOrganizationsOrganization_idDomainsDomain_idContacts", "description": "Assigns one of your contacts (`contact_id`) to the domain as `registrant`, `admin`, `tech` or `billing`, replacing whoever held that role. Recorded in InfraNest only; nothing is sent to the registrar.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "first_name": "Alex", "last_name": "Rivera", "company": "Northwind Cloud", "email": "domains@northwind.example", "phone": "+31 20 555 0123", "address": "Keizersgracht", "city": "Amsterdam", "state": null, "zip": "1015 CJ", "country": "NL", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "house_number": "123", "vat_number": null, "company_number": null, "missing_for_registration": [], "pivot": { "type": "admin" } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contact_id": { "type": "integer", "description": "", "example": 16 }, "type": { "type": "string", "description": "", "example": "registrant", "enum": [ "registrant", "admin", "tech", "billing" ] } }, "required": [ "contact_id", "type" ] }, "example": { "contact_id": 1, "type": "admin" } } } }, "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/contacts/{contact_id}": { "delete": { "summary": "Remove a contact from a domain", "operationId": "deleteApiOrganizationsOrganization_idDomainsDomain_idContactsContact_id", "description": "Unassigns the contact from the domain in every role it held. The contact itself is kept.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "contact_id", "required": true, "description": "The contact's ID.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/pricing": { "get": { "summary": "Get a domain’s registrar pricing", "operationId": "gETorganizationsorgdomainsdomainpricing", "description": "The registrar’s current prices for the domain’s extension, asked live. Answers 404 when no registrar connection is linked; `pricing` is null when the registrar does not allow price lookups with your key.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/actions": { "get": { "summary": "List a domain’s running registrar actions", "operationId": "gETorganizationsorgdomainsdomainactionsFetchCurrentDomainActionFromTheProviderproviderSpecificEgTransIP", "description": "The action currently running at the registrar for this domain, where the registrar reports one; `can_retry` says whether it can be retried. An empty list when no registrar is linked or the registrar does not offer this.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "actions": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/ns-health": { "get": { "summary": "Check a domain’s nameservers", "operationId": "gETorganizationsorgdomainsdomainnsHealthChecksEachNameserverTCPPort53Reachability+AuthoritativeDelegation", "description": "Checks each of the domain’s nameservers now: whether it answers on port 53 and is authoritative, whether the nameservers agree with each other, and whether DNSSEC validates. Empty when the domain has no nameservers; the result is kept for the advisor.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "checks": [ { "ns": "nina.ns.cloudflare.com", "authoritative": true, "reachable": true }, { "ns": "rick.ns.cloudflare.com", "authoritative": true, "reachable": true } ], "ns_consistency": { "consistent": true, "resolvers": { "cloudflare": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "google": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "dnssb": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "adguard": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "nextdns": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ] } }, "dnssec_validates": true, "zone_delegation": { "zone_id": 1, "zone_name": "northwind.com", "provider": "cloudflare", "delegated": true, "delegated_to": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/setup": { "get": { "summary": "Get how a domain is set up", "operationId": "gETdomainsdomainsetupHowTheDomainIsSetUpAndWhatRunsOnIt3937SeeDomainSetup", "description": "Who hosts the domain’s DNS and whether its nameservers answer, its mail provider, and the servers, certificates, monitors and status pages behind its addresses. Based on the DNS zone InfraNest holds; a domain whose DNS is hosted elsewhere gets no website or email details.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "zone": { "id": 1, "name": "northwind.com" }, "registrar": { "label": "Namecheap", "managed": false, "credential_id": null, "provider": null }, "dns": { "provider": "cloudflare", "provider_label": "Cloudflare", "connected": true, "zone_here": true, "nameservers": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "answering": null, "checked_at": null }, "email": { "provider": null, "hosts": [ "mx.northwind.com" ] }, "website": { "records": [ { "type": "A", "value": "198.51.100.10", "url": "/dns/1?record=1" } ], "server": { "type": "server", "id": 1, "label": "web-01", "sublabel": "198.51.100.10", "url": "/servers/1", "meta": [] } }, "runs_on": [ { "record_id": 1, "zone_id": 1, "host": "northwind.com", "type": "A", "value": "198.51.100.10", "url": "/dns/1?record=1", "server": { "type": "server", "id": 1, "label": "web-01", "sublabel": "198.51.100.10", "url": "/servers/1", "meta": [] }, "certificate": { "type": "certificate", "id": 1, "label": "northwind.com", "sublabel": "2026-03-30", "url": "/certificates/1", "meta": [] }, "monitors": [ { "type": "monitor", "id": 1, "label": "Marketing site", "sublabel": "https://northwind.com", "url": "/monitoring/1", "meta": { "type": "http", "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z" } }, { "type": "monitor", "id": 4, "label": "Checkout flow", "sublabel": "https://northwind.com/checkout", "url": "/monitoring/4", "meta": { "type": "http", "last_status": "down", "last_checked_at": "2026-01-15T11:58:00.000000Z" } } ], "status_pages": [] }, { "record_id": 3, "zone_id": 1, "host": "api.northwind.com", "type": "CNAME", "value": "northwind.com", "url": "/dns/1?record=3", "server": null, "certificate": { "type": "certificate", "id": 3, "label": "api.northwind.com", "sublabel": "2026-04-13", "url": "/certificates/3", "meta": [] }, "monitors": [ { "type": "monitor", "id": 3, "label": "API health", "sublabel": "https://api.northwind.com/health", "url": "/monitoring/3", "meta": { "type": "http", "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z" } }, { "type": "monitor", "id": 6, "label": "Search API", "sublabel": "https://api.northwind.com/v1/search", "url": "/monitoring/6", "meta": { "type": "api", "last_status": "degraded", "last_checked_at": "2026-01-15T11:58:00.000000Z" } } ], "status_pages": [] } ], "mail": [ { "record_id": 4, "value": "mx.northwind.com", "url": "/dns/1?record=4" } ], "unmonitored": [ "archive.northwind.com", "cdn.northwind.com" ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/registry-record": { "get": { "summary": "Get a domain’s registry record", "operationId": "gETdomainsdomainregistryRecordWhatTheRegistryItselfSays3937EPPStatusCodesCreatedAndUpdatedDatesAndTheRawRDAPOrWHOISAnswerAskedOnlyWhenSomeoneOpensTheDisclosureThroughThePlatformWideDeduplicatedLookupTheDropCatchChecksUseAndNeverForAnOrganisationWeMayNotReachOutFor1599ADemoFixturesNamesAreInvented", "description": "What the registry itself says about the domain: its status codes, created and updated dates, the source (RDAP or WHOIS) and an excerpt of the raw answer.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "statuses": [], "created_at": null, "updated_at": null, "source": null, "raw": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/advisor": { "get": { "summary": "Get a domain’s advisor findings", "operationId": "gETdomainsdomainadvisorTheAdvisorAlone3935ForThePageToReReadAfterAChangeATogglesResponseCarriesTheDomainNotItsFindingsAndANameserverCheckStoresAResultThePageLoadedBefore", "description": "The current advisor findings for one domain, taking into account what its registrar supports.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "expiry_window_days": 60, "findings": [ { "key": "expiry", "check": "expiry", "status": "info", "variant": "renewalUnknown", "params": { "days": 18, "expires_at": "2026-02-02", "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "action": null, "cause": "domain:1:expiry", "rank": 222, "home": { "source": "domain_finding", "key": "domain_finding:domain:1:expiry", "fingerprint": "" }, "snoozed": false }, { "key": "auto_renew", "check": "auto_renew", "status": "info", "variant": "unknown", "params": { "where": { "label": "Namecheap", "url": "https://ap.www.namecheap.com/domains/list/" } }, "action": null, "cause": "portfolio:auto_renew", "rank": 150, "home": { "source": "domain_finding", "key": "domain_finding:portfolio:auto_renew", "fingerprint": "" }, "snoozed": false } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/capabilities": { "get": { "summary": "Get a domain’s registrar capabilities", "operationId": "gETorganizationsorgdomainsdomaincapabilitiesWhichRegistrarActionsAreAvailableForThisDomainTheRegistrarImplementsTheMethodANDwhereTheProviderExposesPerTLDInfoEgTransIPTheTLDSupportsItDrivesTheUIGreyOutSoWeNeverShowAToggleThatWouldJust422", "description": "Which registrar operations are available for this domain, given what its registrar and extension support, with a `reason` when something is unavailable.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "capabilities": { "nameservers": false, "contacts": false, "dnssec": false, "transfer_lock": false, "whois_privacy": false, "auto_renew": false, "auto_renew_reenable": false, "complete_domain_list": false, "epp_code": false, "register": false, "transfer": false, "renew": false }, "reason": "no_registrar_credential", "registry_withheld": [], "contact_roles": [ "registrant", "admin" ], "dnssec_fields": [ "key_tag", "flags" ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/whois": { "get": { "summary": "Look up a domain’s WHOIS", "operationId": "getApiOrganizationsOrganization_idDomainsDomain_idWhois", "description": "A live WHOIS lookup for the domain. Answers 422 with a message when the lookup fails.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "server": "whois.verisign-grs.com", "output": " Domain Name: NORTHWIND.COM\r\n Registry Domain ID: 4516866_DOMAIN_COM-VRSN\r\n Registrar WHOIS Server: whois.godaddy.…" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/history": { "get": { "summary": "Get a domain’s audit history", "operationId": "getApiOrganizationsOrganization_idDomainsDomain_idHistory", "description": "The 50 most recent audit-log entries for the domain and its manual cost items, newest first.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/{domain_id}/epp-code": { "get": { "summary": "Get a domain’s transfer code", "operationId": "gETorganizationsorgdomainsdomaineppCodeFetchesTheEPPauthCodeLiveFromTheProviderneverStored", "description": "Fetches the domain’s EPP (auth) code live from its registrar; InfraNest never stores it. Needs write access; answers 404 when no registrar is linked or the registrar cannot provide the code.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "domain_id", "required": true, "description": "The domain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/contacts": { "get": { "summary": "List contacts", "operationId": "getApiOrganizationsOrganization_idContacts", "description": "Your organization’s contacts, paginated with `page` and `per_page` (up to 200), with their tags. Filter with `search` or `tag`, and sort with `sort` (`name`, `company`, `email`, `city`, `country`) and `dir`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 1, "organization_id": 1, "first_name": "Alex", "last_name": "Rivera", "company": "Northwind Cloud", "email": "domains@northwind.example", "phone": "+31 20 555 0123", "address": "Keizersgracht", "city": "Amsterdam", "state": null, "zip": "1015 CJ", "country": "NL", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "house_number": "123", "vat_number": null, "company_number": null, "missing_for_registration": [], "tags": [] }, { "id": 3, "organization_id": 1, "first_name": "Priya", "last_name": "Nair", "company": "Northwind Cloud", "email": "legal@northwind.example", "phone": "+44 20 7946 0321", "address": "Shoreditch High Street", "city": "London", "state": "Greater London", "zip": "E1 6JJ", "country": "GB", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "house_number": "42", "vat_number": null, "company_number": null, "missing_for_registration": [], "tags": [] } ], "first_page_url": "http://localhost/api/organizations/1/contacts?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/contacts?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/contacts?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/contacts", "per_page": 25, "prev_page_url": null, "to": 4, "total": 4, "meta": { "tags": [] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a contact", "operationId": "postApiOrganizationsOrganization_idContacts", "description": "Creates a contact you can assign to domains as registrant, admin, tech or billing contact, optionally tagged with `tag_ids`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "first_name": "Ada", "last_name": "Brandt", "email": "ada@northwind.example", "country": "DE", "organization_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 5, "missing_for_registration": [ "address", "city" ], "tags": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "b" }, "last_name": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "n" }, "company": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "g", "nullable": true }, "vat_number": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "z", "nullable": true }, "company_number": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "m", "nullable": true }, "email": { "type": "string", "description": "Must be a valid email address. Must not be greater than 255 characters.", "example": "gulgowski.asia@example.com" }, "phone": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "j", "nullable": true }, "address": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "n", "nullable": true }, "house_number": { "type": "string", "description": "Must not be greater than 20 characters.", "example": "ikhwaykcmyuwpwlv", "nullable": true }, "city": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "q", "nullable": true }, "state": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "w", "nullable": true }, "zip": { "type": "string", "description": "Must not be greater than 20 characters.", "example": "rsitcpscqldzsnrw", "nullable": true }, "country": { "type": "string", "description": "Must be 2 characters.", "example": "tu" } }, "required": [ "first_name", "last_name", "email", "country" ] }, "example": { "first_name": "Ada", "last_name": "Brandt", "email": "ada@northwind.example", "country": "DE" } } } }, "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/contacts/{id}": { "get": { "summary": "Get a contact", "operationId": "getApiOrganizationsOrganization_idContactsId", "description": "One contact with the domains it is assigned to.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "first_name": "Alex", "last_name": "Rivera", "company": "Northwind Cloud", "email": "domains@northwind.example", "phone": "+31 20 555 0123", "address": "Keizersgracht", "city": "Amsterdam", "state": null, "zip": "1015 CJ", "country": "NL", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "house_number": "123", "vat_number": null, "company_number": null, "missing_for_registration": [], "domains": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "put": { "summary": "Update a contact", "operationId": "putApiOrganizationsOrganization_idContactsId", "description": "Updates the contact and, when `tag_ids` is sent, its tags. Recorded in InfraNest only; nothing is sent to a registrar.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "first_name": "Alex", "last_name": "Rivera", "company": "Northwind Cloud GmbH", "email": "domains@northwind.example", "phone": "+31 20 555 0123", "address": "Keizersgracht", "city": "Köln", "state": null, "zip": "1015 CJ", "country": "NL", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "house_number": "123", "vat_number": null, "company_number": null, "missing_for_registration": [], "tags": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "b" }, "last_name": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "n" }, "company": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "g", "nullable": true }, "vat_number": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "z", "nullable": true }, "company_number": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "m", "nullable": true }, "email": { "type": "string", "description": "Must be a valid email address. Must not be greater than 255 characters.", "example": "gulgowski.asia@example.com" }, "phone": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "j", "nullable": true }, "address": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "n", "nullable": true }, "house_number": { "type": "string", "description": "Must not be greater than 20 characters.", "example": "ikhwaykcmyuwpwlv", "nullable": true }, "city": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "q", "nullable": true }, "state": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "w", "nullable": true }, "zip": { "type": "string", "description": "Must not be greater than 20 characters.", "example": "rsitcpscqldzsnrw", "nullable": true }, "country": { "type": "string", "description": "Must be 2 characters.", "example": "tu" } } }, "example": { "company": "Northwind Cloud GmbH", "city": "Köln" } } } }, "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a contact", "operationId": "deleteApiOrganizationsOrganization_idContactsId", "description": "Deletes the contact from your organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Domains" ], "x-infranest-scope": "domains.write", "x-infranest-token-writable": true, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns/address-move": { "get": { "summary": "Plan moving records to another server", "operationId": "whatMovingWouldChangeTheRecordsOnTheServerorTheGivenOnesWithWhatEachBecomesTheOnesLeftOutAndWhyTheMonitorsThatFollowAndTheServersToChooseFromChangesNothing", "description": "Shows what moving A/AAAA records from one server to another would change: each record with its new value, the records left out and why, and the monitors that would follow. Send `from_server_id` or `record_ids`, and optionally `to_server_id`; changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "from_server_id", "description": "The server being left. Send this or `record_ids`.", "example": 12, "required": false, "schema": { "type": "integer", "description": "The server being left. Send this or `record_ids`.", "example": 12 } }, { "in": "query", "name": "record_ids", "description": "Comma-separated A/AAAA record ids, as the cross-zone search returns them.", "example": "41,42", "required": false, "schema": { "type": "string", "description": "Comma-separated A/AAAA record ids, as the cross-zone search returns them.", "example": "41,42" } }, { "in": "query", "name": "to_server_id", "description": "The server to move to; without it the records are listed with no new values.", "example": 14, "required": false, "schema": { "type": "integer", "description": "The server to move to; without it the records are listed with no new values.", "example": 14 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "from": { "server": { "id": 1, "name": "web-01" }, "addresses": [ "198.51.100.10", "2001:db8:1c1e:5a10::/64" ] }, "to": null, "targets": [ { "id": 13, "name": "analytics-01", "ipv4": "192.0.2.80", "ipv6": null, "ipv6_basis": null }, { "id": 3, "name": "api-01", "ipv4": "198.51.100.20", "ipv6": "2001:db8:1c1e:5a20::1", "ipv6_basis": "default" } ], "records": [ { "record_id": 26, "zone_id": 5, "zone_name": "northwind-docs.com", "zone_provider": "cloudflare", "name": "@", "fqdn": "northwind-docs.com", "type": "A", "value": "198.51.100.10", "ttl": 300, "proxied": true, "family": 4, "new_value": null, "excluded": "read_only", "aliases": [ { "zone_id": 5, "record_id": 28, "fqdn": "api.northwind-docs.com" } ] }, { "record_id": 27, "zone_id": 5, "zone_name": "northwind-docs.com", "zone_provider": "cloudflare", "name": "www", "fqdn": "www.northwind-docs.com", "type": "A", "value": "198.51.100.10", "ttl": 300, "proxied": true, "family": 4, "new_value": null, "excluded": "read_only", "aliases": [] } ], "monitors": { "follow": [], "by_name": [] }, "ttl": { "long": 0, "longest": null, "threshold": 3600, "lowered": 300 } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "from_server_id": { "type": "integer", "description": "This field is required when record_ids is not present.", "example": 16, "nullable": true }, "record_ids": { "type": "string", "description": "This field is required when from_server_id is not present. Must match the regex /^\\d+(,\\d+)*$/. Must not be greater than 5000 characters.", "example": "n", "nullable": true }, "to_server_id": { "type": "integer", "description": "", "example": 16, "nullable": true } } } } } }, "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/sync": { "post": { "summary": "Sync a zone from its provider", "operationId": "postApiOrganizationsOrganization_idDnsZonesDnsZone_idSync", "description": "Queues a fresh import of the zone’s records from its DNS provider and answers with `queued: true`. Refused with 422 for a zone with no linked provider connection; manual syncs are limited per hour by your plan.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.write", "x-infranest-token-writable": true, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/zone-file": { "get": { "summary": "Download a zone as a BIND file", "operationId": "downloadTheZoneAsABINDMasterFile638", "description": "Returns the zone’s records as a BIND master file, in plain text, as an attachment named after the zone. The export is recorded in your audit log.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The zone in BIND format.", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/history": { "get": { "summary": "Get a zone’s audit history", "operationId": "gETorganizationsorgdnsZoneszonehistoryWhatHappenedToThisZone708Phase7", "description": "The 50 most recent audit-log entries for the zone and its records, deleted records included, newest first.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 21, "action": "dns_zone.exported", "meta": { "zone": "northwind.com", "format": "bind", "records": 10 }, "user_id": 1, "created_at": "2026-01-15T12:00:00.000000Z" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/changes": { "get": { "summary": "List a zone’s recorded changes", "operationId": "theZonesRecordedChangesNewestFirstGroupedByTheOperationThatMadeThem", "description": "The zone’s record changes from its last 50 operations, newest first, grouped by the operation that made each batch, each with whether it can still be undone or restored to. Also returns a merged timeline and how many days of changes your plan keeps.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "batches": [], "timeline": [ { "kind": "audit", "entry": { "id": 21, "action": "dns_zone.exported", "meta": { "zone": "northwind.com", "format": "bind", "records": 10 }, "user_id": 1, "created_at": "2026-01-15T12:00:00.000000Z" } } ], "tracked_since": null, "writable": false, "retention_days": 90, "dynamic_ip_retention_days": 7 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/restore-preview": { "get": { "summary": "Preview restoring a zone to an earlier point", "operationId": "whatRestoringTheZoneToJustAfterABatchWouldChangeChangesNothing", "description": "Shows what putting every record back the way it was just after the batch `batch_id` (required) would change. Changes nothing; answers 404 when that batch is not in the zone’s history.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "batch_id", "description": "The batch to restore to.", "example": "9b2c6a1e-3f7d-4a8e-9c1b-2d3e4f5a6b7c", "required": true, "schema": { "type": "string", "description": "The batch to restore to.", "example": "9b2c6a1e-3f7d-4a8e-9c1b-2d3e4f5a6b7c" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "batch_id": { "type": "string", "description": "Must be a valid UUID.", "example": "6ff8f7f6-1eb3-3525-be4a-3932c805afed" } }, "required": [ "batch_id" ] } } } }, "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-changes/undo": { "post": { "summary": "Undo a DNS change", "operationId": "undoOneChangeOrAWholeBatchOfThem", "description": "Undoes one recorded change (`change_id`) or every change in a batch (`batch_id`), even across zones, pushing each one to the DNS provider. A change whose record has changed since, or that a dynamic IP keeps up to date, is skipped with its reason; answers 404 when nothing matches.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "change_id": { "type": "integer", "description": "The change to undo. Send this or `batch_id`.", "example": 42 }, "batch_id": { "type": "string", "description": "Every change in this batch, undone as one.", "example": "9b2c6a1e-3f7d-4a8e-9c1b-2d3e4f5a6b7c" } } } } } }, "x-infranest-scope": "dns.write", "x-infranest-token-writable": true, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/outside-changes": { "get": { "summary": "List outside changes to a zone", "operationId": "theZonesOutsideChangesNobodyHasDecidedOnNewestFirstEachWithWhatTheRecordWasAndIs", "description": "Records changed at the DNS provider outside InfraNest that nobody has decided on yet, newest first, each with what the record was and is now. `writable` says whether your earlier value can be put back for this zone.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "changes": [], "writable": false } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/leftovers": { "get": { "summary": "List leftover records in a zone", "operationId": "theRecordsProposedForRemovalEachWithItsReasonAndTheEvidenceBehindIt", "description": "Records the zone appears to have outgrown, such as old verification codes, addresses that stopped answering and duplicates, each with its reason and evidence. `writable` is false when InfraNest cannot change records in this zone.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "items": [], "writable": false, "unanswered_days": 90 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/live-mismatch": { "get": { "summary": "Compare stored records with live DNS", "operationId": "gETStoredBesideLivePerRecordWithTheCause", "description": "Records whose stored value differs from what public resolvers last answered, each with both values, the likely cause and whether taking the live value is offered. Also returns the zone’s delegation state; changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "zone": "northwind.com", "checked_at": "2026-01-15T11:53:00.000000Z", "delegation": { "state": "matches", "reason": null, "live": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "dnssec": null, "belongs_to": "cloudflare", "checked_at": "2026-01-15T11:53:00.000000Z" }, "can_push": false, "records": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/released-address": { "get": { "summary": "Check whether an address left your fleet", "operationId": "checkOneAddressAgainstTheOrganizationsReleasedAddresses", "description": "Says whether the `address` query parameter (required) belongs to one of your servers, or is an address one of your servers held and released. A record cannot be pointed at a released address.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "address", "description": "The A/AAAA value being typed.", "example": "203.0.113.7", "required": true, "schema": { "type": "string", "description": "The A/AAAA value being typed.", "example": "203.0.113.7" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "description": "Released", "type": "object", "example": { "released": { "released_at": "2026-09-02T10:00:00.000000Z", "subject_name": "web-01", "evidence": "deleted" }, "server": null }, "properties": { "released": { "type": "object", "properties": { "released_at": { "type": "string", "example": "2026-01-15T09:30:00" }, "subject_name": { "type": "string", "example": "web-01" }, "evidence": { "type": "string", "example": "deleted" } } }, "server": { "type": "string", "example": null, "nullable": true } } }, { "description": "One of your servers", "type": "object", "example": { "released": null, "server": { "id": 12, "name": "web-02" } }, "properties": { "released": { "type": "string", "example": null, "nullable": true }, "server": { "type": "object", "properties": { "id": { "type": "integer", "example": 12 }, "name": { "type": "string", "example": "web-02" } } } } }, { "description": "Neither", "type": "object", "example": { "released": null, "server": null }, "properties": { "released": { "type": "string", "example": null, "nullable": true }, "server": { "type": "string", "example": null, "nullable": true } } } ] }, "example": { "server": { "id": 1, "name": "web-01" }, "released": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Must not be greater than 64 characters.", "example": "b" } }, "required": [ "address" ] } } } }, "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/record-context": { "get": { "summary": "Get what a zone’s records point at", "operationId": "whatEveryRecordInTheZonePointsAtAndWhatUsesItKeyedByRecordId", "description": "For each record in the zone, keyed by record id: what it points at (one of your servers, a recognised service, a connection or a released address) and what uses it, such as monitors, certificates and status pages. Records with neither are left out; `long_ttl` is the TTL above which InfraNest calls a TTL long.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "object", "properties": { "41": { "type": "object", "properties": { "points_at": { "type": "object", "properties": { "kind": { "type": "string", "example": "server" }, "label": { "type": "string", "example": "web-01" }, "url": { "type": "string", "example": "/servers/12" }, "flagged": { "type": "boolean", "example": true }, "since": { "type": "string", "nullable": true, "example": null } } }, "used_by": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "monitor" }, "id": { "type": "integer", "example": 7 }, "label": { "type": "string", "example": "Website" }, "sublabel": { "type": "string", "example": "https://www.example.com" }, "url": { "type": "string", "example": "/monitoring/7" }, "meta": { "description": "Any JSON value." } } }, "example": [ { "type": "monitor", "id": 7, "label": "Website", "sublabel": "https://www.example.com", "url": "/monitoring/7", "meta": [] } ] } } } } }, "long_ttl": { "type": "integer", "example": 3600 } } }, "example": { "records": { "1": { "points_at": { "kind": "server", "label": "web-01", "url": "/servers/1", "flagged": false, "since": null, "provider": "Hetzner", "note": { "key": "proxied", "params": { "provider": "Cloudflare" } }, "ours": false }, "used_by": [ { "type": "monitor", "id": 1, "label": "Marketing site", "sublabel": "https://northwind.com", "url": "/monitoring/1", "meta": { "type": "http", "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z" } }, { "type": "monitor", "id": 4, "label": "Checkout flow", "sublabel": "https://northwind.com/checkout", "url": "/monitoring/4", "meta": { "type": "http", "last_status": "down", "last_checked_at": "2026-01-15T11:58:00.000000Z" } } ] }, "2": { "points_at": { "kind": "server", "label": "web-01", "url": "/servers/1", "flagged": false, "since": null, "provider": "Hetzner", "note": { "key": "proxied", "params": { "provider": "Cloudflare" } }, "ours": false }, "used_by": [ { "type": "monitor", "id": 8, "label": "www → apex redirect", "sublabel": "https://www.northwind.com", "url": "/monitoring/8", "meta": { "type": "redirect", "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z" } }, { "type": "certificate", "id": 1, "label": "northwind.com", "sublabel": "2026-03-30", "url": "/certificates/1", "meta": [] } ] } }, "long_ttl": 3600 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/points-at": { "get": { "summary": "Preview what a record value would point at", "operationId": "whatAValueWouldPointAtBeforeItIsSavedTheRecordDialogstheNewValueIs3958", "description": "Says what a record of the given `type` with the given `value` (both required) would point at, before you save it. `points_at` is null when nothing is recognised.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "type", "description": "The record type.", "example": "A", "required": true, "schema": { "type": "string", "description": "The record type.", "example": "A" } }, { "in": "query", "name": "value", "description": "The value being typed.", "example": "203.0.113.7", "required": true, "schema": { "type": "string", "description": "The value being typed.", "example": "203.0.113.7" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "description": "One of your servers", "type": "object", "example": { "points_at": { "kind": "server", "label": "web-02", "url": "/servers/14", "flagged": false, "since": null } }, "properties": { "points_at": { "type": "object", "properties": { "kind": { "type": "string", "example": "server" }, "label": { "type": "string", "example": "web-02" }, "url": { "type": "string", "example": "/servers/14" }, "flagged": { "type": "boolean", "example": true }, "since": { "type": "string", "example": null, "nullable": true } } } } }, { "description": "Not recognised", "type": "object", "example": { "points_at": null }, "properties": { "points_at": { "type": "string", "example": null, "nullable": true } } } ] }, "example": { "points_at": { "kind": "server", "label": "web-01", "url": "/servers/1", "flagged": false, "since": null, "provider": "Hetzner", "note": null, "ours": false } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "", "example": "A", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "NS", "SOA", "SRV", "CAA", "PTR", "ALIAS", "CERT", "DNSKEY", "DS", "HTTPS", "LOC", "NAPTR", "OPENPGPKEY", "SMIMEA", "SSHFP", "SVCB", "TLSA", "URI", "DNAME", "RP", "URL", "URL301", "FRAME" ] }, "value": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" } }, "required": [ "type", "value" ] } } } }, "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/dns-records/{record_id}/label": { "put": { "summary": "Set a record’s label", "operationId": "setOrClearWhatARecordIsFor", "description": "Sets or clears a note on what the record is for (`label`, up to 120 characters; empty or null clears it). Kept in InfraNest only and never written to the DNS provider; a labelled record is never proposed as a leftover.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "record_id", "required": true, "description": "The record's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "example": "Verification for our CRM" }, "points_at": { "type": "object", "properties": { "kind": { "type": "string", "example": "custom" }, "label": { "type": "string", "example": "Verification for our CRM" }, "url": { "type": "string", "nullable": true, "example": null }, "flagged": { "type": "boolean", "example": true }, "since": { "type": "string", "nullable": true, "example": null }, "provider": { "type": "string", "nullable": true, "example": null }, "note": { "type": "string", "nullable": true, "example": null }, "ours": { "type": "boolean", "example": true } } } } }, "example": { "label": "Main website", "points_at": { "kind": "custom", "label": "Main website", "url": null, "flagged": false, "since": null, "provider": null, "note": null, "ours": false } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "description": "What the record is for, up to 120 characters. Empty or null clears it.", "example": "Verification for our CRM", "nullable": true } } }, "example": { "label": "Main website" } } } }, "x-infranest-scope": "dns.write", "x-infranest-token-writable": true, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/server-addresses": { "get": { "summary": "List server addresses for records", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_idServerAddresses", "description": "Your servers that have an address, each with the IPv4 and IPv6 address an A or AAAA record should hold to reach it. Where a server holds a whole IPv6 block, `basis` says how the address was chosen.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 12 }, "name": { "type": "string", "example": "web-02" }, "status": { "type": "string", "example": "running" }, "ipv4": { "type": "object", "properties": { "address": { "type": "string", "example": "203.0.113.9" }, "basis": { "type": "string", "example": "exact" } } }, "ipv6": { "type": "object", "properties": { "address": { "type": "string", "example": "2001:db8:aaaa:bbbb::20" }, "basis": { "type": "string", "example": "in_use" }, "block": { "type": "string", "example": "2001:db8:aaaa:bbbb::/64" } }, "nullable": true } } }, "example": [ { "id": 12, "name": "web-02", "status": "running", "ipv4": { "address": "203.0.113.9", "basis": "exact" }, "ipv6": { "address": "2001:db8:aaaa:bbbb::20", "basis": "in_use", "block": "2001:db8:aaaa:bbbb::/64" } } ] } } }, "example": { "data": [ { "id": 13, "name": "analytics-01", "status": "stopped", "ipv4": { "address": "192.0.2.80", "basis": "exact" }, "ipv6": null }, { "id": 3, "name": "api-01", "status": "running", "ipv4": { "address": "198.51.100.20", "basis": "exact" }, "ipv6": { "address": "2001:db8:1c1e:5a20::1", "basis": "default", "block": "2001:db8:1c1e:5a20::/64" } } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones": { "get": { "summary": "List DNS zones", "operationId": "getApiOrganizationsOrganization_idDnsZones", "description": "Your DNS zones, paginated with `page` and `per_page` (up to 200), each with its provider, record count, tags and delegation state. Filter with `search`, `credential`, `tag` or `status` (`active`, `stale`, `drift` for records changed at the provider, or `security`) and sort with `sort` (`zone`, `provider`, `records`, `synced`) and `dir`; `meta.counts` holds the totals.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 11, "organization_id": 1, "domain_id": 20, "name": "northwind-api.dev", "provider": "openprovider", "provider_zone_id": "zone-210", "status": "pending", "last_synced_at": "2026-01-15T10:24:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 7, "ns_live": [ "ns1.openprovider.nl", "ns2.openprovider.be" ], "ns_checked_at": "2026-01-15T11:53:00.000000Z", "security_status": "info", "ns_mismatch_since": null, "provider_modified_at": null, "price_monthly": "0.00", "price_source": "manual", "price_currency": "EUR", "price_amount": "0.0000", "billing_interval": "monthly", "interval_count": 1, "live_mismatch_count": 0, "live_checked_at": "2026-01-15T11:53:00.000000Z", "live_mismatch_since": null, "dnssec_pending": null, "dnssec_pending_since": null, "provider_settings": null, "provider_settings_checked_at": null, "default_ttl": null, "registrar_name": null, "registrar_checked_at": null, "records_count": 7, "custom_fields": [], "delegation": { "state": "matches", "reason": null, "live": [ "ns1.openprovider.nl", "ns2.openprovider.be" ], "dnssec": null, "belongs_to": "openprovider", "checked_at": "2026-01-15T11:53:00.000000Z" }, "can_sign": false, "sync_halt": null, "provider_credential": { "id": 7, "organization_id": 1, "provider": "openprovider", "label": "Openprovider — Reseller", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] }, { "id": 3, "organization_id": 1, "domain_id": 3, "name": "northwind-app.dev", "provider": "cloudflare", "provider_zone_id": "zone-202", "status": "active", "last_synced_at": "2026-01-15T11:48:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 2, "ns_live": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "ns_checked_at": "2026-01-15T11:53:00.000000Z", "security_status": "error", "ns_mismatch_since": null, "provider_modified_at": null, "price_monthly": "4.00", "price_source": "manual", "price_currency": "EUR", "price_amount": "4.0000", "billing_interval": "monthly", "interval_count": 1, "live_mismatch_count": 0, "live_checked_at": "2026-01-15T11:53:00.000000Z", "live_mismatch_since": null, "dnssec_pending": null, "dnssec_pending_since": null, "provider_settings": { "ssl": "flexible", "min_tls_version": "1.0", "security_header": { "strict_transport_security": { "enabled": false } }, "always_use_https": "off", "development_mode": "on", "development_mode_expires_at": "2026-01-15T14:00:00.000000Z" }, "provider_settings_checked_at": "2026-01-15T11:40:00.000000Z", "default_ttl": null, "registrar_name": null, "registrar_checked_at": null, "records_count": 8, "custom_fields": [], "delegation": { "state": "matches", "reason": null, "live": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "dnssec": null, "belongs_to": "cloudflare", "checked_at": "2026-01-15T11:53:00.000000Z" }, "can_sign": true, "sync_halt": null, "provider_credential": { "id": 2, "organization_id": 1, "provider": "cloudflare", "label": "Cloudflare DNS", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] } ], "first_page_url": "http://localhost/api/organizations/1/dns-zones?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/dns-zones?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/dns-zones?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/dns-zones", "per_page": 25, "prev_page_url": null, "to": 13, "total": 13, "meta": { "locked_ids": [], "counts": { "total": 13, "active": 12, "stale": 0, "drift": 0, "security": 4 }, "integrations": [ { "id": 2, "provider": "cloudflare", "label": "Cloudflare DNS" }, { "id": 4, "provider": "dynadot", "label": "Dynadot Registrar" } ], "tags": [], "custom_fields": [] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}": { "get": { "summary": "Get a DNS zone", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_id", "description": "One zone with all its records, its provider connection, whether record changes can be pushed to the provider, its delegation and DNSSEC details, and findings such as records pointing at released addresses. Opening it may queue fresh nameserver and live-DNS checks in the background.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "domain_id": 1, "name": "northwind.com", "provider": "cloudflare", "provider_zone_id": "zone-200", "status": "active", "last_synced_at": "2026-01-15T11:48:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 2, "ns_live": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "ns_checked_at": "2026-01-15T11:53:00.000000Z", "security_status": "warn", "ns_mismatch_since": null, "provider_modified_at": null, "price_monthly": "4.00", "price_source": "manual", "price_currency": "EUR", "price_amount": "4.0000", "billing_interval": "monthly", "interval_count": 1, "live_mismatch_count": 0, "live_checked_at": "2026-01-15T11:53:00.000000Z", "live_mismatch_since": null, "dnssec_pending": null, "dnssec_pending_since": null, "provider_settings": { "ssl": "strict", "min_tls_version": "1.2", "security_header": { "strict_transport_security": { "enabled": true } }, "always_use_https": "on", "development_mode": "off" }, "provider_settings_checked_at": "2026-01-15T11:40:00.000000Z", "default_ttl": null, "registrar_name": null, "registrar_checked_at": null, "records_count": 10, "sync_halt": null, "records": [ { "id": 1, "dns_zone_id": 1, "type": "A", "name": "@", "value": "198.51.100.10", "ttl": 300, "priority": null, "provider_record_id": "rec-200-0", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "comment": null, "proxied": true, "live_values": null, "live_checked_at": null, "value_is_placeholder": false, "live_mismatch": null }, { "id": 2, "dns_zone_id": 1, "type": "A", "name": "www", "value": "198.51.100.10", "ttl": 300, "priority": null, "provider_record_id": "rec-200-1", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "comment": null, "proxied": true, "live_values": null, "live_checked_at": null, "value_is_placeholder": false, "live_mismatch": null } ], "provider_credential": { "id": 2, "organization_id": 1, "provider": "cloudflare", "label": "Cloudflare DNS", "verified_at": "2025-10-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "enabled": true, "enabled_capabilities": null, "disabled_capabilities": null, "error_email_enabled": true, "disabled_operations": null, "alerts_muted_until": null, "spending_capacity": null, "spending_checked_at": null, "scope_check": null, "scope_checked_at": null, "removing_at": null, "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "account_identity": null, "refused_at": null, "refusal_checked_at": null }, "tags": [], "record_types": [ "A", "AAAA" ], "ttl_options": [ 1, 120 ], "can_push_records": false, "delegation": { "state": "matches", "reason": null, "live": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "dnssec": false, "belongs_to": "cloudflare", "checked_at": "2026-01-15T11:53:00.000000Z" }, "proxiable_record_types": [], "can_sign": true, "signing_reason": null, "dnssec_plan": { "shape": "sign_then_paste", "dns": { "provider": "cloudflare", "can_sign": true, "exposes_key": true, "reason": null }, "registrar": { "provider": "Namecheap", "known": true, "can_publish": false, "help_url": null, "fields": [ "key_tag", "flags" ] } }, "managed_hostnames": [], "posture": [ { "id": "cf_ssl_mode", "status": "pass", "value": "strict" }, { "id": "cf_min_tls", "status": "pass", "value": "1.2" } ], "dangling_addresses": [], "unclaimed_cnames": [], "live": { "mismatches": 0, "checked_at": "2026-01-15T11:53:00.000000Z", "mismatch_since": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/dns-records": { "get": { "summary": "List records in a zone", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_idDnsRecords", "description": "Every record in the zone, ordered by type and name, with the dynamic IP source that keeps it up to date, if any. Filter by record type with `type`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "dns_zone_id": 1, "type": "A", "name": "@", "value": "198.51.100.10", "ttl": 300, "priority": null, "provider_record_id": "rec-200-0", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "comment": null, "proxied": true, "live_values": null, "live_checked_at": null, "value_is_placeholder": false, "live_mismatch": null, "dynamic_ip_target": null }, { "id": 88, "dns_zone_id": 1, "type": "A", "name": "archive", "value": "198.51.100.11", "ttl": 300, "priority": null, "provider_record_id": "demo-certificate-archive", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "comment": null, "proxied": false, "live_values": [ "198.51.100.11" ], "live_checked_at": "2026-01-15T11:53:00.000000Z", "value_is_placeholder": false, "live_mismatch": false, "dynamic_ip_target": null } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a record", "operationId": "createARecord", "description": "Creates a record in the zone and pushes it to the DNS provider; `dry_run=1` returns the change without making it. Refused with 422 when the zone is read-only or an A/AAAA value is an address your fleet released, and with 409 when an apex CAA record would block a certificate’s renewal, unless `confirm_caa_impact` is sent.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "dry_run", "description": "Answer with the change this would make, and make none.", "example": true, "required": false, "schema": { "type": "boolean", "description": "Answer with the change this would make, and make none.", "example": true } } ], "responses": { "409": { "description": "The CAA change would block a certificate's renewing CA (#3168)", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "This CAA change would block the certificate authority that renews status.example.com. Their next renewal would fail." }, "error_type": { "type": "string", "example": "caa_blocks_renewal" }, "certificates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 12 }, "subject": { "type": "string", "example": "status.example.com" }, "ca": { "type": "string", "example": "letsencrypt.org" } } }, "example": [ { "id": 12, "subject": "status.example.com", "ca": "letsencrypt.org" } ] } }, "example": { "message": "This CAA change would block the certificate authority that renews status.example.com. Their next renewal would fail.", "error_type": "caa_blocks_renewal", "certificates": [ { "id": 12, "subject": "status.example.com", "ca": "letsencrypt.org" } ] } } } } }, "201": { "description": "Created", "content": { "application/json": { "example": { "id": 91, "dns_zone_id": 14, "type": "A", "name": "api", "value": "192.0.2.20", "ttl": 3600, "priority": null, "provider_record_id": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "comment": null, "proxied": false, "live_values": null, "live_checked_at": null, "value_is_placeholder": false, "live_mismatch": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "", "example": "A", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "NS", "SOA", "SRV", "CAA", "PTR", "ALIAS", "CERT", "DNSKEY", "DS", "HTTPS", "LOC", "NAPTR", "OPENPGPKEY", "SMIMEA", "SSHFP", "SVCB", "TLSA", "URI", "DNAME", "RP", "URL", "URL301", "FRAME" ] }, "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b", "nullable": true }, "value": { "type": "string", "description": "Must not be greater than 65535 characters.", "example": "n" }, "ttl": { "type": "integer", "description": "Must be at least 60. Must not be greater than 86400.", "example": 7 }, "priority": { "type": "integer", "description": "Must be at least 0. Must not be greater than 65535.", "example": 16, "nullable": true }, "proxied": { "type": "boolean", "description": "", "example": true }, "comment": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "m", "nullable": true }, "confirm_caa_impact": { "type": "boolean", "description": "Save an apex CAA record even though it blocks the CA a certificate renews from — send after a 409 `caa_blocks_renewal`.", "example": true } }, "required": [ "type", "value" ] }, "example": { "type": "A", "name": "api", "value": "192.0.2.20", "ttl": 3600 } } } }, "x-infranest-scope": "dns.write", "x-infranest-token-writable": true, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/dns-records/{record_id}": { "get": { "summary": "Get a record", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_idDnsRecordsRecord_id", "description": "One record in the zone. Answers 404 when the record belongs to another zone.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "record_id", "required": true, "description": "The record's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "dns_zone_id": 1, "type": "A", "name": "@", "value": "198.51.100.10", "ttl": 300, "priority": null, "provider_record_id": "rec-200-0", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "comment": null, "proxied": true, "live_values": null, "live_checked_at": null, "value_is_placeholder": false, "live_mismatch": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "put": { "summary": "Update a record", "operationId": "updateARecord", "description": "Changes the record and pushes the change to the DNS provider; `dry_run=1` returns the change without making it. Refused with 422 when the zone is read-only or a new A/AAAA value is an address your fleet released, and with 409 when an apex CAA change would block a certificate’s renewal, unless `confirm_caa_impact` is sent.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "record_id", "required": true, "description": "The record's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "dry_run", "description": "Answer with the change this would make, and make none.", "example": true, "required": false, "schema": { "type": "boolean", "description": "Answer with the change this would make, and make none.", "example": true } } ], "responses": { "409": { "description": "The CAA change would block a certificate's renewing CA (#3168)", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "This CAA change would block the certificate authority that renews status.example.com. Their next renewal would fail." }, "error_type": { "type": "string", "example": "caa_blocks_renewal" }, "certificates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 12 }, "subject": { "type": "string", "example": "status.example.com" }, "ca": { "type": "string", "example": "letsencrypt.org" } } }, "example": [ { "id": 12, "subject": "status.example.com", "ca": "letsencrypt.org" } ] } }, "example": { "message": "This CAA change would block the certificate authority that renews status.example.com. Their next renewal would fail.", "error_type": "caa_blocks_renewal", "certificates": [ { "id": 12, "subject": "status.example.com", "ca": "letsencrypt.org" } ] } } } } }, "200": { "description": "OK", "content": { "application/json": { "example": { "id": 89, "dns_zone_id": 14, "type": "A", "name": "www", "value": "192.0.2.11", "ttl": 3600, "priority": null, "provider_record_id": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "comment": null, "proxied": false, "live_values": null, "live_checked_at": null, "value_is_placeholder": false, "live_mismatch": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "", "example": "A", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "NS", "SOA", "SRV", "CAA", "PTR", "ALIAS", "CERT", "DNSKEY", "DS", "HTTPS", "LOC", "NAPTR", "OPENPGPKEY", "SMIMEA", "SSHFP", "SVCB", "TLSA", "URI", "DNAME", "RP", "URL", "URL301", "FRAME" ] }, "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b", "nullable": true }, "value": { "type": "string", "description": "Must not be greater than 65535 characters.", "example": "n" }, "ttl": { "type": "integer", "description": "Must be at least 60. Must not be greater than 86400.", "example": 7 }, "priority": { "type": "integer", "description": "Must be at least 0. Must not be greater than 65535.", "example": 16, "nullable": true }, "proxied": { "type": "boolean", "description": "", "example": true }, "comment": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "m", "nullable": true }, "confirm_caa_impact": { "type": "boolean", "description": "Save an apex CAA change even though it blocks the CA a certificate renews from — send after a 409 `caa_blocks_renewal`.", "example": true } } }, "example": { "type": "A", "name": "www", "value": "192.0.2.11", "ttl": 3600 } } } }, "x-infranest-scope": "dns.write", "x-infranest-token-writable": true, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a record", "operationId": "deleteARecord", "description": "Deletes the record at the DNS provider first, then in InfraNest; if the provider refuses, the record is kept and 502 is returned. Supports `dry_run=1`, and `confirm_caa_impact=1` after a 409 for an apex CAA record whose removal would block a certificate’s renewal.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "record_id", "required": true, "description": "The record's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "confirm_caa_impact", "description": "Delete an apex CAA record even though that blocks the CA a certificate renews from — send after a 409 `caa_blocks_renewal`.", "example": true, "required": false, "schema": { "type": "boolean", "description": "Delete an apex CAA record even though that blocks the CA a certificate renews from — send after a 409 `caa_blocks_renewal`.", "example": true } }, { "in": "query", "name": "dry_run", "description": "Answer with the change this would make, and make none.", "example": true, "required": false, "schema": { "type": "boolean", "description": "Answer with the change this would make, and make none.", "example": true } } ], "responses": { "409": { "description": "The CAA change would block a certificate's renewing CA (#3168)", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "This CAA change would block the certificate authority that renews status.example.com. Their next renewal would fail." }, "error_type": { "type": "string", "example": "caa_blocks_renewal" }, "certificates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 12 }, "subject": { "type": "string", "example": "status.example.com" }, "ca": { "type": "string", "example": "letsencrypt.org" } } }, "example": [ { "id": 12, "subject": "status.example.com", "ca": "letsencrypt.org" } ] } }, "example": { "message": "This CAA change would block the certificate authority that renews status.example.com. Their next renewal would fail.", "error_type": "caa_blocks_renewal", "certificates": [ { "id": 12, "subject": "status.example.com", "ca": "letsencrypt.org" } ] } } } } }, "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "DNS" ], "x-infranest-scope": "dns.write", "x-infranest-token-writable": true, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/provider-credentials": { "get": { "summary": "List provider accounts", "operationId": "getApiOrganizationsOrganization_idProviderCredentials", "description": "Every connected cloud, DNS, registrar and certificate account, with its health and how many zones, domains, certificates and servers it holds.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "removing": false, "is_oauth": false, "auth_kind": "api_token", "oauth": null, "error_email_enabled": true, "alerts_muted_until": null, "incident": null, "notices": [], "spending": null, "capabilities": [ "cloud", "dns" ], "supported_capabilities": [ "cloud", "dns" ], "cloud_capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "dns_capabilities": { "record_writes": true, "bulk_replace": false, "zone_create": true, "zone_delete": true, "record_proxying": false, "signing": false }, "dns_scope": "any", "cloud_firewall_protocols": [ "tcp", "udp" ], "enabled_capabilities": null, "suspended_capabilities": [], "resource_counts": { "dns": 2, "certificates": 1, "cloud": 6 }, "verified_at": "2025-10-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "fields": [ "api_token" ], "environment": null, "field_values": { "api_token": { "set": true, "secret": true, "display": "••••oken" } }, "context": [], "health": { "status": "ok", "success_rate": 100, "total_calls": 97, "last_error_at": null, "last_success_at": "2026-01-15T12:00:00Z" } }, { "id": 2, "provider": "cloudflare", "label": "Cloudflare DNS", "enabled": true, "removing": false, "is_oauth": false, "auth_kind": "api_token", "oauth": null, "error_email_enabled": true, "alerts_muted_until": null, "incident": null, "notices": [], "spending": null, "capabilities": [ "dns", "registrar" ], "supported_capabilities": [ "dns", "registrar" ], "cloud_capabilities": [], "dns_capabilities": { "record_writes": true, "bulk_replace": false, "zone_create": true, "zone_delete": true, "record_proxying": true, "signing": true }, "dns_scope": "any", "cloud_firewall_protocols": [], "enabled_capabilities": null, "suspended_capabilities": [], "resource_counts": { "dns": 5, "registrar": 0, "certificates": 1 }, "verified_at": "2025-10-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "fields": [ "api_token", "account_id" ], "environment": null, "field_values": { "api_token": { "set": true, "secret": true, "display": "••••oken" }, "account_id": { "set": true, "secret": false, "display": "demoaccount0000000000000000cf01" } }, "context": [], "health": { "status": "ok", "success_rate": 100, "total_calls": 49, "last_error_at": null, "last_success_at": "2026-01-15T12:00:00Z" } } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/provider-credentials/health": { "get": { "summary": "Get provider account health", "operationId": "lightweightHealthSummaryForTheNavBadgeHowManyEnabledIntegrationsAreCurrentlyDegradeddown24HFailureRateGETproviderCredentialshealth", "description": "How many enabled provider accounts there are (`total`) and how many are currently degraded or down (`unhealthy`).", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "unhealthy": 2, "total": 10 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/provider-credentials/{providerCredential_id}": { "get": { "summary": "Get a provider account", "operationId": "gETproviderCredentialASingleAccountForItsDetailPage483Phase3Counts+Health", "description": "One connected provider account with its health, how many zones, domains, certificates and servers it holds, the registrar operations it supports and the result of its last permission check. Secrets are never returned.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "providerCredential_id", "required": true, "description": "The providerCredential's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "removing": false, "is_oauth": false, "auth_kind": "api_token", "oauth": null, "error_email_enabled": true, "alerts_muted_until": null, "incident": null, "notices": [], "spending": null, "capabilities": [ "cloud", "dns" ], "supported_capabilities": [ "cloud", "dns" ], "cloud_capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "dns_capabilities": { "record_writes": true, "bulk_replace": false, "zone_create": true, "zone_delete": true, "record_proxying": false, "signing": false }, "dns_scope": "any", "cloud_firewall_protocols": [ "tcp", "udp" ], "enabled_capabilities": null, "suspended_capabilities": [], "resource_counts": { "dns": 2, "certificates": 1, "cloud": 6 }, "verified_at": "2025-10-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "fields": [ "api_token" ], "environment": null, "field_values": { "api_token": { "set": true, "secret": true, "display": "••••oken" } }, "context": [], "health": { "status": "ok", "success_rate": 100, "total_calls": 97, "last_error_at": null, "last_success_at": "2026-01-15T12:00:00Z" }, "registrar_operations": null, "scope_check": null, "scope_checked_at": null, "disabled_operations": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers": { "get": { "summary": "List servers", "operationId": "getApiOrganizationsOrganization_idCloudServers", "description": "Every server InfraNest tracks in the organization, a page at a time, with its provider, status, addresses and tags. Filter with `search`, `status`, `running`, `datacenter`, `tag`, `credential`, `provider` or `tracking=untracked`, and sort with `sort` and `dir`; self-managed machines are counted in `meta` but not listed.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 13, "organization_id": 1, "provider": "digitalocean", "provider_server_id": "112", "name": "analytics-01", "status": "stopped", "server_type": "c-4", "image": "ubuntu-24-04-x64", "ipv4": "192.0.2.80", "ipv6": null, "datacenter": "nyc3", "provisioned_at": "2025-07-25T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 50, "price_monthly": "84.00", "price_hourly": "0.1151", "location_city": "New York", "location_country": "US", "included_traffic": 6597069766656, "outgoing_traffic": 131941395333, "incoming_traffic": 65970697667, "ipv4_dns_ptr": "analytics-01.northwind.cloud", "firewall_enabled": false }, "provider_credential_id": 9, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": null, "delete_protection": false, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "provider", "agent_health": null, "monitoring_enabled": false, "monitoring_enabled_at": null, "volumes_count": 0, "agent_last_seen_at": null, "agent_tokens_count": 0, "custom_fields": { "1": "Data" }, "capabilities": { "native_delete_protection": false, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": false, "snapshots": true, "backups": true, "isos": false, "rescue": false, "placement_groups": false, "public_network_toggle": false, "scheduled_backups": true, "private_networks": true, "private_network_attach": false, "network_join_on_create": true, "network_attach_ip_choice": false, "private_network_unfiltered": false, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": false, "network_routes": false, "network_rename": true, "network_ip_range_extendable": false, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": false, "volume_native_delete_protection": false, "network_native_delete_protection": false, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": false, "rdns_address_list": false, "reverse_dns": false, "snapshot_description": false, "snapshot_protection": false }, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 50, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 50 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "stopped", "sync_halt": null, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [ { "id": 2, "name": "Staging", "color": "#f59e0b", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 13, "tag_id": 2 } } ] }, { "id": 12, "organization_id": 1, "provider": "digitalocean", "provider_server_id": "111", "name": "queue-01", "status": "running", "server_type": "s-4vcpu-8gb", "image": "ubuntu-24-04-x64", "ipv4": "192.0.2.40", "ipv6": "2001:db8:3:d0::a22:1/64", "datacenter": "fra1", "provisioned_at": "2025-08-06T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "price_monthly": "48.00", "price_hourly": "0.0658", "location_city": "Frankfurt", "location_country": "DE", "included_traffic": 5497558138880, "outgoing_traffic": 1044536046387, "incoming_traffic": 384829069722, "ipv4_dns_ptr": "queue-01.northwind.cloud", "firewall_enabled": false }, "provider_credential_id": 9, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": null, "delete_protection": false, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "agent", "agent_health": null, "monitoring_enabled": true, "monitoring_enabled_at": null, "volumes_count": 0, "agent_last_seen_at": null, "agent_tokens_count": 0, "custom_fields": { "1": "Platform" }, "capabilities": { "native_delete_protection": false, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": false, "snapshots": true, "backups": true, "isos": false, "rescue": false, "placement_groups": false, "public_network_toggle": false, "scheduled_backups": true, "private_networks": true, "private_network_attach": false, "network_join_on_create": true, "network_attach_ip_choice": false, "private_network_unfiltered": false, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": false, "network_routes": false, "network_rename": true, "network_ip_range_extendable": false, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": false, "volume_native_delete_protection": false, "network_native_delete_protection": false, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": false, "rdns_address_list": false, "reverse_dns": false, "snapshot_description": false, "snapshot_protection": false }, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [ { "id": 1, "name": "Production", "color": "#ef4444", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 12, "tag_id": 1 } } ] } ], "first_page_url": "http://localhost/api/organizations/1/cloud-servers?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/cloud-servers?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/cloud-servers?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/cloud-servers", "per_page": 25, "prev_page_url": null, "to": 14, "total": 14, "meta": { "locked_ids": [], "counts": { "total": 14, "running": 12, "untracked": 0, "self_managed": 0 }, "integrations": [ { "id": 9, "provider": "digitalocean", "label": "DigitalOcean — Staging", "capabilities": { "native_delete_protection": false, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": false, "snapshots": true, "backups": true, "isos": false, "rescue": false, "placement_groups": false, "public_network_toggle": false, "scheduled_backups": true, "private_networks": true, "private_network_attach": false, "network_join_on_create": true, "network_attach_ip_choice": false, "private_network_unfiltered": false, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": false, "network_routes": false, "network_rename": true, "network_ip_range_extendable": false, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": false, "volume_native_delete_protection": false, "network_native_delete_protection": false, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": false, "rdns_address_list": false, "reverse_dns": false, "snapshot_description": false, "snapshot_protection": false } }, { "id": 1, "provider": "hetzner", "label": "Hetzner — Production", "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true } } ], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6" }, { "id": 6, "name": "Northwind Platform", "color": "#14b8a6" } ], "custom_fields": [ { "id": 1, "key": "cost_centre", "label": "Cost centre", "type": "select", "options": [ "Platform", "Marketing" ] } ] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}": { "get": { "summary": "Get a server", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_id", "description": "One server with its volumes, tags, cost breakdown and what its provider lets InfraNest do with it. Also says whether it can be renamed and whether its monitoring agent’s readings are being refused.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider": "hetzner", "provider_server_id": "100", "name": "web-01", "status": "running", "server_type": "cpx31", "image": "ubuntu-24.04", "ipv4": "198.51.100.10", "ipv6": "2001:db8:1c1e:5a10::/64", "datacenter": "nbg1-dc3", "provisioned_at": "2025-12-16T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "price_monthly": "15.90", "price_hourly": "0.0218", "location_city": "Nuremberg", "location_country": "DE", "included_traffic": 21990232555520, "outgoing_traffic": 6816972092211, "incoming_traffic": 1979120929997, "ipv4_dns_ptr": "web-01.northwind.cloud", "firewall_enabled": false, "backup_window": "22-02" }, "provider_credential_id": 1, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": null, "delete_protection": true, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "agent", "agent_health": null, "monitoring_enabled": true, "monitoring_enabled_at": null, "volumes_count": 1, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "volumes": [ { "id": 3, "organization_id": 1, "cloud_server_id": 1, "provider": "hetzner", "provider_volume_id": "vol-3", "name": "uploads", "size_gb": 250, "status": "attached", "datacenter": "nbg1-dc3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "price_monthly": "12.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null } ], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 5 } } ], "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "cost": { "base": 15.9, "currency": "EUR", "source": "api", "extras": [ { "key": "backups", "amount": 3.18, "source": "computed", "own": true }, { "key": "volume", "label": "uploads", "amount": 12, "source": "api", "own": false } ], "total": 31.75 }, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "capability_blockers": [], "rename_refusal": null, "agent_silent_after_seconds": 300, "agent_refusal": null, "uptime_seconds": 3542400 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "put": { "summary": "Update a server", "operationId": "putApiOrganizationsOrganization_idCloudServersCloudServer_id", "description": "Changes a server’s name, city, country or tags; only the fields you send change. A new name is sent to the cloud provider first and refused when the provider cannot rename servers, while the provider’s own facts (addresses, type, status) can only be edited on a self-managed server.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 15, "organization_id": 1, "provider": "self_managed", "provider_server_id": null, "name": "office-nas-01", "status": "running", "server_type": null, "image": null, "ipv4": "192.0.2.40", "ipv6": null, "datacenter": null, "provisioned_at": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": null, "provider_credential_id": null, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": null, "delete_protection": false, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "provider", "agent_health": null, "monitoring_enabled": false, "monitoring_enabled_at": null, "volumes_count": 0, "hardware": { "vcpus": null, "ram_gb": null, "disk_gb": null, "plan": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "volumes": [], "tags": [], "provider_credential": null, "cost": { "base": null, "currency": "EUR", "source": "api", "extras": [], "total": null }, "capabilities": [], "capability_blockers": [], "rename_refusal": null, "agent_silent_after_seconds": 300, "agent_refusal": null, "uptime_seconds": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "description": "", "example": "architecto", "nullable": true }, "provider_server_id": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "n", "nullable": true }, "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "g" }, "status": { "type": "string", "description": "", "example": "running", "enum": [ "running", "stopped", "starting", "stopping", "rebuilding", "migrating", "provisioning", "error", "unknown" ] }, "server_type": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "z", "nullable": true }, "image": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "m", "nullable": true }, "ipv4": { "type": "string", "description": "Must not be greater than 45 characters.", "example": "i", "nullable": true }, "ipv6": { "type": "string", "description": "Must not be greater than 45 characters.", "example": "y", "nullable": true }, "datacenter": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "v", "nullable": true }, "provisioned_at": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true }, "meta": { "type": "object", "description": "", "properties": { "location_city": { "type": "string", "description": "Must not be greater than 100 characters.", "example": "d", "nullable": true }, "location_country": { "type": "string", "description": "", "example": "architecto", "nullable": true } } } } }, "example": { "name": "office-nas-01" } } } }, "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/untrack": { "post": { "summary": "Stop tracking a server", "operationId": "stopTrackingThisServerLeaveItRunningAtTheProviderStopListingItHere600", "description": "Hides the server from every list, cost and alert in InfraNest without touching it at the provider, where it keeps running. It no longer counts towards your plan, and tracking it again restores its history.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Server is no longer tracked." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/address-references": { "get": { "summary": "Get what refers to a server’s addresses", "operationId": "whatElseInInfraNestStillNamesThisServersAddress1673", "description": "The DNS records, firewall rules and monitors that name this server’s IPv4 or IPv6 address, with a total. Also lists the other servers a DNS record could be moved to, which is useful before deleting the server.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "addresses": [ "198.51.100.10", "2001:db8:1c1e:5a10::/64" ], "dns_records": [ { "zone_id": 1, "zone_name": "northwind.com", "record_id": 1, "name": "northwind.com", "fqdn": "northwind.com", "type": "A", "value": "198.51.100.10", "writable": false, "aliases": [ { "zone_id": 1, "record_id": 3, "fqdn": "api.northwind.com" } ] }, { "zone_id": 1, "zone_name": "northwind.com", "record_id": 2, "name": "www", "fqdn": "www.northwind.com", "type": "A", "value": "198.51.100.10", "writable": false, "aliases": [] } ], "firewall_rules": [], "monitors": [], "total": 21, "move_targets": [ { "id": 13, "name": "analytics-01", "ipv4": "192.0.2.80", "ipv6": null, "ipv6_basis": null }, { "id": 3, "name": "api-01", "ipv4": "198.51.100.20", "ipv6": "2001:db8:1c1e:5a20::1", "ipv6_basis": "default" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/pricing": { "put": { "summary": "Set a server’s price", "operationId": "setAManualMonthlyPrice276P2FlagsThePriceAsManualSoProviderSyncStopsOverwritingIt", "description": "Sets a manual price for the server in InfraNest, with optional currency and billing interval. A manual price is no longer overwritten by the provider’s price at each sync; nothing changes at the provider.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider": "hetzner", "provider_server_id": "100", "name": "web-01", "status": "running", "server_type": "cpx31", "image": "ubuntu-24.04", "ipv4": "198.51.100.10", "ipv6": "2001:db8:1c1e:5a10::/64", "datacenter": "nbg1-dc3", "provisioned_at": "2025-12-16T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "price_monthly": "15.90", "price_hourly": "0.0218", "location_city": "Nuremberg", "location_country": "DE", "included_traffic": 21990232555520, "outgoing_traffic": 6816972092211, "incoming_traffic": 1979120929997, "ipv4_dns_ptr": "web-01.northwind.cloud", "firewall_enabled": false, "backup_window": "22-02" }, "provider_credential_id": 1, "price_monthly": "7.90", "price_source": "manual", "price_currency": null, "backup_price_override": null, "delete_protection": true, "untracked_at": null, "price_amount": "7.9000", "billing_interval": "monthly", "interval_count": 1, "metrics_source": "agent", "agent_health": null, "monitoring_enabled": true, "monitoring_enabled_at": null, "volumes_count": 1, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "volumes": [ { "id": 3, "organization_id": 1, "cloud_server_id": 1, "provider": "hetzner", "provider_volume_id": "vol-3", "name": "uploads", "size_gb": 250, "status": "attached", "datacenter": "nbg1-dc3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "price_monthly": "12.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null } ], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 5 } } ], "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "cost": { "base": 7.9, "currency": "EUR", "source": "manual", "extras": [ { "key": "backups", "amount": 1.58, "source": "computed", "own": true }, { "key": "volume", "label": "uploads", "amount": 12, "source": "api", "own": false } ], "total": 22.15 }, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "capability_blockers": [], "rename_refusal": null, "agent_silent_after_seconds": 300, "agent_refusal": null, "uptime_seconds": 3542400 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "requestBody": { "required": true, "content": { "application/json": { "example": { "price_monthly": 7.9, "currency": "EUR" } } } }, "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/reset-pricing": { "post": { "summary": "Reset a server’s price", "operationId": "resetAManualPriceBackToTheProvidersLastSyncednetPrice", "description": "Drops the manual price and goes back to the price last synced from the provider. Returns the server with its updated cost breakdown.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider": "hetzner", "provider_server_id": "100", "name": "web-01", "status": "running", "server_type": "cpx31", "image": "ubuntu-24.04", "ipv4": "198.51.100.10", "ipv6": "2001:db8:1c1e:5a10::/64", "datacenter": "nbg1-dc3", "provisioned_at": "2025-12-16T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "price_monthly": "15.90", "price_hourly": "0.0218", "location_city": "Nuremberg", "location_country": "DE", "included_traffic": 21990232555520, "outgoing_traffic": 6816972092211, "incoming_traffic": 1979120929997, "ipv4_dns_ptr": "web-01.northwind.cloud", "firewall_enabled": false, "backup_window": "22-02" }, "provider_credential_id": 1, "price_monthly": "15.90", "price_source": "api", "price_currency": "EUR", "backup_price_override": null, "delete_protection": true, "untracked_at": null, "price_amount": "15.9000", "billing_interval": "monthly", "interval_count": 1, "metrics_source": "agent", "agent_health": null, "monitoring_enabled": true, "monitoring_enabled_at": null, "volumes_count": 1, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "volumes": [ { "id": 3, "organization_id": 1, "cloud_server_id": 1, "provider": "hetzner", "provider_volume_id": "vol-3", "name": "uploads", "size_gb": 250, "status": "attached", "datacenter": "nbg1-dc3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "price_monthly": "12.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null } ], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 5 } } ], "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "cost": { "base": 15.9, "currency": "EUR", "source": "api", "extras": [ { "key": "backups", "amount": 3.18, "source": "computed", "own": true }, { "key": "volume", "label": "uploads", "amount": 12, "source": "api", "own": false } ], "total": 31.75 }, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "capability_blockers": [], "rename_refusal": null, "agent_silent_after_seconds": 300, "agent_refusal": null, "uptime_seconds": 3542400 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/backup-pricing": { "put": { "summary": "Set a server’s backup price", "operationId": "overrideTheBackupsLine276StoredNETnullClearsItBackToTheProvidersPriceHetznersComputedRuleIndependentOfTheBasePriceSoOverridingBackupsNeverFlipsTheBaseToManual", "description": "Overrides the monthly backup cost InfraNest counts for this server with `backup_price_monthly`, net of tax. Send `null` to go back to the provider’s price; the server’s base price is not affected.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider": "hetzner", "provider_server_id": "100", "name": "web-01", "status": "running", "server_type": "cpx31", "image": "ubuntu-24.04", "ipv4": "198.51.100.10", "ipv6": "2001:db8:1c1e:5a10::/64", "datacenter": "nbg1-dc3", "provisioned_at": "2025-12-16T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "price_monthly": "15.90", "price_hourly": "0.0218", "location_city": "Nuremberg", "location_country": "DE", "included_traffic": 21990232555520, "outgoing_traffic": 6816972092211, "incoming_traffic": 1979120929997, "ipv4_dns_ptr": "web-01.northwind.cloud", "firewall_enabled": false, "backup_window": "22-02" }, "provider_credential_id": 1, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": "1.58", "delete_protection": true, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "agent", "agent_health": null, "monitoring_enabled": true, "monitoring_enabled_at": null, "volumes_count": 1, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "volumes": [ { "id": 3, "organization_id": 1, "cloud_server_id": 1, "provider": "hetzner", "provider_volume_id": "vol-3", "name": "uploads", "size_gb": 250, "status": "attached", "datacenter": "nbg1-dc3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "price_monthly": "12.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null } ], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 5 } } ], "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "cost": { "base": 15.9, "currency": "EUR", "source": "api", "extras": [ { "key": "backups", "amount": 1.58, "source": "manual", "own": true }, { "key": "volume", "label": "uploads", "amount": 12, "source": "api", "own": false } ], "total": 30.15 }, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "capability_blockers": [], "rename_refusal": null, "agent_silent_after_seconds": 300, "agent_refusal": null, "uptime_seconds": 3542400 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "backup_price_monthly": { "type": "number", "description": "Must be at least 0. Must not be greater than 9999999.99.", "example": 1, "nullable": true } } }, "example": { "backup_price_monthly": 1.58 } } } }, "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/metrics": { "get": { "summary": "Get a server’s provider metrics", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idMetrics", "description": "CPU, disk and network figures asked live from the cloud provider. Pick the figures with `types` (default `cpu,disk,network`) and set the window with `start`, `end` and `step` in seconds (default: the last hour at 60 seconds); refused when the server has no linked provider account.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "metrics": { "start": "2026-01-15T11:00:00+00:00", "end": "2026-01-15T12:00:00+00:00", "step": 60, "time_series": { "cpu": { "values": [ [ 1768474800, "22.12" ], [ 1768475100, "23.11" ] ] }, "network.0.bandwidth.in": { "values": [ [ 1768474800, "16381032" ], [ 1768475100, "18508096" ] ] }, "network.0.bandwidth.out": { "values": [ [ 1768474800, "38222409" ], [ 1768475100, "43185557" ] ] }, "disk.0.bandwidth.read": { "values": [ [ 1768474800, "5460344" ], [ 1768475100, "6169365" ] ] }, "disk.0.bandwidth.write": { "values": [ [ 1768474800, "8190516" ], [ 1768475100, "9254048" ] ] } } } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/provider-actions": { "get": { "summary": "List a server’s provider actions", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idProviderActions", "description": "The recent actions the cloud provider reports for this server, asked live. Empty when the provider account’s access does not cover it; refused when the server has no linked provider account.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/firewall": { "get": { "summary": "Get a server’s own firewall", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idFirewall", "description": "The firewall attached to this server, read live from the cloud provider. Refused when the server has no linked provider account.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/backups": { "get": { "summary": "List a server’s backups", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idBackups", "description": "The backups the cloud provider holds for this server, asked live. Empty when the provider account’s access does not cover it; refused when the server has no linked provider account.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "images": [ { "id": 90000101, "type": "backup", "status": "available", "description": "web-01 backup", "created": "2026-01-14T22:06:00+00:00", "disk_size": 160, "image_size": 17.84, "protection": { "delete": false }, "bound_to": 100 }, { "id": 90000102, "type": "backup", "status": "available", "description": "web-01 backup", "created": "2026-01-13T22:06:00+00:00", "disk_size": 160, "image_size": 17.8, "protection": { "delete": false }, "bound_to": 100 } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/addons": { "get": { "summary": "List a server’s add-ons", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idAddons", "description": "The add-ons the cloud provider reports for this server, asked live. Empty when the provider account’s access does not cover it; refused when the server has no linked provider account.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/images": { "get": { "summary": "List images available to a server", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idImages", "description": "The operating system images the cloud provider offers for this server, under `images`. Empty when the provider account’s access does not cover the catalogue; refused when the server has no linked provider account.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/isos": { "get": { "summary": "List ISOs available to a server", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idIsos", "description": "The ISO images the cloud provider offers for this server’s type, under `isos`. Refused when the server has no linked provider account.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{serverId}/retrack": { "post": { "summary": "Track a server again", "operationId": "trackItAgainTheRowNeverLeftSoItsMetricsTagsCostsAndAlertRulesComeBackWithIt", "description": "Brings an untracked server back into lists, costs and alerts, with its history, tags and alert rules intact. It counts towards your plan again, so it is refused when you have reached your server limit.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "serverId", "required": true, "description": "The serverId.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider": "hetzner", "provider_server_id": "100", "name": "web-01", "status": "running", "server_type": "cpx31", "image": "ubuntu-24.04", "ipv4": "198.51.100.10", "ipv6": "2001:db8:1c1e:5a10::/64", "datacenter": "nbg1-dc3", "provisioned_at": "2025-12-16T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "price_monthly": "15.90", "price_hourly": "0.0218", "location_city": "Nuremberg", "location_country": "DE", "included_traffic": 21990232555520, "outgoing_traffic": 6816972092211, "incoming_traffic": 1979120929997, "ipv4_dns_ptr": "web-01.northwind.cloud", "firewall_enabled": false, "backup_window": "22-02" }, "provider_credential_id": 1, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": null, "delete_protection": true, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "agent", "agent_health": null, "monitoring_enabled": true, "monitoring_enabled_at": null, "volumes_count": 1, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "volumes": [ { "id": 3, "organization_id": 1, "cloud_server_id": 1, "provider": "hetzner", "provider_volume_id": "vol-3", "name": "uploads", "size_gb": 250, "status": "attached", "datacenter": "nbg1-dc3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "price_monthly": "12.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null } ], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 3 } }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 1, "tag_id": 5 } } ], "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "cost": { "base": 15.9, "currency": "EUR", "source": "api", "extras": [ { "key": "backups", "amount": 3.18, "source": "computed", "own": true }, { "key": "volume", "label": "uploads", "amount": 12, "source": "api", "own": false } ], "total": 31.75 }, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "capability_blockers": [], "rename_refusal": null, "agent_silent_after_seconds": 300, "agent_refusal": null, "uptime_seconds": 3542400 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-volumes": { "get": { "summary": "List volumes", "operationId": "getApiOrganizationsOrganization_idCloudVolumes", "description": "Every storage volume InfraNest tracks in the organization, a page at a time, with the server it is attached to. Filter with `search`, `attached`, `unattached`, `server_id`, `status`, `tag` or `credential`, and sort with `sort` and `dir`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 6, "organization_id": 1, "cloud_server_id": null, "provider": "digitalocean", "provider_volume_id": "vol-6", "name": "analytics-scratch", "size_gb": 300, "status": "available", "datacenter": "nyc3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 9, "price_monthly": "30.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null, "server": null, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] }, { "id": 5, "organization_id": 1, "cloud_server_id": 11, "provider": "digitalocean", "provider_volume_id": "vol-5", "name": "staging-data", "size_gb": 100, "status": "attached", "datacenter": "ams3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 9, "price_monthly": "10.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null, "server": { "id": 11, "name": "staging-api-01", "ipv4": "192.0.2.11", "status": "running", "hardware": { "vcpus": null, "ram_gb": null, "disk_gb": null, "plan": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": null, "sync_halt": null }, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] } ], "first_page_url": "http://localhost/api/organizations/1/cloud-volumes?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/cloud-volumes?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/cloud-volumes?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/cloud-volumes", "per_page": 25, "prev_page_url": null, "to": 6, "total": 6, "meta": { "counts": { "total": 6, "attached": 4, "unattached": 2 }, "integrations": [ { "id": 9, "provider": "digitalocean", "label": "DigitalOcean — Staging" }, { "id": 1, "provider": "hetzner", "label": "Hetzner — Production" } ], "tags": [] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-volumes/{cloudVolume_id}": { "get": { "summary": "Get a volume", "operationId": "getApiOrganizationsOrganization_idCloudVolumesCloudVolume_id", "description": "One volume with its server, tags, what its provider allows and the provider’s size limits where known.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudVolume_id", "required": true, "description": "The cloudVolume's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "cloud_server_id": 4, "provider": "hetzner", "provider_volume_id": "vol-1", "name": "postgres-data", "size_gb": 100, "status": "attached", "datacenter": "hel1-dc2", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "price_monthly": "4.80", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "native_delete_protection": false, "sync_halt": null, "server": { "id": 4, "name": "db-01", "ipv4": "198.51.100.30", "status": "running", "hardware": { "vcpus": null, "ram_gb": null, "disk_gb": null, "plan": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": null, "sync_halt": null }, "tags": [], "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "verified_at": "2025-10-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "enabled": true, "enabled_capabilities": null, "disabled_capabilities": null, "error_email_enabled": true, "disabled_operations": null, "alerts_muted_until": null, "spending_capacity": null, "spending_checked_at": null, "scope_check": null, "scope_checked_at": null, "removing_at": null, "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "account_identity": null, "refused_at": null, "refusal_checked_at": null }, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "size_limits": { "min_gb": 10, "max_gb": 10240 } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-firewalls": { "get": { "summary": "List firewalls", "operationId": "getApiOrganizationsOrganization_idCloudFirewalls", "description": "Every cloud firewall InfraNest tracks in the organization, a page at a time (`per_page`, default 20), ordered by account and name. Each includes the entries a Dynamic IP keeps up to date in it.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 6, "organization_id": 1, "provider": "digitalocean", "provider_firewall_id": "fw-6", "name": "legacy-vpn", "rules": [ { "port": "1194", "protocol": "udp", "direction": "in", "source_ips": [ "0.0.0.0/0" ], "description": "OpenVPN" } ], "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 9, "applied_to_count": 0, "applied_server_ids": [], "delete_protection": false, "capabilities": { "native_delete_protection": false, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": false, "snapshots": true, "backups": true, "isos": false, "rescue": false, "placement_groups": false, "public_network_toggle": false, "scheduled_backups": true, "private_networks": true, "private_network_attach": false, "network_join_on_create": true, "network_attach_ip_choice": false, "private_network_unfiltered": false, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": false, "network_routes": false, "network_rename": true, "network_ip_range_extendable": false, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": false, "volume_native_delete_protection": false, "network_native_delete_protection": false, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": false, "rdns_address_list": false, "reverse_dns": false, "snapshot_description": false, "snapshot_protection": false }, "sync_halt": null, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [], "dynamic_ip_targets": [] }, { "id": 4, "organization_id": 1, "provider": "digitalocean", "provider_firewall_id": "fw-4", "name": "staging", "rules": [ { "port": "443", "protocol": "tcp", "direction": "in", "source_ips": [ "0.0.0.0/0" ], "description": "HTTPS" }, { "port": "22", "protocol": "tcp", "direction": "in", "source_ips": [ "203.0.113.0/24" ], "description": "SSH from the office" } ], "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 9, "applied_to_count": 2, "applied_server_ids": [ "109", "110" ], "delete_protection": false, "capabilities": { "native_delete_protection": false, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": false, "snapshots": true, "backups": true, "isos": false, "rescue": false, "placement_groups": false, "public_network_toggle": false, "scheduled_backups": true, "private_networks": true, "private_network_attach": false, "network_join_on_create": true, "network_attach_ip_choice": false, "private_network_unfiltered": false, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": false, "network_routes": false, "network_rename": true, "network_ip_range_extendable": false, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": false, "volume_native_delete_protection": false, "network_native_delete_protection": false, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": false, "rdns_address_list": false, "reverse_dns": false, "snapshot_description": false, "snapshot_protection": false }, "sync_halt": null, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [], "dynamic_ip_targets": [] } ], "first_page_url": "http://localhost/api/organizations/1/cloud-firewalls?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/cloud-firewalls?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/cloud-firewalls?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/cloud-firewalls", "per_page": 20, "prev_page_url": null, "to": 6, "total": 6 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-firewalls/{cloudFirewall_id}": { "get": { "summary": "Get a firewall", "operationId": "getApiOrganizationsOrganization_idCloudFirewallsCloudFirewall_id", "description": "One firewall with its rules, tags, Dynamic IP entries, what its provider allows and the protocols it accepts.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudFirewall_id", "required": true, "description": "The cloudFirewall's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider": "hetzner", "provider_firewall_id": "fw-1", "name": "web-tier", "rules": [ { "port": "443", "protocol": "tcp", "direction": "in", "source_ips": [ "0.0.0.0/0", "::/0" ], "description": "HTTPS" }, { "port": "80", "protocol": "tcp", "direction": "in", "source_ips": [ "0.0.0.0/0", "::/0" ], "description": "HTTP" } ], "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "applied_to_count": 4, "applied_server_ids": [ "100", "101" ], "delete_protection": false, "sync_halt": null, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "firewall_protocols": [ "tcp", "udp" ], "tags": [], "dynamic_ip_targets": [], "untracked_sources": [], "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-firewalls/{cloudFirewall_id}/drift": { "get": { "summary": "Check a firewall for drift", "operationId": "driftCheck420CompareTheRulesInfraNestHasStoredAgainstTheProvidersLiveRulessomeoneMayHaveEditedTheFirewallDirectlyInTheProviderConsoleReadOnlyNeverWrites", "description": "Compares the firewall’s rules in InfraNest with the rules live at the cloud provider and returns `drifted` with the provider’s rules. When the provider cannot be asked, `drifted` is false and `provider_rules` is null.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudFirewall_id", "required": true, "description": "The cloudFirewall's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/firewall-templates": { "get": { "summary": "List firewall templates", "operationId": "listAllTemplatesBuiltInsFirstThenOrgCustomTemplates", "description": "The built-in firewall templates and the custom templates your organization has saved, with their rules.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "builtin": [ { "id": null, "slug": "web-server", "name": "Web Server", "description": "For a public website or app. Opens HTTP (80), HTTPS (443) and HTTP/3 over QUIC (UDP 443) to everyone. Add SSH restricted to your own IP separately for management.", "is_builtin": true, "rules": [ { "description": "HTTP", "direction": "in", "protocol": "tcp", "port": "80", "ips": [ "0.0.0.0/0", "::/0" ] }, { "description": "HTTPS", "direction": "in", "protocol": "tcp", "port": "443", "ips": [ "0.0.0.0/0", "::/0" ] } ] }, { "id": null, "slug": "mail-server", "name": "Mail Server", "description": "For a self-hosted mail server. Opens SMTP (25), submission (587), SMTPS (465) for delivery and sending, plus IMAP/IMAPS (143/993) and POP3/POP3S (110/995) for clients. Open to everyone.", "is_builtin": true, "rules": [ { "description": "SMTP", "direction": "in", "protocol": "tcp", "port": "25", "ips": [ "0.0.0.0/0", "::/0" ] }, { "description": "Submission", "direction": "in", "protocol": "tcp", "port": "587", "ips": [ "0.0.0.0/0", "::/0" ] } ] } ], "custom": [ { "id": 1, "organization_id": 1, "name": "Web server (80/443)", "description": "Allow HTTP and HTTPS from anywhere, plus SSH from the office network.", "slug": null, "is_builtin": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "rules": [ { "id": 1, "firewall_template_id": 1, "description": "HTTP", "direction": "in", "protocol": "tcp", "port": "80", "ips": [ "0.0.0.0/0", "::/0" ], "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" }, { "id": 2, "firewall_template_id": 1, "description": "HTTPS", "direction": "in", "protocol": "tcp", "port": "443", "ips": [ "0.0.0.0/0", "::/0" ], "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } ] } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/firewall-templates/{templateKey}/preview/{cloudFirewall_id}": { "get": { "summary": "Preview a firewall template", "operationId": "previewApplyingATemplateToAFirewallTheResultingRules+TheCurrentRuleCount", "description": "The rules a template would add to the given firewall, alongside how many rules the firewall has now. `templateKey` is a built-in template’s slug or a custom template’s id; nothing is changed.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "templateKey", "required": true, "description": "The templateKey.", "schema": { "type": "string" } }, { "in": "path", "name": "cloudFirewall_id", "required": true, "description": "The cloudFirewall's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "rules": [ { "description": "HTTP", "direction": "in", "protocol": "tcp", "port": "80", "source_ips": [ "0.0.0.0/0", "::/0" ], "destination_ips": [] }, { "description": "HTTPS", "direction": "in", "protocol": "tcp", "port": "443", "source_ips": [ "0.0.0.0/0", "::/0" ], "destination_ips": [] } ], "current_count": 3 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-load-balancers": { "get": { "summary": "List load balancers", "operationId": "getApiOrganizationsOrganization_idCloudLoadBalancers", "description": "Every load balancer InfraNest tracks in the organization, a page at a time. Filter with `search`, `running`, `status`, `datacenter`, `tag` or `credential`, and sort with `sort` and `dir`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 3, "organization_id": 1, "provider": "digitalocean", "provider_lb_id": "lb-3", "name": "staging-lb", "status": "running", "load_balancer_type": "lb-small", "ipv4": "203.0.113.60", "ipv6": "2001:db8::60", "datacenter": "ams3", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 9, "algorithm": "round_robin", "services": [ { "protocol": "https", "listen_port": 443, "destination_port": 443 } ], "targets": [ { "type": "server", "server_id": 10 } ], "price_monthly": "12.00", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "sync_halt": null, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] }, { "id": 2, "organization_id": 1, "provider": "hetzner", "provider_lb_id": "lb-2", "name": "api-lb", "status": "running", "load_balancer_type": "lb21", "ipv4": "203.0.113.51", "ipv6": "2001:db8::51", "datacenter": "fsn1-dc14", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "algorithm": "least_connections", "services": [ { "protocol": "https", "listen_port": 443, "destination_port": 443 } ], "targets": [ { "type": "server", "server_id": 3 }, { "type": "server", "server_id": 6 } ], "price_monthly": "19.90", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "sync_halt": null, "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] } ], "first_page_url": "http://localhost/api/organizations/1/cloud-load-balancers?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/cloud-load-balancers?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/cloud-load-balancers?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/cloud-load-balancers", "per_page": 25, "prev_page_url": null, "to": 3, "total": 3, "meta": { "counts": { "total": 3, "running": 3 }, "integrations": [ { "id": 9, "provider": "digitalocean", "label": "DigitalOcean — Staging" }, { "id": 1, "provider": "hetzner", "label": "Hetzner — Production" } ], "tags": [] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-load-balancers/{cloudLoadBalancer_id}": { "get": { "summary": "Get a load balancer", "operationId": "getApiOrganizationsOrganization_idCloudLoadBalancersCloudLoadBalancer_id", "description": "One load balancer with its tags and what its provider allows.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudLoadBalancer_id", "required": true, "description": "The cloudLoadBalancer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider": "hetzner", "provider_lb_id": "lb-1", "name": "web-lb", "status": "running", "load_balancer_type": "lb11", "ipv4": "203.0.113.50", "ipv6": "2001:db8::50", "datacenter": "fsn1-dc14", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "provider_credential_id": 1, "algorithm": "round_robin", "services": [ { "protocol": "https", "listen_port": 443, "destination_port": 443 } ], "targets": [ { "type": "server", "server_id": 1 }, { "type": "server", "server_id": 2 } ], "price_monthly": "5.39", "price_source": "api", "price_currency": "eur", "delete_protection": false, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "sync_halt": null, "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-primary-ips": { "get": { "summary": "List IP addresses", "operationId": "everyAddressThisOrganizationHoldsFromWhicheverOfTheTwoSourcesCanSeeIt846", "description": "The IP addresses across your cloud accounts, with the server each is attached to. Where a provider cannot list addresses directly, the list is built from your servers and misses unattached addresses; those accounts are named in `server_derived_credentials`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "id": "ip_1", "name": "web-01-ipv4", "ip": "198.51.100.10", "type": "ipv4", "server_id": 1, "server_name": "web-01", "last_server_name": "web-01", "unattached": false, "dns_ptr": [ { "ip": "198.51.100.10", "dns_ptr": "web-01.northwind.cloud" } ], "datacenter": "nbg1-dc3", "location_city": "Nuremberg", "location_country": "de", "protection": { "delete": false }, "auto_delete": false, "blocked": false, "price_monthly": 0.6, "price_currency": "eur", "price_source": "api", "cloud_ip_id": 1, "credential_id": 1, "credential_label": "Hetzner — Production", "provider": "hetzner", "source": "provider", "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true } }, { "id": "ip_2", "name": "web-02-ipv4", "ip": "198.51.100.11", "type": "ipv4", "server_id": 2, "server_name": "web-02", "last_server_name": "web-02", "unattached": false, "dns_ptr": [ { "ip": "198.51.100.11", "dns_ptr": "web-02.northwind.cloud" } ], "datacenter": "nbg1-dc3", "location_city": "Nuremberg", "location_country": "de", "protection": { "delete": false }, "auto_delete": false, "blocked": false, "price_monthly": 0.6, "price_currency": "eur", "price_source": "api", "cloud_ip_id": 2, "credential_id": 1, "credential_label": "Hetzner — Production", "provider": "hetzner", "source": "provider", "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true } } ], "server_derived_credentials": [ { "id": 5, "label": "TransIP — Amsterdam", "provider": "transip" }, { "id": 8, "label": "OVHcloud — Beauharnois", "provider": "ovh" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-networks": { "get": { "summary": "List networks", "operationId": "getApiOrganizationsOrganization_idCloudNetworks", "description": "Every private network InfraNest tracks in the organization, ordered by name, with its tags. Not paginated.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "id": 1, "organization_id": 1, "provider_credential_id": 1, "provider": "hetzner", "provider_network_id": "net-1", "name": "private-backbone", "ip_range": "10.0.0.0/16", "network_zone": "eu-central", "subnets_count": 2, "routes_count": 0, "servers_count": 6, "protection": { "delete": false }, "labels": [], "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subnets": [ { "type": "cloud", "gateway": "10.0.0.1", "ip_range": "10.0.1.0/24", "network_zone": "eu-central" }, { "type": "cloud", "gateway": "10.0.0.1", "ip_range": "10.0.2.0/24", "network_zone": "eu-central" } ], "routes": [], "servers": [ "100", "101" ], "delete_protection": false, "sync_halt": null, "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] }, { "id": 3, "organization_id": 1, "provider_credential_id": 9, "provider": "digitalocean", "provider_network_id": "net-3", "name": "staging-vpc", "ip_range": "10.10.0.0/20", "network_zone": "ams3", "subnets_count": 1, "routes_count": 0, "servers_count": 2, "protection": { "delete": false }, "labels": [], "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subnets": [ { "type": "cloud", "ip_range": "10.10.0.0/20", "network_zone": "ams3" } ], "routes": [], "servers": [ "109", "110" ], "delete_protection": false, "sync_halt": null, "provider_credential": { "id": 9, "organization_id": 1, "provider": "digitalocean", "label": "DigitalOcean — Staging", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [] } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-networks/{cloudNetwork_id}": { "get": { "summary": "Get a network", "operationId": "getApiOrganizationsOrganization_idCloudNetworksCloudNetwork_id", "description": "One private network with its tags and what its provider allows.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudNetwork_id", "required": true, "description": "The cloudNetwork's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider_credential_id": 1, "provider": "hetzner", "provider_network_id": "net-1", "name": "private-backbone", "ip_range": "10.0.0.0/16", "network_zone": "eu-central", "subnets_count": 2, "routes_count": 0, "servers_count": 6, "protection": { "delete": false }, "labels": [], "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subnets": [ { "type": "cloud", "gateway": "10.0.0.1", "ip_range": "10.0.1.0/24", "network_zone": "eu-central" }, { "type": "cloud", "gateway": "10.0.0.1", "ip_range": "10.0.2.0/24", "network_zone": "eu-central" } ], "routes": [], "servers": [ "100", "101" ], "delete_protection": false, "sync_halt": null, "provider_credential": { "id": 1, "organization_id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "verified_at": "2025-10-15T12:00:00.000000Z", "last_synced_at": "2026-01-15T11:48:00.000000Z", "reconnect_required_at": null, "refused_at": null }, "tags": [], "capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-snapshots": { "get": { "summary": "List snapshots", "operationId": "getApiOrganizationsOrganization_idCloudSnapshots", "description": "Every server snapshot InfraNest tracks in the organization, a page at a time, with the server it belongs to. Filter with `server_id`, `status`, `credential` or `search`, and sort with `sort` and `dir`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 3, "organization_id": 1, "provider_credential_id": null, "cloud_server_id": 1, "provider": "hetzner", "provider_snapshot_id": "snap-302", "name": "web-01 golden image", "description": "Base image the web tier is rebuilt from.", "status": "available", "disk_size_gb": 80, "image_size_gb": 6.2, "source_server_name": "web-01", "protection_delete": true, "created_at": "2025-12-12T12:00:00.000000Z", "updated_at": "2025-12-12T12:00:00.000000Z", "deleted_at": null, "price_monthly": "0.07", "price_amount": null, "price_currency": "EUR", "price_source": "api", "billing_interval": "monthly", "interval_count": 1, "capabilities": [], "provider_credential": null, "server": { "id": 1, "name": "web-01", "ipv4": "198.51.100.10", "status": "running", "hardware": { "vcpus": null, "ram_gb": null, "disk_gb": null, "plan": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": null, "sync_halt": null } }, { "id": 2, "organization_id": 1, "provider_credential_id": null, "cloud_server_id": 4, "provider": "hetzner", "provider_snapshot_id": "snap-301", "name": "db-01 nightly", "description": null, "status": "available", "disk_size_gb": 40, "image_size_gb": 11.1, "source_server_name": "db-01", "protection_delete": false, "created_at": "2026-01-14T12:00:00.000000Z", "updated_at": "2026-01-14T12:00:00.000000Z", "deleted_at": null, "price_monthly": "0.13", "price_amount": null, "price_currency": "EUR", "price_source": "api", "billing_interval": "monthly", "interval_count": 1, "capabilities": [], "provider_credential": null, "server": { "id": 4, "name": "db-01", "ipv4": "198.51.100.30", "status": "running", "hardware": { "vcpus": null, "ram_gb": null, "disk_gb": null, "plan": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": null, "sync_halt": null } } ], "first_page_url": "http://localhost/api/organizations/1/cloud-snapshots?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/cloud-snapshots?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/cloud-snapshots?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/cloud-snapshots", "per_page": 25, "prev_page_url": null, "to": 6, "total": 6, "meta": { "counts": { "total": 6, "available": 6, "creating": 0, "unavailable": 0 }, "integrations": [] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-snapshots/{cloudSnapshot_id}": { "get": { "summary": "Get a snapshot", "operationId": "getApiOrganizationsOrganization_idCloudSnapshotsCloudSnapshot_id", "description": "One snapshot with the server it was taken from.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudSnapshot_id", "required": true, "description": "The cloudSnapshot's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "provider_credential_id": null, "cloud_server_id": 4, "provider": "hetzner", "provider_snapshot_id": "snap-300", "name": "db-01 before schema migration", "description": "Taken automatically before the 2026-08 migration.", "status": "available", "disk_size_gb": 40, "image_size_gb": 11.4, "source_server_name": "db-01", "protection_delete": true, "created_at": "2026-01-06T12:00:00.000000Z", "updated_at": "2026-01-06T12:00:00.000000Z", "deleted_at": null, "price_monthly": "0.14", "price_amount": null, "price_currency": "EUR", "price_source": "api", "billing_interval": "monthly", "interval_count": 1, "provider_credential": null, "server": { "id": 4, "name": "db-01", "ipv4": "198.51.100.30", "status": "running", "hardware": { "vcpus": null, "ram_gb": null, "disk_gb": null, "plan": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": null, "sync_halt": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cloud" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks": { "get": { "summary": "List monitors", "operationId": "getApiOrganizationsOrganization_idMonitoringChecks", "description": "A paginated list of your monitors with their type, target, interval, current status, 24-hour uptime and a 24-hour status chart, plus status counts in `meta`. Filter with `search`, `type`, `kind` (`own` or `external`), `status`, `enabled` and `tag`, and sort with `sort` and `dir`; pass `all=true` for a plain unpaginated list of every monitor.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 3, "organization_id": 1, "name": "API health", "type": "http", "target": "https://api.northwind.com/health", "enabled": true, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "alert_channels_count": 0, "uptime_24h": "0.0", "uptime_chart_24h": [ "up", "up" ], "in_maintenance": false, "effective_interval_seconds": 300, "interval_minutes": 5, "tags": [ { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\MonitoringCheck", "taggable_id": 3, "tag_id": 5 } }, { "id": 1, "name": "Production", "color": "#ef4444", "pivot": { "taggable_type": "App\\Models\\MonitoringCheck", "taggable_id": 3, "tag_id": 1 } } ] }, { "id": 2, "organization_id": 1, "name": "App — northwind-app.dev", "type": "http", "target": "https://northwind-app.dev", "enabled": true, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "alert_channels_count": 0, "uptime_24h": "0.0", "uptime_chart_24h": [ "up", "up" ], "in_maintenance": false, "effective_interval_seconds": 300, "interval_minutes": 5, "tags": [ { "id": 6, "name": "Northwind Platform", "color": "#14b8a6", "pivot": { "taggable_type": "App\\Models\\MonitoringCheck", "taggable_id": 2, "tag_id": 6 } }, { "id": 1, "name": "Production", "color": "#ef4444", "pivot": { "taggable_type": "App\\Models\\MonitoringCheck", "taggable_id": 2, "tag_id": 1 } } ] } ], "first_page_url": "http://localhost/api/organizations/1/monitoring-checks?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/monitoring-checks?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/monitoring-checks?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/monitoring-checks", "per_page": 25, "prev_page_url": null, "to": 13, "total": 13, "meta": { "locked_ids": [], "counts": { "total": 13, "up": 10, "down": 1, "degraded": 1, "paused": 1, "silenced": 0, "pending": 0 }, "tags": [ { "id": 6, "name": "Northwind Platform", "color": "#14b8a6" }, { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9" } ] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a monitor", "operationId": "postApiOrganizationsOrganization_idMonitoringChecks", "description": "Creates a monitor and queues its first check. Pass `external_service_id` instead of a target to watch a third-party status page; a heartbeat monitor gets its own ping URL as its target. Refused when the monitor count, interval, check type or regions are beyond your plan.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "last_status": "unknown", "enabled": true, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "name": "Checkout API", "type": "http", "target": "https://example.com/health", "organization_id": 1, "server_id": null, "server_link": null, "settings": [], "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 15, "alert_channels_count": 0, "interval_minutes": 0, "tags": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "type": { "type": "string", "description": "", "example": "http", "enum": [ "http", "port", "ssl", "dns", "keyword", "redirect", "ping", "api", "heartbeat", "third_party" ] }, "external_service_id": { "type": "integer", "description": "", "example": 16, "nullable": true }, "external_component_ids": { "type": "array", "description": "Must not be greater than 255 characters.", "example": [ "n" ], "items": { "type": "string" } }, "external_alerts_enabled": { "type": "boolean", "description": "", "example": true, "nullable": true }, "target": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "g" }, "interval_seconds": { "type": "integer", "description": "", "example": 30, "enum": [ 30, 60, 120, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 86400 ] }, "enabled": { "type": "boolean", "description": "", "example": true }, "pagerduty_down_severity": { "type": "string", "description": "", "example": "critical", "enum": [ "critical", "error", "warning", "info" ] }, "pagerduty_degraded_severity": { "type": "string", "description": "", "example": "critical", "enum": [ "critical", "error", "warning", "info" ] }, "flap_threshold": { "type": "integer", "description": "Must be at least 1. Must not be greater than 10.", "example": 6 }, "region_consensus_threshold": { "type": "integer", "description": "Must be at least 1. Must not be greater than 10.", "example": 7, "nullable": true }, "preferred_regions": { "type": "array", "description": "", "example": [ "EU" ], "items": { "type": "string", "enum": [ "EU", "NA", "APAC", "auto" ] } }, "probe_mode": { "type": "string", "description": "", "example": "any", "enum": [ "any", "all" ] }, "ip_version": { "type": "string", "description": "", "example": "ipv4", "enum": [ "ipv4", "ipv6", "prefer_ipv4", "prefer_ipv6" ] }, "slow_response_ms": { "type": "integer", "description": "Must be at least 50. Must not be greater than 30000.", "example": 15, "nullable": true }, "ssl_check_enabled": { "type": "boolean", "description": "", "example": true }, "ssl_expiry_days": { "type": "integer", "description": "Must be at least 1. Must not be greater than 90.", "example": 8, "nullable": true }, "settings": { "type": "object", "description": "", "properties": { "method": { "type": "string", "description": "", "example": "GET", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "DELETE" ] }, "expected_status_codes": { "type": "array", "description": "Must be between 100 and 599.", "example": [ 101 ], "items": { "type": "integer" } }, "expected_status": { "type": "integer", "description": "Must be between 100 and 599.", "example": 101 }, "timeout_seconds": { "type": "integer", "description": "Must be at least 1. Must not be greater than 60.", "example": 5 }, "follow_redirects": { "type": "boolean", "description": "", "example": true }, "auth_type": { "type": "string", "description": "", "example": "", "enum": [ "", "basic", "bearer", "digest" ], "nullable": true }, "auth_username": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "j", "nullable": true }, "auth_password": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "n", "nullable": true }, "auth_token": { "type": "string", "description": "Must not be greater than 1000 characters.", "example": "i", "nullable": true }, "request_body": { "type": "string", "description": "Must not be greater than 10000 characters.", "example": "k", "nullable": true }, "request_headers": { "type": "array", "description": "Must not be greater than 1000 characters.", "example": [ "h" ], "items": { "type": "string" } }, "keyword": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "w", "nullable": true }, "keyword_match": { "type": "string", "description": "", "example": "contains", "enum": [ "contains", "not_contains", "regex" ] }, "port": { "type": "integer", "description": "Must be at least 1. Must not be greater than 65535.", "example": 22 }, "warning_days": { "type": "integer", "description": "Must be at least 1. Must not be greater than 90.", "example": 24 }, "record_type": { "type": "string", "description": "Must not be greater than 10 characters.", "example": "kcmyuw" }, "expected_value": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "p", "nullable": true }, "expected_url": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis", "nullable": true }, "packet_count": { "type": "integer", "description": "Must be at least 1. Must not be greater than 10.", "example": 7 }, "nameserver": { "type": "string", "description": "Must not be greater than 253 characters.", "example": "q", "nullable": true }, "assertions": { "type": "array", "description": "", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "", "example": "json_path", "enum": [ "json_path", "response_time" ] }, "path": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "d", "nullable": true }, "operator": { "type": "string", "description": "", "example": "equals", "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "exists", "not_exists" ] }, "value": { "type": "string", "description": "", "example": null, "nullable": true } } } }, "grace_period_seconds": { "type": "integer", "description": "Must be at least 0. Must not be greater than 86400.", "example": 18 } } } }, "required": [ "name", "type", "target" ] }, "example": { "name": "Checkout API", "type": "http", "target": "https://example.com/health", "interval": 300 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}": { "get": { "summary": "Get a monitor", "operationId": "getApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_id", "description": "One monitor with its settings, alert channels, tags, dependencies, maintenance windows, the status pages it appears on, its 30 most recent results and the interval it actually runs at under your plan.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Marketing site", "type": "http", "target": "https://northwind.com", "enabled": true, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "results_count": 576, "alert_channels_count": 0, "status_pages": [ { "id": 1, "name": "Northwind Cloud Status", "slug": "northwind", "is_public": true, "display_name": "Website" } ], "recent_statuses": [ "up", "up" ], "recent_results": [ { "status": "up", "checked_at": "2026-01-15T09:35:00Z", "region": null }, { "status": "up", "checked_at": "2026-01-15T09:40:00Z", "region": null } ], "pagerduty_oncall": [], "released_address": null, "effective_interval_seconds": 300, "interval_minutes": 5, "alert_channels": [], "tags": [ { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\MonitoringCheck", "taggable_id": 1, "tag_id": 5 } }, { "id": 1, "name": "Production", "color": "#ef4444", "pivot": { "taggable_type": "App\\Models\\MonitoringCheck", "taggable_id": 1, "tag_id": 1 } } ], "parent_checks": [], "child_checks": [], "maintenance_windows": [ { "id": 2, "organization_id": 1, "name": "Load balancer certificate rotation", "description": "Replaced the certificate on web-lb and reloaded the listeners.", "starts_at": "2026-01-06T01:00:00.000000Z", "ends_at": "2026-01-06T01:30:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "recurrence_type": "none", "recurrence_days": null, "start_time": null, "duration_minutes": null, "suppress_alerts": true, "status": "completed", "notified_at": null, "source": "manual", "deploy_id": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "created_by": null, "checks": [], "tags": [] }, { "id": 1, "organization_id": 1, "name": "Database cluster upgrade", "description": "Rolling upgrade of the PostgreSQL primary and its replica. Brief API slowdowns are possible; no downtime is expected.", "starts_at": "2026-01-18T02:00:00.000000Z", "ends_at": "2026-01-18T03:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "recurrence_type": "none", "recurrence_days": null, "start_time": null, "duration_minutes": null, "suppress_alerts": true, "status": "scheduled", "notified_at": null, "source": "manual", "deploy_id": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "created_by": null, "checks": [], "tags": [] } ], "latest_ssl_certificate": { "id": 1, "organization_id": 1, "source": "probe", "monitoring_check_id": 1, "domain_id": 1, "cloud_server_id": null, "provider_credential_id": null, "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9", "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "serial": "2395BA42", "sans": [ "northwind.com", "www.northwind.com" ], "not_before": "2025-12-30T12:00:00.000000Z", "not_after": "2026-03-30T12:00:00.000000Z", "purpose": "tls_server", "key_algo": "rsa", "key_bits": 2048, "sig_algo": "SHA256-RSA", "trust": "public", "validation": "DV", "is_wildcard": false, "is_multi_san": true, "managed": true, "renewal_source": "Let's Encrypt (R3)", "classification_override": null, "status": "valid", "superseded_by_id": null, "dismissed_at": null, "deployment_locations": [ { "endpoint": "northwind.com:443", "last_seen": "2026-01-15T11:50:00+00:00", "first_seen": "2026-01-08T12:00:00+00:00" } ], "owner": null, "notes": null, "first_seen_at": "2025-11-16T12:00:00.000000Z", "last_seen_at": "2026-01-15T06:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subject_org": null, "subject_location": null, "chain": [ { "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "is_ca": false, "self_signed": false, "not_after": "2026-03-30T12:00:00+00:00", "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9" }, { "subject": "Let's Encrypt (R3)", "issuer": "ISRG Root X1", "is_ca": true, "self_signed": false, "not_after": "2030-01-15T12:00:00+00:00", "fingerprint": "e04ca19ed66485fb479283c98fbfb4cda1ab67de1965304902bec3f6a55a2c8e" } ], "chain_status": "trusted", "sources": [ { "source": "probe", "last_seen": "2026-01-15T06:00:00+00:00", "first_seen": "2025-11-16T12:00:00+00:00" } ], "crl_url": null, "ocsp_url": null, "caa_status": "ok", "caissuer_url": "http://r3.i.lencr.org/", "no_auto_merge": false, "price_yearly": "0.00", "price_source": "manual", "price_currency": "EUR", "billing_interval": "yearly", "interval_count": 1, "renewal_type": "automatic", "renewal_type_basis": "guess", "served_status": "served", "served_checked_at": "2026-01-15T11:50:00.000000Z", "subscription_ends_at": null, "seller": null, "role": null, "ct_finding": null, "owner_user_id": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "put": { "summary": "Update a monitor", "operationId": "putApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_id", "description": "Changes only the fields you send; keys inside `settings` are merged rather than replaced. Refused when a new interval, check type or set of regions is beyond your plan.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Marketing site", "type": "http", "target": "https://northwind.com", "enabled": true, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "alert_channels_count": 1, "interval_minutes": 5 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "server_id": { "type": "integer", "description": "Must match an existing stored value.", "example": 16, "nullable": true }, "server_link_auto": { "type": "boolean", "description": "", "example": true }, "type": { "type": "string", "description": "", "example": "http", "enum": [ "http", "port", "ssl", "dns", "keyword", "redirect", "ping", "api", "heartbeat", "third_party" ] }, "external_component_ids": { "type": "array", "description": "Must not be greater than 255 characters.", "example": [ "n" ], "items": { "type": "string" } }, "external_alerts_enabled": { "type": "boolean", "description": "", "example": true }, "target": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "g" }, "interval_seconds": { "type": "integer", "description": "", "example": 30, "enum": [ 30, 60, 120, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 86400 ] }, "enabled": { "type": "boolean", "description": "", "example": true }, "pagerduty_down_severity": { "type": "string", "description": "", "example": "critical", "enum": [ "critical", "error", "warning", "info" ] }, "pagerduty_degraded_severity": { "type": "string", "description": "", "example": "critical", "enum": [ "critical", "error", "warning", "info" ] }, "flap_threshold": { "type": "integer", "description": "Must be at least 1. Must not be greater than 10.", "example": 6 }, "region_consensus_threshold": { "type": "integer", "description": "Must be at least 1. Must not be greater than 10.", "example": 7, "nullable": true }, "preferred_regions": { "type": "array", "description": "", "example": [ "EU" ], "items": { "type": "string", "enum": [ "EU", "NA", "APAC", "auto" ] } }, "probe_mode": { "type": "string", "description": "", "example": "any", "enum": [ "any", "all" ] }, "ip_version": { "type": "string", "description": "", "example": "ipv4", "enum": [ "ipv4", "ipv6", "prefer_ipv4", "prefer_ipv6" ] }, "slow_response_ms": { "type": "integer", "description": "Must be at least 50. Must not be greater than 30000.", "example": 15, "nullable": true }, "ssl_check_enabled": { "type": "boolean", "description": "", "example": true }, "ssl_expiry_days": { "type": "integer", "description": "Must be at least 1. Must not be greater than 90.", "example": 8, "nullable": true }, "settings": { "type": "object", "description": "", "properties": { "method": { "type": "string", "description": "", "example": "GET", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "DELETE" ] }, "expected_status_codes": { "type": "array", "description": "Must be between 100 and 599.", "example": [ 101 ], "items": { "type": "integer" } }, "expected_status": { "type": "integer", "description": "Must be between 100 and 599.", "example": 101 }, "timeout_seconds": { "type": "integer", "description": "Must be at least 1. Must not be greater than 60.", "example": 5 }, "follow_redirects": { "type": "boolean", "description": "", "example": true }, "auth_type": { "type": "string", "description": "", "example": "", "enum": [ "", "basic", "bearer", "digest" ], "nullable": true }, "auth_username": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "j", "nullable": true }, "auth_password": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "n", "nullable": true }, "auth_token": { "type": "string", "description": "Must not be greater than 1000 characters.", "example": "i", "nullable": true }, "request_body": { "type": "string", "description": "Must not be greater than 10000 characters.", "example": "k", "nullable": true }, "request_headers": { "type": "array", "description": "Must not be greater than 1000 characters.", "example": [ "h" ], "items": { "type": "string" } }, "keyword": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "w", "nullable": true }, "keyword_match": { "type": "string", "description": "", "example": "contains", "enum": [ "contains", "not_contains", "regex" ] }, "port": { "type": "integer", "description": "Must be at least 1. Must not be greater than 65535.", "example": 22 }, "warning_days": { "type": "integer", "description": "Must be at least 1. Must not be greater than 90.", "example": 24 }, "record_type": { "type": "string", "description": "Must not be greater than 10 characters.", "example": "kcmyuw" }, "expected_value": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "p", "nullable": true }, "expected_url": { "type": "string", "description": "Must not be greater than 500 characters.", "example": "http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis", "nullable": true }, "packet_count": { "type": "integer", "description": "Must be at least 1. Must not be greater than 10.", "example": 7 }, "nameserver": { "type": "string", "description": "Must not be greater than 253 characters.", "example": "q", "nullable": true }, "assertions": { "type": "array", "description": "", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "", "example": "json_path", "enum": [ "json_path", "response_time" ] }, "path": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "d", "nullable": true }, "operator": { "type": "string", "description": "", "example": "equals", "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "exists", "not_exists" ] }, "value": { "type": "string", "description": "", "example": null, "nullable": true } } } }, "grace_period_seconds": { "type": "integer", "description": "Must be at least 0. Must not be greater than 86400.", "example": 18 } } } } }, "example": { "interval_seconds": 300 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a monitor", "operationId": "deleteApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_id", "description": "Permanently deletes the monitor. A monitor locked because it is over your plan’s limit cannot be deleted this way.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/results": { "get": { "summary": "List a monitor’s check results", "operationId": "getApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idResults", "description": "The monitor’s check results, newest first. With `resolution=raw` (the default) each result is one check by one probe, filterable by `status`; individual results are kept for 3 days. With `resolution=hour` or `day` each row sums one hour or one day across probes: checks by outcome (`checks_up`, `checks_degraded` for slow checks, `checks_down` for failures), `up_percent` and the p50 and p95 response times, reaching back as far as your plan keeps history. Set the window with `from` and `to` (ISO 8601; default: everything kept for raw, the last 24 hours for hours, the last 30 days for days), narrow it to one probe `region`, and page with `page` and `per_page` (up to 500, default 50). A range longer than the resolution allows — 3 days raw, 31 days by hour, 366 days by day — is refused with `range_too_large`. `window` repeats the range that was applied.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "resolution", "description": "`raw` (each check, the default), `hour` or `day` (summed across probes).", "example": "hour", "required": false, "schema": { "type": "string", "description": "`raw` (each check, the default), `hour` or `day` (summed across probes).", "example": "hour" } }, { "in": "query", "name": "from", "description": "Start of the window, ISO 8601.", "example": "2026-01-15T09:30:00", "required": false, "schema": { "type": "string", "description": "Start of the window, ISO 8601.", "example": "2026-01-15T09:30:00" } }, { "in": "query", "name": "to", "description": "End of the window, ISO 8601; default now.", "example": "2026-01-15T09:30:00", "required": false, "schema": { "type": "string", "description": "End of the window, ISO 8601; default now.", "example": "2026-01-15T09:30:00" } }, { "in": "query", "name": "status", "description": "Raw results only: only this status (`up`, `down`, `degraded`).", "example": "down", "required": false, "schema": { "type": "string", "description": "Raw results only: only this status (`up`, `down`, `degraded`).", "example": "down" } }, { "in": "query", "name": "region", "description": "Only results from probes in this region.", "example": "eu", "required": false, "schema": { "type": "string", "description": "Only results from probes in this region.", "example": "eu" } }, { "in": "query", "name": "per_page", "description": "Rows per page, 1 to 500. Default 50.", "example": 100, "required": false, "schema": { "type": "integer", "description": "Rows per page, 1 to 500. Default 50.", "example": 100 } }, { "in": "query", "name": "page", "description": "Page number, from 1.", "example": 1, "required": false, "schema": { "type": "integer", "description": "Page number, from 1.", "example": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 1, "monitoring_check_id": 1, "status": "up", "response_time_ms": 180, "status_code": 200, "message": "HTTP 200 — OK", "checked_at": "2026-01-15T12:00:00.000000Z", "meta": null, "probe_id": null, "is_failover": false, "failover_from_region": null, "ssl_fingerprint": null, "ssl_expires_at": null, "scheduled_for": null, "suppressed_by_probe": false, "reason_code": null, "reason_params": null }, { "id": 2, "monitoring_check_id": 1, "status": "up", "response_time_ms": 191, "status_code": 200, "message": "HTTP 200 — OK", "checked_at": "2026-01-15T11:55:00.000000Z", "meta": null, "probe_id": null, "is_failover": false, "failover_from_region": null, "ssl_fingerprint": null, "ssl_expires_at": null, "scheduled_for": null, "suppressed_by_probe": false, "reason_code": null, "reason_params": null } ], "first_page_url": "http://localhost/api/organizations/1/monitoring-checks/1/results?page=1", "from": 1, "last_page": 12, "last_page_url": "http://localhost/api/organizations/1/monitoring-checks/1/results?page=12", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/monitoring-checks/1/results?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": "http://localhost/api/organizations/1/monitoring-checks/1/results?page=2", "path": "http://localhost/api/organizations/1/monitoring-checks/1/results", "per_page": 50, "prev_page_url": null, "to": 50, "total": 576, "window": { "from": null, "to": null, "resolution": "raw" } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "per_page": { "type": "string", "description": "" }, "page": { "type": "integer", "description": "Must be at least 1.", "example": 16 } } } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/alerts": { "post": { "summary": "Attach an alert channel to a monitor", "operationId": "postApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idAlerts", "description": "Sends this monitor’s alerts to the alert channel in `alert_channel_id`, which must belong to your organization. Refused if the channel is already attached.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Ops team — email", "type": "email", "settings": { "email": "ops@northwind.example" }, "enabled": true, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subscriptions": [ "monitoring_down", "monitoring_recovered" ], "is_personal": false, "user_id": null, "format": "html", "last_sent_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "consecutive_failures": 0, "last_failure_at": null, "last_error": null, "last_error_type": null, "broken_since": null, "broken_notified_at": null, "broken_notify_count": 0, "awaiting_confirmation_at": null, "categories": null, "telegram_link_id": null, "telegram_chat_id": null, "slack_installation_id": null, "slack_channel_id": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "alert_channel_id": { "type": "integer", "description": "", "example": 16 } }, "required": [ "alert_channel_id" ] }, "example": { "alert_channel_id": 1 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/alerts/{alertChannel_id}": { "delete": { "summary": "Detach an alert channel from a monitor", "operationId": "deleteApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idAlertsAlertChannel_id", "description": "Stops sending this monitor’s alerts to the channel. A monitor with no channels left keeps running, but no channel receives its alerts.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "alertChannel_id", "required": true, "description": "The alertChannel's ID.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/run": { "post": { "summary": "Run a monitor now", "operationId": "postApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idRun", "description": "Queues an immediate check of the monitor and answers 202 straight away; the result appears in its results once the check has run. Limited by your plan’s hourly allowance of manual checks.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "202": { "description": "OK", "content": { "application/json": { "example": { "message": "Check queued." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/pause": { "post": { "summary": "Pause a monitor", "operationId": "postApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idPause", "description": "Stops the monitor from running until you resume it, and returns the updated monitor.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Marketing site", "type": "http", "target": "https://northwind.com", "enabled": false, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "interval_minutes": 5 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/resume": { "post": { "summary": "Resume a monitor", "operationId": "postApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idResume", "description": "Starts a paused monitor again, queues a check straight away and returns the updated monitor.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Marketing site", "type": "http", "target": "https://northwind.com", "enabled": true, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "interval_minutes": 5 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/clone": { "post": { "summary": "Copy a monitor", "operationId": "postApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idClone", "description": "Creates a copy named with “(copy)” appended, with the same settings but no history. The copy starts paused, and counts against your plan like any new monitor.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "organization_id": 1, "name": "Marketing site (copy)", "type": "http", "target": "https://northwind.com", "enabled": false, "settings": [], "deleted_at": null, "flap_threshold": 2, "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": 1, "server_link": "inferred", "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 16, "alert_channels_count": 0, "interval_minutes": 5 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/stats": { "get": { "summary": "Get a monitor’s uptime and response-time stats", "operationId": "getApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idStats", "description": "Uptime for the last 24 hours, 7 days and 30 days, incident counts, response-time figures and chart series for the chosen `period` (`24h`, `7d` or `30d`, default `24h`). Pass `region` to narrow the figures to one probe region; the regions with data are listed in `regions`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "uptime": { "24h": null, "7d": null, "30d": null }, "chart_data": [ { "time": "2026-01-14T12:00:00+00:00", "avg": 176, "min": 164, "max": 186 }, { "time": "2026-01-14T13:00:00+00:00", "avg": 167, "min": 154, "max": 178 } ], "uptime_chart_data": [ { "time": "2026-01-14T12:00:00+00:00", "up": 12, "total": 12, "degraded": 0, "down_seconds": 0, "status": "up" }, { "time": "2026-01-14T13:00:00+00:00", "up": 12, "total": 12, "degraded": 0, "down_seconds": 0, "status": "up" } ], "period": "24h", "response_time": { "avg": 180, "min": 137, "max": 223 }, "incident_stats": { "24h": { "count": 0, "down_minutes": 0 }, "7d": { "count": 1, "down_minutes": 15 }, "30d": { "count": 1, "down_minutes": 15 } }, "regions": [], "region": null, "chart_by_region": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/aggregates": { "get": { "summary": "Get a monitor’s uptime and response times for a period", "operationId": "getApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idAggregates", "description": "Totals for one window: `uptime_percent` (the share of the time no confirmed outage covered, the figure the app shows), `up_percent` (the share of checks that came back up), checks by outcome, p50 and p95 response time in milliseconds, and the number and minutes of unplanned incidents. Pick `period` (`24h`, `7d`, `30d` or `90d`, default `24h`) or set `from` and `to` (ISO 8601, at most 366 days apart; longer is refused with `range_too_large`); the window starts on the hour `from` falls in. Pass `region` for one probe region, where `uptime_percent` is the share of checks that were up. Response times over more than one hour or probe are averaged from hourly figures, weighted by the number of checks, so they are close rather than exact. `uptime_percent` is null when nothing was measured.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "period", "description": "`24h`, `7d`, `30d` or `90d`. Default `24h`; ignored when `from` or `to` is sent.", "example": "7d", "required": false, "schema": { "type": "string", "description": "`24h`, `7d`, `30d` or `90d`. Default `24h`; ignored when `from` or `to` is sent.", "example": "7d" } }, { "in": "query", "name": "from", "description": "Start of the window, ISO 8601; rounded down to the hour.", "example": "2026-01-15T09:30:00", "required": false, "schema": { "type": "string", "description": "Start of the window, ISO 8601; rounded down to the hour.", "example": "2026-01-15T09:30:00" } }, { "in": "query", "name": "to", "description": "End of the window, ISO 8601; default now.", "example": "2026-01-15T09:30:00", "required": false, "schema": { "type": "string", "description": "End of the window, ISO 8601; default now.", "example": "2026-01-15T09:30:00" } }, { "in": "query", "name": "region", "description": "Only checks from probes in this region.", "example": "eu", "required": false, "schema": { "type": "string", "description": "Only checks from probes in this region.", "example": "eu" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "monitoring_check_id": 1, "period": "24h", "from": "2026-01-14T12:00:00Z", "to": "2026-01-15T12:00:00Z", "region": null, "uptime_percent": null, "up_percent": 100, "checks": { "total": 288, "up": 288, "degraded": 0, "down": 0 }, "response_time_ms": { "p50": 180, "p95": 288 }, "incidents": { "count": 0, "down_minutes": 0 } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "string", "description": "" } } } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/reach": { "get": { "summary": "Get who an outage alert would reach", "operationId": "gETmonitoringCheckscheckreachWhetherAnOutageOnThisMonitorWouldReachAnybody3167stateIsOkNobodyFailingWithTheDestinationsTheDispatcherWouldUseAndHowManyMembersTakeTheStatusMailAnsweredByTheDispatchersOwnResolutionseeMonitorReach", "description": "Whether an outage on this monitor would reach anybody right now: `state` is `ok`, `nobody` or `failing`, with the alert channels it would use, how many members get the status email, and whether it would escalate.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "state": "ok", "channels": [ { "id": 1, "name": "Ops team — email", "type": "email", "failing": false }, { "id": 2, "name": "On-call — critical only", "type": "email", "failing": false } ], "members": 4, "escalation": { "via": "pagerduty" } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/incidents": { "get": { "summary": "List a monitor’s incidents", "operationId": "getApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idIncidents", "description": "The monitor’s 20 most recent incidents, newest first, with their status, impact, start and end times and duration.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 2, "source": "monitor", "title": "Brief marketing-site blip", "status": "resolved", "impact": "minor", "started_at": "2026-01-09T11:45:00.000000Z", "resolved_at": "2026-01-09T12:00:00.000000Z", "duration_seconds": 900, "cause": null, "description": null, "external_status": null, "external_url": null, "is_planned": false, "acknowledged_at": null } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/incidents/{incident_id}": { "patch": { "summary": "Edit a monitor incident", "operationId": "patchApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idIncidentsIncident_id", "description": "Changes an incident’s `description`, or marks it as planned with `is_planned`, which takes it out of uptime figures and the status page’s incident history. Incidents imported from a third-party status page cannot be edited.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "incident_id", "required": true, "description": "The incident's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 2, "monitoring_check_id": 1, "started_at": "2026-01-09T11:45:00.000000Z", "resolved_at": "2026-01-09T12:00:00.000000Z", "duration_seconds": 900, "cause": null, "affected_probe_ids": null, "acknowledged_at": null, "acknowledged_by": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "description": "Caused by an expired upstream certificate.", "is_planned": false, "title": "Brief marketing-site blip", "status": "resolved", "impact": "minor", "source": "monitor", "server_id": null, "cloud_server_alert_rule_id": null, "external_status": null, "external_url": null, "alert_rule_state_id": null, "folded_into": null, "unstable_at": null, "unstable_ended_at": null, "outage_count": 1, "down_since": null, "downtime_seconds": 0, "outages": null, "acknowledged_by_name": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Must not be greater than 2000 characters.", "example": "Eius et animi quos velit et.", "nullable": true }, "is_planned": { "type": "boolean", "description": "", "example": true, "nullable": true } } }, "example": { "description": "Caused by an expired upstream certificate.", "is_planned": false } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/silence": { "post": { "summary": "Silence a monitor’s alerts", "operationId": "postApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idSilence", "description": "Mutes the monitor’s alerts for `duration_minutes` (1 to 10,080), or until you unsilence it when you leave that out. The monitor keeps running.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Marketing site", "type": "http", "target": "https://northwind.com", "enabled": true, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": "2026-01-15T13:00:00.000000Z", "silenced_by": 1, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "interval_minutes": 5 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "duration_minutes": { "type": "integer", "description": "Must be at least 1. Must not be greater than 10080.", "example": 1, "nullable": true } } }, "example": { "duration_minutes": 60 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] }, "delete": { "summary": "Unsilence a monitor’s alerts", "operationId": "deleteApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idSilence", "description": "Lifts a silence straight away so the monitor’s alerts are sent again, and returns the updated monitor.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Marketing site", "type": "http", "target": "https://northwind.com", "enabled": true, "settings": [], "last_status": "up", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 200 — OK", "consecutive_failures": 0, "flap_threshold": 2, "last_status_changed_at": "2026-01-14T12:00:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "interval_minutes": 5 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/affected": { "get": { "summary": "List what an external service affects", "operationId": "WhatThisAffectsTheBlastRadiusOfAnExternalStatusPage409Phase3", "description": "For a monitor that watches a third-party status page: the DNS zones, domains, monitors and servers of yours that depend on that service. Each has a `source` of `manual` (linked by you) or `auto` (zones and domains at the matching provider, detected by InfraNest).", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "provider": null, "resources": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Link a resource to an external service", "operationId": "pinOneOfTheOrgsResourcesToThisExternalServicesBlastRadiusAcceptsASuggestionaddTheAutoDetectedCloudflareZoneOrAnArbitraryManualLinkaMonitorServerTheHeuristicCantInfer", "description": "Records that one of your resources, given by `resource_type` and `resource_id`, depends on the third-party service this monitor watches. Only works on monitors that watch a third-party status page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "", "example": "architecto" }, "resource_id": { "type": "integer", "description": "", "example": 16 } }, "required": [ "resource_type", "resource_id" ] } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/affected/{type}/{resourceId}": { "delete": { "summary": "Unlink a resource from an external service", "operationId": "removeAManualAffectedResourcePin", "description": "Removes a resource you linked to the third-party service this monitor watches. Automatically detected links cannot be removed this way.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "type", "required": true, "description": "The type.", "schema": { "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "description": "The resourceId.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/uptime-report": { "get": { "summary": "Get the monthly uptime report", "operationId": "getApiOrganizationsOrganization_idUptimeReport", "description": "Uptime per monitor for one calendar month, with downtime, incidents, longest outage and the basis of each figure. Pass `month` as `YYYY-MM` (default: the last full month) and `tag` to limit it to monitors with that tag.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "month": "2025-12", "closed": true, "days_in_month": 31, "checks": [ { "id": 3, "name": "API health", "type": "http", "target": "https://api.northwind.com/health", "uptime_pct": 99.951, "downtime_minutes": 22, "incidents": 1, "longest_outage_minutes": 22, "monitored_minutes": 44640, "days_with_data": 31, "planned_minutes_excluded": 0, "probes": [], "started_monitoring": "2026-01-15" }, { "id": 2, "name": "App — northwind-app.dev", "type": "http", "target": "https://northwind-app.dev", "uptime_pct": 100, "downtime_minutes": 0, "incidents": 0, "longest_outage_minutes": 0, "monitored_minutes": 44640, "days_with_data": 31, "planned_minutes_excluded": 0, "probes": [], "started_monitoring": "2026-01-15" } ], "summary": { "checks": 13, "checks_measured": 12, "worst_uptime_pct": 99.951, "mean_uptime_pct": 99.996, "incidents": 1, "downtime_minutes": 22 }, "findings": [ { "key": "uptimeReport.findings.worst", "params": { "check": "API health", "percent": 99.951, "minutes": 22, "n": 1 }, "tone": "warning" }, { "key": "uptimeReport.findings.unmeasured", "params": { "n": 1, "total": 13 }, "tone": "warning" } ], "generated_at": "2026-01-15T12:00:00+00:00", "months": [ { "month": "2025-02", "closed": true, "checks": 13, "checks_measured": 0, "worst_uptime_pct": null, "mean_uptime_pct": null, "incidents": 0, "downtime_minutes": 0 }, { "month": "2025-03", "closed": true, "checks": 13, "checks_measured": 0, "worst_uptime_pct": null, "mean_uptime_pct": null, "incidents": 0, "downtime_minutes": 0 } ], "applied_filters": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status": { "get": { "summary": "Get the current status of everything", "operationId": "getApiOrganizationsOrganization_idStatus", "description": "Everything in your organization as it stands right now, in one call: every monitor with its `status` (`up`, `down`, `degraded`, `paused` or `unknown`), when it was last checked and its 24-hour uptime; every server with its state, whether its agent is reporting (null when no agent is installed) and how many of its alert rules are breaching; the open incidents; the maintenance windows running now; and counts of each in `summary`. Pass `tag` (a tag ID) to narrow it to monitors and servers with that tag, their incidents, and maintenance that carries the tag or covers them. `servers` is null when the token has no Cloud scope or your role cannot see servers.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "tag", "description": "Only monitors and servers with this tag, and what concerns them.", "example": 7, "required": false, "schema": { "type": "integer", "description": "Only monitors and servers with this tag, and what concerns them.", "example": 7 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "generated_at": "2026-01-15T12:00:00Z", "tag": null, "summary": { "monitors": { "total": 13, "up": 10, "down": 1, "degraded": 1, "paused": 1, "unknown": 0 }, "servers": { "total": 14, "running": 12, "agent_not_reporting": 0, "breaching": 0 }, "open_incidents": 1, "active_maintenance": 0 }, "monitors": [ { "id": 3, "name": "API health", "type": "http", "status": "up", "enabled": true, "silenced": false, "last_checked_at": "2026-01-15T11:58:00Z", "uptime_24h": 0 }, { "id": 2, "name": "App — northwind-app.dev", "type": "http", "status": "up", "enabled": true, "silenced": false, "last_checked_at": "2026-01-15T11:58:00Z", "uptime_24h": 0 } ], "servers": [ { "id": 13, "name": "analytics-01", "status": "stopped", "monitoring_enabled": false, "agent_reporting": null, "breaching_alerts": 0 }, { "id": 3, "name": "api-01", "status": "running", "monitoring_enabled": true, "agent_reporting": true, "breaching_alerts": 0 } ], "incidents": [ { "id": 1, "title": "Checkout returning 503", "status": "investigating", "impact": "major", "started_at": "2026-01-15T11:20:00Z", "acknowledged_at": null, "monitoring_check_id": 4, "server_id": null } ], "maintenance": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "integer", "description": "", "example": 16, "nullable": true } } } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/uptime-report/export": { "get": { "summary": "Download the monthly uptime report as CSV", "operationId": "theSameMonthAsACSVAuditedOnTheWayOut", "description": "The same report as a CSV file, one row per monitor. Takes the same `month` and `tag` parameters, and every download is recorded in your audit log.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The month's uptime report as CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/alert-channels": { "get": { "summary": "List alert destinations", "operationId": "getApiOrganizationsOrganization_idAlertChannels", "description": "Every place the organization sends alerts, such as email, Slack or Telegram, with how many checks use each and how many alerts it missed while it refused messages. Pass `personal=1` for only your own personal destinations.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "organization_id": 1, "name": "Ops team — email", "type": "email", "settings": { "email": "ops@northwind.example" }, "enabled": true, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subscriptions": [ "monitoring_down", "monitoring_recovered" ], "is_personal": false, "user_id": null, "format": "html", "last_sent_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "consecutive_failures": 0, "last_failure_at": null, "last_error": null, "last_error_type": null, "broken_since": null, "broken_notified_at": null, "broken_notify_count": 0, "awaiting_confirmation_at": null, "categories": null, "telegram_link_id": null, "telegram_chat_id": null, "slack_installation_id": null, "slack_channel_id": null, "checks_count": 0, "missed_alerts_count": 0, "missed_alerts_min_created_at": null, "needs_telegram_link": false }, { "id": 2, "organization_id": 1, "name": "On-call — critical only", "type": "email", "settings": { "email": "oncall@northwind.example", "critical_only": true }, "enabled": true, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subscriptions": [ "monitoring_down", "domain_expiry_critical" ], "is_personal": false, "user_id": null, "format": "html", "last_sent_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "consecutive_failures": 0, "last_failure_at": null, "last_error": null, "last_error_type": null, "broken_since": null, "broken_notified_at": null, "broken_notify_count": 0, "awaiting_confirmation_at": null, "categories": null, "telegram_link_id": null, "telegram_chat_id": null, "slack_installation_id": null, "slack_channel_id": null, "checks_count": 0, "missed_alerts_count": 0, "missed_alerts_min_created_at": null, "needs_telegram_link": false } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "alerts", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/alert-channels/{alertChannel_id}": { "get": { "summary": "Get an alert destination", "operationId": "getApiOrganizationsOrganization_idAlertChannelsAlertChannel_id", "description": "One alert destination with the checks that send to it.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "alertChannel_id", "required": true, "description": "The alertChannel's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Ops team — email", "type": "email", "settings": { "email": "ops@northwind.example" }, "enabled": true, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subscriptions": [ "monitoring_down", "monitoring_recovered" ], "is_personal": false, "user_id": null, "format": "html", "last_sent_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "consecutive_failures": 0, "last_failure_at": null, "last_error": null, "last_error_type": null, "broken_since": null, "broken_notified_at": null, "broken_notify_count": 0, "awaiting_confirmation_at": null, "categories": null, "telegram_link_id": null, "telegram_chat_id": null, "slack_installation_id": null, "slack_channel_id": null, "checks_count": 0, "checks": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Monitoring" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "alerts", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains/registrars/identities": { "get": { "summary": "List registrars available for catching", "operationId": "theOrgsEligibleRegistrarsByNameWithNothingBehindItThatCanBeSlow1211", "description": "The connected registrar accounts that can register a caught domain, by name, and whether each may race for it. Makes no calls to the registrars.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "registrars": [ { "credential_id": 2, "provider": "cloudflare", "provider_name": "Cloudflare", "provider_label": "Cloudflare DNS", "can_race": false }, { "credential_id": 3, "provider": "namecheap", "provider_name": "Namecheap", "provider_label": "Namecheap Registrar", "can_race": false } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains/registrars": { "get": { "summary": "List registrars for an extension", "operationId": "getApiOrganizationsOrganization_idWatchedDomainsRegistrars", "description": "The connected registrar accounts that can register a caught domain. With `tld`, each says whether it carries that extension and what it charges, and `requirements` lists what the extension asks of a registrant, or null when nothing is on file.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "registrars": [ { "credential_id": 2, "provider": "cloudflare", "provider_name": "Cloudflare", "provider_label": "Cloudflare DNS", "supports_tld": null, "price": null, "can_race": false }, { "credential_id": 3, "provider": "namecheap", "provider_name": "Namecheap", "provider_label": "Namecheap Registrar", "supports_tld": null, "price": null, "can_race": false } ], "requirements": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains/held": { "get": { "summary": "Check whether you already hold a domain", "operationId": "doesThisOrganisationAlreadyHoldTheNameBeingTypedIntoTheAddForm1724", "description": "The domain in your organization matching `name` and `tld` (both required) that you hold or are registering, or null when there is none.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "domain": { "id": 1, "full_name": "northwind.com", "status": "active", "tenure": "held", "registrar": "Namecheap", "expires_at": "2026-02-02T00:00:00+00:00", "auto_renew": true } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 63 characters.", "example": "b" }, "tld": { "type": "string", "description": "Must not be greater than 63 characters.", "example": "n" } }, "required": [ "name", "tld" ] } } } }, "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains": { "get": { "summary": "List watched domains", "operationId": "getApiOrganizationsOrganization_idWatchedDomains", "description": "Your watched domains, paginated with `per_page` (default 25, at most 200) and sorted with `sort` and `dir`. Filter with `search`, `tag` and flags such as `active`, `available`, `registered`, `failed`, `paused` and `in_auction`; `meta` carries counts per status.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 3, "organization_id": 1, "name": "northwind", "tld": "app", "priority": 5, "status": "available", "auto_register": true, "registrar": null, "consecutive_available_count": 0, "notes": null, "last_checked_at": "2026-01-15T09:00:00.000000Z", "available_since": null, "registered_at": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "next_check_at": "2026-01-15T13:00:00.000000Z", "observed_expires_at": null, "observed_status": null, "drop_eta": null, "date_visibility": null, "score": 88, "score_breakdown": null, "scored_at": "2026-01-15T12:00:00.000000Z", "registrar_preferences": null, "lifecycle_stage": "available", "observed_created_at": null, "contact_id": null, "extended_attributes": null, "catchability": 90, "catchability_signals": { "verdict": "available", "factors": [] }, "dns_signals": null, "observed_registrar": null, "observed_updated_at": null, "observed_nameservers": null, "lifecycle_progress": null, "http_signals": null, "enrichment_signals": null, "burst_until": null, "parallel_race": false, "in_auction": false, "auction": null, "backorder": false, "backorder_credential_id": null, "backorder_status": null, "whois_raw_at": null, "drop_eta_uncertainty_days": null, "lifecycle_source": null, "lifecycle_stage_since": "2026-01-10T12:00:00.000000Z", "published_drop_at": null, "deleted_at_registry": null, "dropping_soon_alerted_at": null, "last_successful_check_at": null, "consecutive_check_errors": 0, "check_failing_alerted_at": null, "funding": null, "funding_alerted_at": null, "full_name": "northwind.app", "drop_score": 5, "tags": [] }, { "id": 13, "organization_id": 1, "name": "northwind-app", "tld": "com", "priority": 5, "status": "failed", "auto_register": true, "registrar": null, "consecutive_available_count": 0, "notes": null, "last_checked_at": "2026-01-15T09:00:00.000000Z", "available_since": null, "registered_at": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "next_check_at": "2026-01-15T13:00:00.000000Z", "observed_expires_at": null, "observed_status": null, "drop_eta": null, "date_visibility": null, "score": 87, "score_breakdown": null, "scored_at": "2026-01-15T12:00:00.000000Z", "registrar_preferences": null, "lifecycle_stage": "active", "observed_created_at": null, "contact_id": null, "extended_attributes": null, "catchability": 30, "catchability_signals": { "verdict": "active", "factors": [] }, "dns_signals": null, "observed_registrar": null, "observed_updated_at": null, "observed_nameservers": null, "lifecycle_progress": null, "http_signals": null, "enrichment_signals": null, "burst_until": null, "parallel_race": false, "in_auction": false, "auction": null, "backorder": false, "backorder_credential_id": null, "backorder_status": null, "whois_raw_at": null, "drop_eta_uncertainty_days": null, "lifecycle_source": null, "lifecycle_stage_since": "2026-01-09T12:00:00.000000Z", "published_drop_at": null, "deleted_at_registry": null, "dropping_soon_alerted_at": null, "last_successful_check_at": null, "consecutive_check_errors": 0, "check_failing_alerted_at": null, "funding": null, "funding_alerted_at": null, "full_name": "northwind-app.com", "drop_score": 5, "tags": [] } ], "first_page_url": "http://localhost/api/organizations/1/watched-domains?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/watched-domains?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/watched-domains?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/watched-domains", "per_page": 25, "prev_page_url": null, "to": 16, "total": 16, "meta": { "counts": { "total": 16, "active": 13, "available": 2, "registered": 1, "failed": 1, "paused": 1, "in_auction": 1, "not_armed": 8 }, "tags": [] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains/{watchedDomain_id}": { "get": { "summary": "Get a watched domain", "operationId": "getApiOrganizationsOrganization_idWatchedDomainsWatchedDomain_id", "description": "One watched domain with its stored WHOIS record, lifecycle dates, estimated drop date, the check schedule still ahead and drop statistics for its extension.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "watchedDomain_id", "required": true, "description": "The watchedDomain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "northwind-labs", "tld": "com", "priority": 5, "status": "watching", "auto_register": false, "registrar": null, "consecutive_available_count": 0, "notes": null, "last_checked_at": "2026-01-15T09:00:00.000000Z", "available_since": null, "registered_at": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "next_check_at": "2026-01-15T13:00:00.000000Z", "observed_expires_at": "2025-11-13T12:00:00.000000Z", "observed_status": null, "drop_eta": "2026-01-27T12:00:00.000000Z", "date_visibility": null, "score": 84, "score_breakdown": null, "scored_at": "2026-01-15T12:00:00.000000Z", "registrar_preferences": null, "lifecycle_stage": "redemption", "observed_created_at": null, "contact_id": null, "extended_attributes": null, "catchability": 78, "catchability_signals": { "verdict": "likely", "factors": [] }, "dns_signals": null, "observed_registrar": null, "observed_updated_at": null, "observed_nameservers": null, "lifecycle_progress": null, "http_signals": null, "enrichment_signals": null, "burst_until": null, "parallel_race": false, "in_auction": false, "auction": null, "backorder": false, "backorder_credential_id": null, "backorder_status": null, "whois_raw": null, "whois_raw_at": null, "drop_eta_uncertainty_days": null, "lifecycle_source": null, "lifecycle_stage_since": "2026-01-12T12:00:00.000000Z", "published_drop_at": null, "deleted_at_registry": null, "dropping_soon_alerted_at": null, "last_successful_check_at": null, "consecutive_check_errors": 0, "check_failing_alerted_at": null, "funding": null, "funding_alerted_at": null, "check_logs_count": 0, "registration_logs_count": 0, "full_name": "northwind-labs.com", "drop_score": 5, "tags": [], "drop_stats": { "heuristic": 78, "probability": null, "basis_n": 0, "scope": null, "phase": "redemption", "tld": "com" }, "lifecycle_anchors": { "registered": null, "expired": "2025-11-13T12:00:00+00:00", "redemption": "2025-12-28T12:00:00+00:00", "pending_delete": "2026-01-27T12:00:00+00:00", "drop": "2026-02-01T12:00:00+00:00" }, "measured_samples": null, "release": null, "cadence": [ { "starts_at": null, "every_seconds": 21600 }, { "starts_at": "2026-01-25T12:00:00+00:00", "every_seconds": 3600 } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains/{watchedDomain_id}/check-logs": { "get": { "summary": "List availability checks", "operationId": "getApiOrganizationsOrganization_idWatchedDomainsWatchedDomain_idCheckLogs", "description": "Every availability check run on the watched domain, newest first, 100 per page. Filter with `status`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "watchedDomain_id", "required": true, "description": "The watchedDomain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [], "first_page_url": "http://localhost/api/organizations/1/watched-domains/1/check-logs?page=1", "from": null, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/watched-domains/1/check-logs?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/watched-domains/1/check-logs?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/watched-domains/1/check-logs", "per_page": 100, "prev_page_url": null, "to": null, "total": 0 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains/{watchedDomain_id}/registration-logs": { "get": { "summary": "List registration attempts", "operationId": "getApiOrganizationsOrganization_idWatchedDomainsWatchedDomain_idRegistrationLogs", "description": "Every attempt to register the watched domain, newest first, 50 per page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "watchedDomain_id", "required": true, "description": "The watchedDomain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [], "first_page_url": "http://localhost/api/organizations/1/watched-domains/1/registration-logs?page=1", "from": null, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/watched-domains/1/registration-logs?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/watched-domains/1/registration-logs?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/watched-domains/1/registration-logs", "per_page": 50, "prev_page_url": null, "to": null, "total": 0 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/watched-domains/{watchedDomain_id}/whois-changes": { "get": { "summary": "List WHOIS changes", "operationId": "getApiOrganizationsOrganization_idWatchedDomainsWatchedDomain_idWhoisChanges", "description": "Changes detected in the watched domain’s WHOIS record, newest first, 50 per page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "watchedDomain_id", "required": true, "description": "The watchedDomain's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 1, "watched_domain_id": 1, "field": "status", "old_value": "clientTransferProhibited", "new_value": "redemptionPeriod", "changed_at": "2026-01-11T12:00:00.000000Z" }, { "id": 2, "watched_domain_id": 1, "field": "expiry", "old_value": "2026-08-14", "new_value": "2026-08-14", "changed_at": "2025-12-20T12:00:00.000000Z" } ], "first_page_url": "http://localhost/api/organizations/1/watched-domains/1/whois-changes?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/watched-domains/1/whois-changes?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/watched-domains/1/whois-changes?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/watched-domains/1/whois-changes", "per_page": 50, "prev_page_url": null, "to": 3, "total": 3 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/whois-servers": { "get": { "summary": "List custom WHOIS servers", "operationId": "getApiOrganizationsOrganization_idWhoisServers", "description": "The WHOIS servers you set per extension to use instead of the default ones, sorted by extension.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "organization_id": 1, "tld": "dev", "server": "whois.nic.google", "note": "Override for .dev lookups.", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Drop Catch" ], "x-infranest-scope": "drop-catch.read", "x-infranest-token-writable": false, "x-infranest-module": "drop-catch", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/audit-logs": { "get": { "summary": "List audit log entries", "operationId": "getApiOrganizationsOrganization_idAuditLogs", "description": "Who changed what in the organization, newest first. Filter with the dates `from` and `to`, `action` (matches part of the name), `resource_type` and `token_id` for changes made through one API token; page with `per_page` (default 25, at most 100) and `page`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 25, "organization_id": 1, "user_id": 1, "action": "status_page_subscribers.viewed", "resource_type": "StatusPage", "resource_id": 1, "meta": { "count": 3, "status_page": "Northwind Cloud Status" }, "ip_address": "127.0.0.1", "user_agent": "Symfony", "created_at": "2026-01-15T12:00:00.000000Z", "impersonator_id": null, "via_token_id": 5, "via_token_name": "api-samples", "user": { "id": 1, "name": "Alex Rivera", "email": "demo@example.com", "analytics_id": null }, "impersonator": null }, { "id": 24, "organization_id": 1, "user_id": 1, "action": "data.exported", "resource_type": null, "resource_id": null, "meta": { "month": "2025-12", "format": "csv", "filters": [], "resource": "uptime-report" }, "ip_address": "127.0.0.1", "user_agent": "Symfony", "created_at": "2026-01-15T12:00:00.000000Z", "impersonator_id": null, "via_token_id": 5, "via_token_name": "api-samples", "user": { "id": 1, "name": "Alex Rivera", "email": "demo@example.com", "analytics_id": null }, "impersonator": null } ], "first_page_url": "http://localhost/api/organizations/1/audit-logs?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/audit-logs?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/audit-logs?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/audit-logs", "per_page": 25, "prev_page_url": null, "to": 24, "total": 24 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Audit Log" ], "x-infranest-scope": "audit-log.read", "x-infranest-token-writable": false, "x-infranest-module": "audit-log", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/audit-logs/export": { "get": { "summary": "Export the audit log as CSV", "operationId": "getApiOrganizationsOrganization_idAuditLogsExport", "description": "Downloads every matching entry as a CSV file, with the same filters as the list and no paging. The export is itself recorded in the audit log.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The matching audit log entries as CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Audit Log" ], "x-infranest-scope": "audit-log.read", "x-infranest-token-writable": false, "x-infranest-module": "audit-log", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/subscription": { "get": { "summary": "Get the subscription", "operationId": "getApiOrganizationsOrganization_idSubscription", "description": "The organization’s subscription and plan, the plan whose limits currently apply, whether a free trial is still available and any discount in force. Read-only; returns 404 when there is no subscription.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "plan_id": 2, "status": "active", "provider": "stripe", "provider_subscription_id": "sub_demo_northwind", "trial_ends_at": null, "current_period_start": "2026-01-01T00:00:00.000000Z", "current_period_end": "2026-02-15T12:00:00.000000Z", "canceled_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "cancel_at_period_end": false, "stripe_price_id": null, "currency": "eur", "trial_reminder_sent_at": null, "renewal_reminder_sent_at": null, "card_expiry_reminder_sent_at": null, "addons": [], "card_on_file": false, "trial_recap_sent_at": null, "trial_last_call_sent_at": null, "trial_first_steps_sent_at": null, "trial_ended_at": null, "trial_reactivation_sent_at": null, "recap_period_start": null, "renewal_recap_sent_for": null, "discount_code": null, "discount_percent": null, "discount_amount_off": null, "discount_duration": null, "discount_starts_at": null, "discount_ends_at": null, "discount_label": null, "plan": { "id": 2, "name": "Pro", "slug": "pro", "description": "For freelancers & solo devs — faster checks, cloud, API and automations.", "limits": { "api": true, "rate": { "manual_sync_per_hour": 30, "domain_checks_per_hour": 100, "monitor_checks_per_hour": 120, "provider_api_per_minute": 300 }, "cloud": true, "api.mcp": true, "domains": 100, "servers": 10, "api.read": true, "monitors": 50, "webhooks": true, "api.write": true, "dns.drift": true, "dns_zones": 100, "drop_catch": true, "automations": 25, "data_import": true, "dynamic_ips": 10, "certificates": 100, "status_pages": 3, "team_members": 3, "cloud.backups": true, "cloud.volumes": true, "dns.templates": true, "organizations": 1, "api.tokens_max": 5, "cloud.firewalls": true, "cloud.snapshots": true, "watched_domains": 50, "cloud.volumes_max": 10, "external_monitors": 5, "dropcatch.register": true, "cloud.firewalls_max": 5, "audit.retention_days": 30, "domains.registration": true, "monitor_min_interval": 60, "monitoring.incidents": true, "monitoring.maintenance": true, "cloud.load_balancers_max": 0, "monitoring.calendar_feed": true, "monitoring.retention_days": 90, "status_page_custom_domain": true, "dns.history_retention_days": 90, "automations.premium_actions": true, "integrations.connections_max": 5 }, "price_monthly": 2250, "price_yearly": 22800, "active": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "is_public": true, "sort_order": 2, "stripe_product_id": null, "stripe_prices": null, "prices": { "eur": { "yearly": 22800, "monthly": 2250 } }, "trial_days": 0, "recommended": false, "name_i18n": null, "description_i18n": null, "badge": null, "tagline_i18n": { "de": "Freelancer & Solo-Entwickler", "en": "Freelancers & solo devs", "fr": "Freelances & développeurs solo", "nl": "Freelancers & solo-ontwikkelaars" }, "highlights_i18n": { "de": [ "Alles in Free", "100 Domains" ], "en": [ "Everything in Free", "100 domains" ], "fr": [ "Tout dans Free", "100 domaines" ], "nl": [ "Alles in Free", "100 domeinen" ] }, "contact_sales": false, "contact_url": null }, "effective_plan_id": 2, "effective_plan_slug": "pro", "trial_available": true, "referral_welcome": null, "suggested_promotion_code": null, "discount": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Billing" ], "x-infranest-scope": "billing.read", "x-infranest-token-writable": false, "x-infranest-module": "billing", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/subscription/addons": { "get": { "summary": "List add-ons", "operationId": "gETsubscriptionaddonsPublicAddOnsWithPrices+WhichAreActiveForThisOrg177", "description": "The add-ons on offer with their prices, each marked `owned` when the organization already has it. Read-only.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Billing" ], "x-infranest-scope": "billing.read", "x-infranest-token-writable": false, "x-infranest-module": "billing", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/invoices": { "get": { "summary": "List invoices", "operationId": "gETinvoicesTheOrgsInvoicesbackfilledFromStripeSoHistoryShows", "description": "Your most recent 100 invoices, newest first, with their status, totals, billing period and links to view or download each one. Read-only.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 6, "number": "INF-2026-0100", "status": "paid", "currency": "eur", "total": 4719, "tax": 819, "paid_at": "2026-01-02T00:00:00.000000Z", "hosted_invoice_url": null, "invoice_pdf": null, "period_start": "2026-01-01T00:00:00.000000Z", "period_end": "2026-01-31T23:59:59.000000Z", "created_at": "2026-01-01T00:00:00.000000Z" }, { "id": 5, "number": "INF-2025-0101", "status": "paid", "currency": "eur", "total": 4719, "tax": 819, "paid_at": "2025-12-02T00:00:00.000000Z", "hosted_invoice_url": null, "invoice_pdf": null, "period_start": "2025-12-01T00:00:00.000000Z", "period_end": "2025-12-31T23:59:59.000000Z", "created_at": "2025-12-01T00:00:00.000000Z" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Billing" ], "x-infranest-scope": "billing.read", "x-infranest-token-writable": false, "x-infranest-module": "billing", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/credit-notes": { "get": { "summary": "List credit notes", "operationId": "gETcreditNotesTheReversingHalfOfTheOrgsBillingHistory642", "description": "Credit notes issued against your invoices, with the invoice each one credits, its amounts (negative, in the currency’s smallest unit), how it was settled and a PDF link. Read-only.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Billing" ], "x-infranest-scope": "billing.read", "x-infranest-token-writable": false, "x-infranest-module": "billing", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/account-credit": { "get": { "summary": "Get account credit", "operationId": "gETaccountCreditMoneyWeOweThemPerCurrency662", "description": "Money InfraNest holds for you — for example after a downgrade or a refund — which comes off your next invoice. One balance per currency, in the currency’s smallest unit; empty when you have none. Read-only.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "credit": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Billing" ], "x-infranest-scope": "billing.read", "x-infranest-token-writable": false, "x-infranest-module": "billing", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/automations": { "get": { "summary": "List automations", "operationId": "getApiOrganizationsOrganization_idAutomations", "description": "Every automation, newest first, with its tags and run statistics: runs in the last 30 and 7 days, success rate, average duration and the last run’s status. Test runs are not counted.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "organization_id": 1, "name": "Release published → announce on status page", "trigger_event": "github.release", "conditions": [ { "op": "eq", "field": "action", "value": "published" }, { "op": "eq", "field": "prerelease", "value": "false" } ], "actions": [ { "action": "create_status_announcement", "config": { "body": "{{name}}.", "title": "Released: {{tag}}", "status_page_id": 1 } } ], "enabled": true, "cooldown_seconds": 0, "consecutive_failures": 0, "disabled_reason": null, "last_triggered_at": null, "created_by": 1, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "condition_match": "all", "run_as": "owner", "trigger_kind": "event", "schedule": null, "trigger_events": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "disabled_detail": null, "template_key": null, "tags": [], "runs_30d": 0, "runs_7d": 0, "success_rate": null, "avg_duration_ms": null, "last_status": null, "last_run_at": null, "spark": [ { "total": 0, "failed": 0 }, { "total": 0, "failed": 0 } ] }, { "id": 2, "organization_id": 1, "name": "PR merged to main → run deploy workflow", "trigger_event": "github.pull_request", "conditions": [ { "op": "eq", "field": "merged", "value": "true" }, { "op": "eq", "field": "base_branch", "value": "main" } ], "actions": [ { "action": "require_approval", "config": { "note": "Production deploy" } }, { "action": "github_trigger_workflow", "config": { "ref": "main", "repo": "northwind-cloud/app", "workflow": "deploy.yml", "connection_id": 2 } } ], "enabled": true, "cooldown_seconds": 0, "consecutive_failures": 0, "disabled_reason": null, "last_triggered_at": null, "created_by": 1, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "condition_match": "all", "run_as": "owner", "trigger_kind": "event", "schedule": null, "trigger_events": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "disabled_detail": null, "template_key": null, "tags": [], "runs_30d": 5, "runs_7d": 5, "success_rate": 40, "avg_duration_ms": 3000, "last_status": "awaiting_approval", "last_run_at": "2026-01-15T09:00:00.000000Z", "spark": [ { "total": 1, "failed": 1 }, { "total": 0, "failed": 0 } ] } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Automations" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "automations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/automations/{automationRule_id}": { "get": { "summary": "Get an automation", "operationId": "getApiOrganizationsOrganization_idAutomationsAutomationRule_id", "description": "One automation with its trigger, conditions, actions and tags, plus its 20 most recent runs and their steps.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "automationRule_id", "required": true, "description": "The automationRule's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Release published → announce on status page", "trigger_event": "github.release", "conditions": [ { "op": "eq", "field": "action", "value": "published" }, { "op": "eq", "field": "prerelease", "value": "false" } ], "actions": [ { "action": "create_status_announcement", "config": { "body": "{{name}}.", "title": "Released: {{tag}}", "status_page_id": 1 } } ], "enabled": true, "cooldown_seconds": 0, "consecutive_failures": 0, "disabled_reason": null, "last_triggered_at": null, "created_by": 1, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "condition_match": "all", "run_as": "owner", "trigger_kind": "event", "schedule": null, "trigger_events": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "disabled_detail": null, "template_key": null, "tags": [], "runs": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Automations" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "automations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/automations/{automationRule_id}/runs": { "get": { "summary": "List an automation’s runs", "operationId": "runHistorymostRecentFirstEachWithItsPerStepResults", "description": "The automation’s run history with each run’s steps, newest first, 25 per page. Filter with `status` and the dates `from` and `to`. Unless you may edit automations, what triggered each run is left out and `details_hidden` is true.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "automationRule_id", "required": true, "description": "The automationRule's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "details_hidden": false, "current_page": 1, "data": [], "first_page_url": "http://localhost/api/organizations/1/automations/1/runs?page=1", "from": null, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/automations/1/runs?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/automations/1/runs?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/automations/1/runs", "per_page": 25, "prev_page_url": null, "to": null, "total": 0 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Automations" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "automations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/automation-connections": { "get": { "summary": "List automation connections", "operationId": "theOrgsConnectionsnoSecrets", "description": "The accounts automations can act through, such as GitHub, Jira or PagerDuty, with each one’s status, whether it is paused and whether its triggers can fire.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "provider": "pagerduty", "kind": "oauth", "label": "Northwind on-call", "meta": { "service_name": "Platform — production", "account": "northwind", "auth": "oauth", "region": "us", "authorized_by": { "name": "Alex Rivera", "email": "demo@example.com" }, "webhook_subscription_id": "PD3WHS1" }, "status": "active", "paused": false, "triggers_on": false, "created_at": "2026-01-15T12:00:00+00:00" }, { "id": 2, "provider": "github", "kind": "github_app", "label": "northwind-cloud", "meta": { "installation_id": "20000001", "account": "northwind-cloud" }, "status": "active", "paused": false, "triggers_on": false, "created_at": "2026-01-15T12:00:00+00:00" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Automations" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "automations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/fixes/domains": { "get": { "summary": "Preview domains to add from certificates", "operationId": "gETcertificatesfixesdomainsTheNamesdomainNotListedSuggestsWhereEachIsRegisteredThePlansRoom", "description": "The domain names your certificates use that InfraNest does not track yet, where each is registered as far as is known, and the certificates that use it. Also says how many more domains your plan allows; nothing is changed.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "domains": [], "room": null, "allowed": true } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates": { "get": { "summary": "List certificates", "operationId": "getApiOrganizationsOrganization_idCertificates", "description": "Every TLS certificate in the organization, expired and expiring first, each with its health, findings and who renews it. Narrow it with `domain_id` or `monitoring_check_id`; the list is not paginated.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 10, "organization_id": 1, "source": "manual", "monitoring_check_id": null, "domain_id": null, "cloud_server_id": null, "provider_credential_id": null, "fingerprint": "61e58004edb797c08c1261beb441b56e31cc903bde63441cd503dca9aa79f099", "subject": "vpn.northwind.example", "issuer": "vpn.northwind.example", "serial": "EAABC774", "sans": [ "vpn.northwind.example" ], "not_before": "2025-01-03T12:00:00.000000Z", "not_after": "2026-01-03T12:00:00.000000Z", "purpose": "tls_server", "key_algo": "rsa", "key_bits": 4096, "sig_algo": "SHA256-RSA", "trust": "self_signed", "validation": "OV", "is_wildcard": false, "is_multi_san": false, "managed": false, "renewal_source": null, "classification_override": null, "status": "expired", "superseded_by_id": null, "dismissed_at": null, "deployment_locations": [], "owner": null, "notes": null, "first_seen_at": "2025-11-16T12:00:00.000000Z", "last_seen_at": "2026-01-15T06:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subject_org": null, "subject_location": null, "chain": null, "chain_status": null, "sources": [ { "source": "manual", "last_seen": "2026-01-15T06:00:00+00:00", "first_seen": "2025-11-16T12:00:00+00:00" } ], "crl_url": null, "ocsp_url": null, "caa_status": null, "caissuer_url": null, "no_auto_merge": false, "price_yearly": "0.00", "price_source": "manual", "price_currency": "EUR", "billing_interval": "yearly", "interval_count": 1, "renewal_type": "internal", "renewal_type_basis": "guess", "served_status": null, "served_checked_at": null, "subscription_ends_at": null, "seller": null, "role": null, "ct_finding": null, "owner_user_id": null, "custom_fields": [], "renewer": null, "findings": [ { "tier": "problem", "code": "expired", "severity": "critical", "subject": { "type": "certificate", "id": 10, "name": "vpn.northwind.example" }, "certificate_ids": [ 10 ], "addresses": [], "attention_key": "certificate:10", "due_at": "2026-01-03T12:00:00+00:00", "evidence": { "expires_at": "2026-01-03T12:00:00+00:00", "days_left": -12, "renews_itself": false, "renewal_type": "internal", "renewal_type_basis": "guess", "renewal_source": null, "issuer": "vpn.northwind.example", "served_status": null, "role": null, "renewer": null }, "copy": { "title": { "key": "certificates.rules.expired.title", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } }, "detail": { "key": "certificates.rules.expired.detail", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } }, "short": { "key": "certificates.rules.expired.short", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } } }, "fix": { "kind": "route", "label": "certificates.rules.expired.fix", "route": "/certificates/10" }, "dismissible": false, "advisor": null, "decision": null, "automation": null, "sources": [], "also": [] } ], "finding": { "tier": "problem", "code": "expired", "severity": "critical", "subject": { "type": "certificate", "id": 10, "name": "vpn.northwind.example" }, "certificate_ids": [ 10 ], "addresses": [], "attention_key": "certificate:10", "due_at": "2026-01-03T12:00:00+00:00", "evidence": { "expires_at": "2026-01-03T12:00:00+00:00", "days_left": -12, "renews_itself": false, "renewal_type": "internal", "renewal_type_basis": "guess", "renewal_source": null, "issuer": "vpn.northwind.example", "served_status": null, "role": null, "renewer": null }, "copy": { "title": { "key": "certificates.rules.expired.title", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } }, "detail": { "key": "certificates.rules.expired.detail", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } }, "short": { "key": "certificates.rules.expired.short", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } } }, "fix": { "kind": "route", "label": "certificates.rules.expired.fix", "route": "/certificates/10" }, "dismissible": false, "advisor": null, "decision": null, "automation": null, "sources": [], "also": [] }, "health": { "grade": "warning", "letter": null, "issues": [ { "code": "self_signed", "severity": "warning" } ] }, "in_use": false, "tags": [], "check": null, "domain": null }, { "id": 2, "organization_id": 1, "source": "probe", "monitoring_check_id": 2, "domain_id": 3, "cloud_server_id": null, "provider_credential_id": null, "fingerprint": "b6b045177e3469ad718546c6233a2b7f0166d10e466deeaa6d16f6244f6654db", "subject": "northwind-app.dev", "issuer": "Let's Encrypt (R11)", "serial": "B4B32EC4", "sans": [ "northwind-app.dev", "*.northwind-app.dev" ], "not_before": "2025-11-07T12:00:00.000000Z", "not_after": "2026-02-05T12:00:00.000000Z", "purpose": "tls_server", "key_algo": "ecdsa", "key_bits": 256, "sig_algo": "ECDSA-SHA256", "trust": "public", "validation": "DV", "is_wildcard": true, "is_multi_san": true, "managed": true, "renewal_source": "Let's Encrypt (R11)", "classification_override": null, "status": "expiring_soon", "superseded_by_id": null, "dismissed_at": null, "deployment_locations": [ { "endpoint": "northwind-app.dev:443", "last_seen": "2026-01-15T11:50:00+00:00", "first_seen": "2026-01-08T12:00:00+00:00" } ], "owner": null, "notes": null, "first_seen_at": "2025-11-16T12:00:00.000000Z", "last_seen_at": "2026-01-15T06:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subject_org": null, "subject_location": null, "chain": [ { "subject": "northwind-app.dev", "issuer": "Let's Encrypt (R11)", "is_ca": false, "self_signed": false, "not_after": "2026-02-05T12:00:00+00:00", "fingerprint": "b6b045177e3469ad718546c6233a2b7f0166d10e466deeaa6d16f6244f6654db" }, { "subject": "Let's Encrypt (R11)", "issuer": "ISRG Root X1", "is_ca": true, "self_signed": false, "not_after": "2030-01-15T12:00:00+00:00", "fingerprint": "c12c8a7dcb3f10b2cfd6efb6d14e6516f76cb6d3537ffae6a1f804b618d0cf3c" } ], "chain_status": "trusted", "sources": [ { "source": "probe", "last_seen": "2026-01-15T06:00:00+00:00", "first_seen": "2025-11-16T12:00:00+00:00" } ], "crl_url": null, "ocsp_url": null, "caa_status": null, "caissuer_url": "http://r11.i.lencr.org/", "no_auto_merge": false, "price_yearly": "0.00", "price_source": "manual", "price_currency": "EUR", "billing_interval": "yearly", "interval_count": 1, "renewal_type": "automatic", "renewal_type_basis": "guess", "served_status": "served", "served_checked_at": "2026-01-15T11:50:00.000000Z", "subscription_ends_at": null, "seller": null, "role": null, "ct_finding": null, "owner_user_id": null, "custom_fields": [], "renewer": null, "findings": [ { "tier": "problem", "code": "renewal_overdue", "severity": "warning", "subject": { "type": "certificate", "id": 2, "name": "northwind-app.dev" }, "certificate_ids": [ 2 ], "addresses": [ "northwind-app.dev:443" ], "attention_key": "certificate_renewal:2", "due_at": "2026-02-05T12:00:00+00:00", "evidence": { "expires_at": "2026-02-05T12:00:00+00:00", "days_left": 21, "renews_itself": true, "renewal_type": "automatic", "renewal_type_basis": "guess", "renewal_source": "Let's Encrypt (R11)", "issuer": "Let's Encrypt (R11)", "served_status": "served", "role": null, "renewer": null, "renews_around_at": "2026-01-06T00:00:00+00:00", "last_seen_at": "2026-01-15T06:00:00+00:00" }, "copy": { "title": { "key": "certificates.rules.renewal_overdue.title", "params": { "renews_at": "2026-01-06T00:00:00+00:00", "expires_at": "2026-02-05T12:00:00+00:00", "n": 9, "name": "northwind-app.dev" } }, "detail": { "key": "certificates.rules.renewal_overdue.detail", "params": { "renews_at": "2026-01-06T00:00:00+00:00", "expires_at": "2026-02-05T12:00:00+00:00", "n": 9, "name": "northwind-app.dev" } }, "short": { "key": "certificates.rules.renewal_overdue.short", "params": { "renews_at": "2026-01-06T00:00:00+00:00", "expires_at": "2026-02-05T12:00:00+00:00", "n": 9, "name": "northwind-app.dev" } } }, "fix": { "kind": "route", "label": "certificates.rules.renewal_overdue.fix", "route": "/certificates/2" }, "dismissible": true, "advisor": null, "decision": null, "automation": null, "sources": [], "also": [] } ], "finding": { "tier": "problem", "code": "renewal_overdue", "severity": "warning", "subject": { "type": "certificate", "id": 2, "name": "northwind-app.dev" }, "certificate_ids": [ 2 ], "addresses": [ "northwind-app.dev:443" ], "attention_key": "certificate_renewal:2", "due_at": "2026-02-05T12:00:00+00:00", "evidence": { "expires_at": "2026-02-05T12:00:00+00:00", "days_left": 21, "renews_itself": true, "renewal_type": "automatic", "renewal_type_basis": "guess", "renewal_source": "Let's Encrypt (R11)", "issuer": "Let's Encrypt (R11)", "served_status": "served", "role": null, "renewer": null, "renews_around_at": "2026-01-06T00:00:00+00:00", "last_seen_at": "2026-01-15T06:00:00+00:00" }, "copy": { "title": { "key": "certificates.rules.renewal_overdue.title", "params": { "renews_at": "2026-01-06T00:00:00+00:00", "expires_at": "2026-02-05T12:00:00+00:00", "n": 9, "name": "northwind-app.dev" } }, "detail": { "key": "certificates.rules.renewal_overdue.detail", "params": { "renews_at": "2026-01-06T00:00:00+00:00", "expires_at": "2026-02-05T12:00:00+00:00", "n": 9, "name": "northwind-app.dev" } }, "short": { "key": "certificates.rules.renewal_overdue.short", "params": { "renews_at": "2026-01-06T00:00:00+00:00", "expires_at": "2026-02-05T12:00:00+00:00", "n": 9, "name": "northwind-app.dev" } } }, "fix": { "kind": "route", "label": "certificates.rules.renewal_overdue.fix", "route": "/certificates/2" }, "dismissible": true, "advisor": null, "decision": null, "automation": null, "sources": [], "also": [] }, "health": { "grade": "good", "letter": "A", "issues": [] }, "in_use": true, "tags": [ { "id": 6, "name": "Northwind Platform", "color": "#14b8a6", "pivot": { "taggable_type": "App\\Models\\SslCertificate", "taggable_id": 2, "tag_id": 6 } } ], "check": { "id": 2, "name": "App — northwind-app.dev", "target": "https://northwind-app.dev", "interval_minutes": 0 }, "domain": { "id": 3, "name": "northwind-app", "tld": "dev", "full_name": "northwind-app.dev", "archivable": true, "dns_host": null, "management": "tracked", "sync_halt": null } } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/coverage": { "get": { "summary": "Get certificate coverage per domain", "operationId": "coverageDetection183TheInverseOfTheInventoryForEveryOrgDomainWhetherAValidCertificateIsKnownForItSurfacesTheGapswhichOfMyDomainsAreUnprotectedUntrackedThatTheInventoryListAloneCantShow", "description": "For each of your domains, whether a certificate covers it (`covered`, `expiring`, `expired` or `uncovered`) and the best certificate that does. Superseded and dismissed certificates are left out.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "domain_id": 11, "domain": "northwind.cloud", "status": "covered", "certificate": { "id": 6, "subject": "*.northwind.cloud", "not_after": "2026-03-17T12:00:00.000000Z", "status": "valid", "source": "hetzner" } }, { "domain_id": 1, "domain": "northwind.com", "status": "covered", "certificate": { "id": 8, "subject": "cdn.northwind.com", "not_after": "2026-11-11T12:00:00.000000Z", "status": "valid", "source": "cloudflare" } } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/findings": { "get": { "summary": "List certificate findings", "operationId": "gETorganizationsorgcertificatesfindings", "description": "Everything InfraNest found about your certificates that may need attention, from problems to recommendations, with counts per tier.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "findings": [ { "tier": "problem", "code": "expired", "severity": "critical", "subject": { "type": "certificate", "id": 10, "name": "vpn.northwind.example" }, "certificate_ids": [ 10 ], "addresses": [], "attention_key": "certificate:10", "due_at": "2026-01-03T12:00:00+00:00", "evidence": { "expires_at": "2026-01-03T12:00:00+00:00", "days_left": -12, "renews_itself": false, "renewal_type": "internal", "renewal_type_basis": "guess", "renewal_source": null, "issuer": "vpn.northwind.example", "served_status": null, "role": null, "renewer": null }, "copy": { "title": { "key": "certificates.rules.expired.title", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } }, "detail": { "key": "certificates.rules.expired.detail", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } }, "short": { "key": "certificates.rules.expired.short", "params": { "expires_at": "2026-01-03T12:00:00+00:00", "name": "vpn.northwind.example" } } }, "fix": { "kind": "route", "label": "certificates.rules.expired.fix", "route": "/certificates/10" }, "dismissible": false, "advisor": null, "decision": null, "automation": null, "sources": [], "also": [] }, { "tier": "problem", "code": "domain_expires_first", "severity": "warning", "subject": { "type": "certificate", "id": 12, "name": "northwind.shop" }, "certificate_ids": [ 12 ], "addresses": [ "northwind.shop:443" ], "attention_key": "domain:10", "due_at": "2026-01-26T00:00:00+00:00", "evidence": { "expires_at": "2026-03-17T12:00:00+00:00", "days_left": 61, "renews_itself": true, "renewal_type": "automatic", "renewal_type_basis": "guess", "renewal_source": "Let's Encrypt (R11)", "issuer": "Let's Encrypt (R11)", "served_status": "served", "role": null, "renewer": null, "domain_id": 10, "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "domain_auto_renew": false }, "copy": { "title": { "key": "certificates.rules.domain_expires_first.title", "params": { "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "expires_at": "2026-03-17T12:00:00+00:00", "name": "northwind.shop" } }, "detail": { "key": "certificates.rules.domain_expires_first.detail", "params": { "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "expires_at": "2026-03-17T12:00:00+00:00", "name": "northwind.shop" } }, "short": { "key": "certificates.rules.domain_expires_first.short", "params": { "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "expires_at": "2026-03-17T12:00:00+00:00", "name": "northwind.shop" } } }, "fix": { "kind": "route", "label": "certificates.rules.domain_expires_first.fix", "route": "/domains/10" }, "dismissible": true, "advisor": null, "decision": null, "automation": null, "sources": [], "also": [] } ], "counts": { "problem": 6, "recommendation": 6, "info": 0 } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/overview": { "get": { "summary": "Get the certificate overview", "operationId": "gETorganizationsorgcertificatesoverview", "description": "An address-by-address view of the certificates your visitors actually receive, grouped by domain, with a summary, what needs you, the renewals due in the next 90 days and recommendations. Also lists the members who can be made a certificate’s owner.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "summary": { "state": "needs_you", "addresses_needing_you": 5, "other_problems": 1, "first_problem": { "endpoint_id": 7 }, "todo": [ { "endpoint_id": 7, "host": "northwind.shop", "port": 443, "address": "northwind.shop:443", "finding": { "tier": "problem", "code": "domain_expires_first", "severity": "warning", "subject": { "type": "certificate", "id": 12, "name": "northwind.shop" }, "certificate_ids": [ 12 ], "addresses": [ "northwind.shop:443" ], "attention_key": "domain:10", "due_at": "2026-01-26T00:00:00+00:00", "evidence": { "expires_at": "2026-03-17T12:00:00+00:00", "days_left": 61, "renews_itself": true, "renewal_type": "automatic", "renewal_type_basis": "guess", "renewal_source": "Let's Encrypt (R11)", "issuer": "Let's Encrypt (R11)", "served_status": "served", "role": null, "renewer": null, "domain_id": 10, "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "domain_auto_renew": false }, "copy": { "title": { "key": "certificates.rules.domain_expires_first.title", "params": { "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "expires_at": "2026-03-17T12:00:00+00:00", "name": "northwind.shop" } }, "detail": { "key": "certificates.rules.domain_expires_first.detail", "params": { "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "expires_at": "2026-03-17T12:00:00+00:00", "name": "northwind.shop" } }, "short": { "key": "certificates.rules.domain_expires_first.short", "params": { "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "expires_at": "2026-03-17T12:00:00+00:00", "name": "northwind.shop" } } }, "fix": { "kind": "route", "label": "certificates.rules.domain_expires_first.fix", "route": "/domains/10" }, "dismissible": true, "advisor": null, "decision": null, "automation": null, "sources": [], "also": [] }, "attention_keys": [ "domain:10" ] } ], "decided": [], "addresses": 12, "domains": 5, "renew_automatically": 8, "monitored": 5, "recommendations": 6, "watched": 1, "next_renewal": { "host": "staging.northwind-app.dev", "more": 0, "at": "2026-01-18T00:00:00+00:00", "who": "automatic" } }, "timeline": [ { "certificate_id": 16, "subject": "northwind-mail.com", "issuer": "Sectigo RSA Organization Validation Secure Server CA", "expires_at": "2026-02-02T12:00:00+00:00", "renews_at": null, "who": "you", "endpoint_ids": [ 11 ], "hosts": [ "mx1.northwind-mail.com" ], "listed": true } ], "needs_you": [ { "kind": "problem", "at": "2026-01-26T00:00:00+00:00", "now": false, "severity": "warning", "endpoint_id": 7, "hosts": [ "northwind.shop" ], "reason": { "key": "certificates.rules.domain_expires_first.short", "params": { "domain": "northwind.shop", "domain_expires_at": "2026-01-26T00:00:00+00:00", "expires_at": "2026-03-17T12:00:00+00:00", "name": "northwind.shop" } }, "who": null } ], "groups": [ { "key": "domain:northwind-mail.com", "domain_id": 16, "name": "northwind-mail.com", "in_domains": true, "rows": [ { "domain_id": 16, "endpoint_id": 11, "host": "mx1.northwind-mail.com", "port": 993, "address": "mx1.northwind-mail.com:993", "status": "problem", "severity": "warning", "reason": { "key": "certificates.rules.rollout_incomplete.short", "params": { "address": "mx1.northwind-mail.com:993", "name": "northwind-mail.com", "done": 1, "total": 2, "expires_at": "2026-02-02T12:00:00+00:00", "server": "mail-01" } }, "check_note": null, "certificate": { "id": 16, "subject": "northwind-mail.com", "issuer": "Sectigo RSA Organization Validation Secure Server CA", "not_after": "2026-02-02T12:00:00+00:00", "status": "superseded", "role": null }, "origin_certificate": null, "served_by": { "kind": "server", "provider": "transip", "provider_label": "TransIP", "cloud_server": { "id": 14, "name": "mail-01" }, "resolved_ips": [ "198.51.100.166" ], "edge_network": null, "network": null, "display": { "kind": "server", "name": "mail-01", "ip": "198.51.100.166" }, "dns_record": { "id": 53, "type": "A", "name": "mx1", "value": "198.51.100.166", "zone": { "id": 9, "name": "northwind-mail.com" } } }, "renewal": { "type": "manual_paid", "source": null, "renews_itself": false, "actor": "you" }, "ownership": { "is": "yours", "basis": "domain", "override": null }, "monitor": null, "last_checked_at": "2026-01-15T11:50:00+00:00", "last_check_source": "scan", "last_attempt_at": "2026-01-15T11:50:00+00:00", "failing": null, "findings": [ { "tier": "problem", "code": "rollout_incomplete", "severity": "warning", "subject": { "type": "address", "id": 11, "name": "mx1.northwind-mail.com:993" }, "certificate_ids": [ 16 ], "addresses": [ "mx1.northwind-mail.com:993" ], "attention_key": "certificate_rollout:11", "due_at": "2026-02-02T12:00:00+00:00", "evidence": { "endpoint_id": 11, "serves_certificate_id": 16, "successor_id": 15, "expires_at": "2026-02-02T12:00:00+00:00", "done": 1, "total": 2, "last_checked_at": "2026-01-15T11:50:00+00:00" }, "copy": { "title": { "key": "certificates.rules.rollout_incomplete.title", "params": { "address": "mx1.northwind-mail.com:993", "name": "northwind-mail.com", "done": 1, "total": 2, "expires_at": "2026-02-02T12:00:00+00:00" } }, "detail": { "key": "certificates.rules.rollout_incomplete.detailServer", "params": { "address": "mx1.northwind-mail.com:993", "name": "northwind-mail.com", "done": 1, "total": 2, "expires_at": "2026-02-02T12:00:00+00:00", "server": "mail-01" }, "count": 2 }, "short": { "key": "certificates.rules.rollout_incomplete.short", "params": { "address": "mx1.northwind-mail.com:993", "name": "northwind-mail.com", "done": 1, "total": 2, "expires_at": "2026-02-02T12:00:00+00:00", "server": "mail-01" } } }, "fix": { "kind": "action", "label": "certificates.rules.rollout_incomplete.fix", "action": "certificate.scan", "method": "POST", "endpoint": "/organizations/1/certificates/scan", "body": { "host": "mx1.northwind-mail.com", "port": 993 } }, "dismissible": true, "advisor": null, "decision": null, "automation": { "template": "cert_rollout_not_live_alert", "action": "send_notification", "provider": null, "connected": true, "conditions": [], "title": { "key": "certificates.automate.cert_rollout_not_live_alert", "params": { "days": 0 } } }, "sources": [ { "source": "check", "tone": "bad", "copy": { "key": "certificates.evidence.check.oldCertificate", "params": [] } } ], "also": [] } ], "set_aside": false } ], "count": 2, "problems": 1, "next_expiry": "2026-02-02T12:00:00+00:00" } ], "watched": [ { "endpoint_id": 13, "host": "status.supplier.example", "port": 443, "address": "status.supplier.example:443", "domain_id": null, "status": "ok", "severity": null, "reason": null, "check_note": null, "certificate": { "id": 19, "subject": "status.supplier.example", "issuer": "Let's Encrypt (R3)", "not_after": "2026-03-28T12:00:00+00:00", "status": "valid", "role": null }, "origin_certificate": null, "served_by": { "kind": "address", "provider": null, "provider_label": null, "cloud_server": null, "resolved_ips": [ "203.0.113.210" ], "edge_network": null, "network": null, "display": { "kind": "ip", "name": "203.0.113.210", "ip": "203.0.113.210" }, "dns_record": null }, "renewal": { "type": "automatic", "source": "Let's Encrypt (R3)", "renews_itself": true, "actor": "automatic" }, "ownership": { "is": "watched", "basis": "none", "override": null }, "monitor": { "id": 13, "name": "Supplier status", "status": "up", "last_checked_at": "2026-01-15T11:58:00+00:00" }, "last_checked_at": "2026-01-15T11:50:00+00:00", "last_check_source": "scan", "last_attempt_at": "2026-01-15T11:50:00+00:00", "failing": null, "findings": [] } ], "recommendations": [ { "tier": "recommendation", "code": "chain_incomplete", "severity": "warning", "subject": { "type": "certificate", "id": 4, "name": "docs.northwind.com" }, "certificate_ids": [ 4 ], "addresses": [ "docs.northwind.com:443" ], "attention_key": null, "due_at": null, "evidence": { "expires_at": "2026-03-08T12:00:00+00:00", "days_left": 52, "renews_itself": true, "renewal_type": "automatic", "renewal_type_basis": "guess", "renewal_source": "Let's Encrypt (R11)", "issuer": "Let's Encrypt (R11)", "served_status": "served", "role": null, "renewer": null, "chain_status": "incomplete" }, "copy": { "title": { "key": "certificates.rules.chain_incomplete.title", "params": { "name": "docs.northwind.com" } }, "detail": { "key": "certificates.rules.chain_incomplete.detail", "params": { "name": "docs.northwind.com" } }, "short": { "key": "certificates.rules.chain_incomplete.short", "params": { "name": "docs.northwind.com" } } }, "fix": { "kind": "route", "label": "certificates.rules.chain_incomplete.fix", "route": "/certificates/4" }, "dismissible": true, "advisor": { "resource_type": "certificate", "resource_id": "4", "check_id": "chain" }, "decision": null, "automation": null, "sources": [], "also": [] } ], "recommendation_groups": [ { "code": "chain_incomplete", "severity": "warning", "items": [ { "tier": "recommendation", "code": "chain_incomplete", "severity": "warning", "subject": { "type": "certificate", "id": 4, "name": "docs.northwind.com" }, "certificate_ids": [ 4 ], "addresses": [ "docs.northwind.com:443" ], "attention_key": null, "due_at": null, "evidence": { "expires_at": "2026-03-08T12:00:00+00:00", "days_left": 52, "renews_itself": true, "renewal_type": "automatic", "renewal_type_basis": "guess", "renewal_source": "Let's Encrypt (R11)", "issuer": "Let's Encrypt (R11)", "served_status": "served", "role": null, "renewer": null, "chain_status": "incomplete" }, "copy": { "title": { "key": "certificates.rules.chain_incomplete.title", "params": { "name": "docs.northwind.com" } }, "detail": { "key": "certificates.rules.chain_incomplete.detail", "params": { "name": "docs.northwind.com" } }, "short": { "key": "certificates.rules.chain_incomplete.short", "params": { "name": "docs.northwind.com" } } }, "fix": { "kind": "route", "label": "certificates.rules.chain_incomplete.fix", "route": "/certificates/4" }, "dismissible": true, "advisor": { "resource_type": "certificate", "resource_id": "4", "check_id": "chain" }, "decision": null, "automation": null, "sources": [], "also": [] } ], "count": 1, "copy": { "title": { "key": "certificates.overview.recGroups.chain_incomplete.title", "params": { "n": 1 } }, "detail": { "key": "certificates.overview.recGroups.chain_incomplete.detail", "params": { "n": 1 } } }, "fix": { "kind": "route", "label": "certificates.rules.chain_incomplete.fix", "route": "/certificates/4" }, "dismiss": [ { "resource_type": "certificate", "resource_id": "4", "check_id": "chain" } ] } ], "dismissed_recommendations": [], "tidied": { "replaced": 2, "not_served": 0, "provider": 0, "merged": 1, "dismissed": 0, "untracked": 0 }, "untracked": [], "inventory": [ { "id": 10, "subject": "vpn.northwind.example", "issuer": "vpn.northwind.example", "source": "manual", "sources": [ "manual" ], "not_after": "2026-01-03T12:00:00+00:00", "status": "expired", "role": "not_seen", "hosts": [], "superseded_by_id": null } ], "owner_candidates": [ { "id": 1, "name": "Alex Rivera" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/owner": { "post": { "summary": "Assign an owner to certificates", "operationId": "giveCertificatesAnOwnerOneMemberForAllOfThem3928AssignOwnersOnTheRecommendation", "description": "Makes the member given in `user_id` the owner of each certificate in `certificate_ids` (up to 200). Refused when that person is not a member of the organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "assigned": 1, "owner": { "id": 1, "name": "Alex Rivera" } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "certificate_ids": { "type": "array", "description": "", "example": [ 16 ], "items": { "type": "integer" } }, "user_id": { "type": "integer", "description": "", "example": 16 } }, "required": [ "user_id" ] }, "example": { "certificate_ids": [ 1 ], "user_id": 1 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/fixes/monitors": { "get": { "summary": "Preview monitors to add for certificates", "operationId": "gETcertificatesfixesmonitorsTheChecklistAddressesTheMonitorEachGetsThePlansRoom", "description": "The addresses InfraNest suggests watching with an SSL monitor, the monitor each would get and the certificates involved. Also says how many more monitors your plan allows; nothing is changed.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "addresses": [ { "address": "archive.northwind.com:443", "host": "archive.northwind.com", "port": 443, "certificates": [ { "id": 18, "name": "archive.northwind.com" } ], "monitor": { "name": "archive.northwind.com", "type": "ssl", "target": "archive.northwind.com", "interval_seconds": 3600 }, "unsupported": null }, { "address": "billing.northwind.nl:443", "host": "billing.northwind.nl", "port": 443, "certificates": [ { "id": 14, "name": "billing.northwind.nl" } ], "monitor": { "name": "billing.northwind.nl", "type": "ssl", "target": "billing.northwind.nl", "interval_seconds": 3600 }, "unsupported": null } ], "room": null, "allowed": true } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/fixes/done": { "get": { "summary": "List certificate fixes already applied", "operationId": "gETcertificatesfixesdoneAlreadyDoneForYouForTheCertificateFixes", "description": "The certificate recommendations already acted on, newest first: monitors and domains added from a recommendation and CAA records added to unblock a renewal, with who did it and when.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "lines": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/{sslCertificate_id}": { "get": { "summary": "Get a certificate", "operationId": "getApiOrganizationsOrganization_idCertificatesSslCertificate_id", "description": "One certificate with its domain, server, monitor, owner and tags, where it is served and its place in the renewal series. Also includes its findings and whether its files can be fetched from the provider.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "sslCertificate_id", "required": true, "description": "The sslCertificate's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "source": "probe", "monitoring_check_id": 1, "domain_id": 1, "cloud_server_id": null, "provider_credential_id": null, "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9", "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "serial": "2395BA42", "sans": [ "northwind.com", "www.northwind.com" ], "not_before": "2025-12-30T12:00:00.000000Z", "not_after": "2026-03-30T12:00:00.000000Z", "purpose": "tls_server", "key_algo": "rsa", "key_bits": 2048, "sig_algo": "SHA256-RSA", "trust": "public", "validation": "DV", "is_wildcard": false, "is_multi_san": true, "managed": true, "renewal_source": "Let's Encrypt (R3)", "classification_override": null, "status": "valid", "superseded_by_id": null, "dismissed_at": null, "deployment_locations": [ { "endpoint": "northwind.com:443", "last_seen": "2026-01-15T11:50:00+00:00", "first_seen": "2026-01-08T12:00:00+00:00" } ], "owner": null, "notes": null, "first_seen_at": "2025-11-16T12:00:00.000000Z", "last_seen_at": "2026-01-15T06:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subject_org": null, "subject_location": null, "chain": [ { "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "is_ca": false, "self_signed": false, "not_after": "2026-03-30T12:00:00+00:00", "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9" }, { "subject": "Let's Encrypt (R3)", "issuer": "ISRG Root X1", "is_ca": true, "self_signed": false, "not_after": "2030-01-15T12:00:00+00:00", "fingerprint": "e04ca19ed66485fb479283c98fbfb4cda1ab67de1965304902bec3f6a55a2c8e" } ], "chain_status": "trusted", "sources": [ { "source": "probe", "last_seen": "2026-01-15T06:00:00+00:00", "first_seen": "2025-11-16T12:00:00+00:00" } ], "crl_url": null, "ocsp_url": null, "caa_status": "ok", "caissuer_url": "http://r3.i.lencr.org/", "no_auto_merge": false, "price_yearly": "0.00", "price_source": "manual", "price_currency": "EUR", "billing_interval": "yearly", "interval_count": 1, "renewal_type": "automatic", "renewal_type_basis": "guess", "served_status": "served", "served_checked_at": "2026-01-15T11:50:00.000000Z", "subscription_ends_at": null, "seller": null, "role": null, "ct_finding": null, "owner_user_id": null, "health": { "grade": "good", "letter": "A", "issues": [] }, "in_use": true, "tags": [ { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\SslCertificate", "taggable_id": 1, "tag_id": 5 } } ], "check": { "id": 1, "name": "Marketing site", "target": "https://northwind.com", "interval_minutes": 0 }, "domain": { "id": 1, "name": "northwind", "tld": "com", "full_name": "northwind.com", "archivable": true, "dns_host": null, "management": "tracked", "sync_halt": null }, "cloud_server": null, "provider_credential": null, "superseded_by": null, "owner_user": null, "owner_candidates": [ { "id": 1, "name": "Alex Rivera" }, { "id": 3, "name": "Priya Raghunathan" } ], "bundle_available": false, "whereabouts": { "role": "current", "current_certificate": null, "renewer": null, "served_on": [ { "endpoint_id": 1, "host": "northwind.com", "port": 443, "as": "edge", "proxied": true, "last_checked_at": "2026-01-15T11:50:00+00:00", "last_check_source": "scan", "zone": { "id": 1, "name": "northwind.com", "domain_id": 1 }, "dns_record": { "id": 1, "type": "A", "name": "@", "value": "198.51.100.10" }, "cloud_server": { "id": 1, "name": "web-01" }, "monitor": { "id": 1, "name": "Marketing site" }, "renewer": null } ], "lifecycle": { "previous": null, "next": null, "replaced_at": null, "renewals": 0, "lead_days": null, "expected_renewal_at": "2026-02-28T12:00:00+00:00" }, "rollout": null }, "findings": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "patch": { "summary": "Update a certificate", "operationId": "patchApiOrganizationsOrganization_idCertificatesSslCertificate_id", "description": "Changes InfraNest’s record of the certificate: owner, notes, subscription end date, seller, tags and any corrections to how it is classified (purpose, trust, validation, managed, renewal type). Only the fields you send change; `owner_user_id` must be a member of the organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "sslCertificate_id", "required": true, "description": "The sslCertificate's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "source": "probe", "monitoring_check_id": 1, "domain_id": 1, "cloud_server_id": null, "provider_credential_id": null, "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9", "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "serial": "2395BA42", "sans": [ "northwind.com", "www.northwind.com" ], "not_before": "2025-12-30T12:00:00.000000Z", "not_after": "2026-03-30T12:00:00.000000Z", "purpose": "tls_server", "key_algo": "rsa", "key_bits": 2048, "sig_algo": "SHA256-RSA", "trust": "public", "validation": "DV", "is_wildcard": false, "is_multi_san": true, "managed": true, "renewal_source": "Let's Encrypt (R3)", "classification_override": null, "status": "valid", "superseded_by_id": null, "dismissed_at": null, "deployment_locations": [ { "endpoint": "northwind.com:443", "last_seen": "2026-01-15T11:50:00+00:00", "first_seen": "2026-01-08T12:00:00+00:00" } ], "owner": "Platform team", "notes": "Renewed automatically by the load balancer.", "first_seen_at": "2025-11-16T12:00:00.000000Z", "last_seen_at": "2026-01-15T06:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subject_org": null, "subject_location": null, "chain": [ { "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "is_ca": false, "self_signed": false, "not_after": "2026-03-30T12:00:00+00:00", "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9" }, { "subject": "Let's Encrypt (R3)", "issuer": "ISRG Root X1", "is_ca": true, "self_signed": false, "not_after": "2030-01-15T12:00:00+00:00", "fingerprint": "e04ca19ed66485fb479283c98fbfb4cda1ab67de1965304902bec3f6a55a2c8e" } ], "chain_status": "trusted", "sources": [ { "source": "probe", "last_seen": "2026-01-15T06:00:00+00:00", "first_seen": "2025-11-16T12:00:00+00:00" } ], "crl_url": null, "ocsp_url": null, "caa_status": "ok", "caissuer_url": "http://r3.i.lencr.org/", "no_auto_merge": false, "price_yearly": "0.00", "price_source": "manual", "price_currency": "EUR", "billing_interval": "yearly", "interval_count": 1, "renewal_type": "automatic", "renewal_type_basis": "guess", "served_status": "served", "served_checked_at": "2026-01-15T11:50:00.000000Z", "subscription_ends_at": null, "seller": null, "role": null, "ct_finding": null, "owner_user_id": null, "tags": [ { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\SslCertificate", "taggable_id": 1, "tag_id": 5 } } ], "owner_user": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "owner": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b", "nullable": true }, "owner_user_id": { "type": "integer", "description": "A member who owns it (#3928); checked against the organization below.", "example": 16, "nullable": true }, "notes": { "type": "string", "description": "Must not be greater than 2000 characters.", "example": "n", "nullable": true }, "subscription_ends_at": { "type": "string", "description": "A paid certificate's subscription and who sold it (#3164). Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true }, "seller": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "g", "nullable": true }, "classification_override": { "type": "object", "description": "", "example": null, "properties": { "purpose": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "z", "nullable": true }, "trust": { "type": "string", "description": "", "example": null, "nullable": true }, "validation": { "type": "string", "description": "", "example": null, "nullable": true }, "managed": { "type": "boolean", "description": "", "example": true, "nullable": true }, "renewal_type": { "type": "string", "description": "", "example": "automatic", "enum": [ "automatic", "provider_managed", "manual_paid", "manual_free", "internal" ], "nullable": true } }, "nullable": true }, "tag_ids": { "type": "array", "description": "", "example": [ 16 ], "items": { "type": "integer" } } } }, "example": { "owner": "Platform team", "notes": "Renewed automatically by the load balancer." } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/{sslCertificate_id}/bundle": { "get": { "summary": "Get a certificate’s files from the provider", "operationId": "gETorganizationsorgcertificatescertbundle", "description": "Asks the provider the certificate came from for its files and returns the files; each fetch is recorded in your audit log. Requires write access, and is refused when the certificate did not come from a connected provider that can hand files back or is not linked to a domain.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "sslCertificate_id", "required": true, "description": "The sslCertificate's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/{sslCertificate_id}/timeline": { "get": { "summary": "Get a certificate’s timeline", "operationId": "perCertificateEventTimeline216TheLifecycleHistoryOfAlogicalCertificateAssembledFromWhatsAlreadyPersistedThesupersededByIdRenewalLineageissuedRenewedExpiredPlusEverycertificateAuditLogEntryAcrossTheLineageaddedscannedrotationweakdismissed", "description": "The certificate’s history across its renewals: when it was issued, renewed and expired, plus the changes recorded in your audit log. For certificates you renew and pay for yourself, it also marks the day to order the renewal and when the subscription ends.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "sslCertificate_id", "required": true, "description": "The sslCertificate's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "events": [ { "type": "issued", "at": "2025-12-30T12:00:00+00:00", "fingerprint": "6f6f72db3001" } ], "generations": 1, "markers": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/{sslCertificate_id}/pricing": { "put": { "summary": "Set a certificate’s price", "operationId": "setorClearAManualYearlyPrice276P2cCertsAreAStandaloneCostObjectBilledAnnuallyNoCertificateSourceExposesAPriceSoItsAlwaysUserEntered", "description": "Sets the yearly price InfraNest counts for this certificate, with optional currency and billing interval. Send an empty price to go back to the provider’s figure.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "sslCertificate_id", "required": true, "description": "The sslCertificate's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "source": "probe", "monitoring_check_id": 1, "domain_id": 1, "cloud_server_id": null, "provider_credential_id": null, "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9", "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "serial": "2395BA42", "sans": [ "northwind.com", "www.northwind.com" ], "not_before": "2025-12-30T12:00:00.000000Z", "not_after": "2026-03-30T12:00:00.000000Z", "purpose": "tls_server", "key_algo": "rsa", "key_bits": 2048, "sig_algo": "SHA256-RSA", "trust": "public", "validation": "DV", "is_wildcard": false, "is_multi_san": true, "managed": true, "renewal_source": "Let's Encrypt (R3)", "classification_override": null, "status": "valid", "superseded_by_id": null, "dismissed_at": null, "deployment_locations": [ { "endpoint": "northwind.com:443", "last_seen": "2026-01-15T11:50:00+00:00", "first_seen": "2026-01-08T12:00:00+00:00" } ], "owner": null, "notes": null, "first_seen_at": "2025-11-16T12:00:00.000000Z", "last_seen_at": "2026-01-15T06:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subject_org": null, "subject_location": null, "chain": [ { "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "is_ca": false, "self_signed": false, "not_after": "2026-03-30T12:00:00+00:00", "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9" }, { "subject": "Let's Encrypt (R3)", "issuer": "ISRG Root X1", "is_ca": true, "self_signed": false, "not_after": "2030-01-15T12:00:00+00:00", "fingerprint": "e04ca19ed66485fb479283c98fbfb4cda1ab67de1965304902bec3f6a55a2c8e" } ], "chain_status": "trusted", "sources": [ { "source": "probe", "last_seen": "2026-01-15T06:00:00+00:00", "first_seen": "2025-11-16T12:00:00+00:00" } ], "crl_url": null, "ocsp_url": null, "caa_status": "ok", "caissuer_url": "http://r3.i.lencr.org/", "no_auto_merge": false, "price_yearly": "59.00", "price_source": "manual", "price_currency": "EUR", "billing_interval": "yearly", "interval_count": 1, "renewal_type": "automatic", "renewal_type_basis": "guess", "served_status": "served", "served_checked_at": "2026-01-15T11:50:00.000000Z", "subscription_ends_at": null, "seller": null, "role": null, "ct_finding": null, "owner_user_id": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "certificates", "requestBody": { "required": true, "content": { "application/json": { "example": { "price_yearly": 59, "currency": "EUR" } } } }, "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/{sslCertificate_id}/dismiss": { "post": { "summary": "Dismiss or restore a certificate", "operationId": "postApiOrganizationsOrganization_idCertificatesSslCertificate_idDismiss", "description": "Sets the certificate aside so it no longer counts towards domain coverage. Send `dismissed: false` to restore it.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "sslCertificate_id", "required": true, "description": "The sslCertificate's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "source": "probe", "monitoring_check_id": 1, "domain_id": 1, "cloud_server_id": null, "provider_credential_id": null, "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9", "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "serial": "2395BA42", "sans": [ "northwind.com", "www.northwind.com" ], "not_before": "2025-12-30T12:00:00.000000Z", "not_after": "2026-03-30T12:00:00.000000Z", "purpose": "tls_server", "key_algo": "rsa", "key_bits": 2048, "sig_algo": "SHA256-RSA", "trust": "public", "validation": "DV", "is_wildcard": false, "is_multi_san": true, "managed": true, "renewal_source": "Let's Encrypt (R3)", "classification_override": null, "status": "valid", "superseded_by_id": null, "dismissed_at": "2026-01-15T12:00:00.000000Z", "deployment_locations": [ { "endpoint": "northwind.com:443", "last_seen": "2026-01-15T11:50:00+00:00", "first_seen": "2026-01-08T12:00:00+00:00" } ], "owner": null, "notes": null, "first_seen_at": "2025-11-16T12:00:00.000000Z", "last_seen_at": "2026-01-15T06:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "subject_org": null, "subject_location": null, "chain": [ { "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "is_ca": false, "self_signed": false, "not_after": "2026-03-30T12:00:00+00:00", "fingerprint": "6f6f72db300125c26f8b2c866124ffb57e60a201177144ed5e5b6711eba24cb9" }, { "subject": "Let's Encrypt (R3)", "issuer": "ISRG Root X1", "is_ca": true, "self_signed": false, "not_after": "2030-01-15T12:00:00+00:00", "fingerprint": "e04ca19ed66485fb479283c98fbfb4cda1ab67de1965304902bec3f6a55a2c8e" } ], "chain_status": "trusted", "sources": [ { "source": "probe", "last_seen": "2026-01-15T06:00:00+00:00", "first_seen": "2025-11-16T12:00:00+00:00" } ], "crl_url": null, "ocsp_url": null, "caa_status": "ok", "caissuer_url": "http://r3.i.lencr.org/", "no_auto_merge": false, "price_yearly": "0.00", "price_source": "manual", "price_currency": "EUR", "billing_interval": "yearly", "interval_count": 1, "renewal_type": "automatic", "renewal_type_basis": "guess", "served_status": "served", "served_checked_at": "2026-01-15T11:50:00.000000Z", "subscription_ends_at": null, "seller": null, "role": null, "ct_finding": null, "owner_user_id": null, "tags": [ { "id": 5, "name": "Northwind Retail", "color": "#0ea5e9", "pivot": { "taggable_type": "App\\Models\\SslCertificate", "taggable_id": 1, "tag_id": 5 } } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/certificates/{sslCertificate_id}/caa-fix": { "get": { "summary": "Preview the CAA fix for a certificate", "operationId": "gETcertificatescertcaaFixExactlyTheRecordPOSTWouldWriteAndWhere", "description": "The exact CAA record that would let this certificate’s authority issue it again, the DNS zone it would go in, the CAA records already there and any other certificate it would block. Refused when the certificate’s CAA policy does not block its renewal; nothing is changed.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "sslCertificate_id", "required": true, "description": "The sslCertificate's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Certificates" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "certificates", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cost-items": { "get": { "summary": "List cost items", "operationId": "getApiOrganizationsOrganization_idCostItems", "description": "The recurring costs you recorded on one resource. `entity_type` is required, and `entity_id` too unless `entity_type` is `organization`, which lists costs that belong to the whole organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cost" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_type": { "type": "string", "description": "", "example": "architecto" }, "entity_id": { "type": "integer", "description": "", "example": 16 } }, "required": [ "entity_type" ] } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "costs", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a cost item", "operationId": "postApiOrganizationsOrganization_idCostItems", "description": "Records a recurring cost with a `label`, `amount`, `currency` and optional `period` (default monthly) on a resource (`entity_type`, `entity_id`), or on the whole organization with `entity_type` `organization`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "organization_id": 1, "label": "Uptime SMS credits", "amount": "9.00", "currency": "EUR", "period": "monthly", "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 2 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cost" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_type": { "type": "string", "description": "", "example": "architecto" }, "entity_id": { "type": "integer", "description": "Absent for an org-level cost, which belongs to no object.", "example": 16 } }, "required": [ "entity_type" ] }, "example": { "entity_type": "organization", "label": "Uptime SMS credits", "amount": 9, "currency": "EUR" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "costs", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/cost-items/{costItem_id}": { "patch": { "summary": "Update a cost item", "operationId": "patchApiOrganizationsOrganization_idCostItemsCostItem_id", "description": "Changes the cost’s `label`, `amount`, `currency` and `period`. `label`, `amount` and `currency` are required on every update; an omitted `period` resets to monthly.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "costItem_id", "required": true, "description": "The costItem's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "cost_itemable_type": null, "cost_itemable_id": null, "label": "Status page SMS credits", "amount": "15.00", "currency": "EUR", "period": "monthly", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cost" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "costs", "requestBody": { "required": true, "content": { "application/json": { "example": { "label": "Status page SMS credits", "amount": 15, "currency": "EUR" } } } }, "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a cost item", "operationId": "deleteApiOrganizationsOrganization_idCostItemsCostItem_id", "description": "Deletes the recorded cost.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "costItem_id", "required": true, "description": "The costItem's ID.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cost" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "costs", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/price-changes": { "get": { "summary": "List price changes for a resource", "operationId": "getApiOrganizationsOrganization_idPriceChanges", "description": "How one resource’s price has changed over time, newest first, up to 100 entries. `entity_type` and `entity_id` are required.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 2, "organization_id": 1, "priceable_type": "App\\Models\\Domain", "priceable_id": 1, "label": "northwind.com", "field": "renewal_price", "old_amount": "13.5000", "old_currency": "EUR", "old_interval": "yearly", "old_interval_count": 1, "new_amount": "12.5000", "new_currency": "EUR", "new_interval": "yearly", "new_interval_count": 1, "source": "api", "changed_by_user_id": null, "observed_at": "2025-12-02T12:00:00.000000Z", "effective_from": "2025-12-02T00:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "changed_by": null } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cost reporting" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_type": { "type": "string", "description": "", "example": "architecto" }, "entity_id": { "type": "integer", "description": "", "example": 16 } }, "required": [ "entity_type", "entity_id" ] } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "costs", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cost-events": { "get": { "summary": "List cost events", "operationId": "getApiOrganizationsOrganization_idCostEvents", "description": "Money spent on a date, such as registrations, renewals, transfers and purchases, newest first, up to 500 entries. Narrow with `entity_type`, `entity_id`, `from` and `to`. Requires a plan that includes cost reporting.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Cost reporting" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_type": { "type": "string", "description": "", "example": "architecto" }, "entity_id": { "type": "integer", "description": "", "example": 16 }, "from": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00" }, "to": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00" } } } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "costs", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/custom-fields": { "get": { "summary": "List custom fields", "operationId": "getApiOrganizationsOrganization_idCustomFields", "description": "The organization’s custom field definitions in display order. Pass `entity_type` to list only the fields that apply to that kind of record.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "organization_id": 1, "entity_types": [ "server", "domain" ], "key": "cost_centre", "label": "Cost centre", "type": "select", "options": [ "Platform", "Marketing" ], "required": false, "sort": 0, "show_on_detail": true, "show_as_column": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null }, { "id": 2, "organization_id": 1, "entity_types": [ "server" ], "key": "owner_team", "label": "Owning team", "type": "text", "options": null, "required": false, "sort": 1, "show_on_detail": true, "show_as_column": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Custom fields" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_type": { "type": "string", "description": "", "example": "architecto" } } } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a custom field", "operationId": "postApiOrganizationsOrganization_idCustomFields", "description": "Defines a custom field with `entity_types`, a unique `key`, a `label` and a `type`; select and multi-select fields also need `options`. Requires a plan that includes custom fields.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "entity_types": [ "server" ], "key": "cost_center", "label": "Cost center", "type": "text", "options": null, "required": false, "sort": 0, "show_on_detail": true, "show_as_column": false, "organization_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 4 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Custom fields" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "tags", "requestBody": { "required": true, "content": { "application/json": { "example": { "entity_types": [ "server" ], "key": "cost_center", "label": "Cost center", "type": "text" } } } }, "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/custom-fields/{customFieldDefinition_id}": { "patch": { "summary": "Update a custom field", "operationId": "patchApiOrganizationsOrganization_idCustomFieldsCustomFieldDefinition_id", "description": "Replaces the field’s definition; send the full set of fields, as on create. Requires a plan that includes custom fields.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "customFieldDefinition_id", "required": true, "description": "The customFieldDefinition's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "entity_types": [ "server", "domain" ], "key": "cost_centre", "label": "Responsible team", "type": "select", "options": [ "Platform", "Marketing" ], "required": false, "sort": 0, "show_on_detail": true, "show_as_column": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Custom fields" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "tags", "requestBody": { "required": true, "content": { "application/json": { "example": { "entity_types": [ "server", "domain" ], "key": "cost_centre", "label": "Responsible team", "type": "select", "options": [ "Platform", "Marketing", "Data", "Internal tools" ] } } } }, "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a custom field", "operationId": "deleteApiOrganizationsOrganization_idCustomFieldsCustomFieldDefinition_id", "description": "Deletes the field definition together with every value stored for it. Requires a plan that includes custom fields.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "customFieldDefinition_id", "required": true, "description": "The customFieldDefinition's ID.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Custom fields" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/custom-field-values": { "get": { "summary": "List custom field values for a record", "operationId": "getApiOrganizationsOrganization_idCustomFieldValues", "description": "The custom field values set on one record. `entity_type` and `entity_id` are required; returns 404 when the record is not in this organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "custom_field_definition_id": 1, "value": "Platform" }, { "id": 2, "custom_field_definition_id": 2, "value": "Web platform" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Custom fields" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_type": { "type": "string", "description": "", "example": "architecto" }, "entity_id": { "type": "integer", "description": "", "example": 16 } }, "required": [ "entity_type", "entity_id" ] } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "put": { "summary": "Set a custom field value", "operationId": "putApiOrganizationsOrganization_idCustomFieldValues", "description": "Sets the `value` of one field (`definition_id`) on one record (`entity_type`, `entity_id`), checked against the field’s type and options. A null value clears it and returns 204. Requires a plan that includes custom fields.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "custom_field_definition_id": 1, "value": "Platform" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Custom fields" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_type": { "type": "string", "description": "", "example": "architecto" }, "entity_id": { "type": "integer", "description": "", "example": 16 }, "definition_id": { "type": "integer", "description": "", "example": 16 }, "value": { "type": "string", "description": "" } }, "required": [ "entity_type", "entity_id", "definition_id" ] }, "example": { "entity_type": "server", "entity_id": 1, "definition_id": 1, "value": "Platform" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/dynamic-ips": { "get": { "summary": "List dynamic IP sources", "operationId": "getApiOrganizationsOrganization_idDynamicIps", "description": "Your dynamic IP sources (connections whose address changes, such as a home or office line), ordered by label, each with its tags and the DNS records and firewalls it keeps up to date.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "organization_id": 1, "label": "Office — Amsterdam", "current_ipv4": null, "current_ipv6": null, "ipv4_updated_at": null, "ipv6_updated_at": null, "last_used_at": null, "created_by": 1, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "observed_ipv4": null, "observed_ipv6": null, "alert_on_change": true, "firewall_strict": false, "firewall_fail_closed": false, "country_code": null, "city": null, "asn": null, "asn_org": null, "is_hosting": false, "silent_notified_at": null, "public_id": null, "last_attempt_at": null, "last_attempt_result": null, "last_attempt_ip": null, "last_attempt_agent": null, "agent_server_id": null, "targets_count": 0, "tags": [], "targets": [] } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Dynamic IP" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dynamic-ips/agent-servers": { "get": { "summary": "List servers a dynamic IP can follow", "operationId": "theServersWhoseInfraNestAgentASourceCanTakeItsAddressFrom3970EveryServerHereWithAnAgentTokenNewestCheckInFirstSoTheMachineTheCustomerJustInstalledItOnIsAtTheTop", "description": "Your servers with an InfraNest agent, which a dynamic IP source can take its address from, most recent agent check-in first.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 3, "name": "api-01", "agent_last_seen_at": "2026-01-15T11:57:00+00:00" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Dynamic IP" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dynamic-ips/{dynamicIp_id}": { "get": { "summary": "Get a dynamic IP source", "operationId": "getApiOrganizationsOrganization_idDynamicIpsDynamicIp_id", "description": "One source with its targets, its 20 most recent address events and the server agent it follows, if any. The update token is never included; `can_reveal` says whether it can be shown again.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dynamicIp_id", "required": true, "description": "The dynamicIp's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "label": "Office — Amsterdam", "current_ipv4": null, "current_ipv6": null, "ipv4_updated_at": null, "ipv6_updated_at": null, "last_used_at": null, "created_by": 1, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "observed_ipv4": null, "observed_ipv6": null, "alert_on_change": true, "firewall_strict": false, "firewall_fail_closed": false, "country_code": null, "city": null, "asn": null, "asn_org": null, "is_hosting": false, "silent_notified_at": null, "public_id": null, "last_attempt_at": null, "last_attempt_result": null, "last_attempt_ip": null, "last_attempt_agent": null, "agent_server_id": null, "targets_count": 0, "targets": [], "events": [], "agent_server": null, "can_reveal": false } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Dynamic IP" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dynamic-ips/{dynamicIp_id}/history": { "get": { "summary": "Get a dynamic IP source’s history", "operationId": "theSourcesHistoryTab3968AddressChangesWhatEachUpdatedOrFailedToAndSettingChanges", "description": "Address changes, what each one updated or failed to update, and changes to the source’s settings, newest first. Drawn from your audit log, so it ages out with your plan’s audit retention.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dynamicIp_id", "required": true, "description": "The dynamicIp's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "entries": [], "truncated": false } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Dynamic IP" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/roles": { "get": { "summary": "List roles", "operationId": "gETorganizationsorganizationroles", "description": "The built-in roles followed by the organization’s custom roles, each with its permissions.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "id": 2, "organization_id": null, "name": "Admin", "slug": "admin", "is_system": true, "permissions": { "dns.read": true, "dns.write": true, "cloud.read": true, "cloud.write": true, "billing.read": true, "domains.read": true, "roles.manage": false, "billing.write": false, "domains.write": true, "domains.delete": false, "members.manage": true, "monitoring.read": true, "monitoring.write": true }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null }, { "id": 3, "organization_id": null, "name": "Member", "slug": "member", "is_system": true, "permissions": { "dns.read": true, "dns.write": false, "cloud.read": true, "cloud.write": false, "billing.read": false, "domains.read": true, "roles.manage": false, "billing.write": false, "domains.write": false, "domains.delete": false, "members.manage": false, "monitoring.read": true, "monitoring.write": false }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "members.read", "x-infranest-token-writable": false, "x-infranest-module": "organization", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/roles/{id}": { "get": { "summary": "Get a role", "operationId": "gETorganizationsorganizationrolesrole", "description": "One role and its permissions. Either a built-in role or one of this organization’s custom roles.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": { "id": 1, "organization_id": null, "name": "Owner", "slug": "owner", "is_system": true, "permissions": { "dns.read": true, "dns.write": true, "cloud.read": true, "cloud.write": true, "billing.read": true, "domains.read": true, "roles.manage": true, "billing.write": true, "domains.write": true, "domains.delete": true, "members.manage": true, "monitoring.read": true, "monitoring.write": true }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "members.read", "x-infranest-token-writable": false, "x-infranest-module": "organization", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/domains/registrar-moves": { "get": { "summary": "List registrar moves", "operationId": "getApiOrganizationsOrganization_idDomainsRegistrarMoves", "description": "The 200 most recent moves of domains to another registrar you have connected, newest first, each with its domain, source and target connection, and current state.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "domains.read", "x-infranest-token-writable": false, "x-infranest-module": "domains", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns/overview": { "get": { "summary": "Get the DNS overview", "operationId": "getApiOrganizationsOrganization_idDnsOverview", "description": "A summary across all your DNS zones: what needs your attention, grouped by cause, the recent changes, where your DNS is hosted and what is worth tidying up. Changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "summary": { "state": "needs_you", "critical": false, "zones": 13, "needing_you": 2, "fine": 11, "live_match": 12, "live_checked": 12, "records": 88, "hosts": 6, "last_synced_at": "2026-01-15T11:53:00+00:00" }, "needs": [ { "key": "advisor:6:dnssec", "cause": "advisor", "critical": false, "subject": "northwind.de", "zones": [ { "id": 6, "name": "northwind.de" } ], "params": [], "since": null, "due_at": null, "route": "/dns/6", "finding": { "id": "dnssec", "status": "error", "variant": "error" }, "halt": null, "attention_keys": [ "dnssec_broken:9" ] }, { "key": "advisor:3:cf_ssl_mode", "cause": "advisor", "critical": false, "subject": "northwind-app.dev", "zones": [ { "id": 3, "name": "northwind-app.dev" } ], "params": [], "since": null, "due_at": null, "route": "/dns/3", "finding": { "id": "cf_ssl_mode", "status": "error", "value": "flexible" }, "halt": null, "attention_keys": [ "dns_zone_finding:3:cf_ssl_mode" ] } ], "decided": [], "changes": { "from": "2026-01-08T12:00:00+00:00", "entries": [ { "key": "audit:2", "kind": "audit", "action": "dns_record.created", "at": "2026-01-15T07:00:00+00:00", "zones": [ { "id": null, "name": "" } ], "actor": { "type": "user", "name": "Sam Okoye" }, "outside": false, "count": 1, "params": { "name": "@", "type": "" }, "batch": null, "writable": false, "provider": null }, { "key": "audit:8", "kind": "audit", "action": "dns_record.updated", "at": "2026-01-12T11:00:00+00:00", "zones": [ { "id": null, "name": "" } ], "actor": { "type": "user", "name": "Tom Bakker" }, "outside": false, "count": 1, "params": { "name": "@", "type": "" }, "batch": null, "writable": false, "provider": null } ], "truncated": false }, "hosts": [ { "key": "cred:2", "name": "Cloudflare DNS", "provider": "cloudflare", "credential_id": 2, "zones": 5, "connected": true, "halt": null }, { "key": "cred:1", "name": "Hetzner — Production", "provider": "hetzner", "credential_id": 1, "zones": 2, "connected": true, "halt": null } ], "domains_without_zone": 5, "recommendations": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns/search": { "get": { "summary": "Search records across all zones", "operationId": "getApiOrganizationsOrganization_idDnsSearch", "description": "Finds DNS records in any of your zones that match the `q` query parameter, by name, value or address, grouped by zone with the reason each one matched. A query shorter than two characters returns nothing with `too_short` set; at most 100 records are returned, with `truncated` set when there were more.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "query": "", "too_short": true, "min_length": 2, "total": 0, "truncated": false, "zones": [], "address_record_ids": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns/moves": { "get": { "summary": "List DNS host moves", "operationId": "getApiOrganizationsOrganization_idDnsMoves", "description": "The 200 most recent moves of a domain’s DNS to another DNS host, newest first, each with its domain, target connection, current `state` and timestamps.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/security-check": { "get": { "summary": "Check a zone’s live DNS security", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_idSecurityCheck", "description": "Resolves the zone’s SPF, DMARC, DKIM, MX, CAA, MTA-STS, BIMI, NS, address and DNSSEC answers from public DNS right now, with findings judged by the same rules as the stored-record advisor. Reflects what the internet answers, not what InfraNest stores.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "zone": "northwind.com", "checked_at": "2026-01-15T12:00:00.000000Z", "dnssec": { "state": "unknown", "ds": [], "validates": null }, "spf": [], "dmarc": [], "dkim": [], "mx": [], "a": [], "aaaa": [], "caa": [], "wildcard_a": [], "wildcard_aaaa": [], "mta_sts": [], "bimi": [], "ns": [], "ns_matches_provider": null, "snapshot": { "spf": [], "dmarc": [], "dkim_selectors": [], "mx": [], "null_mx": false, "mail_provider": null, "mx_cname_targets": [], "apex_a": [], "apex_aaaa": [], "apex_cname": [], "caa": [], "wildcard_a": [], "wildcard_aaaa": [], "cf_exposed_ips": [], "mta_sts": [], "bimi": [], "apex_ns": [], "ns_matches_provider": null, "mail_subdomains_missing_spf": [] }, "findings": [ { "id": "dnssec", "status": "pass", "variant": "pass" }, { "id": "no_mail", "status": "info", "variant": "info", "fix": { "type": "no_mail" } } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/advisor": { "get": { "summary": "Get a zone’s advisor findings", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_idAdvisor", "description": "Findings about the zone’s stored records, such as missing or weak email protection, with the snapshot those findings were judged from. Changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "snapshot": { "spf": [ "v=spf1 include:_spf.northwind.com ~all" ], "dmarc": [ "v=DMARC1; p=quarantine; rua=mailto:dmarc@northwind.example" ], "dkim_selectors": [], "mx": [ "mx.northwind.com" ], "null_mx": false, "mail_provider": null, "mx_cname_targets": [], "apex_a": [ "198.51.100.10" ], "apex_aaaa": [], "apex_cname": [], "caa": [ "0 issue \"letsencrypt.org\"" ], "caa_required": { "certificates": [ { "id": 1, "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "ids": [ "letsencrypt.org" ], "wildcard": false, "renews_itself": true, "provider": false }, { "id": 13, "subject": "cdn.northwind.com", "issuer": "Let's Encrypt (R3)", "ids": [ "letsencrypt.org" ], "wildcard": false, "renews_itself": true, "provider": false } ], "expected": [], "fronts": [ { "key": "cloudflare", "label": "Cloudflare", "ids": [ "letsencrypt.org", "pki.goog" ], "publishes_own": true } ] }, "wildcard_a": [], "wildcard_aaaa": [], "cf_exposed_ips": [ "198.51.100.10" ], "mta_sts": [], "bimi": [], "apex_ns": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ], "ns_matches_provider": true, "mail_subdomains_missing_spf": [] }, "findings": [ { "id": "ns", "status": "pass", "variant": "pass", "values": [ "nina.ns.cloudflare.com", "rick.ns.cloudflare.com" ] }, { "id": "dnssec", "status": "pass", "variant": "pass" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/email-protection": { "get": { "summary": "Preview email protection for a zone", "operationId": "thePlanEachRecordAsItIsAndAsItWouldBeOrWhyItIsRefused", "description": "Shows each email record (such as SPF and DMARC) as it is and as it would be, or why a change is refused. `mode` is required: `protect` for a domain that receives mail, `no_mail` for one that sends none; `live=1` also checks against public DNS. Changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "mode", "description": "`protect` (a domain that receives mail) or `no_mail`.", "example": "protect", "required": true, "schema": { "type": "string", "description": "`protect` (a domain that receives mail) or `no_mail`.", "example": "protect" } }, { "in": "query", "name": "provider", "description": "A mail provider key, when MX names nobody with an SPF include.", "example": "google_workspace", "required": false, "schema": { "type": "string", "description": "A mail provider key, when MX names nobody with an SPF include.", "example": "google_workspace" } }, { "in": "query", "name": "live", "description": "Also check each record against public DNS, and look for the DKIM key there.", "example": true, "required": false, "schema": { "type": "boolean", "description": "Also check each record against public DNS, and look for the DKIM key there.", "example": true } }, { "in": "query", "name": "dkim_target", "description": "Microsoft 365: the selector1 CNAME target as Defender shows it.", "example": "selector1-acme-com._domainkey.contoso.onmicrosoft.com", "required": false, "schema": { "type": "string", "description": "Microsoft 365: the selector1 CNAME target as Defender shows it.", "example": "selector1-acme-com._domainkey.contoso.onmicrosoft.com" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "zone_id": 1, "zone": "northwind.com", "mode": "no_mail", "route": "here", "where": { "label": "Cloudflare", "url": null }, "provider": null, "providers": [], "records": [], "refusals": [ { "key": "mode", "reason": "receives_mail", "params": [] } ], "lookups": null, "dkim": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/caa-protection": { "get": { "summary": "Preview CAA protection for a zone", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_idCaaProtection", "description": "Shows the CAA records that would be added, each of the zone’s certificates and whether it stays renewable, or why a change is refused. `live=1` also checks each record against public DNS. Changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "live", "description": "Also check each record to add against public DNS.", "example": true, "required": false, "schema": { "type": "boolean", "description": "Also check each record to add against public DNS.", "example": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "zone_id": 1, "zone": "northwind.com", "route": "here", "where": { "label": "Cloudflare", "url": null }, "records": [ { "key": "kept:7", "action": "none", "type": "CAA", "name": "@", "value": "0 issue \"letsencrypt.org\"", "current": null, "record_id": null, "reason": "caa_kept", "params": [] }, { "key": "issue:globalsign.com", "action": "create", "type": "CAA", "name": "@", "value": "0 issue \"globalsign.com\"", "current": null, "record_id": null, "reason": "caa_cert", "params": { "subject": "shop.northwind.com" } } ], "refusals": [], "certificates": [ { "id": 1, "subject": "northwind.com", "issuer": "Let's Encrypt (R3)", "ca": "letsencrypt.org", "wildcard": false, "state": "stays_renewable" }, { "id": 13, "subject": "cdn.northwind.com", "issuer": "Let's Encrypt (R3)", "ca": "letsencrypt.org", "wildcard": false, "state": "stays_renewable" } ], "fronts": [ { "label": "Cloudflare", "ids": [ "letsencrypt.org", "pki.goog" ], "publishes_own": true } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/dnssec": { "get": { "summary": "Get a zone’s DNSSEC status", "operationId": "theZonesDNSSECStateAtTheProviderReadOnly", "description": "Reads the zone’s DNSSEC state from its DNS provider, including the DS details to add at your registrar when signing is waiting on that step. `status` is null when the provider cannot sign the zone or its state could not be read.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "status": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-zones/{dnsZone_id}/dns-records/{record_id}/propagation": { "get": { "summary": "Check a record’s propagation", "operationId": "getApiOrganizationsOrganization_idDnsZonesDnsZone_idDnsRecordsRecord_idPropagation", "description": "Asks public DNS resolvers for the record and reports, per resolver, whether its stored value is live yet; `tier=fast` uses only the quicker resolvers. With `landing=1` it instead reports whether the record’s latest change (or the one in `change_id`) has taken effect, and `landing` is null when nothing changed recently.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "dnsZone_id", "required": true, "description": "The dnsZone's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "record_id", "required": true, "description": "The record's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-templates": { "get": { "summary": "List DNS templates", "operationId": "getApiOrganizationsOrganizationIdDnsTemplates", "description": "The built-in DNS templates followed by your organization’s custom templates, each with its records, plus the TTL values a template can use.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "builtin": [ { "id": null, "slug": "google-workspace", "name": "Google Workspace", "description": "MX records, SPF, and DMARC starter for Google Workspace email.", "is_builtin": true, "records": [ { "type": "MX", "name": "@", "value": "aspmx.l.google.com.", "ttl": 3600, "priority": 1 }, { "type": "MX", "name": "@", "value": "alt1.aspmx.l.google.com.", "ttl": 3600, "priority": 5 } ] }, { "id": null, "slug": "microsoft-365", "name": "Microsoft 365", "description": "MX record, SPF, Autodiscover CNAME, and DMARC starter for Microsoft 365. The MX is filled in from the domain.", "is_builtin": true, "records": [ { "type": "MX", "name": "@", "value": "{zone_dashed}.mail.protection.outlook.com.", "ttl": 3600, "priority": 0 }, { "type": "TXT", "name": "@", "value": "v=spf1 include:spf.protection.outlook.com -all", "ttl": 3600 } ] } ], "custom": [ { "id": 1, "organization_id": 1, "name": "Google Workspace mail", "description": "MX, SPF and DKIM for a domain that sends mail through Google Workspace.", "slug": "google-workspace-mail", "is_builtin": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "records": [ { "id": 1, "dns_template_id": 1, "type": "MX", "name": "@", "value": "aspmx.l.google.com", "ttl": 3600, "priority": 1, "proxied": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" }, { "id": 2, "dns_template_id": 1, "type": "MX", "name": "@", "value": "alt1.aspmx.l.google.com", "ttl": 3600, "priority": 5, "proxied": false, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z" } ] } ], "ttl_options": [ 1, 30 ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-templates/{templateKey}/preview/{zone_id}": { "get": { "summary": "Preview applying a template", "operationId": "previewWhatApplyingATemplateToAZoneWouldDo", "description": "Shows each of the template’s records for the zone with its status (such as `add`, `overwrite` or `unchanged`), the existing value it would replace and the TTL the zone will actually get. `templateKey` is a built-in template’s slug or a custom template’s id; changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "templateKey", "required": true, "description": "The templateKey.", "schema": { "type": "string" } }, { "in": "path", "name": "zone_id", "required": true, "description": "The zone's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "type": "A", "name": "@", "value": "{server_ipv4}", "ttl": 3600, "priority": null, "proxied": false, "unfilled": "{server_ipv4}", "status": "skipped", "existing_value": null, "reason": "The A record \"@\" needs a value the template cannot know ({server_ipv4}). Add it yourself." }, { "type": "AAAA", "name": "@", "value": "{server_ipv6}", "ttl": 3600, "priority": null, "proxied": false, "unfilled": "{server_ipv6}", "status": "skipped", "existing_value": null, "reason": "The AAAA record \"@\" needs a value the template cannot know ({server_ipv6}). Add it yourself." } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "dns.read", "x-infranest-token-writable": false, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/dns-templates/{templateKey}/apply/{zone_id}": { "post": { "summary": "Apply a template to a zone", "operationId": "applyATemplateToAZoneCreatingOrUpdatingRecords", "description": "Creates or updates the template’s records in the zone and pushes each change to the DNS provider; with `overwrite=false`, records that already exist with the same type and name are left alone. `dry_run=1` returns the changes without making any. A CAA record that would block a certificate’s renewal is refused with 409 unless `confirm_caa_impact` is sent.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "templateKey", "required": true, "description": "The templateKey.", "schema": { "type": "string" } }, { "in": "path", "name": "zone_id", "required": true, "description": "The zone's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "dry_run", "description": "Answer with the changes this would make, and make none.", "example": true, "required": false, "schema": { "type": "boolean", "description": "Answer with the changes this would make, and make none.", "example": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "added": 1, "overwritten": 0, "failed": 0, "error": null, "skipped": 2, "skipped_reason": "The A record \"@\" needs a value the template cannot know ({server_ipv4}). Add it yourself. The AAAA record \"@\" needs a value the template cannot know ({server_ipv6}). Add it yourself.", "message": "Applied Static Site: 1 records added, 0 updated. 2 skipped: The A record \"@\" needs a value the template cannot know ({server_ipv4}). Add it yourself. The AAAA record \"@\" needs a value the template cannot know ({server_ipv6}). Add it yourself." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "overwrite": { "type": "boolean", "description": "", "example": true, "nullable": true }, "confirm_caa_impact": { "type": "boolean", "description": "Apply even though a template CAA record blocks a certificate's renewing CA (#3168) — after a 409.", "example": true, "nullable": true } } } } } }, "x-infranest-scope": "dns.write", "x-infranest-token-writable": true, "x-infranest-module": "dns", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/sandbox/reset": { "post": { "summary": "Reset a sandbox", "operationId": "removeEverythingInASandboxAndSeedItsSampleDataAgainTheAppAndTheSandboxsOwnTestTokensMayCallItResettingBetweenRunsIsWhatATestSuiteDoesAnythingButASandboxAnswers404", "description": "Removes everything in your sandbox organization and restores its sample zones, records, monitors, server and tags. Works only on a sandbox, with its own test token or from the app; any other organization answers 404.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": null, "x-infranest-token-writable": true, "x-infranest-module": "organization", "x-infranest-errors": [ "unauthenticated", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/metrics-overview": { "get": { "summary": "List servers with their latest metrics", "operationId": "serverSideListUXConvergence139CPUNetworkStatusAreDerivedFromTheLatestMetricAndFromWhatIsWatchingTheServerSoTheyreExposedAsCorrelatedSubSelectsTheSortWhitelistCanOrderBy", "description": "Every server in the organization with its latest CPU, memory, disk, load and network readings, its alert-rule counts and whether it is breaching, a page at a time. Monitored servers come first; filter with `search`, `credential`, `tag` or `status` (for example `breaching`, `norules`, `notreporting`, `monitored`).", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 12, "organization_id": 1, "provider": "digitalocean", "provider_server_id": "111", "name": "queue-01", "status": "running", "server_type": "s-4vcpu-8gb", "image": "ubuntu-24-04-x64", "ipv4": "192.0.2.40", "ipv6": "2001:db8:3:d0::a22:1/64", "datacenter": "fra1", "provisioned_at": "2025-08-06T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "price_monthly": "48.00", "price_hourly": "0.0658", "location_city": "Frankfurt", "location_country": "DE", "included_traffic": 5497558138880, "outgoing_traffic": 1044536046387, "incoming_traffic": 384829069722, "ipv4_dns_ptr": "queue-01.northwind.cloud", "firewall_enabled": false }, "provider_credential_id": 9, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": null, "delete_protection": false, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "agent", "monitoring_enabled": true, "monitoring_enabled_at": null, "breached_rules": 0, "cpu_percent": 64.03, "network_in_bps": 14121908, "network_out_bps": 10591431, "memory_percent": 67.71, "worst_mount_percent": 55, "load_1": 2.56, "load_5": 2.49, "load_15": 2.42, "collected_at": "2026-01-13 12:05:00", "agent_last_seen_at": null, "agent_tokens_count": 0, "silence": null, "active_rules": 1, "in_breach": false, "coverage": "agent", "provider_metrics": true, "worst_mount_point": "/", "disk_forecast": { "mount_point": "/", "days_left": 39, "percent_per_day": 1.08, "fit": 0.99, "from_percent": 57 }, "load_24h": [ 2.28, 2.11 ], "agent_version": null, "agent_status": "unknown", "agent_refusal": null, "hardware": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160, "plan": { "vcpus": 4, "ram_gb": 8, "disk_gb": 160 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "tags": [ { "id": 1, "name": "Production", "color": "#ef4444", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 12, "tag_id": 1 } } ] }, { "id": 10, "organization_id": 1, "provider": "digitalocean", "provider_server_id": "109", "name": "staging-web-01", "status": "running", "server_type": "s-2vcpu-4gb", "image": "ubuntu-24-04-x64", "ipv4": "192.0.2.10", "ipv6": "2001:db8:800:c1::a10:1/64", "datacenter": "ams3", "provisioned_at": "2025-08-30T12:00:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "meta": { "vcpus": 2, "ram_gb": 4, "disk_gb": 80, "price_monthly": "24.00", "price_hourly": "0.0329", "location_city": "Amsterdam", "location_country": "NL", "included_traffic": 4398046511104, "outgoing_traffic": 483785116221, "incoming_traffic": 219902325555, "ipv4_dns_ptr": "staging-web-01.northwind.cloud", "firewall_enabled": false }, "provider_credential_id": 9, "price_monthly": null, "price_source": "api", "price_currency": null, "backup_price_override": null, "delete_protection": false, "untracked_at": null, "price_amount": null, "billing_interval": "monthly", "interval_count": 1, "metrics_source": "provider", "monitoring_enabled": true, "monitoring_enabled_at": null, "breached_rules": 0, "cpu_percent": 8.67, "network_in_bps": 3530477, "network_out_bps": 7060954, "memory_percent": null, "worst_mount_percent": null, "load_1": null, "load_5": null, "load_15": null, "collected_at": "2026-01-13 12:05:00", "agent_last_seen_at": null, "agent_tokens_count": 0, "silence": null, "active_rules": 1, "in_breach": false, "coverage": "provider", "provider_metrics": true, "worst_mount_point": null, "disk_forecast": null, "load_24h": null, "agent_version": null, "agent_status": "unknown", "agent_refusal": null, "hardware": { "vcpus": 2, "ram_gb": 4, "disk_gb": 80, "plan": { "vcpus": 2, "ram_gb": 4, "disk_gb": 80 }, "machine": { "vcpus": null, "ram_gb": null, "disk_gb": null }, "mismatch": [], "disk_unallocated": false }, "live_status": "running", "sync_halt": null, "tags": [ { "id": 2, "name": "Staging", "color": "#f59e0b", "pivot": { "taggable_type": "App\\Models\\CloudServer", "taggable_id": 10, "tag_id": 2 } } ] } ], "first_page_url": "http://localhost/api/organizations/1/cloud-servers/metrics-overview?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/cloud-servers/metrics-overview?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/cloud-servers/metrics-overview?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/cloud-servers/metrics-overview", "per_page": 25, "prev_page_url": null, "to": 14, "total": 14, "meta": { "counts": { "total": 14, "breaching": 0, "noagent": 9, "notreporting": 4, "ok": 10, "norules": 0, "notmonitored": 3, "monitored": 11, "avgCpu": 29 }, "agent_silent_after_seconds": 300, "counted_at": "2026-01-15T12:00:00.000000Z", "integrations": [ { "id": 9, "provider": "digitalocean", "label": "DigitalOcean — Staging" }, { "id": 1, "provider": "hetzner", "label": "Hetzner — Production" } ], "tags": [ { "id": 3, "name": "Customer-facing", "color": "#3b82f6" }, { "id": 6, "name": "Northwind Platform", "color": "#14b8a6" } ] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/metric-series": { "get": { "summary": "Get a server’s stored metric series", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idMetricSeries", "description": "Time series InfraNest has stored for this server, as `[unix seconds, value]` pairs, oldest first, with the alert threshold that applies to each metric. Pick a comma-separated `metrics` list, then either a fixed `range` (`live`, `h1`, `h12`, `h24`, `d7`, `d30`; default `h24`) or your own window with `from` and `to` (ISO 8601) and optionally `resolution`: `raw` for every sample (kept for 48 hours, at most 48 hours per request) or `hour` for hourly averages (at most 92 days per request). Without `resolution`, raw samples are used when they still cover the window. A longer range is refused with `range_too_large`. Points are paged with `page` and `per_page` (up to 10,000, the default); `pagination` says how many points the window holds and `window` the range that was applied.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "metrics", "description": "Comma-separated metrics. Default `cpu_percent,memory_percent,worst_mount_percent,load_1`.", "example": "cpu_percent,memory_percent", "required": false, "schema": { "type": "string", "description": "Comma-separated metrics. Default `cpu_percent,memory_percent,worst_mount_percent,load_1`.", "example": "cpu_percent,memory_percent" } }, { "in": "query", "name": "range", "description": "A fixed window: `live`, `h1`, `h12`, `h24`, `d7` or `d30`. Default `h24`.", "example": "d7", "required": false, "schema": { "type": "string", "description": "A fixed window: `live`, `h1`, `h12`, `h24`, `d7` or `d30`. Default `h24`.", "example": "d7" } }, { "in": "query", "name": "from", "description": "Start of your own window, ISO 8601, instead of `range`.", "example": "2026-01-15T09:30:00", "required": false, "schema": { "type": "string", "description": "Start of your own window, ISO 8601, instead of `range`.", "example": "2026-01-15T09:30:00" } }, { "in": "query", "name": "to", "description": "End of your own window, ISO 8601; default now.", "example": "2026-01-15T09:30:00", "required": false, "schema": { "type": "string", "description": "End of your own window, ISO 8601; default now.", "example": "2026-01-15T09:30:00" } }, { "in": "query", "name": "resolution", "description": "`raw` or `hour`; default: raw when the samples still cover the window.", "example": "hour", "required": false, "schema": { "type": "string", "description": "`raw` or `hour`; default: raw when the samples still cover the window.", "example": "hour" } }, { "in": "query", "name": "per_page", "description": "Points per page, 1 to 10,000. Default 10,000.", "example": 1000, "required": false, "schema": { "type": "integer", "description": "Points per page, 1 to 10,000. Default 10,000.", "example": 1000 } }, { "in": "query", "name": "page", "description": "Page number, from 1.", "example": 1, "required": false, "schema": { "type": "integer", "description": "Page number, from 1.", "example": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "range": "h24", "window": { "from": "2026-01-14T12:00:00Z", "to": "2026-01-15T12:00:00Z" }, "source": "agent", "resolution": "raw", "series": { "cpu_percent": [ [ 1768392000, 24.25 ], [ 1768392300, 23.23 ] ], "memory_percent": [ [ 1768392000, 62.8 ], [ 1768392300, 62.43 ] ], "worst_mount_percent": [ [ 1768392000, 33 ], [ 1768392300, 33 ] ], "load_1": [ [ 1768392000, 0.97 ], [ 1768392300, 0.93 ] ] }, "pagination": { "page": 1, "per_page": 10000, "total": 289, "last_page": 1 }, "thresholds": { "cpu_percent": { "operator": ">", "threshold": 85, "duration_minutes": 15 }, "memory_percent": null, "worst_mount_percent": null, "load_1": null }, "facts": { "vcpus": 4, "worst_mount": { "mount_point": "/", "used_bytes": 58411555225, "total_bytes": 171798691840, "days_left": 61 } } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "range": { "type": "string", "description": "" }, "metrics": { "type": "string", "description": "", "example": "architecto" }, "page": { "type": "integer", "description": "Must be at least 1.", "example": 22 }, "per_page": { "type": "string", "description": "" } } } } } }, "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/agent-snapshot": { "get": { "summary": "Get a server’s agent snapshot", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idAgentSnapshot", "description": "The latest state the monitoring agent reported from inside the server: disk mounts with forecasts, top processes, watched services, containers and ignored units. Also includes the agent’s own health, version status and whether alerts are currently quiet.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "container_names": [], "mounts": [ { "mount_point": "/", "device": "/dev/sda1", "used_bytes": 58411555225, "total_bytes": 171798691840, "used_percent": 34, "inodes_percent": null, "collected_at": "2026-01-15T12:00:00.000000Z", "usage": null, "scan": null, "forecast": { "days_left": 61, "percent_per_day": 1.08, "fit": 0.99, "from_percent": 34 } } ], "processes": [], "services": [], "services_summary": { "watched": 0, "active": 0, "failed": 0, "ignored": 0 }, "ignored_units": [], "containers": null, "collected_at": "2026-01-15T12:00:00.000000Z", "metrics_source": "agent", "uptime_seconds": 3542400, "agent_health": null, "agent_status": "unknown", "agent_latest_version": null, "has_token": false, "alerts_quiet_until": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/container-names": { "put": { "summary": "Name a container", "operationId": "putApiOrganizationsOrganization_idCloudServersCloudServer_idContainerNames", "description": "Gives one of the server’s reported containers a display name in InfraNest, identified by `container_id`. Returns the server’s full list of saved container names; each server has a cap on saved names.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "container_names": [ { "container_id": "3f2a9c1b7d4e", "display_name": "web" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "container_id": { "type": "string", "description": "Must match the regex /\\A[0-9a-f]{12,64}\\z/.", "example": "A5c489f179aebz" }, "display_name": { "type": "string", "description": "Must match the regex /\\A[^\\p{C}]+\\z/u. Must not be greater than 100 characters.", "example": "w" } }, "required": [ "container_id", "display_name" ] }, "example": { "container_id": "3f2a9c1b7d4e", "display_name": "web" } } } }, "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Remove a container name", "operationId": "deleteApiOrganizationsOrganization_idCloudServersCloudServer_idContainerNames", "description": "Removes the display name saved for the container given in `container_id`. Returns the server’s remaining saved container names.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "container_names": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "container_id": { "type": "string", "description": "Must match the regex /\\A[0-9a-f]{12,64}\\z/.", "example": "A5c489f179aebz" } }, "required": [ "container_id" ] }, "example": { "container_id": "3f2a9c1b7d4e" } } } }, "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/attention": { "get": { "summary": "Get what needs attention on a server", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idAttention", "description": "A short summary of the server: its uptime, whether alerts are quiet and until when, and the metric trend closest to crossing its alert threshold. Fields are null when there is nothing to say.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "uptime_seconds": 3542400, "alerts_quiet_until": null, "silence": null, "trend": { "metric": "disk_used_percent", "mount_point": "/", "current": 34, "per_day": 1.08, "days_left": 61, "threshold": null, "also_moving": 0, "window_days": 7 }, "others_ok": true, "certificates": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/snooze": { "post": { "summary": "Snooze a server’s alerts", "operationId": "postApiOrganizationsOrganization_idCloudServersCloudServer_idSnooze", "description": "Silences the server’s alerts for `minutes` (5 to 1440) by creating a short maintenance window, and returns when it ends. Refused when your plan does not include maintenance windows.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "maintenance_window_id": 5, "until": "2026-01-15T13:00:00+00:00" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "minutes": { "type": "integer", "description": "Capped at a day. Beyond that somebody wants a scheduled window with a name and a reason,\nwhich is the full form — a snooze that can run for a week is a way to switch monitoring off\nand forget you did. Must be at least 5. Must not be greater than 1440.", "example": 1 } } }, "example": { "minutes": 60 } } } }, "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] }, "delete": { "summary": "End a server’s snooze", "operationId": "endTheSilenceBeforeItRunsOut1870", "description": "Ends a snooze before it runs out. Scheduled maintenance windows are left alone, so the response says whether anything was ended and until when alerts are still quiet.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ended": 0, "alerts_quiet_until": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/ignored-units": { "post": { "summary": "Ignore a failed service", "operationId": "postApiOrganizationsOrganization_idCloudServersCloudServer_idIgnoredUnits", "description": "Stops a failed system service, named in `unit`, from raising alerts on this server, without silencing other service failures. Any name is accepted; returns the server’s list of ignored units.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "ignored_units": [ { "unit": "snapd.service", "ignored_at": "2026-01-15T12:00:00+00:00", "ignored_by": "Alex Rivera" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "requestBody": { "required": true, "content": { "application/json": { "example": { "unit": "snapd.service" } } } }, "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] }, "delete": { "summary": "Stop ignoring a failed service", "operationId": "deleteApiOrganizationsOrganization_idCloudServersCloudServer_idIgnoredUnits", "description": "Lets the service named in `unit` raise alerts again on this server; if it is still failed, it counts from now. Returns the remaining ignored units.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ignored_units": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "requestBody": { "required": true, "content": { "application/json": { "example": { "unit": "snapd.service" } } } }, "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/monitoring": { "post": { "summary": "Turn on monitoring for a server", "operationId": "postApiOrganizationsOrganization_idCloudServersCloudServer_idMonitoring", "description": "Starts monitoring the server in InfraNest and returns how many monitored servers your plan allows and uses. Refused when you have reached that limit; repeating it on a monitored server changes nothing.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "monitoring_enabled": true, "monitoring_enabled_at": null, "usage": 11, "limit": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] }, "delete": { "summary": "Turn off monitoring for a server", "operationId": "deleteApiOrganizationsOrganization_idCloudServersCloudServer_idMonitoring", "description": "Stops monitoring the server and frees its place in your plan’s monitored-server count. The server itself is not affected.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "monitoring_enabled": false, "monitoring_enabled_at": null, "usage": 10, "limit": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/agent-release": { "get": { "summary": "Get the latest monitoring agent release", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idAgentRelease", "description": "The current release of the InfraNest monitoring agent with its checksums, the install script URLs and the address the agent should report to. The answer is the same for every server.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "version": null, "published_at": null, "install_sh_sha256": null, "install_ps1_sha256": null, "repo": "InfraNest-Infrastructure-Organized/infranest-agent", "install_sh_url": "https://get.infranest.io/agent.sh", "install_ps1_url": "https://get.infranest.io/agent.ps1", "checksums_url": "https://github.com/InfraNest-Infrastructure-Organized/infranest-agent/releases/latest/download/SHA256SUMS", "releases_url": "https://github.com/InfraNest-Infrastructure-Organized/infranest-agent/releases", "ingest_url": "http://localhost" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/agent-tokens": { "get": { "summary": "List a server’s agent tokens", "operationId": "getApiOrganizationsOrganization_idCloudServersCloudServer_idAgentTokens", "description": "The tokens the monitoring agent on this server can report with, newest first, with who created each and when it was last used. The token values themselves are never returned.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/alert-rules": { "get": { "summary": "List a server’s alert rules", "operationId": "whatIsWatchingThisServerTheWholeCatalogueAlways1789", "description": "Every alert in the catalogue for this server, each marked as inherited from the organization, overridden here or not configured, plus any older standalone rules. With `active=1` it returns only the rules actually being evaluated, as a flat list.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "key": "cpu_percent", "group": "struggling", "kind": "metric", "metric": "cpu_percent", "agent_only": false, "duration_unit": "minutes", "duration_bounds": { "min": 1, "max": 1440 }, "recommended": { "operator": ">", "threshold": 90, "duration_minutes": 10 }, "origin": "inherited", "configured": true, "default_active": true, "is_active": true, "operator": ">", "threshold": 85, "duration_minutes": 15, "default_id": 1, "override_id": null, "inherited_threshold": null, "inherited_duration_minutes": null, "is_breaching": false, "advisory": false, "in_breach_since": null, "subject": null }, { "key": "memory_percent", "group": "struggling", "kind": "metric", "metric": "memory_percent", "agent_only": true, "duration_unit": "minutes", "duration_bounds": { "min": 1, "max": 1440 }, "recommended": { "operator": ">", "threshold": 90, "duration_minutes": 10 }, "origin": "unconfigured", "configured": false, "default_active": false, "is_active": false, "operator": ">", "threshold": 90, "duration_minutes": 10, "default_id": null, "override_id": null, "inherited_threshold": null, "inherited_duration_minutes": null, "is_breaching": false, "advisory": false, "in_breach_since": null, "subject": null } ], "legacy": [], "min_duration_minutes": 1 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/alert-rules/{alertRule_id}": { "patch": { "summary": "Update a server alert rule", "operationId": "nostoreAddingARuleToOneServerIsWhat1789RemovedTheCatalogueIsFixedSoThereWasNeverAnythingToAddAndARuleVisibleOnOneServerAndNowhereElseIsExactlyTheSecondAuthoringPathThatMadeAlertingHardToReasonAboutSwitchingAnEntryOnForTheOrganisationIsseeAlertRuleDefaultControllerupsertTurningItOffForOneServerIsAnOverrideWithisActiveFalseWhichoverrideBelowAlreadyWrites", "description": "Changes the `operator`, `threshold`, `duration_minutes` or `is_active` of one of this server’s rules. Changing the operator or threshold clears any breach the rule was tracking; durations outside the allowed range, or shorter than your plan allows, are refused.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "alertRule_id", "required": true, "description": "The alertRule's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "server_id": 1, "metric": "cpu_percent", "operator": ">", "threshold": 85, "duration_minutes": 10, "is_active": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "alert_rule_default_id": null, "kind": "metric" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "operator": { "type": "string", "description": "", "example": ">", "enum": [ ">", "<" ] }, "threshold": { "type": "number", "description": "", "example": 4326.41688 }, "duration_minutes": { "type": "string", "description": "The widest range any kind allows; the kind's own bounds are checked once it is known." }, "is_active": { "type": "boolean", "description": "", "example": true } } }, "example": { "threshold": 85 } } } }, "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Reset or delete a server alert rule", "operationId": "deleteApiOrganizationsOrganization_idCloudServersCloudServer_idAlertRulesAlertRule_id", "description": "Removes the rule from this server. For an override, the organization’s default applies again; an older standalone rule is simply deleted.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "alertRule_id", "required": true, "description": "The alertRule's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Deleted." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/cloud-servers/{cloudServer_id}/alert-rule-overrides": { "put": { "summary": "Override an alert rule for a server", "operationId": "overrideTheBaselineForThisServerOnlyOnOffOrDifferentNumbers", "description": "Sets this server’s own version of an organization alert, identified by `default_id` or a catalogue `key`, with any of `operator`, `threshold`, `duration_minutes` and `is_active`. Send `is_active: false` to stop watching it on this server only; anything you leave out is copied from the organization default.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "cloudServer_id", "required": true, "description": "The cloudServer's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "id": 2, "organization_id": 1, "server_id": 1, "metric": "cpu_percent", "operator": ">", "threshold": 85, "duration_minutes": 15, "is_active": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "alert_rule_default_id": 1, "kind": "metric" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "default_id": { "type": "integer", "description": "This field is required when key is not present.", "example": 16 }, "key": { "type": "string", "description": "This field is required when default_id is not present.", "example": "architecto" }, "operator": { "type": "string", "description": "", "example": ">", "enum": [ ">", "<" ] }, "threshold": { "type": "number", "description": "", "example": 4326.41688 }, "duration_minutes": { "type": "string", "description": "The widest range any kind allows; the kind's own bounds are checked once it is known." }, "is_active": { "type": "boolean", "description": "", "example": true } } }, "example": { "key": "cpu_percent", "threshold": 85 } } } }, "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/endpoints/{endpointId}/retrack": { "post": { "summary": "Track an address again", "operationId": "trackItAgainTakesAnIdNotABoundModelTheGlobalScopeHidesAnUntrackedAddressFromEveryQueryIncludingRouteModelBindingAndThisIsTheOneEndpointWhoseJobIsToReachOneResolvedWithinTheOrganisationSoItCanOnlyFindAnAddressThisOrgOwns", "description": "Brings an untracked address back so it is checked and shown again. Its certificates and monitor were never changed.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "endpointId", "required": true, "description": "The endpointId.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "endpoint_id": 1, "untracked_at": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "cloud.write", "x-infranest-token-writable": true, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/monitoring/active-regions": { "get": { "summary": "List active probe regions", "operationId": "getApiMonitoringActiveRegions", "description": "The regions that currently have at least one active probe, as a sorted list of region names. Use these values when choosing where a monitor runs.", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "rate_limited" ] } }, "/api/organizations/{organization_id}/external-services": { "get": { "summary": "List external services", "operationId": "getApiOrganizationsOrganization_idExternalServices", "description": "The third-party services you can watch: the curated catalogue plus any you added yourself. Each comes with its status page address, overall status, components and when it was last polled.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 16, "name": "Anthropic", "status_url": "https://status.anthropic.com", "schema": null, "overall_status": "unknown", "components": null, "is_curated": true, "last_polled_at": null }, { "id": 19, "name": "Atlassian", "status_url": "https://status.atlassian.com", "schema": null, "overall_status": "unknown", "components": null, "is_curated": true, "last_polled_at": null } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/email-dns-monitors": { "get": { "summary": "Preview email DNS monitors for a domain", "operationId": "theChecksstoreWouldCreateForThisDomainAndHowManyMonitorsThatIs", "description": "Looks up the MX, SPF and DMARC records the domain in `domain` publishes and returns the DNS monitors that would watch those records. Nothing is created; `resolved` is false when the lookup failed.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create email DNS monitors for a domain", "operationId": "postApiOrganizationsOrganization_idEmailDnsMonitors", "description": "Creates one DNS monitor for each MX, SPF and DMARC record the domain in `domain` publishes right now, and queues a first check of each. Either every monitor is created or none is: the request is refused when the domain publishes none of those records or the monitors would exceed your plan.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success. No example of this answer is recorded yet." }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/dependencies": { "get": { "summary": "List a monitor’s dependencies", "operationId": "getApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idDependencies", "description": "The monitors this one depends on (`parents`) and the monitors that depend on it (`children`), each with its name, type, target and current status.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "parents": [], "children": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Add a monitor dependency", "operationId": "postApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idDependencies", "description": "Pass `parent_check_id` to make this monitor depend on another, or `child_check_id` to make another depend on it. Both monitors must be yours, and a dependency on itself or one that would form a loop is refused.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "parent_check_id": 1, "child_check_id": 3, "organization_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 2 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "parent_check_id": { "type": "integer", "description": "This field is required when child_check_id is not present. Must match an existing stored value.", "example": 16, "nullable": true }, "child_check_id": { "type": "integer", "description": "This field is required when parent_check_id is not present. Must match an existing stored value.", "example": 16, "nullable": true } } }, "example": { "child_check_id": 3 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/monitoring-checks/{monitoringCheck_id}/dependencies/{otherCheck_id}": { "delete": { "summary": "Remove a monitor dependency", "operationId": "deleteApiOrganizationsOrganization_idMonitoringChecksMonitoringCheck_idDependenciesOtherCheck_id", "description": "Removes the dependency between the two monitors, in whichever direction it runs.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "monitoringCheck_id", "required": true, "description": "The monitoringCheck's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "otherCheck_id", "required": true, "description": "The otherCheck's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Deleted." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-links": { "get": { "summary": "List deploy links", "operationId": "getApiOrganizationsOrganization_idDeployLinks", "description": "Your links between a repository and a monitor, server or tag, each with its newest deploy. Pass `monitor` to list only that monitor’s own links; `deploys_connected` says whether anything can report deploys to your organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "id": 1, "repository": "northwind-cloud/app", "kind": "deployment", "environment": "production", "workflow": null, "branch": null, "target_type": "monitor", "target_id": 2, "target_name": "App — northwind-app.dev", "last_deploy_at": "2026-01-15T11:18:00+00:00", "has_deployments": true, "checking": true }, { "id": 2, "repository": "northwind-cloud/storefront", "kind": "deployment", "environment": "production", "workflow": null, "branch": null, "target_type": "monitor", "target_id": 4, "target_name": "Checkout flow", "last_deploy_at": "2026-01-15T11:17:00+00:00", "has_deployments": true, "checking": true } ], "deploys_connected": true, "source": { "key": "github", "label": "GitHub" } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a deploy link", "operationId": "postApiOrganizationsOrganization_idDeployLinks", "description": "Links deploys of a `repository` to a monitor, server or tag (`target_type` and `target_id`). `kind` chooses what counts as a deploy: `deployment` (optionally for one `environment`), `workflow` (a `workflow` file, optionally on one `branch`) or `release`; earlier deploys are imported in the background.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "id": 3, "repository": "northwind-cloud/app", "kind": "deployment", "environment": null, "workflow": null, "branch": null, "target_type": "server", "target_id": 1, "target_name": "web-01", "last_deploy_at": "2026-01-15T11:18:00+00:00", "has_deployments": true, "checking": true } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "repository": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "environment": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "n", "nullable": true }, "target_type": { "type": "string", "description": "", "example": "architecto" }, "target_id": { "type": "integer", "description": "", "example": 16 }, "kind": { "type": "string", "description": "What counts as a deploy (#2893). A workflow is named by its file, as GitHub's API addresses it.", "example": null, "nullable": true }, "workflow": { "type": "string", "description": "This field is required when kind is workflow. Must match the regex /^[\\w.-]+\\.ya?ml$/. Must not be greater than 255 characters.", "example": "n", "nullable": true }, "branch": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "g", "nullable": true } }, "required": [ "repository", "target_type", "target_id" ] }, "example": { "repository": "northwind-cloud/app", "target_type": "server", "target_id": 1 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-links/targets": { "get": { "summary": "List deploy link targets", "operationId": "whatALinkCanPointAtForThePickerThisOrgsMonitorsServersAndTags", "description": "The monitors, servers and tags a deploy link can point at, by ID and name.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "monitors": [ { "id": 3, "name": "API health" }, { "id": 2, "name": "App — northwind-app.dev" } ], "servers": [ { "id": 13, "name": "analytics-01" }, { "id": 3, "name": "api-01" } ], "tags": [ { "id": 3, "name": "Customer-facing" }, { "id": 4, "name": "Internal" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-links/check": { "get": { "summary": "Check whether a repository has deploys", "operationId": "whetherGitHubHasAnyDeployForARepository2892AskedWhileSomeonePicksItInTheFormSoARepositoryThatNeverDeploysIsSaidBeforeItIsLinkedCachedBrieflyTheFormAsksAsItIsTypedIntoNullWhenGitHubCouldNotBeAskedWhichNeverWarns", "description": "Whether GitHub has any deployment for `repository`, so you can tell before linking one that never deploys. `has_deployments` is null when GitHub could not be asked.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "has_deployments": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-links/{deployLink_id}": { "delete": { "summary": "Delete a deploy link", "operationId": "deleteApiOrganizationsOrganization_idDeployLinksDeployLink_id", "description": "Removes the link, so its deploys no longer appear on that monitor, server or tag.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "deployLink_id", "required": true, "description": "The deployLink's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-events": { "get": { "summary": "List deploys for a monitor or server", "operationId": "deploysLinkedToOneMonitorOrServerInATimeRangeForChartMarkers", "description": "The deploys linked to one monitor (`monitor`) or server (`server`) between `from` and `to`; the window defaults to the 24 hours before `to`, which defaults to now. Also lists the repositories linked to it.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [], "links": [], "receives_deploys": true, "manage_path": "/integrations/github" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor": { "type": "integer", "description": "This field is required when server is not present.", "example": 16 }, "server": { "type": "integer", "description": "This field is required when monitor is not present.", "example": 16 }, "from": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true }, "to": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true } } } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-events/sources": { "get": { "summary": "List repositories that have deployed", "operationId": "repositoriesAndEnvironmentsThatHaveAlreadyDeployedHereWhatTheLinkPickerOffersFirstBecauseTheyAreTheOnesThatWillActuallyDrawAMarker", "description": "Each repository and environment that has already reported a deploy to your organization, up to 500.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "repository": "northwind-cloud/app", "environment": "production" }, { "repository": "northwind-cloud/storefront", "environment": "production" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-events/{deployEvent_id}/changes": { "get": { "summary": "Get what a deploy changed", "operationId": "whatADeployIncluded2894TheCommitsAndPullRequestsSinceTheDeployBeforeItToTheSamePlaceTheSameRepositoryKindOfDeployWorkflowAndEnvironmentforAReleaseThePreviousReleaseAskedWhenSomeoneHoversAMarkerOrOpensAnIncidentNeverStored", "description": "The commits and pull requests since the previous successful deploy to the same place. Returns `first: true` when there is no earlier deploy to compare with, and `unavailable: true` when GitHub could not say.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "deployEvent_id", "required": true, "description": "The deployEvent's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "first": true } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/incidents": { "get": { "summary": "List incidents", "operationId": "getApiOrganizationsOrganization_idIncidents", "description": "A paginated list of your monitors’ incidents with their monitor, status, impact, latest update and who acknowledged each one, plus counts in `meta`. `period` is `24h`, `7d` (default), `30d` or `all`; filter with `status` (`open`, `acked` or `resolved`) and `search`, or pass `incident` to fetch a single incident whatever its age.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 2, "monitoring_check_id": 1, "source": "monitor", "title": "Brief marketing-site blip", "status": "resolved", "impact": "minor", "started_at": "2026-01-09T11:45:00.000000Z", "resolved_at": "2026-01-09T12:00:00.000000Z", "duration_seconds": 900, "cause": null, "description": null, "external_status": null, "external_url": null, "is_planned": false, "acknowledged_at": null, "acknowledged_by": null, "check": { "id": 1, "name": "Marketing site", "type": "http", "last_status": "up", "interval_minutes": 0 }, "updates": [ { "id": 5, "monitoring_incident_id": 2, "status": "resolved", "message": "A CDN configuration change was rolled back and the site recovered. No other services were affected.", "user_id": null, "created_at": "2026-01-09T12:00:00.000000Z", "user": null } ] }, { "id": 1, "monitoring_check_id": 4, "source": "monitor", "title": "Checkout returning 503", "status": "investigating", "impact": "major", "started_at": "2026-01-15T11:20:00.000000Z", "resolved_at": null, "duration_seconds": null, "cause": "Upstream payment gateway timeout", "description": null, "external_status": null, "external_url": null, "is_planned": false, "acknowledged_at": null, "acknowledged_by": null, "check": { "id": 4, "name": "Checkout flow", "type": "http", "last_status": "down", "interval_minutes": 0 }, "updates": [ { "id": 3, "monitoring_incident_id": 1, "status": "monitoring", "message": "The failover is live and checkout is succeeding again. Watching error rates before we call this resolved.", "user_id": null, "created_at": "2026-01-15T11:54:00.000000Z", "user": null } ] } ], "first_page_url": "http://localhost/api/organizations/1/incidents?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/incidents?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/incidents?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/incidents", "per_page": 25, "prev_page_url": null, "to": 2, "total": 2, "meta": { "counts": { "total": 2, "open": 1, "acked": 0, "resolved": 1 } } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "incidents", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/incidents/{incident_id}": { "patch": { "summary": "Update an incident", "operationId": "patchApiOrganizationsOrganization_idIncidentsIncident_id", "description": "Changes an incident’s `title`, `status`, `impact`, `description` or `is_planned`. Setting `status` to `resolved` resolves an open incident, and any other status reopens a resolved one; incidents imported from a third-party status page cannot be edited.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "incident_id", "required": true, "description": "The incident's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "monitoring_check_id": 4, "started_at": "2026-01-15T11:20:00.000000Z", "resolved_at": null, "duration_seconds": null, "cause": "Upstream payment gateway timeout", "affected_probe_ids": null, "acknowledged_at": null, "acknowledged_by": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "description": null, "is_planned": false, "title": "Checkout returning 503", "status": "identified", "impact": "major", "source": "monitor", "server_id": null, "cloud_server_alert_rule_id": null, "external_status": null, "external_url": null, "alert_rule_state_id": null, "folded_into": null, "unstable_at": null, "unstable_ended_at": null, "outage_count": 1, "down_since": null, "downtime_seconds": 0, "outages": null, "acknowledged_by_name": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b", "nullable": true }, "status": { "type": "string", "description": "", "example": "investigating", "enum": [ "investigating", "identified", "monitoring", "resolved" ] }, "impact": { "type": "string", "description": "", "example": "critical", "enum": [ "critical", "major", "minor", "none" ] }, "description": { "type": "string", "description": "Must not be greater than 5000 characters.", "example": "Et animi quos velit et fugiat.", "nullable": true }, "is_planned": { "type": "boolean", "description": "", "example": true } } }, "example": { "status": "identified", "impact": "major" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "incidents", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/incidents/{incident_id}/updates": { "get": { "summary": "Get an incident’s timeline", "operationId": "getApiOrganizationsOrganization_idIncidentsIncident_idUpdates", "description": "The incident’s public status updates and internal team notes, plus the alert channels that were notified, deploys shortly before it began, who PagerDuty is paging, notes from PagerDuty and tickets opened for it.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "incident_id", "required": true, "description": "The incident's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "updates": [ { "id": 3, "monitoring_incident_id": 1, "status": "monitoring", "message": "The failover is live and checkout is succeeding again. Watching error rates before we call this resolved.", "user_id": null, "created_at": "2026-01-15T11:54:00.000000Z", "user": null }, { "id": 8, "monitoring_incident_id": 1, "status": "investigating", "message": "The provider has acknowledged an incident on their side. We are holding while they work.", "user_id": 1, "created_at": "2026-01-15T11:51:00.000000Z", "user": { "id": 1, "first_name": null, "last_name": null, "analytics_id": null } } ], "team_notes": [], "notified": [ "email", "slack" ], "deploys": [ { "id": 9, "source": "github", "kind": "deployment", "workflow": null, "repository": "northwind-cloud/storefront", "environment": "production", "state": "success", "sha": "f19e6c7000000000000000000000000000000000", "ref": "main", "actor": "jordan-k", "url": "https://github.com/northwind-cloud/storefront/deployments", "deployed_at": "2026-01-15T11:17:00+00:00" } ], "oncall": [], "pagerduty_notes": [ { "id": 2, "author_name": "Alex Rivera", "content": "Secondary payment route is warmed up — Sam is switching checkout over to it now.", "created_at": "2026-01-15T11:45:00+00:00" }, { "id": 1, "author_name": "Sam Okoye", "content": "Payment gateway status page shows degraded API performance in eu-west. Opening a ticket with them.", "created_at": "2026-01-15T11:26:00+00:00" } ], "tickets": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "incidents", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Post an incident update", "operationId": "postApiOrganizationsOrganization_idIncidentsIncident_idUpdates", "description": "Posts a public status update with a `status` and `message`, and moves the incident to that status (`resolved` resolves it). Status page subscribers are notified unless you send `notify_subscribers: false`; incidents imported from a third-party status page cannot be updated.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "incident_id", "required": true, "description": "The incident's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "monitoring_incident_id": 1, "status": "monitoring", "message": "A fix is out; we are watching checkout recover.", "user_id": 1, "created_at": "2026-01-15T12:00:00.000000Z", "id": 9, "incident": { "id": 1, "monitoring_check_id": 4, "started_at": "2026-01-15T11:20:00.000000Z", "resolved_at": null, "duration_seconds": null, "cause": "Upstream payment gateway timeout", "affected_probe_ids": null, "acknowledged_at": null, "acknowledged_by": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "description": null, "is_planned": false, "title": "Checkout returning 503", "status": "investigating", "impact": "major", "source": "monitor", "server_id": null, "cloud_server_alert_rule_id": null, "external_status": null, "external_url": null, "alert_rule_state_id": null, "folded_into": null, "unstable_at": null, "unstable_ended_at": null, "outage_count": 1, "down_since": null, "downtime_seconds": 0, "outages": null, "acknowledged_by_name": null }, "user": { "id": 1, "first_name": null, "last_name": null, "analytics_id": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "", "example": "investigating", "enum": [ "investigating", "identified", "monitoring", "resolved" ] }, "message": { "type": "string", "description": "Must not be greater than 5000 characters.", "example": "b" }, "notify_subscribers": { "type": "boolean", "description": "", "example": true } }, "required": [ "status", "message" ] }, "example": { "status": "monitoring", "message": "A fix is out; we are watching checkout recover." } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "incidents", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/incidents/{incident_id}/acknowledge": { "post": { "summary": "Acknowledge an incident", "operationId": "postApiOrganizationsOrganization_idIncidentsIncident_idAcknowledge", "description": "Marks the incident as acknowledged by you, so your team knows someone is on it, and returns it with who acknowledged it.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "incident_id", "required": true, "description": "The incident's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "monitoring_check_id": 4, "started_at": "2026-01-15T11:20:00.000000Z", "resolved_at": null, "duration_seconds": null, "cause": "Upstream payment gateway timeout", "affected_probe_ids": null, "acknowledged_at": "2026-01-15T12:00:00.000000Z", "acknowledged_by": { "id": 1, "first_name": null, "last_name": null, "analytics_id": null }, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "description": null, "is_planned": false, "title": "Checkout returning 503", "status": "investigating", "impact": "major", "source": "monitor", "server_id": null, "cloud_server_alert_rule_id": null, "external_status": null, "external_url": null, "alert_rule_state_id": null, "folded_into": null, "unstable_at": null, "unstable_ended_at": null, "outage_count": 1, "down_since": null, "downtime_seconds": 0, "outages": null, "acknowledged_by_name": null, "check": { "id": 4, "organization_id": 1, "name": "Checkout flow", "type": "http", "target": "https://northwind.com/checkout", "enabled": true, "settings": [], "last_status": "down", "last_checked_at": "2026-01-15T11:58:00.000000Z", "deleted_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "last_message": "HTTP 503 — Service Unavailable", "consecutive_failures": 8, "flap_threshold": 2, "last_status_changed_at": "2026-01-15T11:20:00.000000Z", "consensus_threshold": 1, "preferred_regions": [ "EU" ], "probe_mode": "any", "ip_version": "prefer_ipv4", "slow_response_ms": null, "ssl_check_enabled": true, "ssl_expiry_days": 21, "heartbeat_uuid": null, "last_ping_at": null, "silenced_until": null, "silenced_by": null, "is_suppressed_by_parent": false, "external_service_id": null, "external_component_ids": null, "external_alerts_enabled": false, "region_checked_at": null, "region_consensus_threshold": null, "last_reason_code": null, "last_reason_params": null, "interval_seconds": 300, "badge_enabled": false, "badge_token": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "server_id": null, "server_link": null, "pagerduty_down_severity": "critical", "pagerduty_degraded_severity": "warning", "interval_minutes": 5 } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "incidents", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/incidents/{incident_id}/unacknowledge": { "post": { "summary": "Remove an incident acknowledgement", "operationId": "postApiOrganizationsOrganization_idIncidentsIncident_idUnacknowledge", "description": "Clears the acknowledgement so the incident reads as unhandled again.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "incident_id", "required": true, "description": "The incident's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "monitoring_check_id": 4, "started_at": "2026-01-15T11:20:00.000000Z", "resolved_at": null, "duration_seconds": null, "cause": "Upstream payment gateway timeout", "affected_probe_ids": null, "acknowledged_at": null, "acknowledged_by": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "description": null, "is_planned": false, "title": "Checkout returning 503", "status": "investigating", "impact": "major", "source": "monitor", "server_id": null, "cloud_server_alert_rule_id": null, "external_status": null, "external_url": null, "alert_rule_state_id": null, "folded_into": null, "unstable_at": null, "unstable_ended_at": null, "outage_count": 1, "down_since": null, "downtime_seconds": 0, "outages": null, "acknowledged_by_name": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "incidents", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/incidents/{incident_id}/notes": { "post": { "summary": "Add a team note to an incident", "operationId": "aNoteForTheTeam3795NeverTheStatusPageNotTheIncidentsFeatureLikeAcknowledging3796", "description": "Adds an internal note in `body` for your team. Notes never appear on a status page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "incident_id", "required": true, "description": "The incident's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "id": 1, "body": "Rolled back release 2026.01.15 — error rate back to normal.", "via": "app", "by": "Alex Rivera", "created_at": "2026-01-15T12:00:00+00:00" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "description": "", "example": "architecto" } }, "required": [ "body" ] }, "example": { "body": "Rolled back release 2026.01.15 — error rate back to normal." } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "incidents", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/maintenance-windows/{maintenanceWindow_id}": { "delete": { "summary": "Delete a maintenance window", "operationId": "deleteApiOrganizationsOrganization_idMaintenanceWindowsMaintenanceWindow_id", "description": "Permanently deletes the maintenance window.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "maintenanceWindow_id", "required": true, "description": "The maintenanceWindow's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Deleted." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "maintenance", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] }, "patch": { "summary": "Update a maintenance window", "operationId": "patchApiOrganizationsOrganization_idMaintenanceWindowsMaintenanceWindow_id", "description": "Changes the fields you send. Sending `check_ids` or `server_ids` replaces what the window covers, and an empty list clears it.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "maintenanceWindow_id", "required": true, "description": "The maintenanceWindow's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Database cluster upgrade", "description": "Primary database moves to PostgreSQL 17. Expect two minutes of read-only mode.", "starts_at": "2026-01-18T02:00:00.000000Z", "ends_at": "2026-01-18T03:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "recurrence_type": "none", "recurrence_days": null, "start_time": null, "duration_minutes": null, "suppress_alerts": true, "status": "scheduled", "notified_at": null, "source": "manual", "deploy_id": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "created_by": null, "checks": [], "servers": [], "tags": [], "is_active": false, "occurrence_starts_at": "2026-01-18T02:00:00Z", "occurrence_ends_at": "2026-01-18T03:00:00Z", "schedule_timezone": "UTC" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "description": { "type": "string", "description": "Must not be greater than 2000 characters.", "example": "Et animi quos velit et fugiat.", "nullable": true }, "recurrence_type": { "type": "string", "description": "", "example": "none", "enum": [ "none", "daily", "weekly" ], "nullable": true }, "recurrence_days": { "type": "array", "description": "Must be at least 0. Must not be greater than 6.", "example": [ 2 ], "items": { "type": "integer" } }, "start_time": { "type": "string", "description": "Must be a valid date in the format H:i.", "example": "09:30", "nullable": true }, "duration_minutes": { "type": "integer", "description": "Must be at least 1. Must not be greater than 1440.", "example": 5, "nullable": true }, "starts_at": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true }, "ends_at": { "type": "string", "description": "Must be a valid date. Must be a date after starts_at.", "example": "2026-01-15", "nullable": true }, "suppress_alerts": { "type": "boolean", "description": "", "example": true, "nullable": true }, "check_ids": { "type": "array", "description": "Must match an existing stored value.", "example": [ 16 ], "items": { "type": "integer" } }, "server_ids": { "type": "array", "description": "Must match an existing stored value.", "example": [ 16 ], "items": { "type": "integer" } } } }, "example": { "description": "Primary database moves to PostgreSQL 17. Expect two minutes of read-only mode." } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "maintenance", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/maintenance-windows/{maintenanceWindow_id}/verifying": { "patch": { "summary": "Mark a maintenance window as verifying", "operationId": "patchApiOrganizationsOrganization_idMaintenanceWindowsMaintenanceWindow_idVerifying", "description": "Moves a window that is in progress to `verifying`, while you check that everything works again. Refused for a window in any other state.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "maintenanceWindow_id", "required": true, "description": "The maintenanceWindow's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 4, "organization_id": 1, "name": "Database upgrade", "description": null, "starts_at": "2026-01-15T11:50:00.000000Z", "ends_at": "2026-01-15T13:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "recurrence_type": "none", "recurrence_days": null, "start_time": null, "duration_minutes": null, "suppress_alerts": true, "status": "verifying", "notified_at": null, "source": "manual", "deploy_id": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "created_by": null, "checks": [], "servers": [], "tags": [], "is_active": true, "occurrence_starts_at": "2026-01-15T11:50:00Z", "occurrence_ends_at": "2026-01-15T13:00:00Z", "schedule_timezone": "UTC" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "maintenance", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/maintenance-windows/{maintenanceWindow_id}/complete": { "patch": { "summary": "Complete a maintenance window", "operationId": "patchApiOrganizationsOrganization_idMaintenanceWindowsMaintenanceWindow_idComplete", "description": "Marks a window that is in progress or verifying as completed. Refused for a window in any other state.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "maintenanceWindow_id", "required": true, "description": "The maintenanceWindow's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 4, "organization_id": 1, "name": "Database upgrade", "description": null, "starts_at": "2026-01-15T11:50:00.000000Z", "ends_at": "2026-01-15T13:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "recurrence_type": "none", "recurrence_days": null, "start_time": null, "duration_minutes": null, "suppress_alerts": true, "status": "completed", "notified_at": null, "source": "manual", "deploy_id": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "created_by": null, "checks": [], "servers": [], "tags": [], "is_active": false, "occurrence_starts_at": null, "occurrence_ends_at": null, "schedule_timezone": "UTC" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "maintenance", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] } }, "/api/organizations/{organization_id}/maintenance-windows": { "get": { "summary": "List maintenance windows", "operationId": "getApiOrganizationsOrganization_idMaintenanceWindows", "description": "A paginated list of your maintenance windows with the monitors, servers and tags each window covers, whether each window is in effect and its current or next occurrence, plus counts in `meta`. Filter with `search`, `tag` and `status` (`active`, `scheduled`, `recurring` or `completed`), and sort with `sort` (`schedule`, `name`, `monitors` or `status`) and `dir`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "current_page": 1, "data": [ { "id": 3, "organization_id": 1, "name": "Nightly backup window", "description": "Alerts are suppressed while backups run.", "starts_at": null, "ends_at": null, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "recurrence_type": "daily", "recurrence_days": null, "start_time": "03:00", "duration_minutes": 45, "suppress_alerts": true, "status": "scheduled", "notified_at": null, "source": "manual", "deploy_id": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "created_by": null, "checks_count": 0, "checks": [], "servers": [], "tags": [], "is_active": false, "occurrence_starts_at": "2026-01-16T03:00:00Z", "occurrence_ends_at": "2026-01-16T03:45:00Z", "schedule_timezone": "UTC" }, { "id": 2, "organization_id": 1, "name": "Load balancer certificate rotation", "description": "Replaced the certificate on web-lb and reloaded the listeners.", "starts_at": "2026-01-06T01:00:00.000000Z", "ends_at": "2026-01-06T01:30:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "recurrence_type": "none", "recurrence_days": null, "start_time": null, "duration_minutes": null, "suppress_alerts": true, "status": "completed", "notified_at": null, "source": "manual", "deploy_id": null, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "created_by": null, "checks_count": 0, "checks": [], "servers": [], "tags": [], "is_active": false, "occurrence_starts_at": null, "occurrence_ends_at": null, "schedule_timezone": "UTC" } ], "first_page_url": "http://localhost/api/organizations/1/maintenance-windows?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/api/organizations/1/maintenance-windows?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "http://localhost/api/organizations/1/maintenance-windows?page=1", "label": "1", "page": 1, "active": true } ], "next_page_url": null, "path": "http://localhost/api/organizations/1/maintenance-windows", "per_page": 25, "prev_page_url": null, "to": 3, "total": 3, "meta": { "counts": { "total": 3, "active": 0, "scheduled": 1, "recurring": 1, "completed": 1 }, "tags": [] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "maintenance", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a maintenance window", "operationId": "postApiOrganizationsOrganization_idMaintenanceWindows", "description": "Schedules maintenance for the monitors in `check_ids` and servers in `server_ids`; a window with no monitors applies to every monitor. A one-time window needs `starts_at` and `ends_at`, a `daily` or `weekly` one needs `start_time` and `duration_minutes`, and alerts are suppressed during it unless `suppress_alerts` is false. Subscribers of the affected status pages are told about the new window.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "name": "Load balancer upgrade", "description": null, "recurrence_type": "none", "recurrence_days": null, "start_time": null, "duration_minutes": null, "starts_at": "2026-01-17T22:00:00.000000Z", "ends_at": "2026-01-17T23:00:00.000000Z", "suppress_alerts": true, "organization_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 6, "checks": [ { "id": 1, "name": "Marketing site", "type": "http", "interval_minutes": 0, "pivot": { "maintenance_window_id": 6, "monitoring_check_id": 1 } } ], "servers": [], "tags": [], "is_active": false, "occurrence_starts_at": "2026-01-17T22:00:00Z", "occurrence_ends_at": "2026-01-17T23:00:00Z", "schedule_timezone": "UTC" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "description": { "type": "string", "description": "Must not be greater than 2000 characters.", "example": "Et animi quos velit et fugiat.", "nullable": true }, "recurrence_type": { "type": "string", "description": "", "example": "none", "enum": [ "none", "daily", "weekly" ], "nullable": true }, "recurrence_days": { "type": "array", "description": "Must be at least 0. Must not be greater than 6.", "example": [ 2 ], "items": { "type": "integer" } }, "start_time": { "type": "string", "description": "Must be a valid date in the format H:i.", "example": "09:30", "nullable": true }, "duration_minutes": { "type": "integer", "description": "Must be at least 1. Must not be greater than 1440.", "example": 5, "nullable": true }, "starts_at": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true }, "ends_at": { "type": "string", "description": "Must be a valid date. Must be a date after starts_at.", "example": "2026-01-15", "nullable": true }, "suppress_alerts": { "type": "boolean", "description": "", "example": true, "nullable": true }, "check_ids": { "type": "array", "description": "Must match an existing stored value.", "example": [ 16 ], "items": { "type": "integer" } }, "server_ids": { "type": "array", "description": "Must match an existing stored value.", "example": [ 16 ], "items": { "type": "integer" } } }, "required": [ "name" ] }, "example": { "name": "Load balancer upgrade", "starts_at": "2026-01-17T22:00:00Z", "ends_at": "2026-01-17T23:00:00Z", "suppress_alerts": true, "check_ids": [ 1 ] } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "maintenance", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/deploy-tokens": { "get": { "summary": "List deploy tokens", "operationId": "getApiOrganizationsOrganization_idDeployTokens", "description": "Your deploy tokens, newest first, with their name, creator, the monitors each token applies to, whether a signature is required and when each token was last used. Token secrets are never returned.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "name": "CI — deploy hook", "created_by": 1, "last_used_at": "2026-01-11T12:00:00.000000Z", "monitor_ids": [], "require_signature": true, "created_at": "2026-01-15T12:00:00.000000Z", "creator": { "id": 1, "name": "Alex Rivera", "analytics_id": null } }, { "id": 2, "name": "Staging redeploy", "created_by": 1, "last_used_at": "2025-12-27T12:00:00.000000Z", "monitor_ids": [], "require_signature": false, "created_at": "2026-01-15T12:00:00.000000Z", "creator": { "id": 1, "name": "Alex Rivera", "analytics_id": null } } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/tags": { "get": { "summary": "List tags", "operationId": "getApiOrganizationsOrganization_idTags", "description": "Every tag in the organization, with its colour, whether it names a client, its uptime target and how many resources carry it (`usage_count`).", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 3, "organization_id": 1, "name": "Customer-facing", "color": "#3b82f6", "uptime_target_pct": null, "is_client": false, "created_at": "2026-01-15T12:00:00.000000Z", "usage_count": 12 }, { "id": 4, "organization_id": 1, "name": "Internal", "color": "#8b5cf6", "uptime_target_pct": null, "is_client": false, "created_at": "2026-01-15T12:00:00.000000Z", "usage_count": 11 } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a tag", "operationId": "postApiOrganizationsOrganization_idTags", "description": "Creates a tag from a `name` (up to 50 characters) and a hex `color` such as `#ff8800`; `is_client` is optional. Refused with 422 when a tag with that name already exists.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "name": "Payments", "color": "#3B82F6", "organization_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 7 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "b" }, "color": { "type": "string", "description": "Must match the regex /^#[0-9A-Fa-f]{6}$/.", "example": "#fEEeDb" }, "is_client": { "type": "boolean", "description": "", "example": true } }, "required": [ "name", "color" ] }, "example": { "name": "Payments", "color": "#3B82F6" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/tags/{tag_id}": { "patch": { "summary": "Update a tag", "operationId": "patchApiOrganizationsOrganization_idTagsTag_id", "description": "Changes any of `name`, `color`, `is_client` and `uptime_target_pct` (0 to 100, or null to clear it). Refused with 422 when the new name is already taken.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "tag_id", "required": true, "description": "The tag's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Production", "color": "#22C55E", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "uptime_target_pct": "99.900", "is_client": false } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 50 characters.", "example": "b" }, "color": { "type": "string", "description": "Must match the regex /^#[0-9A-Fa-f]{6}$/.", "example": "#fEEeDb" }, "uptime_target_pct": { "type": "number", "description": "The availability agreed with this client (#896). Null clears it, and a cleared target is\nreported as \"none agreed\" rather than as 100%. Must be at least 0. Must not be greater than 100.", "example": 5, "nullable": true }, "is_client": { "type": "boolean", "description": "This tag names a client (#2996): attention items on what it tags are grouped under it.", "example": true } } }, "example": { "color": "#22C55E", "uptime_target_pct": 99.9 } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a tag", "operationId": "deleteApiOrganizationsOrganization_idTagsTag_id", "description": "Deletes the tag and removes it from every resource that carried it. The resources themselves are kept.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "tag_id", "required": true, "description": "The tag's ID.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "tags", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/attention-summary": { "get": { "summary": "Get your attention summary preview", "operationId": "getApiOrganizationsOrganization_idAttentionSummary", "description": "When your next “needs you” summary for this organization is due, how it is delivered, and a preview of up to 10 items it would contain. `receives` is false when you have turned the summary off, and `available` is false when it cannot be put together right now.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "hour": null, "organisation_hour": 10, "next_at": "2026-01-16T10:00:00+00:00", "via": "email", "telegram": true, "receives": true, "available": true, "count": 13, "new": 13, "will_send": true, "items": [ { "title": "northwind-labs.com will not renew itself", "detail": "Expires Jan 24, 2026 and auto-renew is off.", "route": "/domains/14", "severity": "warning", "new": true }, { "title": "northwind.shop will not renew itself", "detail": "Expires Jan 26, 2026 and auto-renew is off.", "route": "/domains/10", "severity": "warning", "new": true } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "monitoring", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages": { "get": { "summary": "List status pages", "operationId": "getApiOrganizationsOrganization_idStatusPages", "description": "Every status page in your organization with its component and subscriber counts, how many components are operational or degraded, which are down, and the page’s 90-day uptime.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "organization_id": 1, "name": "Northwind Cloud Status", "slug": "northwind", "custom_domain": "status.northwind.example", "is_public": true, "password_hash": null, "description": "Live status of Northwind Cloud services.", "logo_url": null, "show_incident_history": true, "show_uptime_percentage": true, "subscriber_notifications_enabled": true, "theme": "light", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "overall_status": "major_outage", "custom_domain_status": "pending", "allow_indexing": true, "show_group_labels": true, "footer_text": null, "footer_url": null, "show_tags": false, "show_badge_branding": true, "edge_published": false, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "header_image_url": null, "density": "comfortable", "history_days": 90, "show_aggregate_bar": true, "show_maintenance": true, "show_third_party": true, "template": "default", "on_call_note": "Primary: Sam Okoye · +31 6 12 34 56 78 · #northwind-oncall on Slack. Escalation after 15m: Alex Rivera.", "header_style": "band", "accent_color": null, "header_gradient": true, "links": null, "subscriber_reply_to": null, "meta_title": null, "show_name_with_logo": true, "custom_domain_pending_since": null, "components_count": 8, "subscribers_count": 3, "components_up": 6, "down_components": [ "Checkout & payments" ], "degraded_count": 1, "uptime_90d": 100, "edge_publish_eligible": false } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}": { "get": { "summary": "Get a status page", "operationId": "getApiOrganizationsOrganization_idStatusPagesStatusPage_id", "description": "One status page with its settings, its components with the monitor and group behind each, and counts of components, announcements and subscribers.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "organization_id": 1, "name": "Northwind Cloud Status", "slug": "northwind", "custom_domain": "status.northwind.example", "is_public": true, "password_hash": null, "description": "Live status of Northwind Cloud services.", "logo_url": null, "show_incident_history": true, "show_uptime_percentage": true, "subscriber_notifications_enabled": true, "theme": "light", "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "overall_status": "major_outage", "custom_domain_status": "pending", "allow_indexing": true, "show_group_labels": true, "footer_text": null, "footer_url": null, "show_tags": false, "show_badge_branding": true, "edge_published": false, "deleted_at": null, "purge_after": null, "purge_reminder_sent_at": null, "deleted_by_id": null, "deleted_by_label": null, "deletion_reason": null, "header_image_url": null, "density": "comfortable", "history_days": 90, "show_aggregate_bar": true, "show_maintenance": true, "show_third_party": true, "template": "default", "on_call_note": "Primary: Sam Okoye · +31 6 12 34 56 78 · #northwind-oncall on Slack. Escalation after 15m: Alex Rivera.", "header_style": "band", "accent_color": null, "header_gradient": true, "links": null, "subscriber_reply_to": null, "meta_title": null, "show_name_with_logo": true, "custom_domain_pending_since": null, "components_count": 8, "announcements_count": 2, "subscribers_count": 3, "edge_publish_eligible": false, "components": [ { "id": 1, "status_page_id": 1, "monitoring_check_id": 1, "display_name": "Website", "sort_order": 0, "status": "operational", "status_override": false, "show_uptime_bar": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "runbook_url": null, "status_page_component_group_id": 1, "description": null, "affects_overall_status": true, "group_name": "Public", "monitoring_check": { "id": 1, "name": "Marketing site", "type": "http", "interval_minutes": 0 }, "group": { "id": 1, "name": "Public" } }, { "id": 2, "status_page_id": 1, "monitoring_check_id": 2, "display_name": "Web app", "sort_order": 1, "status": "operational", "status_override": false, "show_uptime_bar": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "runbook_url": null, "status_page_component_group_id": 1, "description": null, "affects_overall_status": true, "group_name": "Public", "monitoring_check": { "id": 2, "name": "App — northwind-app.dev", "type": "http", "interval_minutes": 0 }, "group": { "id": 1, "name": "Public" } } ], "link_card_url": "http://localhost/api/status/northwind/card.png?v=66f618c615aff8ba" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/internal": { "get": { "summary": "Get the internal view of a status page", "operationId": "getApiOrganizationsOrganization_idStatusPagesStatusPage_idInternal", "description": "The team-only view of the page: each component with its monitor, runbook link, regions reporting and 30 days of uptime, plus active incidents, the next maintenance and the on-call note. These internal fields are never shown on the public page, and this view needs a plan that includes private status pages.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "page": { "id": 1, "name": "Northwind Cloud Status", "slug": "northwind", "logo_url": null, "is_public": true, "on_call_note": "Primary: Sam Okoye · +31 6 12 34 56 78 · #northwind-oncall on Slack. Escalation after 15m: Alex Rivera." }, "metrics": { "overall_status": "major_outage", "monitors_up": 6, "monitors_total": 8, "uptime_30d": 100, "next_maintenance": null }, "groups": [ { "name": "Public", "components": [ { "id": 1, "display_name": "Website", "status": "operational", "monitoring_check_id": 1, "monitor_name": "Marketing site", "runbook_url": null, "last_checked_at": "2026-01-15T11:58:00+00:00", "regions_reporting": null, "regions_total": null, "uptime_bars": [ { "date": "2025-12-16", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false }, { "date": "2025-12-17", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false } ] }, { "id": 2, "display_name": "Web app", "status": "operational", "monitoring_check_id": 2, "monitor_name": "App — northwind-app.dev", "runbook_url": null, "last_checked_at": "2026-01-15T11:58:00+00:00", "regions_reporting": null, "regions_total": null, "uptime_bars": [ { "date": "2025-12-16", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false }, { "date": "2025-12-17", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false } ] } ] }, { "name": "Developer", "components": [ { "id": 6, "display_name": "API", "status": "operational", "monitoring_check_id": 3, "monitor_name": "API health", "runbook_url": "https://wiki.northwind.example/runbooks/api", "last_checked_at": "2026-01-15T11:58:00+00:00", "regions_reporting": null, "regions_total": null, "uptime_bars": [ { "date": "2025-12-16", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false }, { "date": "2025-12-17", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false } ] }, { "id": 7, "display_name": "Search API", "status": "degraded", "monitoring_check_id": 6, "monitor_name": "Search API", "runbook_url": null, "last_checked_at": "2026-01-15T11:58:00+00:00", "regions_reporting": null, "regions_total": null, "uptime_bars": [ { "date": "2025-12-16", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false }, { "date": "2025-12-17", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false } ] } ] } ], "active_incidents": [ { "id": 1, "monitoring_check_id": 4, "title": "Checkout returning 503", "status": "investigating", "impact": "major", "started_at": "2026-01-15T11:20:00+00:00", "is_planned": false, "public_url": "/status/northwind/incidents/1" } ], "matrix_days": 30 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/overview": { "get": { "summary": "Get a status page overview", "operationId": "getApiOrganizationsOrganization_idStatusPagesStatusPage_idOverview", "description": "The page at a glance: setup (components, custom domain, subscribers, whether it is public), uptime over the page’s history window, current status with active incidents, and the next maintenance and announcement due to end.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "setup": { "components": { "count": 8, "linked": 8, "groups": 2 }, "domain": { "hostname": "status.northwind.example", "status": "pending" }, "subscribers": { "enabled": true, "count": 3 }, "is_public": true }, "uptime": { "days": 90, "pct": 100, "bars": [ { "d": "2025-10-17", "p": 100, "c": "green" }, { "d": "2025-10-18", "p": 100, "c": "green" } ] }, "now": { "overall_status": "major_outage", "components_total": 8, "by_status": { "operational": 6, "major_outage": 1, "degraded": 1 }, "incidents": [ { "id": 1, "monitoring_check_id": 4, "title": "Checkout returning 503", "status": "investigating", "impact": "major", "started_at": "2026-01-15T11:20:00+00:00", "is_planned": false, "public_url": "/status/northwind/incidents/1" } ] }, "upcoming": { "maintenance": null, "announcement_ends": { "id": 1, "title": "Scheduled maintenance this weekend", "ends_at": "2026-01-21T12:00:00+00:00" } } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/analytics": { "get": { "summary": "Get status page traffic", "operationId": "getApiOrganizationsOrganization_idStatusPagesStatusPage_idAnalytics", "description": "Views, unique visitors and subscribe clicks over the last `days` (7, 30 or 90; default 30), compared with the period before, with the busiest day and a daily series. Counts only; no individual visits are recorded.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "days": 30, "totals": { "views": 0, "unique_visitors": 0, "subscribe_clicks": 0 }, "previous": { "views": 0, "unique_visitors": 0, "subscribe_clicks": 0 }, "change_pct": null, "busiest": null, "series": [ { "d": "2025-12-17", "views": 0, "unique_visitors": 0, "subscribe_clicks": 0 }, { "d": "2025-12-18", "views": 0, "unique_visitors": 0, "subscribe_clicks": 0 } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/components": { "get": { "summary": "List status page components", "operationId": "thePagesServicesInTheOrderThePageRendersThemEachWithItsOwnHistory1918", "description": "The page’s components in display order, each with its group, linked monitor and uptime bars over the page’s history window. A component with no monitor has no bars.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "status_page_id": 1, "monitoring_check_id": 1, "display_name": "Website", "sort_order": 0, "status": "operational", "status_override": false, "show_uptime_bar": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "runbook_url": null, "status_page_component_group_id": 1, "description": null, "affects_overall_status": true, "group_name": "Public", "monitoring_check": { "id": 1, "name": "Marketing site", "type": "http", "last_status": "up", "external_service_id": null, "interval_minutes": 0 }, "group": { "id": 1, "name": "Public", "sort_order": 0 }, "uptime_bars": [ { "date": "2025-10-17", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false }, { "date": "2025-10-18", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false } ] }, { "id": 2, "status_page_id": 1, "monitoring_check_id": 2, "display_name": "Web app", "sort_order": 1, "status": "operational", "status_override": false, "show_uptime_bar": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "runbook_url": null, "status_page_component_group_id": 1, "description": null, "affects_overall_status": true, "group_name": "Public", "monitoring_check": { "id": 2, "name": "App — northwind-app.dev", "type": "http", "last_status": "up", "external_service_id": null, "interval_minutes": 0 }, "group": { "id": 1, "name": "Public", "sort_order": 0 }, "uptime_bars": [ { "date": "2025-10-17", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false }, { "date": "2025-10-18", "uptime_pct": 100, "colour": "green", "incidents": [], "imported": false } ] } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Add a component to a status page", "operationId": "postApiOrganizationsOrganization_idStatusPagesStatusPage_idComponents", "description": "Adds a component with a `display_name`, optionally linked to one of your monitors with `monitoring_check_id`. A `group_name` that does not exist yet creates that group, and a `runbook_url` must start with https:// and is only shown internally.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "display_name": "Payments API", "description": null, "status_page_component_group_id": null, "sort_order": 8, "monitoring_check_id": null, "status": "operational", "status_override": false, "show_uptime_bar": true, "affects_overall_status": true, "runbook_url": null, "status_page_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 9, "group_name": null, "monitoring_check": null, "group": null } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "description": { "type": "string", "description": "What this service IS, for the reader who does not already know (#1985). Must not be greater than 255 characters.", "example": "Et animi quos velit et fugiat.", "nullable": true }, "group_name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "d", "nullable": true }, "sort_order": { "type": "integer", "description": "Must be at least 0.", "example": 37 }, "monitoring_check_id": { "type": "integer", "description": "Must match an existing stored value.", "example": 16, "nullable": true }, "status": { "type": "string", "description": "", "example": null, "nullable": true }, "status_override": { "type": "boolean", "description": "", "example": true }, "show_uptime_bar": { "type": "boolean", "description": "", "example": true }, "affects_overall_status": { "type": "boolean", "description": "", "example": true }, "runbook_url": { "type": "string", "description": "Followed by somebody in a hurry who will not read the scheme first (#1350). Must be a valid URL. Must start with one of https:// Must not be greater than 500 characters.", "example": "http://bailey.com/", "nullable": true } }, "required": [ "display_name" ] }, "example": { "display_name": "Payments API" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/components/bulk": { "post": { "summary": "Add several monitors to a status page", "operationId": "addSeveralServicesAtOnceFromTheMonitorsTheOrganisationAlreadyHas1881", "description": "Adds a component for each of up to 50 monitors in `monitoring_check_ids`, named after the monitor and optionally placed in `group_name`. Monitors already on the page are skipped and listed in `skipped`; third-party monitors are added ungrouped and do not affect the page’s overall status.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "created": [], "skipped": [ 1, 2 ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitoring_check_ids": { "type": "array", "description": "Must match an existing stored value.", "example": [ 16 ], "items": { "type": "integer" } }, "group_name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "n", "nullable": true } } }, "example": { "monitoring_check_ids": [ 1, 2, 3 ] } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/components/{component_id}": { "patch": { "summary": "Update a status page component", "operationId": "patchApiOrganizationsOrganization_idStatusPagesStatusPage_idComponentsComponent_id", "description": "Changes the fields you send, such as the name, description, linked monitor, status override, group or runbook link. A new `group_name` creates that group.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "component_id", "required": true, "description": "The component's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "status_page_id": 1, "monitoring_check_id": 1, "display_name": "Checkout", "sort_order": 0, "status": "operational", "status_override": false, "show_uptime_bar": true, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "runbook_url": null, "status_page_component_group_id": 1, "description": "Payments and order confirmation", "affects_overall_status": true, "group_name": "Public", "monitoring_check": { "id": 1, "name": "Marketing site", "type": "http", "last_status": "up", "external_service_id": null, "interval_minutes": 0 }, "group": { "id": 1, "name": "Public", "sort_order": 0 } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "description": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "Et animi quos velit et fugiat.", "nullable": true }, "group_name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "d", "nullable": true }, "sort_order": { "type": "integer", "description": "Must be at least 0.", "example": 37 }, "monitoring_check_id": { "type": "integer", "description": "Must match an existing stored value.", "example": 16, "nullable": true }, "status": { "type": "string", "description": "", "example": null, "nullable": true }, "status_override": { "type": "boolean", "description": "", "example": true }, "show_uptime_bar": { "type": "boolean", "description": "", "example": true }, "affects_overall_status": { "type": "boolean", "description": "", "example": true }, "runbook_url": { "type": "string", "description": "Followed by somebody in a hurry who will not read the scheme first (#1350). Must be a valid URL. Must start with one of https:// Must not be greater than 500 characters.", "example": "http://bailey.com/", "nullable": true } } }, "example": { "display_name": "Checkout", "description": "Payments and order confirmation" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Remove a component from a status page", "operationId": "deleteApiOrganizationsOrganization_idStatusPagesStatusPage_idComponentsComponent_id", "description": "Deletes the component from the page. The monitor behind it is not affected.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "component_id", "required": true, "description": "The component's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Deleted." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/components/sort": { "post": { "summary": "Reorder status page components", "operationId": "postApiOrganizationsOrganization_idStatusPagesStatusPage_idComponentsSort", "description": "Sets the display order from `order`, a list of component IDs. Every ID must belong to this page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Order updated." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "array", "description": "Must match an existing stored value.", "example": [ 16 ], "items": { "type": "integer" } } } }, "example": { "order": [ 8, 7, 6, 5, 4, 3, 2, 1 ] } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/component-groups": { "get": { "summary": "List status page groups", "operationId": "getApiOrganizationsOrganization_idStatusPagesStatusPage_idComponentGroups", "description": "The page’s component groups in display order, each with how many components it holds.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 1, "status_page_id": 1, "name": "Public", "sort_order": 0, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "shows_platform_status": false, "components_count": 5 }, { "id": 2, "status_page_id": 1, "name": "Developer", "sort_order": 1, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "shows_platform_status": false, "components_count": 3 } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Create a status page group", "operationId": "postApiOrganizationsOrganization_idStatusPagesStatusPage_idComponentGroups", "description": "Adds a group with a `name` at the end of the page. Names must be unique within the page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "name": "Customer apps", "sort_order": 2, "status_page_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 3 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" } }, "required": [ "name" ] }, "example": { "name": "Customer apps" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/component-groups/sort": { "post": { "summary": "Reorder status page groups", "operationId": "postApiOrganizationsOrganization_idStatusPagesStatusPage_idComponentGroupsSort", "description": "Sets the display order from `order`, a list of group IDs. Every ID must belong to this page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Order updated." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "array", "description": "Must match an existing stored value.", "example": [ 16 ], "items": { "type": "integer" } } } }, "example": { "order": [ 2, 1 ] } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/component-groups/{componentGroup_id}": { "patch": { "summary": "Update a status page group", "operationId": "renameAGroupOnceForEveryComponentInIt", "description": "Renames the group for every component in it. Setting `shows_platform_status` to true on one group clears it from every other group on the page.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "componentGroup_id", "required": true, "description": "The componentGroup's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "status_page_id": 1, "name": "Customer-facing apps", "sort_order": 0, "created_at": "2026-01-15T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "shows_platform_status": false } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "shows_platform_status": { "type": "boolean", "description": "", "example": true } } }, "example": { "name": "Customer-facing apps" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a status page group", "operationId": "removeTheHeadingKeepTheServices", "description": "Removes the group but keeps its components, which become ungrouped. The response says how many were ungrouped.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "componentGroup_id", "required": true, "description": "The componentGroup's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Deleted.", "components_ungrouped": 5 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/announcements": { "get": { "summary": "List status page announcements", "operationId": "getApiOrganizationsOrganization_idStatusPagesStatusPage_idAnnouncements", "description": "The announcements you posted on this page, newest first, including ones scheduled for later or no longer shown.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 2, "status_page_id": 1, "title": "Released: v2.14.0", "body": "Faster search and a clearer billing page.", "show_from": "2026-01-15T09:00:00.000000Z", "show_until": "2026-01-22T12:00:00.000000Z", "created_at": "2026-01-15T09:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "kind": "information" }, { "id": 1, "status_page_id": 1, "title": "Scheduled maintenance this weekend", "body": "We'll be upgrading our database cluster on Saturday 02:00–03:00 UTC. Brief API slowdowns are possible; no downtime is expected.", "show_from": "2026-01-14T12:00:00.000000Z", "show_until": "2026-01-21T12:00:00.000000Z", "created_at": "2026-01-14T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "kind": "information" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] }, "post": { "summary": "Post a status page announcement", "operationId": "postApiOrganizationsOrganization_idStatusPagesStatusPage_idAnnouncements", "description": "Publishes a notice with a `title` and `body` on the public page. `kind` is `information` or `warning`, and `show_from` and `show_until` limit when it is shown.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "example": { "title": "New status page address", "body": "This page now also answers at status.northwind.example.", "status_page_id": 1, "updated_at": "2026-01-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "id": 3 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "body": { "type": "string", "description": "Must not be greater than 10000 characters.", "example": "n" }, "kind": { "type": "string", "description": "Two, on purpose: anything louder than a warning is an incident (#1989).", "example": "information", "enum": [ "information", "warning" ], "nullable": true }, "show_from": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true }, "show_until": { "type": "string", "description": "Must be a valid date. Must be a date after or equal to show_from.", "example": "2026-01-15", "nullable": true } }, "required": [ "title", "body" ] }, "example": { "title": "New status page address", "body": "This page now also answers at status.northwind.example." } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "idempotency_in_progress", "validation_failed", "idempotency_key_reused", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/other-notices": { "get": { "summary": "List incidents and maintenance on a status page", "operationId": "getApiOrganizationsOrganization_idStatusPagesStatusPage_idOtherNotices", "description": "The incidents and maintenance windows that appear on this page automatically from its monitors, from the last 90 days or still open. Read-only; edit each one on the incident or maintenance window itself.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "notices": [ { "kind": "incident", "id": 1, "title": "Checkout returning 503", "starts_at": "2026-01-15T11:20:00+00:00", "ends_at": null, "open": true, "href": "/monitoring/incidents" }, { "kind": "incident", "id": 2, "title": "Brief marketing-site blip", "starts_at": "2026-01-09T11:45:00+00:00", "ends_at": "2026-01-09T12:00:00+00:00", "open": false, "href": "/monitoring/incidents" } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/announcements/{announcement_id}": { "patch": { "summary": "Update a status page announcement", "operationId": "patchApiOrganizationsOrganization_idStatusPagesStatusPage_idAnnouncementsAnnouncement_id", "description": "Changes the announcement’s title, body, kind or display window.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "announcement_id", "required": true, "description": "The announcement's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "status_page_id": 1, "title": "Status page has moved", "body": "We'll be upgrading our database cluster on Saturday 02:00–03:00 UTC. Brief API slowdowns are possible; no downtime is expected.", "show_from": "2026-01-14T12:00:00.000000Z", "show_until": "2026-01-21T12:00:00.000000Z", "created_at": "2026-01-14T12:00:00.000000Z", "updated_at": "2026-01-15T12:00:00.000000Z", "kind": "information" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "Must not be greater than 255 characters.", "example": "b" }, "body": { "type": "string", "description": "Must not be greater than 10000 characters.", "example": "n" }, "kind": { "type": "string", "description": "", "example": "information", "enum": [ "information", "warning" ], "nullable": true }, "show_from": { "type": "string", "description": "Must be a valid date.", "example": "2026-01-15T09:30:00", "nullable": true }, "show_until": { "type": "string", "description": "Must be a valid date. Must be a date after or equal to show_from.", "example": "2026-01-15", "nullable": true } } }, "example": { "title": "Status page has moved", "kind": "information" } } } }, "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "validation_failed", "rate_limited" ] }, "delete": { "summary": "Delete a status page announcement", "operationId": "deleteApiOrganizationsOrganization_idStatusPagesStatusPage_idAnnouncementsAnnouncement_id", "description": "Removes the announcement from the page permanently.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "announcement_id", "required": true, "description": "The announcement's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Deleted." } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.write", "x-infranest-token-writable": true, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "write_disabled", "organization_suspended", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/subscribers": { "get": { "summary": "Get status page subscriber counts", "operationId": "theTilesAndTheGrowthCurveCountsOnlyTheRowsArelist", "description": "How many people subscribe to the page, how many have confirmed or are pending, a count per channel, and a 90-day growth curve. Counts only; use the subscriber list for individual entries.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "total": 3, "confirmed": 3, "pending": 0, "channels": { "email": 3, "slack": 0, "teams": 0, "discord": 0 }, "growth": { "days": 90, "points": [ { "d": "2025-10-18", "total": 0, "confirmed": 0 }, { "d": "2025-10-19", "total": 0, "confirmed": 0 } ] } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/subscribers/list": { "get": { "summary": "List status page subscribers", "operationId": "thePagesSubscribersAPageAtATime2032", "description": "The page’s subscribers, newest first, with their channel, label, confirmation date and whether delivery is failing. Filter with `q` (searches email addresses) and `status` (`confirmed` or `pending`), and page with `per_page` (10 to 100); reading the list is recorded in your audit log, and webhook addresses are never shown in full.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "id": 3, "channel": "email", "label": "oncall@northwind.example", "confirmed_at": "2026-01-10T12:00:00+00:00", "subscribed_at": "2026-01-15T12:00:00+00:00", "undeliverable": null }, { "id": 2, "channel": "email", "label": "sre@northwind.example", "confirmed_at": "2025-12-29T12:00:00+00:00", "subscribed_at": "2026-01-15T12:00:00+00:00", "undeliverable": null } ], "total": 3, "per_page": 25, "current_page": 1, "last_page": 1 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/status-pages/{statusPage_id}/cname-setup": { "get": { "summary": "Get custom domain CNAME setup", "operationId": "whetherTheStatusPagesCustomDomainCanHaveItsCNAMEAutoCreatedIeItSitsUnderADNSZoneThisOrgManagesWithAPushSyncableProviderDrivesTheSetItUpForMeButton", "description": "Whether the page’s custom domain, or the one in `domain`, sits in a DNS zone you manage in InfraNest, whether InfraNest can create the CNAME record there for you, and whether it is already published. Includes the CNAME target to point the domain at.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "statusPage_id", "required": true, "description": "The statusPage's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "manageable": false, "matched": false, "published": false, "cname_target": "pages.infranest.io" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "status-pages", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/endpoints/{endpoint_id}/monitor": { "get": { "summary": "Get an address’s monitor", "operationId": "whatTheMonitorOnThisAddressKnows3166Status30DayUptimeResponseTimeTheCertificateEachProbeLocationReceivesAndWhereItsAlertsGomonitorNullWhenNothingWatchesTheAddressAnAbsenceThePageExplainsNotAnError", "description": "What the monitor on this address knows: its status, 30-day uptime, response time, the certificate each probe location receives and where its alerts go. `monitor` is null when nothing watches the address.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "endpoint_id", "required": true, "description": "The endpoint's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "endpoint": { "id": 1, "host": "northwind.com", "port": 443, "proxied": true }, "monitor": { "monitor": { "id": 1, "name": "Marketing site", "type": "http", "enabled": true }, "status": "up", "last_checked_at": "2026-01-15T11:58:00+00:00", "uptime_30d": 100, "response_ms": 179, "chain_status": null, "locations": [ { "probe_id": null, "name": null, "region": null, "country_code": null, "status": "up", "response_ms": 180, "checked_at": "2026-01-15T12:00:00+00:00", "fingerprint": null, "certificate": null } ], "alerts": { "channels": [ { "id": 1, "name": "Ops team — email", "type": "email" }, { "id": 2, "name": "On-call — critical only", "type": "email" } ], "people": [ { "id": 2, "name": "Sam Okoye" }, { "id": 3, "name": "Priya Raghunathan" } ], "reaches_anyone": true }, "findings": [], "summary": { "status": "up", "uptime_30d": 100, "locations": 1, "locations_agree": true } } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/export": { "get": { "summary": "List exportable data", "operationId": "theResourcesThisOrgCanExport+WhichFormatsAreUnlockedDrivesTheSettingsDataPage", "description": "The kinds of data you can export and the formats available, each marked `locked` when your plan does not include it. CSV is always available; JSON and XML need a plan with advanced export.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "resources": [ { "key": "domains", "label": "Domains", "locked": false }, { "key": "contacts", "label": "Contacts", "locked": false } ], "formats": [ { "key": "csv", "locked": false }, { "key": "json", "locked": false } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "data.read", "x-infranest-token-writable": false, "x-infranest-module": "data", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/export/bundle": { "get": { "summary": "Download a full data export", "operationId": "ExportAllMyData263AZipOfEveryRegisteredResourceAsJSON+CSVPlusAManifest", "description": "A ZIP file with a CSV and a JSON file for every kind of data your role may read, plus a `manifest.json` that lists what is included.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Every exportable resource, one file each, in a ZIP archive.", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "data.read", "x-infranest-token-writable": false, "x-infranest-module": "data", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/export/{resource}": { "get": { "summary": "Export one kind of data", "operationId": "streamOneResourceAsCSVOrJSONOrgScopedAllowlistedColumnsPlanGatedAudited", "description": "Downloads every record of one kind as a file, in `format` `csv` (default), `json` or `xml`; pass `ids[]` to export only those records. Refused when your role may not read that data or your plan does not include the resource or format.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "resource", "required": true, "description": "The resource.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The resource as CSV (the default), JSON or XML, as `format` asks.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/xml": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "data.read", "x-infranest-token-writable": false, "x-infranest-module": "data", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/import": { "get": { "summary": "List importable data", "operationId": "importableResources+WhetherThisOrgsPlanAllowsImportingDrivesTheDataImportUI", "description": "The kinds of data you can import from CSV, with the column headers each expects, and whether your plan allows importing (`allowed`). Requires permission to manage the organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "resources": [ { "key": "contacts", "label": "Contacts", "headers": [ "first_name", "last_name" ] }, { "key": "ssl-certificates", "label": "SSL certificates", "headers": [ "subject", "sans" ] } ], "allowed": true } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "data.read", "x-infranest-token-writable": false, "x-infranest-module": "data", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/referrals": { "get": { "summary": "Get your referrals", "operationId": "getApiOrganizationsOrganization_idReferrals", "description": "Your referral link, what it has earned and how much discount is left, and the workspaces that signed up with it — names partly hidden, with where each referral has got to. `enabled` is false when the referral programme is switched off. Read-only.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "enabled": true, "code": "northwind-cloud", "link": "http://localhost/r/northwind-cloud", "can_change": true, "currency": "eur", "stats": { "signed_up": 5, "paying": 3, "rewards_this_year": 2, "max_rewards_per_year": 12, "earned": 12800, "on_its_way": 1, "remaining": 7000 }, "referrals": [ { "id": 4, "name": "Ve•••• Labs", "joined_at": "2026-01-11T12:00:00+00:00", "status": "pending", "void_reason": null, "credited_from": null, "reward_amount": null, "reward_currency": null, "reward_remaining": null }, { "id": 3, "name": "Ha•••• IT", "joined_at": "2025-12-26T12:00:00+00:00", "status": "qualifying", "void_reason": null, "credited_from": "2026-01-28T12:00:00+00:00", "reward_amount": null, "reward_currency": null, "reward_remaining": null } ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Endpoints" ], "x-infranest-scope": "billing.read", "x-infranest-token-writable": false, "x-infranest-module": "billing", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/provider-credentials/{providerCredential_id}/logs": { "get": { "summary": "List a provider account’s call log", "operationId": "getApiOrganizationsOrganization_idProviderCredentialsProviderCredential_idLogs", "description": "The most recent 200 calls InfraNest made with this account, newest first. Filter with `status` (`success` or `failure`) and the dates `from` and `to`.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "providerCredential_id", "required": true, "description": "The providerCredential's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "id": 9, "provider": "hetzner", "capability": "cloud", "method": "GET", "endpoint": "/v1/servers", "success": true, "http_status": 200, "duration_ms": 60, "error_type": null, "error_message": null, "provider_request_id": null, "request_summary": null, "response_summary": null, "created_at": "2026-01-15T12:00:00.000000Z" }, { "id": 10, "provider": "hetzner", "capability": "cloud", "method": "GET", "endpoint": "/v1/volumes", "success": true, "http_status": 200, "duration_ms": 112, "error_type": null, "error_message": null, "provider_request_id": null, "request_summary": null, "response_summary": null, "created_at": "2026-01-15T11:57:00.000000Z" } ] } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Integration Logs" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/integrations": { "get": { "summary": "List connected integrations", "operationId": "getApiOrganizationsOrganization_idIntegrations", "description": "Everything the organization has connected — cloud, DNS, registrar and certificate accounts, alert destinations, outbound webhooks, automation connections and calendars — each with its status and health. Also returns summary counts and the integrations your plan does not include (`locks`).", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "connections": [ { "id": 1, "kind": "provider", "provider": "hetzner", "integration_key": "hetzner", "name": "Hetzner — Production", "categories": [ "cloud", "dns" ], "capabilities": [ "cloud", "dns" ], "counts": { "servers": 6, "zones": 2, "domains": 0, "certs": 1 }, "suspended_capabilities": [], "incident": null, "auth_kind": "api_token", "enabled": true, "status": "connected", "locked": false, "health": { "status": "ok", "success_rate": 100, "total_calls": 97, "last_error_at": null, "last_success_at": "2026-01-15T12:00:00Z" }, "rate_limited": null, "last_activity_at": "2026-01-15T12:00:00Z" }, { "id": 2, "kind": "provider", "provider": "cloudflare", "integration_key": "cloudflare", "name": "Cloudflare DNS", "categories": [ "dns", "domains" ], "capabilities": [ "dns", "registrar" ], "counts": { "servers": 0, "zones": 5, "domains": 0, "certs": 1 }, "suspended_capabilities": [], "incident": null, "auth_kind": "api_token", "enabled": true, "status": "connected", "locked": false, "health": { "status": "ok", "success_rate": 100, "total_calls": 49, "last_error_at": null, "last_success_at": "2026-01-15T12:00:00Z" }, "rate_limited": null, "last_activity_at": "2026-01-15T12:00:00Z" } ], "summary": { "total": 22, "connected": 16, "degraded": 3, "failing": 2, "disabled": 1, "issues": 5, "locked": 0 }, "locks": [] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Integrations" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/integrations/{provider}/activity/export": { "get": { "summary": "Export integration activity as CSV", "operationId": "streamThefilteredAPIActivityLogForAProviderAsACSVDownload", "description": "Downloads every call logged for this integration as a CSV file, newest first. Takes the same `status`, `capability`, `direction`, `credential_id` and `search` filters as the activity list.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "provider", "required": true, "description": "The provider.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The integration's activity log as CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Integrations" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/integrations/{provider}/activity": { "get": { "summary": "List integration activity", "operationId": "providerAPIActivity256TheIntegrationLogAcrossAllOfThisOrgsCredentialsForTheProviderPaginated+FilterableaccountCapabilityStatusSearchFollowingTheStandardServerTableContractSoTheDetailPagesActivityTabUsesTheSharedDataTable", "description": "The calls made to and received from this integration, newest first, paginated with `per_page` (5 to 100, default 20). Filter with `status` (`success` or `error`), `capability`, `direction`, `credential_id` and `search`; `meta` lists the accounts and filter values available.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "provider", "required": true, "description": "The provider.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [ { "id": 9, "credential_id": 1, "capability": "cloud", "direction": "outbound", "method": "GET", "endpoint": "/v1/servers", "action": "listServers", "success": true, "http_status": 200, "duration_ms": 60, "error_type": null, "error_message": null, "created_at": "2026-01-15T12:00:00.000000Z" }, { "id": 10, "credential_id": 1, "capability": "cloud", "direction": "outbound", "method": "GET", "endpoint": "/v1/volumes", "action": "listVolumes", "success": true, "http_status": 200, "duration_ms": 112, "error_type": null, "error_message": null, "created_at": "2026-01-15T11:57:00.000000Z" } ], "total": 672, "last_page": 34, "meta": { "accounts": [ { "id": 1, "label": "Hetzner — Production", "context": [] } ], "capabilities": [ "cloud" ], "directions": [ "outbound" ], "rate_limit": null } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Integrations" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/integrations/{provider}/accounts/{id}": { "get": { "summary": "Get an integration account", "operationId": "gETOrganizationsorganizationintegrationsprovideraccountsid", "description": "One connected account of an integration, whatever kind it is, with its status and health. Returns 404 when the account does not exist or does not belong to this integration and organization.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "provider", "required": true, "description": "The provider.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The id's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "id": 1, "provider": "hetzner", "label": "Hetzner — Production", "enabled": true, "removing": false, "is_oauth": false, "auth_kind": "api_token", "oauth": null, "error_email_enabled": true, "alerts_muted_until": null, "incident": null, "notices": [], "spending": null, "capabilities": [ "cloud", "dns" ], "supported_capabilities": [ "cloud", "dns" ], "cloud_capabilities": { "native_delete_protection": true, "server_destroy": true, "server_destroy_is_cancellation": false, "server_create": true, "server_rename": true, "console": true, "snapshots": true, "backups": true, "isos": true, "rescue": true, "placement_groups": true, "public_network_toggle": true, "scheduled_backups": true, "private_networks": true, "private_network_attach": true, "network_join_on_create": false, "network_attach_ip_choice": true, "private_network_unfiltered": true, "floating_ips": true, "networks_creatable": true, "network_cidr": true, "network_subnets": true, "network_routes": true, "network_rename": true, "network_ip_range_extendable": true, "firewalls_creatable": true, "firewall_multi_server": true, "firewall_renamable": true, "firewall_outbound": true, "firewall_ipv6": true, "firewall_dynamic_ip": true, "server_firewall": false, "load_balancers_creatable": true, "load_balancer_rename": true, "load_balancer_algorithm": true, "load_balancer_services": true, "load_balancer_targets": true, "volumes_creatable": true, "volume_resize": true, "volume_rename": true, "volume_native_delete_protection": true, "network_native_delete_protection": true, "user_data": true, "install_flavour": false, "images_per_plan": false, "metrics": true, "metrics_disk_throughput": true, "rdns_subnet": true, "rdns_address_list": false, "reverse_dns": true, "snapshot_description": true, "snapshot_protection": true }, "dns_capabilities": { "record_writes": true, "bulk_replace": false, "zone_create": true, "zone_delete": true, "record_proxying": false, "signing": false }, "dns_scope": "any", "cloud_firewall_protocols": [ "tcp", "udp" ], "enabled_capabilities": null, "suspended_capabilities": [], "resource_counts": { "dns": 2, "certificates": 1, "cloud": 6 }, "verified_at": "2025-10-15T12:00:00.000000Z", "created_at": "2026-01-15T12:00:00.000000Z", "fields": [ "api_token" ], "environment": null, "field_values": { "api_token": { "set": true, "secret": true, "display": "••••oken" } }, "context": [], "health": { "status": "ok", "success_rate": 100, "total_calls": 97, "last_error_at": null, "last_success_at": "2026-01-15T12:00:00Z" }, "registrar_operations": null, "scope_check": null, "scope_checked_at": null, "disabled_operations": [], "api_base": "/organizations/1/provider-credentials/1" } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Integrations" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/integrations/{provider}": { "get": { "summary": "Get an integration", "operationId": "appStoreDetailForOneProvider256TheCodeOwnedStructuralConfig+DirectusPresentationContentresolvedForTheRequestLocale+ThisOrgsExistingConnectionsForThatProvider", "description": "What the integration offers, the organization’s connections to it, and whether your plan allows connecting it. Returns 404 for an unknown integration.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } }, { "in": "path", "name": "provider", "required": true, "description": "The provider.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "provider": { "key": "hetzner", "label": "Hetzner", "logo": "hetzner", "capabilities": [ "cloud", "dns" ], "categories": [ "cloud", "dns" ], "dns_scope": "any", "features": [ "zone_discovery", "record_ids" ], "environments": [], "oauth": false, "one_click": false, "needs_allowlist": false, "featured": true, "premium": false, "min_plan": null, "max_connections": null, "credentials": [ { "key": "api_token", "label": "integrations.providers.hetzner.apiToken.label", "secret": true, "multiline": false, "help": "integrations.providers.hetzner.apiToken.help", "help_params": { "aws_account_id": "InfraNest's AWS account (set AWS_INFRANEST_ACCOUNT_ID)" }, "placeholder": "LRK9mXv2QpT8sYw4…", "prefill": null, "type": "text", "options": null, "depends_on": null, "show_when": null, "default": null } ], "kind": "provider", "content": null }, "connections": [ { "id": 1, "kind": "provider", "provider": "hetzner", "integration_key": "hetzner", "name": "Hetzner — Production", "categories": [ "cloud", "dns" ], "capabilities": [ "cloud", "dns" ], "counts": { "servers": 6, "zones": 2, "domains": 0, "certs": 1 }, "suspended_capabilities": [], "incident": null, "auth_kind": "api_token", "enabled": true, "status": "connected", "locked": false, "health": { "status": "ok", "success_rate": 100, "total_calls": 97, "last_error_at": null, "last_success_at": "2026-01-15T12:00:00Z" }, "rate_limited": null, "last_activity_at": "2026-01-15T12:00:00Z" } ], "gate": { "locked": false, "reason": null, "premium": false, "min_plan": null, "min_plan_name": null, "current_plan": "pro", "current_plan_name": "Pro", "max_connections": null, "used": 1, "grandfathered": false, "included": false } } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Integrations" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/connect-requests": { "get": { "summary": "List connect requests", "operationId": "gETOrganizationsorganizationconnectRequestsprovider", "description": "The 20 most recent links you created to ask someone else to connect a provider account, newest first, with who requested each one. Filter with `provider` or `kind`; the response also gives how many days a new link stays valid.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "data": [], "ttl_days": 3 } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Integrations" ], "x-infranest-scope": "cloud.read", "x-infranest-token-writable": false, "x-infranest-module": "cloud", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } }, "/api/organizations/{organization_id}/webhook-endpoints/schema": { "get": { "summary": "Get the outbound webhook JSON Schema", "operationId": "theJSONSchemaOfTheEnvelopeWePOSTForTheChosenEvents2240PastedIntoAPowerAutomateTriggerOrParseJSONStepSoThePayloadsFieldsArriveTypedEveryEventWhenNoneAreNamed", "description": "The JSON Schema of the payload InfraNest sends to your webhook endpoints, for tools that type a payload from a schema. Narrow it with `events[]`; with none, it covers every event. `events` lists every event you can name.", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "description": "Your organization's ID.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "schema": { "type": "object", "properties": { "event": { "title": "Event", "type": "string" }, "created_at": { "title": "Created at", "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "acknowledged_by": { "title": "Acknowledged by", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "action": { "title": "Action", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actor": { "title": "Actor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "agent": { "title": "Agent", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "asn_org": { "title": "ASN org", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assignee": { "title": "Assignee", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assignees": { "title": "Assignees", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "auction": { "title": "Auction", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "author": { "title": "Author", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "base_branch": { "title": "Base branch", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "branch": { "title": "Branch", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "change": { "title": "Change", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changed_fields": { "title": "Changed fields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "check_name": { "title": "Check name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "comment": { "title": "Comment", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commits": { "title": "Commits", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "conclusion": { "title": "Conclusion", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "context": { "title": "Context", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country_code": { "title": "Country code", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created": { "title": "Created", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "creator": { "title": "Creator", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "current_ipv4": { "title": "Current IPv4", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "current_ipv6": { "title": "Current IPv6", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "custom_fields": { "title": "Custom fields", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "days_left": { "title": "Days left", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "deleted": { "title": "Deleted", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "deleted_in": { "title": "Deleted in", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deployment_id": { "title": "Deployment ID", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "title": "Domain", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "draft": { "title": "Draft", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "drop_eta": { "title": "Drop ETA", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "duration_minutes": { "title": "Duration minutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endpoint": { "title": "Endpoint", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "environment": { "title": "Environment", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "environment_url": { "title": "Environment URL", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "escalation_policy": { "title": "Escalation policy", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires_at": { "title": "Expires at", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "expiry_may_be_stale": { "title": "Expiry may be stale", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "forced": { "title": "Forced", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "head_branch": { "title": "Head branch", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "head_sha": { "title": "Head SHA", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "host": { "title": "Host", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "identifier": { "title": "Identifier", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "incident_title": { "title": "Incident title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "incident_type": { "title": "Incident type", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "incident_url": { "title": "Incident URL", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ip": { "title": "IP", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ip_version": { "title": "IP version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_hosting": { "title": "Is hosting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_pull_request": { "title": "Is pull request", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "issue_type": { "title": "Issue type", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuer": { "title": "Issuer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issues": { "title": "Issues", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "labels": { "title": "Labels", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "log_url": { "title": "Log URL", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "merged": { "title": "Merged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "monitor_type": { "title": "Monitor type", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "new_nameservers": { "title": "New nameservers", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "note": { "title": "Note", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "note_trimmed": { "title": "Note trimmed", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "number": { "title": "Number", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "old_nameservers": { "title": "Old nameservers", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "owner": { "title": "Owner", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_email": { "title": "Owner email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_name": { "title": "Owner name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pd_connection_id": { "title": "PagerDuty connection ID", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "pd_incident_id": { "title": "PagerDuty incident ID", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prerelease": { "title": "Prerelease", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "previous_state": { "title": "Previous state", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priority": { "title": "Priority" }, "production_environment": { "title": "Production environment", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "project": { "title": "Project", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "provider": { "title": "Provider", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pusher": { "title": "Pusher", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "record_action": { "title": "Record action", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "record_name": { "title": "Record name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "record_type": { "title": "Record type", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "records": { "title": "Records", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ref": { "title": "Ref", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ref_type": { "title": "Ref type", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "registrar": { "title": "Registrar", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repo": { "title": "Repo", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "responder": { "title": "Responder", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "responder_message": { "title": "Responder message", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "responder_state": { "title": "Responder state", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer": { "title": "Reviewer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "run_attempt": { "title": "Run attempt", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "run_id": { "title": "Run ID", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "run_number": { "title": "Run number", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "server_name": { "title": "Server name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "service": { "title": "Service", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sha": { "title": "SHA", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "size_gb": { "title": "Size GB", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "state": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status_page": { "title": "Status page", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subject": { "title": "Subject", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tag": { "title": "Tag", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "task": { "title": "Task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "team": { "title": "Team", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tld": { "title": "TLD", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transient_environment": { "title": "Transient environment", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "trigger_event": { "title": "Triggering event", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "triggering_actor": { "title": "Triggering actor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "unused": { "title": "Unused", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "update_status": { "title": "Update status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "title": "Urgency", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "title": "URL", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "via": { "title": "Via", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflow": { "title": "Workflow", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zone": { "title": "Zone", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "required": [ "event", "created_at" ] }, "events": [ "domain.registered", "domain.expiring" ] } } } }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } }, "tags": [ "Webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "description": "", "example": [ "architecto" ], "items": { "type": "string" } } } } } } }, "x-infranest-scope": "monitoring.read", "x-infranest-token-writable": false, "x-infranest-module": "integrations", "x-infranest-errors": [ "unauthenticated", "scope_missing", "wrong_organization", "test_token_required", "test_token_sandbox_only", "permission_denied", "not_found", "rate_limited" ] } } } }