Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
openapi: 3.1.0
info:
description: OpenStatus is a open-source status page platform with global uptime monitoring. The OpenStatus API allows you to interact with the OpenStatus platform programmatically. To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings. Requests are rate limited per API key or token (600 per minute, 100 per 10 seconds); exceeding a limit returns HTTP 429 with a Retry-After header. See https://www.openstatus.dev/docs/reference/api-rate-limits.
title: OpenStatus API
version: v2.0.0
contact:
email: [email protected]
url: https://www.openstatus.dev
servers:
- url: https://api.openstatus.dev
description: Production
externalDocs:
description: OpenStatus Documentation
url: https://www.openstatus.dev/docs
components:
responses:
RateLimited:
description: Rate limit exceeded (Connect code resource_exhausted). Retry after the number of seconds in the Retry-After header. See https://www.openstatus.dev/docs/reference/api-rate-limits.
headers:
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
example: 7
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-openstatus-key
schemas:
connect.error:
type: object
properties:
code:
type: string
examples:
- not_found
enum:
- canceled
- unknown
- invalid_argument
- deadline_exceeded
- not_found
- already_exists
- permission_denied
- resource_exhausted
- failed_precondition
- aborted
- out_of_range
- unimplemented
- internal
- unavailable
- data_loss
- unauthenticated
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/connect.error_details.Any'
description: A list of messages that carry the error details. There is no limit on the number of messages.
title: Connect Error
additionalProperties: true
description: 'Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation'
connect.error_details.Any:
type: object
properties:
type:
type: string
description: 'A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field.'
value:
type: string
format: binary
description: The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field.
debug:
oneOf:
- type: object
title: Any
additionalProperties: true
description: Detailed error information.
discriminator:
propertyName: type
title: Debug
description: Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
openstatus.health.v1.CheckRequest:
type: object
properties:
service:
type: string
title: service
description: Optional service name to check. If empty, checks overall service health.
title: CheckRequest
additionalProperties: false
description: CheckRequest is the request message for health checks.
openstatus.health.v1.CheckResponse:
type: object
properties:
status:
title: status
description: The serving status of the service.
$ref: '#/components/schemas/openstatus.health.v1.CheckResponse.ServingStatus'
title: CheckResponse
additionalProperties: false
description: CheckResponse is the response message for health checks.
openstatus.health.v1.CheckResponse.ServingStatus:
type: string
title: ServingStatus
enum:
- SERVING_STATUS_UNSPECIFIED
- SERVING_STATUS_SERVING
- SERVING_STATUS_NOT_SERVING
description: ServingStatus represents the health status of the service.
openstatus.incident.v1.AddIncidentNoteRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident (required).
message:
type: string
title: message
maxLength: 10000
minLength: 1
description: Note text, markdown (required, 1-10000 characters).
title: AddIncidentNoteRequest
additionalProperties: false
description: AddIncidentNoteRequest is the request to add a note to an incident timeline.
openstatus.incident.v1.AddIncidentNoteResponse:
type: object
properties:
event:
title: event
description: The timeline event that was added.
$ref: '#/components/schemas/openstatus.incident.v1.IncidentEvent'
title: AddIncidentNoteResponse
additionalProperties: false
description: AddIncidentNoteResponse is the response after adding a note.
openstatus.incident.v1.ApprovePostmortemRequest:
type: object
properties:
incidentId:
type: string
title: incident_id
minLength: 1
description: ID of the incident (required).
close:
type:
- boolean
- "null"
title: close
description: Also close the incident (optional, defaults to false).
title: ApprovePostmortemRequest
additionalProperties: false
description: ApprovePostmortemRequest is the request to approve the postmortem of an incident.
openstatus.incident.v1.ApprovePostmortemResponse:
type: object
properties:
postmortem:
title: postmortem
description: The approved postmortem.
$ref: '#/components/schemas/openstatus.incident.v1.Postmortem'
incident:
title: incident
description: The incident after approval (without its timeline).
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: ApprovePostmortemResponse
additionalProperties: false
description: ApprovePostmortemResponse is the response after approving the postmortem.
openstatus.incident.v1.CloseIncidentRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident (required).
skipPostmortem:
type:
- boolean
- "null"
title: skip_postmortem
description: Close without an approved postmortem (optional, defaults to false).
title: CloseIncidentRequest
additionalProperties: false
description: CloseIncidentRequest is the request to close a resolved incident.
openstatus.incident.v1.CloseIncidentResponse:
type: object
properties:
incident:
title: incident
description: The closed incident (without its timeline).
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: CloseIncidentResponse
additionalProperties: false
description: CloseIncidentResponse is the response after closing an incident.
openstatus.incident.v1.DeclareIncidentRequest:
type: object
properties:
title:
type: string
examples:
- Checkout API returns 502
title: title
maxLength: 256
minLength: 1
description: Title of the incident (required, 1-256 characters).
severity:
not:
enum:
- INCIDENT_SEVERITY_UNSPECIFIED
title: severity
description: Severity of the incident (required).
$ref: '#/components/schemas/openstatus.incident.v1.IncidentSeverity'
summary:
type:
- string
- "null"
title: summary
maxLength: 4000
minLength: 1
description: Short human summary (optional, 1-4000 characters).
commanderEmail:
type:
- string
- "null"
examples:
- [email protected]
title: commander_email
format: email
description: Email of the member who leads the response (optional, defaults to unassigned).
startedAt:
type:
- string
- "null"
examples:
- "2024-03-15T10:30:00Z"
title: started_at
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: When the impact began (RFC 3339 format, optional, defaults to now).
statusReportId:
type:
- string
- "null"
title: status_report_id
minLength: 1
description: ID of a status report to link (optional).
openSlackChannel:
type:
- boolean
- "null"
title: open_slack_channel
description: Whether to open a Slack channel for the incident when Slack is connected (optional, defaults to false).
title: DeclareIncidentRequest
additionalProperties: false
description: DeclareIncidentRequest is the request to declare a new incident.
openstatus.incident.v1.DeclareIncidentResponse:
type: object
properties:
incident:
title: incident
description: The declared incident.
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: DeclareIncidentResponse
additionalProperties: false
description: DeclareIncidentResponse is the response after declaring an incident.
openstatus.incident.v1.DeleteIncidentRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident (required).
title: DeleteIncidentRequest
additionalProperties: false
description: DeleteIncidentRequest is the request to delete an incident.
openstatus.incident.v1.DeleteIncidentResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteIncidentResponse
additionalProperties: false
description: DeleteIncidentResponse is the response after deleting an incident.
openstatus.incident.v1.GetIncidentRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident to retrieve (required).
title: GetIncidentRequest
additionalProperties: false
description: GetIncidentRequest is the request to get an incident by ID.
openstatus.incident.v1.GetIncidentResponse:
type: object
properties:
incident:
title: incident
description: The requested incident.
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: GetIncidentResponse
additionalProperties: false
description: GetIncidentResponse is the response containing the incident and its timeline.
openstatus.incident.v1.GetPostmortemRequest:
type: object
properties:
incidentId:
type: string
title: incident_id
minLength: 1
description: ID of the incident (required).
title: GetPostmortemRequest
additionalProperties: false
description: GetPostmortemRequest is the request to get the postmortem of an incident.
openstatus.incident.v1.GetPostmortemResponse:
type: object
properties:
postmortem:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.Postmortem'
- type: "null"
title: postmortem
description: The postmortem (unset when none has been written yet).
title: GetPostmortemResponse
additionalProperties: false
description: GetPostmortemResponse is the response containing the postmortem, if any.
openstatus.incident.v1.Incident:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the incident.
title:
type: string
title: title
description: Title of the incident.
severity:
title: severity
description: Severity of the incident.
$ref: '#/components/schemas/openstatus.incident.v1.IncidentSeverity'
status:
title: status
description: Current status of the incident.
$ref: '#/components/schemas/openstatus.incident.v1.IncidentStatus'
summary:
type:
- string
- "null"
title: summary
description: Short human summary.
commander:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentUser'
- type: "null"
title: commander
description: Member leading the response (unset when unassigned).
declaredBy:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentUser'
- type: "null"
title: declared_by
description: Member who declared the incident (unset for API keys without a creator).
resolvedBy:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentUser'
- type: "null"
title: resolved_by
description: Member who last resolved the incident (unset again when the incident is reopened).
declaredAt:
type: string
title: declared_at
description: Timestamp when the incident was declared (RFC 3339 format).
startedAt:
type: string
title: started_at
description: Timestamp when the impact began (RFC 3339 format).
mitigatedAt:
type:
- string
- "null"
title: mitigated_at
description: Timestamp when the incident was first mitigated (RFC 3339 format).
resolvedAt:
type:
- string
- "null"
title: resolved_at
description: Timestamp of the last resolution (RFC 3339 format). Kept when the incident is reopened.
closedAt:
type:
- string
- "null"
title: closed_at
description: |-
Timestamp when the incident was closed or canceled (RFC 3339 format).
A closed incident is read-only except for its postmortem.
statusReport:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentStatusReport'
- type: "null"
title: status_report
description: Linked public status report.
slackChannelUrl:
type:
- string
- "null"
title: slack_channel_url
description: Link to the bound Slack channel.
allowedTransitions:
type: array
items:
$ref: '#/components/schemas/openstatus.incident.v1.IncidentStatus'
title: allowed_transitions
description: Statuses SetIncidentStatus accepts from the current state (empty once closed).
deletable:
type: boolean
title: deletable
description: 'Whether DeleteIncident is allowed: only while open and never mitigated, resolved or closed.'
events:
type: array
items:
$ref: '#/components/schemas/openstatus.incident.v1.IncidentEvent'
title: events
description: Timeline, newest first (only included in GetIncident).
createdAt:
type: string
title: created_at
description: Timestamp when the incident was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the incident was last updated (RFC 3339 format).
title: Incident
additionalProperties: false
description: Incident is a managed incident with full details.
openstatus.incident.v1.IncidentEvent:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the event.
type:
title: type
description: Kind of event.
$ref: '#/components/schemas/openstatus.incident.v1.IncidentEventType'
message:
type: string
title: message
description: 'Text of the event: the note for notes, a rendered summary otherwise.'
createdBy:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentUser'
- type: "null"
title: created_by
description: Member who caused the event (unset for system events and API keys without a creator).
createdAt:
type: string
title: created_at
description: Timestamp when the event was recorded (RFC 3339 format).
title: IncidentEvent
additionalProperties: false
description: IncidentEvent is one entry of an incident timeline.
openstatus.incident.v1.IncidentEventType:
type: string
title: IncidentEventType
enum:
- INCIDENT_EVENT_TYPE_UNSPECIFIED
- INCIDENT_EVENT_TYPE_DECLARED
- INCIDENT_EVENT_TYPE_SEVERITY_CHANGED
- INCIDENT_EVENT_TYPE_STATUS_CHANGED
- INCIDENT_EVENT_TYPE_COMMANDER_CHANGED
- INCIDENT_EVENT_TYPE_STARTED_AT_CHANGED
- INCIDENT_EVENT_TYPE_NOTE
- INCIDENT_EVENT_TYPE_STATUS_REPORT_LINKED
- INCIDENT_EVENT_TYPE_STATUS_REPORT_UNLINKED
- INCIDENT_EVENT_TYPE_SLACK_CHANNEL_BOUND
- INCIDENT_EVENT_TYPE_SLACK_CHANNEL_UNBOUND
- INCIDENT_EVENT_TYPE_RESOLVED
- INCIDENT_EVENT_TYPE_CANCELED
- INCIDENT_EVENT_TYPE_POSTMORTEM_DRAFTED
- INCIDENT_EVENT_TYPE_POSTMORTEM_UPDATED
- INCIDENT_EVENT_TYPE_POSTMORTEM_APPROVED
- INCIDENT_EVENT_TYPE_CLOSED
description: IncidentEventType is the kind of entry in an incident timeline.
openstatus.incident.v1.IncidentSeverity:
type: string
title: IncidentSeverity
enum:
- INCIDENT_SEVERITY_UNSPECIFIED
- INCIDENT_SEVERITY_CRITICAL
- INCIDENT_SEVERITY_MAJOR
- INCIDENT_SEVERITY_MINOR
description: IncidentSeverity is how bad an incident is.
openstatus.incident.v1.IncidentStatus:
type: string
title: IncidentStatus
enum:
- INCIDENT_STATUS_UNSPECIFIED
- INCIDENT_STATUS_OPEN
- INCIDENT_STATUS_MITIGATED
- INCIDENT_STATUS_RESOLVED
- INCIDENT_STATUS_CANCELED
description: |-
IncidentStatus is the lifecycle state of an incident.
Closed is not a status: a closed incident has closed_at set and keeps its last status.
openstatus.incident.v1.IncidentStatusReport:
type: object
properties:
id:
type: string
title: id
description: ID of the status report.
title:
type: string
title: title
description: Title of the status report.
status:
title: status
description: Current status of the status report.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
pageId:
type: string
title: page_id
description: ID of the status page the report belongs to (empty in ListIncidents results).
title: IncidentStatusReport
additionalProperties: false
description: IncidentStatusReport is the public status report linked to an incident.
openstatus.incident.v1.IncidentSummary:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the incident.
title:
type: string
title: title
description: Title of the incident.
severity:
title: severity
description: Severity of the incident.
$ref: '#/components/schemas/openstatus.incident.v1.IncidentSeverity'
status:
title: status
description: Current status of the incident.
$ref: '#/components/schemas/openstatus.incident.v1.IncidentStatus'
commander:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentUser'
- type: "null"
title: commander
description: Member leading the response (unset when unassigned).
declaredAt:
type: string
title: declared_at
description: Timestamp when the incident was declared (RFC 3339 format).
startedAt:
type: string
title: started_at
description: Timestamp when the impact began (RFC 3339 format).
resolvedAt:
type:
- string
- "null"
title: resolved_at
description: Timestamp of the last resolution (RFC 3339 format). Kept when the incident is reopened.
closedAt:
type:
- string
- "null"
title: closed_at
description: Timestamp when the incident was closed or canceled (RFC 3339 format).
statusReport:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentStatusReport'
- type: "null"
title: status_report
description: Linked public status report.
createdAt:
type: string
title: created_at
description: Timestamp when the incident was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the incident was last updated (RFC 3339 format).
title: IncidentSummary
additionalProperties: false
description: IncidentSummary is the metadata of an incident (used in list responses).
openstatus.incident.v1.IncidentUser:
type: object
properties:
email:
type: string
title: email
description: Email address of the member (empty for a deleted account).
name:
type: string
title: name
description: Display name of the member ("Deleted user" for a deleted account).
title: IncidentUser
additionalProperties: false
description: IncidentUser is a workspace member referenced by an incident.
openstatus.incident.v1.LinkStatusReportRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident (required).
statusReportId:
type: string
title: status_report_id
minLength: 1
description: ID of the status report to link (required).
title: LinkStatusReportRequest
additionalProperties: false
description: LinkStatusReportRequest is the request to link a status report to an incident.
openstatus.incident.v1.LinkStatusReportResponse:
type: object
properties:
incident:
title: incident
description: The updated incident (without its timeline).
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: LinkStatusReportResponse
additionalProperties: false
description: LinkStatusReportResponse is the response after linking a status report.
openstatus.incident.v1.ListIncidentsRequest:
type: object
properties:
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of incidents to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of incidents to skip for pagination (defaults to 0).
statuses:
type: array
items:
$ref: '#/components/schemas/openstatus.incident.v1.IncidentStatus'
title: statuses
description: Filter by status (optional). If empty, returns all statuses.
closed:
type:
- boolean
- "null"
title: closed
description: Filter by closed state (optional). If unset, returns both.
title: ListIncidentsRequest
additionalProperties: false
description: ListIncidentsRequest is the request to list incidents.
openstatus.incident.v1.ListIncidentsResponse:
type: object
properties:
incidents:
type: array
items:
$ref: '#/components/schemas/openstatus.incident.v1.IncidentSummary'
title: incidents
description: List of incidents (metadata only, use GetIncident for full details).
totalSize:
type: integer
title: total_size
format: int32
description: Total number of incidents matching the filter.
title: ListIncidentsResponse
additionalProperties: false
description: ListIncidentsResponse is the response containing incident summaries.
openstatus.incident.v1.Postmortem:
type: object
properties:
incidentId:
type: string
title: incident_id
description: ID of the incident the postmortem belongs to.
status:
title: status
description: Review state of the postmortem.
$ref: '#/components/schemas/openstatus.incident.v1.PostmortemStatus'
content:
type: string
title: content
description: Markdown body of the postmortem.
draftedBy:
title: drafted_by
description: Who wrote the current body.
$ref: '#/components/schemas/openstatus.incident.v1.PostmortemAuthor'
approvedBy:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentUser'
- type: "null"
title: approved_by
description: Member who approved the postmortem.
approvedAt:
type:
- string
- "null"
title: approved_at
description: Timestamp when the postmortem was approved (RFC 3339 format).
createdAt:
type: string
title: created_at
description: Timestamp when the postmortem was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the postmortem was last updated (RFC 3339 format).
title: Postmortem
additionalProperties: false
description: Postmortem is the review written after an incident is resolved.
openstatus.incident.v1.PostmortemAuthor:
type: string
title: PostmortemAuthor
enum:
- POSTMORTEM_AUTHOR_UNSPECIFIED
- POSTMORTEM_AUTHOR_AGENT
- POSTMORTEM_AUTHOR_USER
description: PostmortemAuthor is who wrote the current postmortem body.
openstatus.incident.v1.PostmortemStatus:
type: string
title: PostmortemStatus
enum:
- POSTMORTEM_STATUS_UNSPECIFIED
- POSTMORTEM_STATUS_DRAFT
- POSTMORTEM_STATUS_APPROVED
description: PostmortemStatus is the review state of a postmortem.
openstatus.incident.v1.SetIncidentStatusRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident (required).
status:
not:
enum:
- INCIDENT_STATUS_UNSPECIFIED
title: status
description: Target status (required).
$ref: '#/components/schemas/openstatus.incident.v1.IncidentStatus'
note:
type:
- string
- "null"
title: note
maxLength: 10000
description: Note recorded with the change (optional, up to 10000 characters).
title: SetIncidentStatusRequest
additionalProperties: false
description: SetIncidentStatusRequest is the request to change the status of an incident.
openstatus.incident.v1.SetIncidentStatusResponse:
type: object
properties:
incident:
title: incident
description: The updated incident (without its timeline).
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: SetIncidentStatusResponse
additionalProperties: false
description: SetIncidentStatusResponse is the response after changing the status of an incident.
openstatus.incident.v1.UnlinkStatusReportRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident (required).
title: UnlinkStatusReportRequest
additionalProperties: false
description: UnlinkStatusReportRequest is the request to unlink the status report of an incident.
openstatus.incident.v1.UnlinkStatusReportResponse:
type: object
properties:
incident:
title: incident
description: The updated incident (without its timeline).
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: UnlinkStatusReportResponse
additionalProperties: false
description: UnlinkStatusReportResponse is the response after unlinking the status report.
openstatus.incident.v1.UpdateIncidentRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the incident to update (required).
title:
type:
- string
- "null"
title: title
maxLength: 256
minLength: 1
description: New title (optional, 1-256 characters).
severity:
oneOf:
- $ref: '#/components/schemas/openstatus.incident.v1.IncidentSeverity'
- type: "null"
not:
enum:
- INCIDENT_SEVERITY_UNSPECIFIED
title: severity
description: New severity (optional).
summary:
type:
- string
- "null"
title: summary
maxLength: 4000
minLength: 1
description: New summary (optional, 1-4000 characters).
clearSummary:
type:
- boolean
- "null"
title: clear_summary
description: Set to true to remove the summary. Cannot be combined with summary.
commanderEmail:
type:
- string
- "null"
title: commander_email
format: email
description: Email of the new commander (optional).
clearCommander:
type:
- boolean
- "null"
title: clear_commander
description: Set to true to unassign the commander. Cannot be combined with commander_email.
startedAt:
type:
- string
- "null"
title: started_at
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: New start of impact (RFC 3339 format, optional).
title: UpdateIncidentRequest
additionalProperties: false
description: |
UpdateIncidentRequest is the request to edit an incident.
commander_email_or_clear_commander // set either commander_email or clear_commander, not both
summary_or_clear_summary // set either summary or clear_summary, not both
openstatus.incident.v1.UpdateIncidentResponse:
type: object
properties:
incident:
title: incident
description: The updated incident (without its timeline).
$ref: '#/components/schemas/openstatus.incident.v1.Incident'
title: UpdateIncidentResponse
additionalProperties: false
description: UpdateIncidentResponse is the response after updating an incident.
openstatus.incident.v1.UpdatePostmortemRequest:
type: object
properties:
incidentId:
type: string
title: incident_id
minLength: 1
description: ID of the incident (required).
content:
type: string
title: content
maxLength: 100000
minLength: 1
description: Markdown body (required, 1-100000 characters). Replaces the current body; an approved postmortem stays approved.
title: UpdatePostmortemRequest
additionalProperties: false
description: UpdatePostmortemRequest is the request to write the postmortem of a resolved incident.
openstatus.incident.v1.UpdatePostmortemResponse:
type: object
properties:
postmortem:
title: postmortem
description: The saved postmortem.
$ref: '#/components/schemas/openstatus.incident.v1.Postmortem'
title: UpdatePostmortemResponse
additionalProperties: false
description: UpdatePostmortemResponse is the response after writing the postmortem.
openstatus.maintenance.v1.AddMaintenanceUpdateRequest:
type: object
properties:
maintenanceId:
type: string
title: maintenance_id
minLength: 1
description: ID of the maintenance to update (required).
message:
type: string
title: message
minLength: 1
description: Public update message (required).
date:
type:
- string
- "null"
title: date
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: Optional date for the update (RFC 3339 format). Defaults to current time.
notify:
type:
- boolean
- "null"
title: notify
description: Whether to notify subscribers about this update.
title: AddMaintenanceUpdateRequest
additionalProperties: false
description: AddMaintenanceUpdateRequest is the request to append a maintenance update.
openstatus.maintenance.v1.AddMaintenanceUpdateResponse:
type: object
properties:
maintenanceUpdate:
title: maintenance_update
description: The created update.
$ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
title: AddMaintenanceUpdateResponse
additionalProperties: false
description: AddMaintenanceUpdateResponse is the response after appending an update.
openstatus.maintenance.v1.CreateMaintenanceRequest:
type: object
properties:
title:
type: string
examples:
- Database Migration
title: title
maxLength: 256
minLength: 1
description: Title of the maintenance (required, 1-256 characters).
message:
type: string
title: message
minLength: 1
description: |-
Message describing the maintenance (required). Posted as the first
maintenance update.
from:
type: string
examples:
- "2024-03-01T02:00:00Z"
title: from
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: Start time of the maintenance window (RFC 3339 format, required).
to:
type: string
examples:
- "2024-03-01T06:00:00Z"
title: to
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: End time of the maintenance window (RFC 3339 format, required).
pageId:
type: string
title: page_id
minLength: 1
description: Page ID to associate with this maintenance (required).
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: Page component IDs to associate with this maintenance (optional).
notify:
type:
- boolean
- "null"
title: notify
description: Whether to notify subscribers about this maintenance (optional, defaults to false).
title: CreateMaintenanceRequest
additionalProperties: false
description: CreateMaintenanceRequest is the request to create a new maintenance window.
openstatus.maintenance.v1.CreateMaintenanceResponse:
type: object
properties:
maintenance:
title: maintenance
description: The created maintenance.
$ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'
title: CreateMaintenanceResponse
additionalProperties: false
description: CreateMaintenanceResponse is the response after creating a maintenance window.
openstatus.maintenance.v1.DeleteMaintenanceRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the maintenance to delete (required).
title: DeleteMaintenanceRequest
additionalProperties: false
description: DeleteMaintenanceRequest is the request to delete a maintenance window.
openstatus.maintenance.v1.DeleteMaintenanceResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteMaintenanceResponse
additionalProperties: false
description: DeleteMaintenanceResponse is the response after deleting a maintenance window.
openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the update to remove (required).
title: DeleteMaintenanceUpdateRequest
additionalProperties: false
description: DeleteMaintenanceUpdateRequest is the request to remove an update.
openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteMaintenanceUpdateResponse
additionalProperties: false
description: DeleteMaintenanceUpdateResponse is the response after removing an update.
openstatus.maintenance.v1.GetMaintenanceRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the maintenance to retrieve (required).
title: GetMaintenanceRequest
additionalProperties: false
description: GetMaintenanceRequest is the request to get a maintenance window by ID.
openstatus.maintenance.v1.GetMaintenanceResponse:
type: object
properties:
maintenance:
title: maintenance
description: The requested maintenance.
$ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'
title: GetMaintenanceResponse
additionalProperties: false
description: GetMaintenanceResponse is the response containing the maintenance window.
openstatus.maintenance.v1.ListMaintenancesRequest:
type: object
properties:
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of maintenances to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of maintenances to skip for pagination (defaults to 0).
pageId:
type:
- string
- "null"
title: page_id
description: Filter by page ID (optional).
title: ListMaintenancesRequest
additionalProperties: false
description: ListMaintenancesRequest is the request to list maintenance windows.
openstatus.maintenance.v1.ListMaintenancesResponse:
type: object
properties:
maintenances:
type: array
items:
$ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'
title: maintenances
description: List of maintenances.
totalSize:
type: integer
title: total_size
format: int32
description: Total number of maintenances matching the filter.
title: ListMaintenancesResponse
additionalProperties: false
description: ListMaintenancesResponse is the response containing maintenance window summaries.
openstatus.maintenance.v1.Maintenance:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the maintenance.
title:
type: string
title: title
description: Title of the maintenance.
message:
type: string
title: message
description: Message of the newest maintenance update.
from:
type: string
title: from
description: Start time of the maintenance window (RFC 3339 format).
to:
type: string
title: to
description: End time of the maintenance window (RFC 3339 format).
pageId:
type: string
title: page_id
description: ID of the page this maintenance is associated with.
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: IDs of affected page components.
createdAt:
type: string
title: created_at
description: Timestamp when the maintenance was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the maintenance was last updated (RFC 3339 format).
updates:
type: array
items:
$ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
title: updates
description: Full maintenance update timeline, newest first.
title: Maintenance
additionalProperties: false
description: Maintenance represents a maintenance window with full details.
openstatus.maintenance.v1.MaintenanceSummary:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the maintenance.
title:
type: string
title: title
description: Title of the maintenance.
message:
type: string
title: message
description: Message of the newest maintenance update.
from:
type: string
title: from
description: Start time of the maintenance window (RFC 3339 format).
to:
type: string
title: to
description: End time of the maintenance window (RFC 3339 format).
pageId:
type: string
title: page_id
description: ID of the page this maintenance is associated with.
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: IDs of affected page components.
createdAt:
type: string
title: created_at
description: Timestamp when the maintenance was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the maintenance was last updated (RFC 3339 format).
title: MaintenanceSummary
additionalProperties: false
description: MaintenanceSummary represents metadata for a maintenance window (used in list responses).
openstatus.maintenance.v1.MaintenanceUpdate:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the update.
message:
type: string
title: message
description: Public update message.
date:
type: string
title: date
description: Date of the update (RFC 3339 format).
maintenanceId:
type: string
title: maintenance_id
description: ID of the maintenance this update belongs to.
createdAt:
type: string
title: created_at
description: Timestamp when the update was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the update was last updated (RFC 3339 format).
title: MaintenanceUpdate
additionalProperties: false
description: MaintenanceUpdate represents a timeline entry for a maintenance window.
openstatus.maintenance.v1.UpdateMaintenanceRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the maintenance to update (required).
title:
type:
- string
- "null"
title: title
maxLength: 256
minLength: 1
description: New title for the maintenance (optional).
message:
type:
- string
- "null"
title: message
description: Replaces the message of the newest maintenance update (optional).
from:
type:
- string
- "null"
title: from
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: New start time (RFC 3339 format, optional).
to:
type:
- string
- "null"
title: to
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: New end time (RFC 3339 format, optional).
pageId:
type:
- string
- "null"
title: page_id
description: 'Deprecated: page_id is now derived from page_component_ids.'
deprecated: true
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: New list of page component IDs (optional, replaces existing list).
updatePageComponentIds:
type:
- boolean
- "null"
title: update_page_component_ids
description: |-
Set to true to update page component associations.
When true, page_component_ids replaces the existing list (empty clears all).
When false or unset, page_component_ids is ignored and existing associations are preserved.
title: UpdateMaintenanceRequest
additionalProperties: false
description: UpdateMaintenanceRequest is the request to update a maintenance window.
openstatus.maintenance.v1.UpdateMaintenanceResponse:
type: object
properties:
maintenance:
title: maintenance
description: The updated maintenance.
$ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'
title: UpdateMaintenanceResponse
additionalProperties: false
description: UpdateMaintenanceResponse is the response after updating a maintenance window.
openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the update to edit (required).
message:
type:
- string
- "null"
title: message
minLength: 1
description: New public message.
date:
type:
- string
- "null"
title: date
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: New update date (RFC 3339 format).
title: UpdateMaintenanceUpdateRequest
additionalProperties: false
description: UpdateMaintenanceUpdateRequest is the request to edit an update.
openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse:
type: object
properties:
maintenanceUpdate:
title: maintenance_update
description: The updated timeline entry.
$ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
title: UpdateMaintenanceUpdateResponse
additionalProperties: false
description: UpdateMaintenanceUpdateResponse is the response after editing an update.
openstatus.monitor.v1.BodyAssertion:
type: object
properties:
target:
type: string
title: target
description: Target value to compare against.
comparator:
not:
enum:
- STRING_COMPARATOR_UNSPECIFIED
title: comparator
description: Comparison operation (required, must not be UNSPECIFIED).
$ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'
title: BodyAssertion
additionalProperties: false
description: BodyAssertion defines an assertion for response body content.
openstatus.monitor.v1.CreateDNSMonitorRequest:
type: object
properties:
monitor:
title: monitor
description: Monitor configuration (required).
$ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'
title: CreateDNSMonitorRequest
required:
- monitor
additionalProperties: false
description: CreateDNSMonitorRequest is the request to create a new DNS monitor.
openstatus.monitor.v1.CreateDNSMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The created monitor with assigned ID.
$ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'
title: CreateDNSMonitorResponse
additionalProperties: false
description: CreateDNSMonitorResponse is the response after creating a DNS monitor.
openstatus.monitor.v1.CreateGRPCMonitorRequest:
type: object
properties:
monitor:
title: monitor
description: Monitor configuration (required).
$ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'
title: CreateGRPCMonitorRequest
required:
- monitor
additionalProperties: false
description: CreateGRPCMonitorRequest is the request to create a new gRPC monitor.
openstatus.monitor.v1.CreateGRPCMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The created monitor with assigned ID.
$ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'
title: CreateGRPCMonitorResponse
additionalProperties: false
description: CreateGRPCMonitorResponse is the response after creating a gRPC monitor.
openstatus.monitor.v1.CreateHTTPMonitorRequest:
type: object
properties:
monitor:
title: monitor
description: Monitor configuration (required).
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'
title: CreateHTTPMonitorRequest
required:
- monitor
additionalProperties: false
description: CreateHTTPMonitorRequest is the request to create a new HTTP monitor.
openstatus.monitor.v1.CreateHTTPMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The created monitor with assigned ID.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'
title: CreateHTTPMonitorResponse
additionalProperties: false
description: CreateHTTPMonitorResponse is the response after creating an HTTP monitor.
openstatus.monitor.v1.CreateICMPMonitorRequest:
type: object
properties:
monitor:
title: monitor
description: Monitor configuration (required).
$ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'
title: CreateICMPMonitorRequest
required:
- monitor
additionalProperties: false
description: CreateICMPMonitorRequest is the request to create a new ICMP monitor.
openstatus.monitor.v1.CreateICMPMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The created monitor with assigned ID.
$ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'
title: CreateICMPMonitorResponse
additionalProperties: false
description: CreateICMPMonitorResponse is the response after creating an ICMP monitor.
openstatus.monitor.v1.CreateTCPMonitorRequest:
type: object
properties:
monitor:
title: monitor
description: Monitor configuration (required).
$ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'
title: CreateTCPMonitorRequest
required:
- monitor
additionalProperties: false
description: CreateTCPMonitorRequest is the request to create a new TCP monitor.
openstatus.monitor.v1.CreateTCPMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The created monitor with assigned ID.
$ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'
title: CreateTCPMonitorResponse
additionalProperties: false
description: CreateTCPMonitorResponse is the response after creating a TCP monitor.
openstatus.monitor.v1.DNSMonitor:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the monitor (output only for create requests).
name:
type: string
examples:
- DNS Resolution Check
title: name
maxLength: 256
minLength: 1
description: Name of the monitor (required, max 256 characters).
uri:
type: string
examples:
- example.com
title: uri
maxLength: 2048
minLength: 1
description: Domain to resolve (required, max 2048 characters).
periodicity:
not:
enum:
- PERIODICITY_UNSPECIFIED
title: periodicity
description: Check periodicity (required).
$ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'
timeout:
type:
- integer
- string
title: timeout
maximum: 300000
minimum: 0
format: int64
description: Timeout in milliseconds (0-300000, defaults to 45000).
degradedAt:
type:
- integer
- string
- "null"
title: degraded_at
maximum: 300000
minimum: 0
format: int64
description: Latency threshold for degraded status in milliseconds (optional, 0-300000).
retry:
type:
- integer
- string
title: retry
maximum: 10
minimum: 0
format: int64
description: Number of retry attempts (0-10, defaults to 3).
recordAssertions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.RecordAssertion'
title: record_assertions
maxItems: 10
description: DNS record assertions for validation.
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the monitor (optional).
active:
type:
- boolean
- "null"
title: active
description: Whether the monitor is active (defaults to false).
public:
type:
- boolean
- "null"
title: public
description: Whether the monitor is publicly visible (defaults to false).
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
title: regions
maxItems: 28
description: Geographic regions to run checks from.
openTelemetry:
title: open_telemetry
description: OpenTelemetry configuration for exporting metrics.
$ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'
status:
title: status
description: Current operational status of the monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'
privateLocationIds:
type: array
items:
type: string
readOnly: true
title: private_location_ids
description: IDs of private locations that run this monitor. Read-only.
readOnly: true
title: DNSMonitor
additionalProperties: false
description: DNSMonitor defines the configuration for a DNS monitor.
openstatus.monitor.v1.DeleteMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to delete (required).
title: DeleteMonitorRequest
additionalProperties: false
description: DeleteMonitorRequest is the request to delete a monitor.
openstatus.monitor.v1.DeleteMonitorResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteMonitorResponse
additionalProperties: false
description: DeleteMonitorResponse is the response after deleting a monitor.
openstatus.monitor.v1.GRPCMonitor:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the monitor (output only for create requests).
name:
type: string
examples:
- Checkout gRPC
title: name
maxLength: 256
minLength: 1
description: Name of the monitor (required, max 256 characters).
uri:
type: string
examples:
- api.example.com:443
title: uri
maxLength: 2048
minLength: 1
pattern: ^(\[[0-9a-fA-F:]+\]|[^:/\s]+):[0-9]{1,5}$
description: Target in "host:port" form. IPv6 addresses must be bracketed.
periodicity:
not:
enum:
- PERIODICITY_UNSPECIFIED
title: periodicity
description: Check periodicity (required).
$ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'
timeout:
type:
- integer
- string
title: timeout
maximum: 300000
minimum: 0
format: int64
description: Timeout in milliseconds (0-300000, defaults to 45000).
degradedAt:
type:
- integer
- string
- "null"
title: degraded_at
maximum: 300000
minimum: 0
format: int64
description: Latency threshold for degraded status in milliseconds (optional, 0-300000).
retry:
type:
- integer
- string
title: retry
maximum: 10
minimum: 0
format: int64
description: Number of retry attempts (0-10, defaults to 3).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the monitor (optional).
active:
type:
- boolean
- "null"
title: active
description: Whether the monitor is active (defaults to false).
public:
type:
- boolean
- "null"
title: public
description: Whether the monitor is publicly visible (defaults to false).
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
title: regions
maxItems: 28
description: Geographic regions to run checks from.
openTelemetry:
title: open_telemetry
description: OpenTelemetry configuration for exporting metrics.
$ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'
status:
title: status
description: Current operational status of the monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'
privateLocationIds:
type: array
items:
type: string
readOnly: true
title: private_location_ids
description: IDs of private locations that run this monitor. Read-only.
readOnly: true
service:
type:
- string
- "null"
examples:
- checkout.v1.CheckoutService
title: service
maxLength: 512
description: Service name passed to Health/Check. Empty means overall server health.
tlsMode:
oneOf:
- $ref: '#/components/schemas/openstatus.monitor.v1.GRPCTlsMode'
- type: "null"
title: tls_mode
description: How the connection to the target is secured. Defaults to TLS.
metadata:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Headers'
title: metadata
maxItems: 20
description: Metadata sent with the health check request.
title: GRPCMonitor
additionalProperties: false
description: |-
GRPCMonitor defines the configuration for a gRPC health check monitor.
The probe calls grpc.health.v1.Health/Check on the target.
openstatus.monitor.v1.GRPCTlsMode:
type: string
title: GRPCTlsMode
enum:
- GRPC_TLS_MODE_UNSPECIFIED
- GRPC_TLS_MODE_TLS
- GRPC_TLS_MODE_PLAINTEXT
- GRPC_TLS_MODE_TLS_INSECURE
description: GRPCTlsMode selects how the probe secures its connection to the target.
openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to get a response log for (required).
logId:
type: string
title: log_id
minLength: 1
description: Response log ID to retrieve (required).
title: GetMonitorHTTPResponseLogRequest
additionalProperties: false
description: GetMonitorHTTPResponseLogRequest is the request to get one response log.
openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse:
type: object
properties:
log:
title: log
description: Response log details.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogDetail'
title: GetMonitorHTTPResponseLogResponse
additionalProperties: false
description: GetMonitorHTTPResponseLogResponse is the response containing one response log.
openstatus.monitor.v1.GetMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to retrieve (required).
title: GetMonitorRequest
additionalProperties: false
description: GetMonitorRequest is the request to get a single monitor by ID.
openstatus.monitor.v1.GetMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The monitor configuration (one of HTTP, TCP, DNS, ICMP, or gRPC).
$ref: '#/components/schemas/openstatus.monitor.v1.MonitorConfig'
title: GetMonitorResponse
additionalProperties: false
description: GetMonitorResponse is the response containing the monitor.
openstatus.monitor.v1.GetMonitorStatusRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to get status for (required).
title: GetMonitorStatusRequest
additionalProperties: false
description: GetMonitorStatusRequest is the request to get the status of all regions for a monitor.
openstatus.monitor.v1.GetMonitorStatusResponse:
type: object
properties:
id:
type: string
title: id
description: Monitor ID.
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.RegionStatus'
title: regions
description: Status for each region.
title: GetMonitorStatusResponse
additionalProperties: false
description: GetMonitorStatusResponse is the response containing the status of all regions for a monitor.
openstatus.monitor.v1.GetMonitorSummaryRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to get summary for (required).
timeRange:
title: time_range
description: Time range for metrics aggregation (defaults to 1 day if unspecified).
$ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
title: regions
maxItems: 28
description: Optional filter by regions. If empty, returns metrics for all regions.
title: GetMonitorSummaryRequest
additionalProperties: false
description: GetMonitorSummaryRequest is the request to get aggregated metrics for a monitor.
openstatus.monitor.v1.GetMonitorSummaryResponse:
type: object
properties:
id:
type: string
title: id
description: Monitor ID.
lastPingAt:
type: string
title: last_ping_at
description: Timestamp of the last check in RFC 3339 format.
totalSuccessful:
type:
- integer
- string
title: total_successful
format: int64
description: Total number of successful requests.
totalDegraded:
type:
- integer
- string
title: total_degraded
format: int64
description: Total number of degraded requests.
totalFailed:
type:
- integer
- string
title: total_failed
format: int64
description: Total number of failed requests.
p50:
type:
- integer
- string
title: p50
format: int64
description: 50th percentile (median) latency in milliseconds.
p75:
type:
- integer
- string
title: p75
format: int64
description: 75th percentile latency in milliseconds.
p90:
type:
- integer
- string
title: p90
format: int64
description: 90th percentile latency in milliseconds.
p95:
type:
- integer
- string
title: p95
format: int64
description: 95th percentile latency in milliseconds.
p99:
type:
- integer
- string
title: p99
format: int64
description: 99th percentile latency in milliseconds.
timeRange:
title: time_range
description: Time range used for the metrics.
$ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
title: regions
description: Regions included in the metrics.
title: GetMonitorSummaryResponse
additionalProperties: false
description: GetMonitorSummaryResponse is the response containing aggregated metrics for a monitor.
openstatus.monitor.v1.HTTPMethod:
type: string
title: HTTPMethod
enum:
- HTTP_METHOD_UNSPECIFIED
- HTTP_METHOD_GET
- HTTP_METHOD_POST
- HTTP_METHOD_HEAD
- HTTP_METHOD_PUT
- HTTP_METHOD_PATCH
- HTTP_METHOD_DELETE
- HTTP_METHOD_TRACE
- HTTP_METHOD_CONNECT
- HTTP_METHOD_OPTIONS
description: HTTP methods supported for monitors.
openstatus.monitor.v1.HTTPMonitor:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the monitor (output only for create requests).
name:
type: string
examples:
- Production API Health Check
title: name
maxLength: 256
minLength: 1
description: Name of the monitor (required, max 256 characters).
url:
type: string
examples:
- https://api.example.com/health
title: url
maxLength: 2048
minLength: 1
format: uri
description: URL to monitor (required, max 2048 characters).
periodicity:
not:
enum:
- PERIODICITY_UNSPECIFIED
title: periodicity
description: Check periodicity (required).
$ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'
method:
not:
enum:
- HTTP_METHOD_UNSPECIFIED
title: method
description: HTTP method to use (defaults to GET).
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPMethod'
body:
type: string
examples:
- map[key:value]
title: body
description: Request body (optional).
timeout:
type:
- integer
- string
title: timeout
maximum: 300000
minimum: 0
format: int64
description: Timeout in milliseconds (0-300000, defaults to 45000).
degradedAt:
type:
- integer
- string
- "null"
title: degraded_at
maximum: 300000
minimum: 0
format: int64
description: Latency threshold for degraded status in milliseconds (optional, 0-300000).
retry:
type:
- integer
- string
title: retry
maximum: 10
minimum: 0
format: int64
description: Number of retry attempts (0-10, defaults to 3).
followRedirects:
type:
- boolean
- "null"
title: follow_redirects
description: Whether to follow HTTP redirects (defaults to true when not specified).
headers:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Headers'
title: headers
maxItems: 20
description: Custom headers for the request.
statusCodeAssertions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.StatusCodeAssertion'
title: status_code_assertions
maxItems: 10
description: Status code assertions for the response.
bodyAssertions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.BodyAssertion'
title: body_assertions
maxItems: 10
description: Body content assertions for the response.
headerAssertions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.HeaderAssertion'
title: header_assertions
maxItems: 10
description: Header assertions for the response.
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the monitor (optional).
active:
type:
- boolean
- "null"
title: active
description: Whether the monitor is active (defaults to false).
public:
type:
- boolean
- "null"
title: public
description: Whether the monitor is publicly visible (defaults to false).
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
title: regions
maxItems: 28
description: Geographic regions to run checks from.
openTelemetry:
title: open_telemetry
description: OpenTelemetry configuration for exporting metrics.
$ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'
status:
title: status
description: Current operational status of the monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'
privateLocationIds:
type: array
items:
type: string
readOnly: true
title: private_location_ids
description: IDs of private locations that run this monitor. Read-only.
readOnly: true
title: HTTPMonitor
additionalProperties: false
description: HTTPMonitor defines the configuration for an HTTP monitor.
openstatus.monitor.v1.HTTPResponseLogDetail:
type: object
properties:
log:
title: log
description: Compact response log fields.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'
url:
type: string
title: url
description: Checked URL.
error:
type: boolean
title: error
description: Whether the check errored.
message:
type:
- string
- "null"
title: message
description: Error message, when present.
headers:
type: object
title: headers
additionalProperties:
type: string
title: value
description: Redacted response headers.
assertions:
type:
- string
- "null"
title: assertions
description: Serialized assertions used for the check.
title: HTTPResponseLogDetail
additionalProperties: false
description: HTTPResponseLogDetail contains full response log debugging data.
openstatus.monitor.v1.HTTPResponseLogDetail.HeadersEntry:
type: object
properties:
key:
type: string
title: key
value:
type: string
title: value
title: HeadersEntry
additionalProperties: false
openstatus.monitor.v1.HTTPResponseLogListItem:
type: object
properties:
id:
type:
- string
- "null"
title: id
description: Response log ID.
latency:
type: integer
title: latency
format: int32
description: Latency in milliseconds.
statusCode:
type:
- integer
- "null"
title: status_code
format: int32
description: HTTP status code.
monitorId:
type: string
title: monitor_id
description: Monitor ID.
requestStatus:
title: request_status
description: Request status classification.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogRequestStatus'
region:
title: region
description: Region where the check ran.
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
cronTimestamp:
type:
- integer
- string
title: cron_timestamp
format: int64
description: Cron bucket timestamp in Unix milliseconds.
trigger:
title: trigger
description: Check trigger.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTrigger'
timestamp:
type:
- integer
- string
title: timestamp
format: int64
description: Response timestamp in Unix milliseconds.
timing:
oneOf:
- $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTiming'
- type: "null"
title: timing
description: Timing phases.
title: HTTPResponseLogListItem
additionalProperties: false
description: HTTPResponseLogListItem is a compact response log entry.
openstatus.monitor.v1.HTTPResponseLogPagination:
type: object
properties:
limit:
type: integer
title: limit
format: int32
description: Requested page size.
offset:
type: integer
title: offset
format: int32
description: Requested offset.
hasMore:
type: boolean
title: has_more
description: Whether more logs are available.
nextOffset:
type:
- integer
- "null"
title: next_offset
format: int32
description: Next offset if more logs are available.
title: HTTPResponseLogPagination
additionalProperties: false
description: HTTPResponseLogPagination contains offset pagination metadata.
openstatus.monitor.v1.HTTPResponseLogRequestStatus:
type: string
title: HTTPResponseLogRequestStatus
enum:
- HTTP_RESPONSE_LOG_REQUEST_STATUS_UNSPECIFIED
- HTTP_RESPONSE_LOG_REQUEST_STATUS_SUCCESS
- HTTP_RESPONSE_LOG_REQUEST_STATUS_ERROR
- HTTP_RESPONSE_LOG_REQUEST_STATUS_DEGRADED
description: HTTPResponseLogRequestStatus is the result classification for an HTTP response log.
openstatus.monitor.v1.HTTPResponseLogTiming:
type: object
properties:
dns:
type: integer
title: dns
format: int32
description: DNS lookup duration.
connect:
type: integer
title: connect
format: int32
description: TCP connection duration.
tls:
type: integer
title: tls
format: int32
description: TLS handshake duration.
ttfb:
type: integer
title: ttfb
format: int32
description: Time to first byte duration.
transfer:
type: integer
title: transfer
format: int32
description: Response transfer duration.
title: HTTPResponseLogTiming
additionalProperties: false
description: HTTPResponseLogTiming contains calculated timing phases in milliseconds.
openstatus.monitor.v1.HTTPResponseLogTrigger:
type: string
title: HTTPResponseLogTrigger
enum:
- HTTP_RESPONSE_LOG_TRIGGER_UNSPECIFIED
- HTTP_RESPONSE_LOG_TRIGGER_CRON
- HTTP_RESPONSE_LOG_TRIGGER_API
description: HTTPResponseLogTrigger describes what started the monitor check.
openstatus.monitor.v1.HeaderAssertion:
type: object
properties:
target:
type: string
title: target
description: Target value to compare against.
comparator:
not:
enum:
- STRING_COMPARATOR_UNSPECIFIED
title: comparator
description: Comparison operation (required, must not be UNSPECIFIED).
$ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'
key:
type: string
title: key
minLength: 1
description: Header key to check (required).
title: HeaderAssertion
additionalProperties: false
description: HeaderAssertion defines an assertion for response headers.
openstatus.monitor.v1.Headers:
type: object
properties:
key:
type: string
examples:
- Authorization
title: key
minLength: 1
description: Header name.
value:
type: string
examples:
- Bearer token123
title: value
description: Header value.
title: Headers
additionalProperties: false
description: Headers represents a key-value pair for HTTP headers.
openstatus.monitor.v1.ICMPMonitor:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the monitor (output only for create requests).
name:
type: string
examples:
- Ping Gateway
title: name
maxLength: 256
minLength: 1
description: Name of the monitor (required, max 256 characters).
uri:
type: string
examples:
- 1.1.1.1
title: uri
maxLength: 2048
minLength: 1
description: URI to monitor in format "host or IP" (required, max 2048 characters).
periodicity:
not:
enum:
- PERIODICITY_UNSPECIFIED
title: periodicity
description: Check periodicity (required).
$ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'
timeout:
type:
- integer
- string
title: timeout
maximum: 300000
minimum: 0
format: int64
description: Timeout in milliseconds (0-300000, defaults to 45000).
degradedAt:
type:
- integer
- string
- "null"
title: degraded_at
maximum: 300000
minimum: 0
format: int64
description: Latency threshold for degraded status in milliseconds (optional, 0-300000).
retry:
type:
- integer
- string
title: retry
maximum: 10
minimum: 0
format: int64
description: Number of retry attempts (0-10, defaults to 3).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the monitor (optional).
active:
type:
- boolean
- "null"
title: active
description: Whether the monitor is active (defaults to false).
public:
type:
- boolean
- "null"
title: public
description: Whether the monitor is publicly visible (defaults to false).
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
title: regions
maxItems: 28
description: Geographic regions to run checks from.
openTelemetry:
title: open_telemetry
description: OpenTelemetry configuration for exporting metrics.
$ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'
status:
title: status
description: Current operational status of the monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'
privateLocationIds:
type: array
items:
type: string
readOnly: true
title: private_location_ids
description: IDs of private locations that run this monitor. Read-only.
readOnly: true
title: ICMPMonitor
additionalProperties: false
description: ICMPMonitor defines the configuration for a ICMP monitor.
openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to list response logs for (required).
fromTimestamp:
type:
- integer
- string
- "null"
title: from_timestamp
format: int64
description: Start of the response log window as Unix milliseconds within the 14-day retention window.
toTimestamp:
type:
- integer
- string
- "null"
title: to_timestamp
format: int64
description: End of the response log window as Unix milliseconds within the 14-day retention window.
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of logs to return (1-100, defaults to 25).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of logs to skip for pagination (defaults to 0).
title: ListMonitorHTTPResponseLogsRequest
additionalProperties: false
description: ListMonitorHTTPResponseLogsRequest is the request to list response logs within the 14-day HTTP response-log window.
openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse:
type: object
properties:
logs:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'
title: logs
description: Response logs.
pagination:
title: pagination
description: Pagination metadata.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogPagination'
title: ListMonitorHTTPResponseLogsResponse
additionalProperties: false
description: ListMonitorHTTPResponseLogsResponse is the response containing response logs.
openstatus.monitor.v1.ListMonitorsRequest:
type: object
properties:
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of monitors to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of monitors to skip for pagination (defaults to 0).
title: ListMonitorsRequest
additionalProperties: false
description: ListMonitorsRequest is the request to list monitors.
openstatus.monitor.v1.ListMonitorsResponse:
type: object
properties:
httpMonitors:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'
title: http_monitors
description: HTTP monitors in the workspace.
tcpMonitors:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'
title: tcp_monitors
description: TCP monitors in the workspace.
dnsMonitors:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'
title: dns_monitors
description: DNS monitors in the workspace.
icmpMonitors:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'
title: icmp_monitors
description: ICMP monitors in the workspace.
grpcMonitors:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'
title: grpc_monitors
description: gRPC monitors in the workspace.
totalSize:
type: integer
title: total_size
format: int32
description: Total number of monitors across all types.
title: ListMonitorsResponse
additionalProperties: false
description: ListMonitorsResponse is the response containing a list of monitors.
openstatus.monitor.v1.MonitorConfig:
type: object
oneOf:
- type: object
properties:
dns:
title: dns
description: DNS monitor configuration.
$ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'
title: dns
required:
- dns
- type: object
properties:
grpc:
title: grpc
description: gRPC monitor configuration.
$ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'
title: grpc
required:
- grpc
- type: object
properties:
http:
title: http
description: HTTP monitor configuration.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'
title: http
required:
- http
- type: object
properties:
icmp:
title: icmp
description: ICMP monitor configuration.
$ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'
title: icmp
required:
- icmp
- type: object
properties:
tcp:
title: tcp
description: TCP monitor configuration.
$ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'
title: tcp
required:
- tcp
title: MonitorConfig
additionalProperties: false
description: MonitorConfig represents the type-specific configuration for a monitor.
openstatus.monitor.v1.MonitorStatus:
type: string
title: MonitorStatus
enum:
- MONITOR_STATUS_UNSPECIFIED
- MONITOR_STATUS_ACTIVE
- MONITOR_STATUS_DEGRADED
- MONITOR_STATUS_ERROR
description: MonitorStatus represents the operational status of a monitor.
openstatus.monitor.v1.NumberComparator:
type: string
title: NumberComparator
enum:
- NUMBER_COMPARATOR_UNSPECIFIED
- NUMBER_COMPARATOR_EQUAL
- NUMBER_COMPARATOR_NOT_EQUAL
- NUMBER_COMPARATOR_GREATER_THAN
- NUMBER_COMPARATOR_GREATER_THAN_OR_EQUAL
- NUMBER_COMPARATOR_LESS_THAN
- NUMBER_COMPARATOR_LESS_THAN_OR_EQUAL
description: NumberComparator defines comparison operations for numeric values.
openstatus.monitor.v1.OpenTelemetryConfig:
type: object
properties:
endpoint:
type: string
title: endpoint
maxLength: 2048
description: OTEL endpoint URL.
headers:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Headers'
title: headers
maxItems: 20
description: Custom headers for OTEL requests.
title: OpenTelemetryConfig
additionalProperties: false
description: OpenTelemetry configuration for exporting metrics.
openstatus.monitor.v1.Periodicity:
type: string
title: Periodicity
enum:
- PERIODICITY_UNSPECIFIED
- PERIODICITY_30S
- PERIODICITY_1M
- PERIODICITY_5M
- PERIODICITY_10M
- PERIODICITY_30M
- PERIODICITY_1H
description: Monitor periodicity options.
openstatus.monitor.v1.RecordAssertion:
type: object
properties:
record:
type: string
title: record
enum:
- A
- AAAA
- CNAME
- MX
- TXT
description: DNS record type (e.g., "A", "AAAA", "CNAME", "MX", "TXT").
comparator:
not:
enum:
- RECORD_COMPARATOR_UNSPECIFIED
title: comparator
description: Comparison operation (required, must not be UNSPECIFIED).
$ref: '#/components/schemas/openstatus.monitor.v1.RecordComparator'
target:
type: string
title: target
description: Target value to compare against.
title: RecordAssertion
additionalProperties: false
description: RecordAssertion defines an assertion for DNS records.
openstatus.monitor.v1.RecordComparator:
type: string
title: RecordComparator
enum:
- RECORD_COMPARATOR_UNSPECIFIED
- RECORD_COMPARATOR_EQUAL
- RECORD_COMPARATOR_NOT_EQUAL
- RECORD_COMPARATOR_CONTAINS
- RECORD_COMPARATOR_NOT_CONTAINS
description: RecordComparator defines comparison operations for DNS records.
openstatus.monitor.v1.Region:
type: string
title: Region
enum:
- REGION_UNSPECIFIED
- REGION_FLY_AMS
- REGION_FLY_ARN
- REGION_FLY_BOM
- REGION_FLY_CDG
- REGION_FLY_DFW
- REGION_FLY_EWR
- REGION_FLY_FRA
- REGION_FLY_GRU
- REGION_FLY_IAD
- REGION_FLY_JNB
- REGION_FLY_LAX
- REGION_FLY_LHR
- REGION_FLY_NRT
- REGION_FLY_ORD
- REGION_FLY_SJC
- REGION_FLY_SIN
- REGION_FLY_SYD
- REGION_FLY_YYZ
- REGION_KOYEB_FRA
- REGION_KOYEB_PAR
- REGION_KOYEB_SFO
- REGION_KOYEB_SIN
- REGION_KOYEB_TYO
- REGION_KOYEB_WAS
- REGION_RAILWAY_US_WEST2
- REGION_RAILWAY_US_EAST4
- REGION_RAILWAY_EUROPE_WEST4
- REGION_RAILWAY_ASIA_SOUTHEAST1
description: |-
Geographic regions where monitors can run checks from.
REGION_FLY_BOM is deprecated and rejected on create/update; use REGION_FLY_SIN.
openstatus.monitor.v1.RegionStatus:
type: object
properties:
region:
title: region
description: The region identifier.
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
status:
title: status
description: The status of the monitor in this region.
$ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'
title: RegionStatus
additionalProperties: false
description: RegionStatus represents the status of a monitor in a specific region.
openstatus.monitor.v1.StatusCodeAssertion:
type: object
properties:
target:
type:
- integer
- string
title: target
maximum: 599
minimum: 100
format: int64
description: Target status code to compare against (100-599).
comparator:
not:
enum:
- NUMBER_COMPARATOR_UNSPECIFIED
title: comparator
description: Comparison operation (required, must not be UNSPECIFIED).
$ref: '#/components/schemas/openstatus.monitor.v1.NumberComparator'
title: StatusCodeAssertion
additionalProperties: false
description: StatusCodeAssertion defines an assertion for HTTP status codes.
openstatus.monitor.v1.StringComparator:
type: string
title: StringComparator
enum:
- STRING_COMPARATOR_UNSPECIFIED
- STRING_COMPARATOR_CONTAINS
- STRING_COMPARATOR_NOT_CONTAINS
- STRING_COMPARATOR_EQUAL
- STRING_COMPARATOR_NOT_EQUAL
- STRING_COMPARATOR_EMPTY
- STRING_COMPARATOR_NOT_EMPTY
- STRING_COMPARATOR_GREATER_THAN
- STRING_COMPARATOR_GREATER_THAN_OR_EQUAL
- STRING_COMPARATOR_LESS_THAN
- STRING_COMPARATOR_LESS_THAN_OR_EQUAL
description: StringComparator defines comparison operations for string values.
openstatus.monitor.v1.TCPMonitor:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the monitor (output only for create requests).
name:
type: string
examples:
- Database Connection Check
title: name
maxLength: 256
minLength: 1
description: Name of the monitor (required, max 256 characters).
uri:
type: string
examples:
- tcp://db.example.com:5432
title: uri
maxLength: 2048
minLength: 1
description: URI to monitor in format "host:port" (required, max 2048 characters).
periodicity:
not:
enum:
- PERIODICITY_UNSPECIFIED
title: periodicity
description: Check periodicity (required).
$ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'
timeout:
type:
- integer
- string
title: timeout
maximum: 300000
minimum: 0
format: int64
description: Timeout in milliseconds (0-300000, defaults to 45000).
degradedAt:
type:
- integer
- string
- "null"
title: degraded_at
maximum: 300000
minimum: 0
format: int64
description: Latency threshold for degraded status in milliseconds (optional, 0-300000).
retry:
type:
- integer
- string
title: retry
maximum: 10
minimum: 0
format: int64
description: Number of retry attempts (0-10, defaults to 3).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the monitor (optional).
active:
type:
- boolean
- "null"
title: active
description: Whether the monitor is active (defaults to false).
public:
type:
- boolean
- "null"
title: public
description: Whether the monitor is publicly visible (defaults to false).
regions:
type: array
items:
$ref: '#/components/schemas/openstatus.monitor.v1.Region'
title: regions
maxItems: 28
description: Geographic regions to run checks from.
openTelemetry:
title: open_telemetry
description: OpenTelemetry configuration for exporting metrics.
$ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'
status:
title: status
description: Current operational status of the monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'
privateLocationIds:
type: array
items:
type: string
readOnly: true
title: private_location_ids
description: IDs of private locations that run this monitor. Read-only.
readOnly: true
title: TCPMonitor
additionalProperties: false
description: TCPMonitor defines the configuration for a TCP monitor.
openstatus.monitor.v1.TimeRange:
type: string
title: TimeRange
enum:
- TIME_RANGE_UNSPECIFIED
- TIME_RANGE_1D
- TIME_RANGE_7D
- TIME_RANGE_14D
description: TimeRange represents the time period for metrics aggregation.
openstatus.monitor.v1.TriggerMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to trigger (required).
title: TriggerMonitorRequest
additionalProperties: false
description: TriggerMonitorRequest is the request to trigger a monitor check.
openstatus.monitor.v1.TriggerMonitorResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the trigger was successful.
title: TriggerMonitorResponse
additionalProperties: false
description: TriggerMonitorResponse is the response after triggering a monitor.
openstatus.monitor.v1.UpdateDNSMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to update (required).
monitor:
oneOf:
- $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'
- type: "null"
title: monitor
description: Updated monitor configuration (all fields optional for partial updates).
title: UpdateDNSMonitorRequest
additionalProperties: false
description: UpdateDNSMonitorRequest is the request to update an existing DNS monitor.
openstatus.monitor.v1.UpdateDNSMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The updated monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'
title: UpdateDNSMonitorResponse
additionalProperties: false
description: UpdateDNSMonitorResponse is the response after updating a DNS monitor.
openstatus.monitor.v1.UpdateGRPCMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to update (required).
monitor:
oneOf:
- $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'
- type: "null"
title: monitor
description: Updated monitor configuration (all fields optional for partial updates).
title: UpdateGRPCMonitorRequest
additionalProperties: false
description: UpdateGRPCMonitorRequest is the request to update an existing gRPC monitor.
openstatus.monitor.v1.UpdateGRPCMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The updated monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'
title: UpdateGRPCMonitorResponse
additionalProperties: false
description: UpdateGRPCMonitorResponse is the response after updating a gRPC monitor.
openstatus.monitor.v1.UpdateHTTPMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to update (required).
monitor:
oneOf:
- $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'
- type: "null"
title: monitor
description: Updated monitor configuration (all fields optional for partial updates).
title: UpdateHTTPMonitorRequest
additionalProperties: false
description: UpdateHTTPMonitorRequest is the request to update an existing HTTP monitor.
openstatus.monitor.v1.UpdateHTTPMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The updated monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'
title: UpdateHTTPMonitorResponse
additionalProperties: false
description: UpdateHTTPMonitorResponse is the response after updating an HTTP monitor.
openstatus.monitor.v1.UpdateICMPMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to update (required).
monitor:
oneOf:
- $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'
- type: "null"
title: monitor
description: Updated monitor configuration (all fields optional for partial updates).
title: UpdateICMPMonitorRequest
additionalProperties: false
description: UpdateICMPMonitorRequest is the request to update an existing ICMP monitor.
openstatus.monitor.v1.UpdateICMPMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The updated monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'
title: UpdateICMPMonitorResponse
additionalProperties: false
description: UpdateICMPMonitorResponse is the response after updating an ICMP monitor.
openstatus.monitor.v1.UpdateTCPMonitorRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Monitor ID to update (required).
monitor:
oneOf:
- $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'
- type: "null"
title: monitor
description: Updated monitor configuration (all fields optional for partial updates).
title: UpdateTCPMonitorRequest
additionalProperties: false
description: UpdateTCPMonitorRequest is the request to update an existing TCP monitor.
openstatus.monitor.v1.UpdateTCPMonitorResponse:
type: object
properties:
monitor:
title: monitor
description: The updated monitor.
$ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'
title: UpdateTCPMonitorResponse
additionalProperties: false
description: UpdateTCPMonitorResponse is the response after updating a TCP monitor.
openstatus.notification.v1.CheckNotificationLimitRequest:
type: object
title: CheckNotificationLimitRequest
additionalProperties: false
description: CheckNotificationLimitRequest is the request to check notification limits.
openstatus.notification.v1.CheckNotificationLimitResponse:
type: object
properties:
limitReached:
type: boolean
title: limit_reached
description: Whether the workspace has reached its notification limit.
currentCount:
type: integer
title: current_count
format: int32
description: Current number of notification channels.
maxCount:
type: integer
title: max_count
format: int32
description: Maximum allowed notification channels.
title: CheckNotificationLimitResponse
additionalProperties: false
description: CheckNotificationLimitResponse is the response containing limit information.
openstatus.notification.v1.CreateNotificationRequest:
type: object
properties:
name:
type: string
examples:
- Slack Ops Channel
title: name
minLength: 1
description: Display name for the notification channel.
provider:
not:
enum:
- NOTIFICATION_PROVIDER_UNSPECIFIED
title: provider
description: Provider type.
$ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'
data:
title: data
description: Provider-specific configuration.
$ref: '#/components/schemas/openstatus.notification.v1.NotificationData'
monitorIds:
type: array
items:
type: string
title: monitor_ids
description: IDs of monitors to associate with this notification.
title: CreateNotificationRequest
required:
- data
additionalProperties: false
description: CreateNotificationRequest is the request to create a new notification channel.
openstatus.notification.v1.CreateNotificationResponse:
type: object
properties:
notification:
title: notification
description: The created notification channel.
$ref: '#/components/schemas/openstatus.notification.v1.Notification'
title: CreateNotificationResponse
additionalProperties: false
description: CreateNotificationResponse is the response after creating a notification channel.
openstatus.notification.v1.DeleteNotificationRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Notification ID to delete (required).
title: DeleteNotificationRequest
additionalProperties: false
description: DeleteNotificationRequest is the request to delete a notification channel.
openstatus.notification.v1.DeleteNotificationResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteNotificationResponse
additionalProperties: false
description: DeleteNotificationResponse is the response after deleting a notification channel.
openstatus.notification.v1.DiscordData:
type: object
properties:
webhookUrl:
type: string
examples:
- https://discord.com/api/webhooks/123/abc
title: webhook_url
format: uri
description: Discord webhook URL.
title: DiscordData
additionalProperties: false
description: DiscordData contains configuration for Discord notifications.
openstatus.notification.v1.EmailData:
type: object
properties:
email:
type: string
examples:
- [email protected]
title: email
format: email
description: Email address to send notifications to.
title: EmailData
additionalProperties: false
description: EmailData contains configuration for email notifications.
openstatus.notification.v1.GetNotificationRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Notification ID to retrieve (required).
title: GetNotificationRequest
additionalProperties: false
description: GetNotificationRequest is the request to get a notification channel.
openstatus.notification.v1.GetNotificationResponse:
type: object
properties:
notification:
title: notification
description: The notification channel.
$ref: '#/components/schemas/openstatus.notification.v1.Notification'
title: GetNotificationResponse
additionalProperties: false
description: GetNotificationResponse is the response containing the notification channel.
openstatus.notification.v1.GoogleChatData:
type: object
properties:
webhookUrl:
type: string
title: webhook_url
format: uri
description: Google Chat webhook URL.
title: GoogleChatData
additionalProperties: false
description: GoogleChatData contains configuration for Google Chat notifications.
openstatus.notification.v1.GrafanaOncallData:
type: object
properties:
webhookUrl:
type: string
title: webhook_url
format: uri
description: Grafana OnCall webhook URL.
title: GrafanaOncallData
additionalProperties: false
description: GrafanaOncallData contains configuration for Grafana OnCall notifications.
openstatus.notification.v1.ListNotificationsRequest:
type: object
properties:
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of notifications to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of notifications to skip for pagination (defaults to 0).
title: ListNotificationsRequest
additionalProperties: false
description: ListNotificationsRequest is the request to list notification channels.
openstatus.notification.v1.ListNotificationsResponse:
type: object
properties:
notifications:
type: array
items:
$ref: '#/components/schemas/openstatus.notification.v1.NotificationSummary'
title: notifications
description: Notification channel summaries.
totalSize:
type: integer
title: total_size
format: int32
description: Total number of notification channels.
title: ListNotificationsResponse
additionalProperties: false
description: ListNotificationsResponse is the response containing notification channels.
openstatus.notification.v1.MsTeamsData:
type: object
properties:
webhookUrl:
type: string
examples:
- https://prod-00.westeurope.logic.azure.com:443/workflows/abc/triggers/manual/paths/invoke
title: webhook_url
format: uri
description: Microsoft Teams webhook URL (Power Automate Workflows).
title: MsTeamsData
additionalProperties: false
description: MsTeamsData contains configuration for Microsoft Teams notifications.
openstatus.notification.v1.Notification:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the notification.
name:
type: string
title: name
description: Display name for the notification channel.
provider:
title: provider
description: Provider type.
$ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'
data:
title: data
description: Provider-specific configuration.
$ref: '#/components/schemas/openstatus.notification.v1.NotificationData'
monitorIds:
type: array
items:
type: string
title: monitor_ids
description: IDs of monitors associated with this notification.
createdAt:
type: string
title: created_at
description: Timestamp when the notification was created (RFC 3339).
updatedAt:
type: string
title: updated_at
description: Timestamp when the notification was last updated (RFC 3339).
title: Notification
additionalProperties: false
description: Notification represents a notification channel with full details.
openstatus.notification.v1.NotificationData:
type: object
oneOf:
- type: object
properties:
discord:
title: discord
description: Discord configuration.
$ref: '#/components/schemas/openstatus.notification.v1.DiscordData'
title: discord
required:
- discord
- type: object
properties:
email:
title: email
description: Email configuration.
$ref: '#/components/schemas/openstatus.notification.v1.EmailData'
title: email
required:
- email
- type: object
properties:
googleChat:
title: google_chat
description: Google Chat configuration.
$ref: '#/components/schemas/openstatus.notification.v1.GoogleChatData'
title: google_chat
required:
- googleChat
- type: object
properties:
grafanaOncall:
title: grafana_oncall
description: Grafana OnCall configuration.
$ref: '#/components/schemas/openstatus.notification.v1.GrafanaOncallData'
title: grafana_oncall
required:
- grafanaOncall
- type: object
properties:
msTeams:
title: ms_teams
description: Microsoft Teams configuration.
$ref: '#/components/schemas/openstatus.notification.v1.MsTeamsData'
title: ms_teams
required:
- msTeams
- type: object
properties:
ntfy:
title: ntfy
description: Ntfy configuration.
$ref: '#/components/schemas/openstatus.notification.v1.NtfyData'
title: ntfy
required:
- ntfy
- type: object
properties:
opsgenie:
title: opsgenie
description: Opsgenie configuration.
$ref: '#/components/schemas/openstatus.notification.v1.OpsgenieData'
title: opsgenie
required:
- opsgenie
- type: object
properties:
pagerduty:
title: pagerduty
description: PagerDuty configuration.
$ref: '#/components/schemas/openstatus.notification.v1.PagerDutyData'
title: pagerduty
required:
- pagerduty
- type: object
properties:
slack:
title: slack
description: Slack configuration.
$ref: '#/components/schemas/openstatus.notification.v1.SlackData'
title: slack
required:
- slack
- type: object
properties:
sms:
title: sms
description: 'Deprecated: SMS is no longer offered; use whatsapp.'
deprecated: true
$ref: '#/components/schemas/openstatus.notification.v1.SmsData'
title: sms
required:
- sms
- type: object
properties:
telegram:
title: telegram
description: Telegram configuration.
$ref: '#/components/schemas/openstatus.notification.v1.TelegramData'
title: telegram
required:
- telegram
- type: object
properties:
webhook:
title: webhook
description: Webhook configuration.
$ref: '#/components/schemas/openstatus.notification.v1.WebhookData'
title: webhook
required:
- webhook
- type: object
properties:
whatsapp:
title: whatsapp
description: WhatsApp configuration.
$ref: '#/components/schemas/openstatus.notification.v1.WhatsappData'
title: whatsapp
required:
- whatsapp
title: NotificationData
additionalProperties: false
description: NotificationData is a union of provider-specific configuration.
openstatus.notification.v1.NotificationProvider:
type: string
title: NotificationProvider
enum:
- NOTIFICATION_PROVIDER_UNSPECIFIED
- NOTIFICATION_PROVIDER_DISCORD
- NOTIFICATION_PROVIDER_EMAIL
- NOTIFICATION_PROVIDER_GOOGLE_CHAT
- NOTIFICATION_PROVIDER_GRAFANA_ONCALL
- NOTIFICATION_PROVIDER_NTFY
- NOTIFICATION_PROVIDER_PAGERDUTY
- NOTIFICATION_PROVIDER_OPSGENIE
- NOTIFICATION_PROVIDER_SLACK
- NOTIFICATION_PROVIDER_SMS
- NOTIFICATION_PROVIDER_TELEGRAM
- NOTIFICATION_PROVIDER_WEBHOOK
- NOTIFICATION_PROVIDER_WHATSAPP
- NOTIFICATION_PROVIDER_MS_TEAMS
description: NotificationProvider represents the supported notification channel types.
openstatus.notification.v1.NotificationSummary:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the notification.
name:
type: string
title: name
description: Display name for the notification channel.
provider:
title: provider
description: Provider type.
$ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'
monitorCount:
type: integer
title: monitor_count
format: int32
description: Number of monitors associated with this notification.
createdAt:
type: string
title: created_at
description: Timestamp when the notification was created (RFC 3339).
updatedAt:
type: string
title: updated_at
description: Timestamp when the notification was last updated (RFC 3339).
title: NotificationSummary
additionalProperties: false
description: NotificationSummary represents a notification channel summary for list responses.
openstatus.notification.v1.NtfyData:
type: object
properties:
topic:
type: string
examples:
- openstatus-alerts
title: topic
minLength: 1
description: Ntfy topic to publish to.
serverUrl:
type: string
title: server_url
description: Ntfy server URL (defaults to https://ntfy.sh).
token:
type:
- string
- "null"
title: token
description: Optional authentication token.
title: NtfyData
additionalProperties: false
description: NtfyData contains configuration for Ntfy notifications.
openstatus.notification.v1.OpsgenieData:
type: object
properties:
apiKey:
type: string
title: api_key
minLength: 1
description: Opsgenie API key.
region:
title: region
description: Opsgenie region.
$ref: '#/components/schemas/openstatus.notification.v1.OpsgenieRegion'
title: OpsgenieData
additionalProperties: false
description: OpsgenieData contains configuration for Opsgenie notifications.
openstatus.notification.v1.OpsgenieRegion:
type: string
title: OpsgenieRegion
enum:
- OPSGENIE_REGION_UNSPECIFIED
- OPSGENIE_REGION_US
- OPSGENIE_REGION_EU
description: OpsgenieRegion represents the Opsgenie API region.
openstatus.notification.v1.PagerDutyData:
type: object
properties:
integrationKey:
type: string
examples:
- a1b2c3d4e5f6g7h8i9j0
title: integration_key
minLength: 1
description: PagerDuty integration key.
title: PagerDutyData
additionalProperties: false
description: PagerDutyData contains configuration for PagerDuty notifications.
openstatus.notification.v1.SendTestNotificationRequest:
type: object
properties:
provider:
not:
enum:
- NOTIFICATION_PROVIDER_UNSPECIFIED
title: provider
description: Provider type.
$ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'
data:
title: data
description: Provider-specific configuration.
$ref: '#/components/schemas/openstatus.notification.v1.NotificationData'
title: SendTestNotificationRequest
required:
- data
additionalProperties: false
description: SendTestNotificationRequest is the request to send a test notification.
openstatus.notification.v1.SendTestNotificationResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the test was successful.
errorMessage:
type:
- string
- "null"
title: error_message
description: Optional error message if the test failed.
title: SendTestNotificationResponse
additionalProperties: false
description: SendTestNotificationResponse is the response after sending a test notification.
openstatus.notification.v1.SlackData:
type: object
properties:
webhookUrl:
type: string
examples:
- https://hooks.slack.com/services/T00/B00/xxx
title: webhook_url
format: uri
description: Slack webhook URL.
title: SlackData
additionalProperties: false
description: SlackData contains configuration for Slack notifications.
openstatus.notification.v1.SmsData:
type: object
properties:
phoneNumber:
type: string
examples:
- "+14155551234"
title: phone_number
minLength: 1
description: Phone number to send SMS to.
title: SmsData
additionalProperties: false
description: 'Deprecated: SMS is no longer offered; use WhatsappData. Kept for existing channels.'
deprecated: true
openstatus.notification.v1.TelegramData:
type: object
properties:
chatId:
type: string
examples:
- "-1001234567890"
title: chat_id
minLength: 1
description: Telegram chat ID.
title: TelegramData
additionalProperties: false
description: TelegramData contains configuration for Telegram notifications.
openstatus.notification.v1.UpdateNotificationRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: Notification ID to update (required).
name:
type:
- string
- "null"
title: name
description: Updated display name.
data:
oneOf:
- $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'
- type: "null"
title: data
description: Updated provider-specific configuration.
monitorIds:
type: array
items:
type: string
title: monitor_ids
description: Updated monitor IDs to associate.
updateMonitorIds:
type:
- boolean
- "null"
title: update_monitor_ids
description: |-
Set to true to update monitor associations.
When true, monitor_ids replaces the existing list (empty clears all).
When false or unset, monitor_ids is ignored and existing associations are preserved.
title: UpdateNotificationRequest
additionalProperties: false
description: UpdateNotificationRequest is the request to update a notification channel.
openstatus.notification.v1.UpdateNotificationResponse:
type: object
properties:
notification:
title: notification
description: The updated notification channel.
$ref: '#/components/schemas/openstatus.notification.v1.Notification'
title: UpdateNotificationResponse
additionalProperties: false
description: UpdateNotificationResponse is the response after updating a notification channel.
openstatus.notification.v1.WebhookData:
type: object
properties:
endpoint:
type: string
examples:
- https://api.example.com/webhooks/openstatus
title: endpoint
format: uri
description: Webhook endpoint URL.
headers:
type: array
items:
$ref: '#/components/schemas/openstatus.notification.v1.WebhookHeader'
title: headers
description: Optional custom headers.
title: WebhookData
additionalProperties: false
description: WebhookData contains configuration for custom webhook notifications.
openstatus.notification.v1.WebhookHeader:
type: object
properties:
key:
type: string
title: key
minLength: 1
description: Header name.
value:
type: string
title: value
description: Header value.
title: WebhookHeader
additionalProperties: false
description: WebhookHeader represents a custom header for webhook requests.
openstatus.notification.v1.WhatsappData:
type: object
properties:
phoneNumber:
type: string
title: phone_number
minLength: 1
description: Phone number to send WhatsApp messages to.
title: WhatsappData
additionalProperties: false
description: WhatsappData contains configuration for WhatsApp notifications.
openstatus.private_location.v1.CreatePrivateLocationRequest:
type: object
properties:
name:
type: string
examples:
- eu-west-agent
title: name
maxLength: 256
minLength: 1
description: Display name for the private location (required, 1-256 characters).
monitorIds:
type: array
items:
type: string
title: monitor_ids
description: IDs of monitors this private location should run (optional).
metadata:
type: object
title: metadata
maxProperties: 20
additionalProperties:
type: string
title: value
maxLength: 256
description: User-defined key/value labels (optional, up to 20 entries).
title: CreatePrivateLocationRequest
additionalProperties: false
description: CreatePrivateLocationRequest is the request to create a new private location.
openstatus.private_location.v1.CreatePrivateLocationRequest.MetadataEntry:
type: object
properties:
key:
type: string
title: key
value:
type: string
title: value
title: MetadataEntry
additionalProperties: false
openstatus.private_location.v1.CreatePrivateLocationResponse:
type: object
properties:
privateLocation:
title: private_location
description: The created private location, including its generated agent token.
$ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'
title: CreatePrivateLocationResponse
additionalProperties: false
description: CreatePrivateLocationResponse is the response after creating a private location.
openstatus.private_location.v1.DeletePrivateLocationRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the private location to delete (required).
title: DeletePrivateLocationRequest
additionalProperties: false
description: DeletePrivateLocationRequest is the request to delete a private location.
openstatus.private_location.v1.DeletePrivateLocationResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeletePrivateLocationResponse
additionalProperties: false
description: DeletePrivateLocationResponse is the response after deleting a private location.
openstatus.private_location.v1.GetPrivateLocationRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the private location to retrieve (required).
title: GetPrivateLocationRequest
additionalProperties: false
description: GetPrivateLocationRequest is the request to get a private location by ID.
openstatus.private_location.v1.GetPrivateLocationResponse:
type: object
properties:
privateLocation:
title: private_location
description: The requested private location.
$ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'
title: GetPrivateLocationResponse
additionalProperties: false
description: GetPrivateLocationResponse is the response containing the private location.
openstatus.private_location.v1.ListPrivateLocationsRequest:
type: object
properties:
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of private locations to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of private locations to skip for pagination (defaults to 0).
title: ListPrivateLocationsRequest
additionalProperties: false
description: ListPrivateLocationsRequest is the request to list private locations.
openstatus.private_location.v1.ListPrivateLocationsResponse:
type: object
properties:
privateLocations:
type: array
items:
$ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationSummary'
title: private_locations
description: List of private locations.
totalSize:
type: integer
title: total_size
format: int32
description: Total number of private locations in the workspace.
title: ListPrivateLocationsResponse
additionalProperties: false
description: ListPrivateLocationsResponse is the response containing private location summaries.
openstatus.private_location.v1.PrivateLocation:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the private location.
name:
type: string
title: name
description: Display name for the private location.
token:
type: string
title: token
description: |-
Agent credential. Generated by the server on creation and used by the
agent to authenticate; treat it as a secret.
monitorIds:
type: array
items:
type: string
title: monitor_ids
description: IDs of monitors this private location runs.
lastSeenAt:
type: string
title: last_seen_at
description: Last time the agent reported a result (RFC 3339), empty if it never has.
createdAt:
type: string
title: created_at
description: Timestamp when the private location was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the private location was last updated (RFC 3339 format).
metadata:
type: object
title: metadata
additionalProperties:
type: string
title: value
description: User-defined key/value labels attached to this private location.
status:
title: status
description: Computed health of the agent. Read-only.
$ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'
title: PrivateLocation
additionalProperties: false
description: PrivateLocation represents a self-hosted checker agent with full details.
openstatus.private_location.v1.PrivateLocation.MetadataEntry:
type: object
properties:
key:
type: string
title: key
value:
type: string
title: value
title: MetadataEntry
additionalProperties: false
openstatus.private_location.v1.PrivateLocationStatus:
type: string
title: PrivateLocationStatus
enum:
- PRIVATE_LOCATION_STATUS_UNSPECIFIED
- PRIVATE_LOCATION_STATUS_ACTIVE
- PRIVATE_LOCATION_STATUS_ERROR
description: |-
PrivateLocationStatus is the computed health of a private location, derived
from the agent heartbeat. Read-only — it cannot be set through the API.
openstatus.private_location.v1.PrivateLocationSummary:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the private location.
name:
type: string
title: name
description: Display name for the private location.
monitorCount:
type: integer
title: monitor_count
format: int32
description: Number of monitors this private location runs.
lastSeenAt:
type: string
title: last_seen_at
description: Last time the agent reported a result (RFC 3339), empty if it never has.
createdAt:
type: string
title: created_at
description: Timestamp when the private location was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the private location was last updated (RFC 3339 format).
status:
title: status
description: Computed health of the agent. Read-only.
$ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'
metadata:
type: object
title: metadata
additionalProperties:
type: string
title: value
description: User-defined key/value labels attached to this private location.
title: PrivateLocationSummary
additionalProperties: false
description: |-
PrivateLocationSummary represents metadata for a private location (used in
list responses). The agent token is intentionally omitted.
openstatus.private_location.v1.PrivateLocationSummary.MetadataEntry:
type: object
properties:
key:
type: string
title: key
value:
type: string
title: value
title: MetadataEntry
additionalProperties: false
openstatus.private_location.v1.UpdatePrivateLocationRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the private location to update (required).
name:
type:
- string
- "null"
title: name
maxLength: 256
minLength: 1
description: New display name for the private location (optional).
monitorIds:
type: array
items:
type: string
title: monitor_ids
description: New list of monitor IDs. Only applied when update_monitor_ids is true.
updateMonitorIds:
type:
- boolean
- "null"
title: update_monitor_ids
description: |-
When true, monitor_ids replaces the current associations (an empty list
clears all). When false or unset, monitor_ids is ignored and existing
associations are preserved.
metadata:
type: object
title: metadata
maxProperties: 20
additionalProperties:
type: string
title: value
maxLength: 256
description: New key/value labels. Only applied when update_metadata is true.
updateMetadata:
type:
- boolean
- "null"
title: update_metadata
description: |-
When true, metadata replaces the current labels (an empty map clears all).
When false or unset, metadata is ignored and existing labels are preserved.
title: UpdatePrivateLocationRequest
additionalProperties: false
description: UpdatePrivateLocationRequest is the request to update a private location.
openstatus.private_location.v1.UpdatePrivateLocationRequest.MetadataEntry:
type: object
properties:
key:
type: string
title: key
value:
type: string
title: value
title: MetadataEntry
additionalProperties: false
openstatus.private_location.v1.UpdatePrivateLocationResponse:
type: object
properties:
privateLocation:
title: private_location
description: The updated private location.
$ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'
title: UpdatePrivateLocationResponse
additionalProperties: false
description: UpdatePrivateLocationResponse is the response after updating a private location.
openstatus.status_page.v1.AddMonitorComponentRequest:
type: object
properties:
pageId:
type: string
title: page_id
minLength: 1
description: ID of the status page to add the component to (required).
monitorId:
type: string
title: monitor_id
minLength: 1
description: ID of the monitor to associate with this component (required).
name:
type:
- string
- "null"
title: name
maxLength: 256
description: Display name for the component (optional, defaults to monitor name).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the component (optional).
order:
type:
- integer
- "null"
title: order
format: int32
description: Display order of the component (optional).
groupId:
type:
- string
- "null"
title: group_id
description: ID of the group to add this component to (optional).
title: AddMonitorComponentRequest
additionalProperties: false
description: AddMonitorComponentRequest is the request to add a monitor-based component to a status page.
openstatus.status_page.v1.AddMonitorComponentResponse:
type: object
properties:
component:
title: component
description: The created component.
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'
title: AddMonitorComponentResponse
additionalProperties: false
description: AddMonitorComponentResponse is the response after adding a monitor component.
openstatus.status_page.v1.AddStaticComponentRequest:
type: object
properties:
pageId:
type: string
title: page_id
minLength: 1
description: ID of the status page to add the component to (required).
name:
type: string
title: name
maxLength: 256
minLength: 1
description: Display name for the component (required).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the component (optional).
order:
type:
- integer
- "null"
title: order
format: int32
description: Display order of the component (optional).
groupId:
type:
- string
- "null"
title: group_id
description: ID of the group to add this component to (optional).
title: AddStaticComponentRequest
additionalProperties: false
description: AddStaticComponentRequest is the request to add a static component to a status page.
openstatus.status_page.v1.AddStaticComponentResponse:
type: object
properties:
component:
title: component
description: The created component.
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'
title: AddStaticComponentResponse
additionalProperties: false
description: AddStaticComponentResponse is the response after adding a static component.
openstatus.status_page.v1.ComponentDayBucket:
type: object
properties:
day:
type: string
title: day
description: Day in RFC 3339 format (UTC midnight).
count:
type:
- integer
- string
title: count
format: int64
description: Total checks that day.
ok:
type:
- integer
- string
title: ok
format: int64
description: Successful checks.
degraded:
type:
- integer
- string
title: degraded
format: int64
description: Degraded checks.
error:
type:
- integer
- string
title: error
format: int64
description: Failed checks.
status:
title: status
description: Convenience resolved status for the day.
$ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayStatus'
impact:
oneOf:
- $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'
- type: "null"
title: impact
description: Worst status-report impact overlapping the day (absent when none).
title: ComponentDayBucket
additionalProperties: false
description: ComponentDayBucket is one day of status data for a component.
openstatus.status_page.v1.ComponentDayStatus:
type: string
title: ComponentDayStatus
enum:
- COMPONENT_DAY_STATUS_UNSPECIFIED
- COMPONENT_DAY_STATUS_OPERATIONAL
- COMPONENT_DAY_STATUS_DEGRADED
- COMPONENT_DAY_STATUS_DOWN
- COMPONENT_DAY_STATUS_MAINTENANCE
- COMPONENT_DAY_STATUS_EMPTY
description: ComponentDayStatus is the resolved status of a component on a given day.
openstatus.status_page.v1.ComponentEvent:
type: object
properties:
id:
type: string
title: id
description: Identifier of the underlying event.
name:
type: string
title: name
description: Human-readable name (incident "Downtime", maintenance / report title).
type:
title: type
description: Kind of event.
$ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventType'
status:
title: status
description: Projected status this event contributes.
$ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventStatus'
from:
type: string
title: from
description: Start time (RFC 3339).
to:
type:
- string
- "null"
title: to
description: End time (RFC 3339); absent while the event is ongoing.
impact:
oneOf:
- $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'
- type: "null"
title: impact
description: Worst impact over the event (reports only; absent otherwise).
title: ComponentEvent
additionalProperties: false
description: ComponentEvent is a single incident / maintenance / report affecting a component.
openstatus.status_page.v1.ComponentEventStatus:
type: string
title: ComponentEventStatus
enum:
- COMPONENT_EVENT_STATUS_UNSPECIFIED
- COMPONENT_EVENT_STATUS_OPERATIONAL
- COMPONENT_EVENT_STATUS_DEGRADED
- COMPONENT_EVENT_STATUS_DOWN
- COMPONENT_EVENT_STATUS_MAINTENANCE
description: ComponentEventStatus is the projected status an event contributes.
openstatus.status_page.v1.ComponentEventType:
type: string
title: ComponentEventType
enum:
- COMPONENT_EVENT_TYPE_UNSPECIFIED
- COMPONENT_EVENT_TYPE_MAINTENANCE
- COMPONENT_EVENT_TYPE_INCIDENT
- COMPONENT_EVENT_TYPE_REPORT
description: ComponentEventType is the kind of timeline event affecting a component.
openstatus.status_page.v1.ComponentStatus:
type: object
properties:
componentId:
type: string
title: component_id
description: ID of the component.
status:
title: status
description: Current status of the component.
$ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'
title: ComponentStatus
additionalProperties: false
description: ComponentStatus represents the status of a single component.
openstatus.status_page.v1.CreateComponentGroupRequest:
type: object
properties:
pageId:
type: string
title: page_id
minLength: 1
description: ID of the status page to create the group in (required).
name:
type: string
title: name
maxLength: 256
minLength: 1
description: Display name for the group (required).
defaultOpen:
type:
- boolean
- "null"
title: default_open
description: Whether the group should be expanded by default on the status page (optional, defaults to false).
title: CreateComponentGroupRequest
additionalProperties: false
description: CreateComponentGroupRequest is the request to create a new component group.
openstatus.status_page.v1.CreateComponentGroupResponse:
type: object
properties:
group:
title: group
description: The created component group.
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'
title: CreateComponentGroupResponse
additionalProperties: false
description: CreateComponentGroupResponse is the response after creating a component group.
openstatus.status_page.v1.CreatePageSubscriptionRequest:
type: object
allOf:
- properties:
pageId:
type: string
title: page_id
minLength: 1
description: ID of the status page (required).
name:
type:
- string
- "null"
title: name
maxLength: 255
description: Optional human-readable label.
componentIds:
type: array
items:
type: string
title: component_ids
description: Component scope. Empty = entire page.
- oneOf:
- type: object
properties:
emailChannel:
title: email_channel
$ref: '#/components/schemas/openstatus.status_page.v1.EmailChannel'
title: email_channel
required:
- emailChannel
- type: object
properties:
webhookChannel:
title: webhook_channel
$ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannel'
title: webhook_channel
required:
- webhookChannel
title: CreatePageSubscriptionRequest
additionalProperties: false
description: CreatePageSubscriptionRequest is the request to add a vendor-managed subscriber to a status page.
openstatus.status_page.v1.CreatePageSubscriptionResponse:
type: object
properties:
subscriber:
title: subscriber
description: The created subscriber.
$ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'
title: CreatePageSubscriptionResponse
additionalProperties: false
description: CreatePageSubscriptionResponse is the response after creating a vendor-managed subscription.
openstatus.status_page.v1.CreateStatusPageRequest:
type: object
properties:
title:
type: string
examples:
- Acme Corp Status
title: title
maxLength: 256
minLength: 1
description: Title of the status page (required).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: Description of the status page (optional).
slug:
type: string
examples:
- my-status-page
title: slug
maxLength: 256
minLength: 1
pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description: URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens.
homepageUrl:
type:
- string
- "null"
examples:
- https://www.example.com
title: homepage_url
description: URL to the homepage (optional).
contactUrl:
type:
- string
- "null"
title: contact_url
description: URL to the contact page (optional).
defaultLocale:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.Locale'
- type: "null"
title: default_locale
description: Default locale for the status page (optional, defaults to EN).
locales:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.Locale'
title: locales
description: Enabled locales for the status page (optional).
icon:
type:
- string
- "null"
title: icon
maxLength: 1024
description: Icon URL for the status page (optional).
customDomain:
type:
- string
- "null"
title: custom_domain
maxLength: 256
description: Custom domain for the status page (optional).
theme:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'
- type: "null"
title: theme
description: Visual theme for the status page (optional, defaults to SYSTEM).
accessType:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'
- type: "null"
title: access_type
description: Access type for the status page (optional, defaults to PUBLIC).
password:
type:
- string
- "null"
title: password
maxLength: 256
minLength: 1
description: Password for the status page (required when access_type is PASSWORD_PROTECTED).
authEmailDomains:
type: array
items:
type: string
title: auth_email_domains
description: Email domains allowed to access the page (used when access_type is AUTHENTICATED).
allowIndex:
type:
- boolean
- "null"
title: allow_index
description: Whether search engines are allowed to index this status page (optional, defaults to true).
allowedIpRanges:
type:
- string
- "null"
title: allowed_ip_ranges
description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).
customTheme:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'
- type: "null"
title: custom_theme
description: |-
Per-mode CSS variable overrides merged over the theme (optional).
Only supported variable names are accepted. Requires the custom-theme plan feature.
title: CreateStatusPageRequest
additionalProperties: false
description: CreateStatusPageRequest is the request to create a new status page.
openstatus.status_page.v1.CreateStatusPageResponse:
type: object
properties:
statusPage:
title: status_page
description: The created status page.
$ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'
title: CreateStatusPageResponse
additionalProperties: false
description: CreateStatusPageResponse is the response after creating a status page.
openstatus.status_page.v1.CustomTheme:
type: object
properties:
light:
type: object
title: light
additionalProperties:
type: string
title: value
description: 'CSS variable overrides applied in light mode, keyed by variable name (e.g. "--primary": "hsl(24 94% 50%)").'
dark:
type: object
title: dark
additionalProperties:
type: string
title: value
description: CSS variable overrides applied in dark mode, keyed by variable name.
title: CustomTheme
additionalProperties: false
description: CustomTheme holds per-mode CSS variable overrides merged over the page theme.
openstatus.status_page.v1.CustomTheme.DarkEntry:
type: object
properties:
key:
type: string
title: key
value:
type: string
title: value
title: DarkEntry
additionalProperties: false
openstatus.status_page.v1.CustomTheme.LightEntry:
type: object
properties:
key:
type: string
title: key
value:
type: string
title: value
title: LightEntry
additionalProperties: false
openstatus.status_page.v1.DeleteComponentGroupRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the component group to delete (required).
title: DeleteComponentGroupRequest
additionalProperties: false
description: DeleteComponentGroupRequest is the request to delete a component group.
openstatus.status_page.v1.DeleteComponentGroupResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteComponentGroupResponse
additionalProperties: false
description: DeleteComponentGroupResponse is the response after deleting a component group.
openstatus.status_page.v1.DeleteStatusPageRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the status page to delete (required).
title: DeleteStatusPageRequest
additionalProperties: false
description: DeleteStatusPageRequest is the request to delete a status page.
openstatus.status_page.v1.DeleteStatusPageResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteStatusPageResponse
additionalProperties: false
description: DeleteStatusPageResponse is the response after deleting a status page.
openstatus.status_page.v1.EmailChannel:
type: object
properties:
email:
type: string
title: email
format: email
description: Email address of the subscriber (required).
title: EmailChannel
additionalProperties: false
description: EmailChannel carries the email-channel fields for CreatePageSubscription.
openstatus.status_page.v1.GetOverallStatusRequest:
type: object
oneOf:
- type: object
properties:
id:
type: string
title: id
description: ID of the status page.
title: id
required:
- id
- type: object
properties:
slug:
type: string
title: slug
description: Slug of the status page.
title: slug
required:
- slug
title: GetOverallStatusRequest
additionalProperties: false
description: GetOverallStatusRequest is the request to get the overall status of a status page.
openstatus.status_page.v1.GetOverallStatusResponse:
type: object
properties:
overallStatus:
title: overall_status
description: Aggregated status across all components.
$ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'
componentStatuses:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'
title: component_statuses
description: Status of individual components.
title: GetOverallStatusResponse
additionalProperties: false
description: GetOverallStatusResponse is the response containing the overall status and individual component statuses.
openstatus.status_page.v1.GetPageComponentDailySummaryRequest:
type: object
allOf:
- properties:
componentIds:
type: array
items:
type: string
minLength: 1
title: component_ids
description: Restrict the result to these component ids (optional, defaults to all components).
days:
type:
- integer
- "null"
title: days
maximum: 45
minimum: 1
format: int32
description: Number of days to return (1-45, defaults to 45 if unspecified).
- oneOf:
- type: object
properties:
id:
type: string
title: id
description: ID of the status page.
title: id
required:
- id
- type: object
properties:
slug:
type: string
title: slug
description: Slug of the status page.
title: slug
required:
- slug
title: GetPageComponentDailySummaryRequest
additionalProperties: false
description: GetPageComponentDailySummaryRequest is the request for per-component daily summaries.
openstatus.status_page.v1.GetPageComponentDailySummaryResponse:
type: object
properties:
components:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponentDailySummary'
title: components
description: Per-component daily summaries, in page order.
title: GetPageComponentDailySummaryResponse
additionalProperties: false
description: GetPageComponentDailySummaryResponse is the response containing per-component summaries.
openstatus.status_page.v1.GetPageComponentRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the component to retrieve (required).
title: GetPageComponentRequest
additionalProperties: false
description: GetPageComponentRequest is the request to fetch a single component by ID.
openstatus.status_page.v1.GetPageComponentResponse:
type: object
properties:
component:
title: component
description: The requested component.
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'
title: GetPageComponentResponse
additionalProperties: false
description: GetPageComponentResponse is the response containing the component.
openstatus.status_page.v1.GetStatusPageContentRequest:
type: object
oneOf:
- type: object
properties:
id:
type: string
title: id
description: ID of the status page.
title: id
required:
- id
- type: object
properties:
slug:
type: string
title: slug
description: Slug of the status page.
title: slug
required:
- slug
title: GetStatusPageContentRequest
additionalProperties: false
description: GetStatusPageContentRequest is the request to get the full content of a status page.
openstatus.status_page.v1.GetStatusPageContentResponse:
type: object
properties:
statusPage:
title: status_page
description: The status page details.
$ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'
components:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'
title: components
description: Components on the status page.
groups:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'
title: groups
description: Component groups on the status page.
statusReports:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'
title: status_reports
description: Active and recent status reports.
maintenances:
type: array
items:
$ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'
title: maintenances
description: Scheduled maintenances.
title: GetStatusPageContentResponse
additionalProperties: false
description: GetStatusPageContentResponse is the response containing the full status page content.
openstatus.status_page.v1.GetStatusPageOverviewRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the status page (required, workspace-scoped).
title: GetStatusPageOverviewRequest
additionalProperties: false
description: GetStatusPageOverviewRequest requests the full overview of a status page by id.
openstatus.status_page.v1.GetStatusPageOverviewResponse:
type: object
properties:
statusPage:
title: status_page
description: The status page details.
$ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'
configuration:
title: configuration
description: Rich rendering configuration of the page.
$ref: '#/components/schemas/openstatus.status_page.v1.PageConfiguration'
components:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'
title: components
description: Components on the status page.
groups:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'
title: groups
description: Component groups on the status page.
statusReports:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'
title: status_reports
description: Active and recent status reports.
maintenances:
type: array
items:
$ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'
title: maintenances
description: Scheduled maintenances.
overallStatus:
title: overall_status
description: Aggregated status across all components.
$ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'
componentStatuses:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'
title: component_statuses
description: Status of individual components.
title: GetStatusPageOverviewResponse
additionalProperties: false
description: GetStatusPageOverviewResponse bundles all data for a single status page.
openstatus.status_page.v1.GetStatusPageRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the status page to retrieve (required).
title: GetStatusPageRequest
additionalProperties: false
description: GetStatusPageRequest is the request to get a status page by ID.
openstatus.status_page.v1.GetStatusPageResponse:
type: object
properties:
statusPage:
title: status_page
description: The requested status page.
$ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'
title: GetStatusPageResponse
additionalProperties: false
description: GetStatusPageResponse is the response containing the status page.
openstatus.status_page.v1.ListStatusPagesRequest:
type: object
properties:
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of pages to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of pages to skip for pagination (defaults to 0).
title: ListStatusPagesRequest
additionalProperties: false
description: ListStatusPagesRequest is the request to list status pages.
openstatus.status_page.v1.ListStatusPagesResponse:
type: object
properties:
statusPages:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.StatusPageSummary'
title: status_pages
description: List of status pages (metadata only).
totalSize:
type: integer
title: total_size
format: int32
description: Total number of status pages.
title: ListStatusPagesResponse
additionalProperties: false
description: ListStatusPagesResponse is the response containing status page summaries.
openstatus.status_page.v1.ListSubscribersRequest:
type: object
properties:
pageId:
type: string
title: page_id
minLength: 1
description: ID of the status page to list subscribers for (required).
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of subscribers to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of subscribers to skip for pagination (defaults to 0).
includeUnsubscribed:
type:
- boolean
- "null"
title: include_unsubscribed
description: Whether to include unsubscribed users (defaults to false).
title: ListSubscribersRequest
additionalProperties: false
description: ListSubscribersRequest is the request to list subscribers of a status page.
openstatus.status_page.v1.ListSubscribersResponse:
type: object
properties:
subscribers:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'
title: subscribers
description: List of subscribers.
totalSize:
type: integer
title: total_size
format: int32
description: Total number of subscribers matching the filter.
title: ListSubscribersResponse
additionalProperties: false
description: ListSubscribersResponse is the response containing status page subscribers.
openstatus.status_page.v1.Locale:
type: string
title: Locale
enum:
- LOCALE_UNSPECIFIED
- LOCALE_EN
- LOCALE_FR
- LOCALE_DE
- LOCALE_TR
- LOCALE_HI
- LOCALE_KO
- LOCALE_JA
description: Locale defines the supported languages for a status page.
openstatus.status_page.v1.OverallStatus:
type: string
title: OverallStatus
enum:
- OVERALL_STATUS_UNSPECIFIED
- OVERALL_STATUS_OPERATIONAL
- OVERALL_STATUS_DEGRADED
- OVERALL_STATUS_PARTIAL_OUTAGE
- OVERALL_STATUS_MAJOR_OUTAGE
- OVERALL_STATUS_MAINTENANCE
- OVERALL_STATUS_UNKNOWN
description: OverallStatus represents the aggregated status of all components on a page.
openstatus.status_page.v1.PageAccessType:
type: string
title: PageAccessType
enum:
- PAGE_ACCESS_TYPE_UNSPECIFIED
- PAGE_ACCESS_TYPE_PUBLIC
- PAGE_ACCESS_TYPE_PASSWORD_PROTECTED
- PAGE_ACCESS_TYPE_AUTHENTICATED
- PAGE_ACCESS_TYPE_IP_RESTRICTED
description: PageAccessType defines who can access the status page.
openstatus.status_page.v1.PageBarType:
type: string
title: PageBarType
enum:
- PAGE_BAR_TYPE_UNSPECIFIED
- PAGE_BAR_TYPE_ABSOLUTE
- PAGE_BAR_TYPE_MANUAL
description: PageBarType mirrors page.configuration.type (how the status bar is computed).
openstatus.status_page.v1.PageComponent:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the component.
pageId:
type: string
title: page_id
description: ID of the status page this component belongs to.
name:
type: string
title: name
description: Display name of the component.
description:
type: string
title: description
description: Description of the component (optional).
type:
title: type
description: Type of the component (monitor or static).
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'
monitorId:
type: string
title: monitor_id
description: ID of the monitor if type is MONITOR (optional).
order:
type: integer
title: order
format: int32
description: Display order of the component.
groupId:
type: string
title: group_id
description: ID of the group this component belongs to (optional).
groupOrder:
type: integer
title: group_order
format: int32
description: Order within the group if grouped.
createdAt:
type: string
title: created_at
description: Timestamp when the component was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the component was last updated (RFC 3339 format).
title: PageComponent
additionalProperties: false
description: PageComponent represents a component displayed on a status page.
openstatus.status_page.v1.PageComponentDailySummary:
type: object
properties:
componentId:
type: string
title: component_id
description: ID of the component.
type:
title: type
description: Component type (monitor or static).
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'
monitorId:
type:
- string
- "null"
title: monitor_id
description: Monitor id backing the component (absent for static components).
name:
type: string
title: name
description: Display name of the component.
buckets:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayBucket'
title: buckets
description: Per-day buckets, oldest first.
events:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.ComponentEvent'
title: events
description: Events affecting the component within the window.
title: PageComponentDailySummary
additionalProperties: false
description: PageComponentDailySummary is the per-day buckets + event timeline for one component.
openstatus.status_page.v1.PageComponentGroup:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the group.
pageId:
type: string
title: page_id
description: ID of the status page this group belongs to.
name:
type: string
title: name
description: Display name of the group.
createdAt:
type: string
title: created_at
description: Timestamp when the group was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the group was last updated (RFC 3339 format).
defaultOpen:
type: boolean
title: default_open
description: Whether the group should be expanded by default on the status page.
title: PageComponentGroup
additionalProperties: false
description: PageComponentGroup represents a group of components on a status page.
openstatus.status_page.v1.PageComponentType:
type: string
title: PageComponentType
enum:
- PAGE_COMPONENT_TYPE_UNSPECIFIED
- PAGE_COMPONENT_TYPE_MONITOR
- PAGE_COMPONENT_TYPE_STATIC
description: PageComponentType defines the type of a component on a status page.
openstatus.status_page.v1.PageConfiguration:
type: object
properties:
metricType:
title: metric_type
description: Which metric the status bars represent (configuration.value).
$ref: '#/components/schemas/openstatus.status_page.v1.PageMetricType'
barType:
title: bar_type
description: How the status bar is computed (configuration.type).
$ref: '#/components/schemas/openstatus.status_page.v1.PageBarType'
showUptime:
type: boolean
title: show_uptime
description: Whether to show the uptime percentage (configuration.uptime).
themeKey:
type: string
title: theme_key
description: |-
Theme key from the theme store (configuration.theme), e.g. "default".
Free-form string rather than an enum because the theme catalog is dynamic.
days:
type: integer
title: days
format: int32
description: 'Number of uptime-bar days rendered on the page (configuration.days): 30 or 45.'
title: PageConfiguration
additionalProperties: false
description: PageConfiguration is the rich rendering config stored in page.configuration.
openstatus.status_page.v1.PageMetricType:
type: string
title: PageMetricType
enum:
- PAGE_METRIC_TYPE_UNSPECIFIED
- PAGE_METRIC_TYPE_DURATION
- PAGE_METRIC_TYPE_REQUESTS
- PAGE_METRIC_TYPE_MANUAL
description: PageMetricType mirrors page.configuration.value (which metric the status bars represent).
openstatus.status_page.v1.PageSubscriber:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the subscriber.
pageId:
type: string
title: page_id
description: ID of the status page the user is subscribed to.
email:
type: string
title: email
description: Email address of the subscriber (empty for webhook channels).
acceptedAt:
type: string
title: accepted_at
description: Timestamp when the subscription was accepted/confirmed (RFC 3339 format, optional).
unsubscribedAt:
type: string
title: unsubscribed_at
description: Timestamp when the user unsubscribed (RFC 3339 format, optional).
createdAt:
type: string
title: created_at
description: Timestamp when the subscription was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the subscription was last updated (RFC 3339 format).
source:
title: source
description: How the subscription was created. Vendor-added rows skip verification.
$ref: '#/components/schemas/openstatus.status_page.v1.SubscriberSource'
name:
type:
- string
- "null"
title: name
description: 'Optional human-readable label (e.g. "Supabase #incidents").'
channelType:
type: string
title: channel_type
description: 'Channel type: "email" or "webhook".'
webhookUrl:
type:
- string
- "null"
title: webhook_url
description: Webhook URL (populated only for channel_type = "webhook").
channelConfig:
type:
- string
- "null"
title: channel_config
description: JSON-encoded channel config (e.g. custom headers). Populated for webhook channels.
componentIds:
type: array
items:
type: string
title: component_ids
description: IDs of components this subscription is scoped to. Empty = entire page.
title: PageSubscriber
additionalProperties: false
description: PageSubscriber represents a subscriber to a status page.
openstatus.status_page.v1.PageTheme:
type: string
title: PageTheme
enum:
- PAGE_THEME_UNSPECIFIED
- PAGE_THEME_SYSTEM
- PAGE_THEME_LIGHT
- PAGE_THEME_DARK
description: PageTheme defines the visual theme of the status page.
openstatus.status_page.v1.RemoveComponentRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the component to remove (required).
title: RemoveComponentRequest
additionalProperties: false
description: RemoveComponentRequest is the request to remove a component from a status page.
openstatus.status_page.v1.RemoveComponentResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the removal was successful.
title: RemoveComponentResponse
additionalProperties: false
description: RemoveComponentResponse is the response after removing a component.
openstatus.status_page.v1.StatusPage:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the status page.
title:
type: string
title: title
description: Title of the status page.
description:
type: string
title: description
description: Description of the status page.
slug:
type: string
examples:
- acme-corp
title: slug
description: URL-friendly slug for the status page.
customDomain:
type: string
examples:
- status.example.com
title: custom_domain
description: Custom domain for the status page (optional).
published:
type: boolean
title: published
description: Whether the status page is published and visible.
accessType:
title: access_type
description: Access type for the status page.
$ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'
theme:
title: theme
description: Visual theme for the status page.
$ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'
homepageUrl:
type: string
title: homepage_url
description: URL to the homepage (optional).
contactUrl:
type: string
title: contact_url
description: URL to the contact page (optional).
icon:
type: string
title: icon
description: Icon URL for the status page (optional).
createdAt:
type: string
examples:
- "2024-01-15T09:00:00Z"
title: created_at
description: Timestamp when the page was created (RFC 3339 format).
updatedAt:
type: string
examples:
- "2024-06-20T14:30:00Z"
title: updated_at
description: Timestamp when the page was last updated (RFC 3339 format).
defaultLocale:
title: default_locale
description: Default locale for the status page.
$ref: '#/components/schemas/openstatus.status_page.v1.Locale'
locales:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.Locale'
title: locales
description: Enabled locales for the status page.
password:
type: string
title: password
description: Password for the status page (only set when access_type is PASSWORD_PROTECTED).
authEmailDomains:
type: array
items:
type: string
title: auth_email_domains
description: Email domains allowed to access the page (only set when access_type is AUTHENTICATED).
allowIndex:
type: boolean
title: allow_index
description: Whether search engines are allowed to index this status page.
allowedIpRanges:
type: string
title: allowed_ip_ranges
description: Comma-separated IPv4 CIDR ranges (only set when access_type is IP_RESTRICTED).
customTheme:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'
- type: "null"
title: custom_theme
description: Per-mode CSS variable overrides merged over the theme (only set when configured).
title: StatusPage
additionalProperties: false
description: StatusPage represents a full status page with all details.
openstatus.status_page.v1.StatusPageSummary:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the status page.
title:
type: string
title: title
description: Title of the status page.
slug:
type: string
title: slug
description: URL-friendly slug for the status page.
published:
type: boolean
title: published
description: Whether the status page is published and visible.
createdAt:
type: string
title: created_at
description: Timestamp when the page was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the page was last updated (RFC 3339 format).
customDomain:
type: string
examples:
- status.example.com
title: custom_domain
description: Custom domain for the status page (optional).
title: StatusPageSummary
additionalProperties: false
description: StatusPageSummary represents metadata for a status page (used in list responses).
openstatus.status_page.v1.SubscribeToPageRequest:
type: object
properties:
pageId:
type: string
title: page_id
minLength: 1
description: ID of the status page to subscribe to (required).
email:
type: string
examples:
- [email protected]
title: email
format: email
description: Email address to subscribe (required).
title: SubscribeToPageRequest
additionalProperties: false
description: SubscribeToPageRequest is the request to subscribe an email to a status page.
openstatus.status_page.v1.SubscribeToPageResponse:
type: object
properties:
subscriber:
title: subscriber
description: The created subscriber.
$ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'
title: SubscribeToPageResponse
additionalProperties: false
description: SubscribeToPageResponse is the response after subscribing to a status page.
openstatus.status_page.v1.SubscriberSource:
type: string
title: SubscriberSource
enum:
- SUBSCRIBER_SOURCE_UNSPECIFIED
- SUBSCRIBER_SOURCE_SELF_SIGNUP
- SUBSCRIBER_SOURCE_VENDOR
- SUBSCRIBER_SOURCE_IMPORT
description: SubscriberSource indicates how the subscription was created.
openstatus.status_page.v1.UnsubscribeFromPageRequest:
type: object
allOf:
- properties:
pageId:
type: string
title: page_id
minLength: 1
description: ID of the status page to unsubscribe from (required).
- oneOf:
- type: object
properties:
email:
type: string
title: email
description: Email address to unsubscribe.
title: email
required:
- email
- type: object
properties:
id:
type: string
title: id
description: Subscriber ID.
title: id
required:
- id
title: UnsubscribeFromPageRequest
additionalProperties: false
description: UnsubscribeFromPageRequest is the request to unsubscribe from a status page.
openstatus.status_page.v1.UnsubscribeFromPageResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the unsubscription was successful.
title: UnsubscribeFromPageResponse
additionalProperties: false
description: UnsubscribeFromPageResponse is the response after unsubscribing from a status page.
openstatus.status_page.v1.UpdateComponentGroupRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the component group to update (required).
name:
type:
- string
- "null"
title: name
maxLength: 256
minLength: 1
description: New display name for the group (optional).
defaultOpen:
type:
- boolean
- "null"
title: default_open
description: Whether the group should be expanded by default on the status page (optional).
title: UpdateComponentGroupRequest
additionalProperties: false
description: UpdateComponentGroupRequest is the request to update a component group.
openstatus.status_page.v1.UpdateComponentGroupResponse:
type: object
properties:
group:
title: group
description: The updated component group.
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'
title: UpdateComponentGroupResponse
additionalProperties: false
description: UpdateComponentGroupResponse is the response after updating a component group.
openstatus.status_page.v1.UpdateComponentRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the component to update (required).
name:
type:
- string
- "null"
title: name
maxLength: 256
description: New display name for the component (optional).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: New description for the component (optional).
order:
type:
- integer
- "null"
title: order
format: int32
description: New display order (optional).
groupId:
type:
- string
- "null"
title: group_id
description: New group ID (optional, set to empty string to remove from group).
groupOrder:
type:
- integer
- "null"
title: group_order
format: int32
description: New order within the group (optional).
title: UpdateComponentRequest
additionalProperties: false
description: UpdateComponentRequest is the request to update a component.
openstatus.status_page.v1.UpdateComponentResponse:
type: object
properties:
component:
title: component
description: The updated component.
$ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'
title: UpdateComponentResponse
additionalProperties: false
description: UpdateComponentResponse is the response after updating a component.
openstatus.status_page.v1.UpdateStatusPageRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the status page to update (required).
title:
type:
- string
- "null"
title: title
maxLength: 256
minLength: 1
description: New title for the status page (optional).
description:
type:
- string
- "null"
title: description
maxLength: 1024
description: New description for the status page (optional).
slug:
type:
- string
- "null"
title: slug
maxLength: 256
minLength: 1
pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description: New slug for the status page (optional).
homepageUrl:
type:
- string
- "null"
title: homepage_url
description: New homepage URL (optional).
contactUrl:
type:
- string
- "null"
title: contact_url
description: New contact URL (optional).
defaultLocale:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.Locale'
- type: "null"
title: default_locale
description: New default locale for the status page (optional).
locales:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.Locale'
title: locales
description: New enabled locales for the status page (optional).
icon:
type:
- string
- "null"
title: icon
maxLength: 1024
description: New icon URL for the status page (optional).
customDomain:
type:
- string
- "null"
title: custom_domain
maxLength: 256
description: New custom domain (optional).
theme:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'
- type: "null"
title: theme
description: New visual theme (optional).
accessType:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'
- type: "null"
title: access_type
description: New access type (optional).
password:
type:
- string
- "null"
title: password
maxLength: 256
minLength: 1
description: New password (optional, required when access_type is PASSWORD_PROTECTED).
authEmailDomains:
type: array
items:
type: string
title: auth_email_domains
description: New email domains (optional, required when access_type is AUTHENTICATED).
allowIndex:
type:
- boolean
- "null"
title: allow_index
description: Whether search engines are allowed to index this status page (optional).
allowedIpRanges:
type:
- string
- "null"
title: allowed_ip_ranges
description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).
customTheme:
oneOf:
- $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'
- type: "null"
title: custom_theme
description: |-
New per-mode CSS variable overrides (optional). Omit to keep the current
value; send an empty message to clear. Requires the custom-theme plan feature.
title: UpdateStatusPageRequest
additionalProperties: false
description: UpdateStatusPageRequest is the request to update a status page.
openstatus.status_page.v1.UpdateStatusPageResponse:
type: object
properties:
statusPage:
title: status_page
description: The updated status page.
$ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'
title: UpdateStatusPageResponse
additionalProperties: false
description: UpdateStatusPageResponse is the response after updating a status page.
openstatus.status_page.v1.WebhookChannel:
type: object
properties:
webhookUrl:
type: string
title: webhook_url
maxLength: 2048
minLength: 1
format: uri
description: Webhook URL (required). Payload flavor (Slack / Discord / generic) is auto-detected from the URL prefix.
headers:
type: array
items:
$ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannelHeader'
title: headers
description: Optional custom HTTP headers attached to every dispatch.
title: WebhookChannel
additionalProperties: false
description: WebhookChannel carries the webhook-channel fields for CreatePageSubscription.
openstatus.status_page.v1.WebhookChannelHeader:
type: object
properties:
key:
type: string
title: key
minLength: 1
value:
type: string
title: value
title: WebhookChannelHeader
additionalProperties: false
description: WebhookChannelHeader is a single custom HTTP header.
openstatus.status_report.v1.AddStatusReportUpdateRequest:
type: object
properties:
statusReportId:
type: string
title: status_report_id
minLength: 1
description: ID of the status report to update (required).
status:
title: status
description: New status for the report (required).
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
message:
type: string
title: message
minLength: 1
description: Message describing what changed (required).
date:
type:
- string
- "null"
title: date
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: Optional date for the update (RFC 3339 format). Defaults to current time if not provided.
notify:
type:
- boolean
- "null"
title: notify
description: Whether to notify subscribers about this update (optional, defaults to false).
componentImpacts:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'
title: component_impacts
description: |-
Per-component impacts this update sets (optional). Components named here
are added to the report's affected set; omitted components keep their
prior impact.
title: AddStatusReportUpdateRequest
additionalProperties: false
description: AddStatusReportUpdateRequest is the request to add a new update to a status report.
openstatus.status_report.v1.AddStatusReportUpdateResponse:
type: object
properties:
statusReport:
title: status_report
description: The updated status report with the new update included.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'
title: AddStatusReportUpdateResponse
additionalProperties: false
description: AddStatusReportUpdateResponse is the response after adding an update to a status report.
openstatus.status_report.v1.ComponentImpact:
type: object
properties:
pageComponentId:
type: string
title: page_component_id
description: ID of the affected page component.
impact:
title: impact
description: Impact set for the component.
$ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'
title: ComponentImpact
additionalProperties: false
description: ComponentImpact pairs a page component with the impact an update set for it.
openstatus.status_report.v1.CreateStatusReportRequest:
type: object
properties:
title:
type: string
examples:
- API Degradation Investigation
title: title
minLength: 1
description: Title of the status report (required).
status:
title: status
description: Initial status (required).
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
message:
type: string
examples:
- We are investigating reports of increased API latency.
title: message
minLength: 1
description: Initial message describing the incident (required).
date:
type: string
examples:
- "2024-03-15T10:30:00Z"
title: date
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: Date when the event occurred (RFC 3339 format, required).
pageId:
type: string
title: page_id
minLength: 1
description: Page ID to associate with this report (required).
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: Page component IDs to associate with this report (optional).
notify:
type:
- boolean
- "null"
title: notify
description: Whether to notify subscribers about this status report (optional, defaults to false).
componentImpacts:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'
title: component_impacts
description: |-
Per-component impacts set by the initial update (optional). When provided,
the named components are added to the report's affected set. Omitting this
field creates a legacy report without impact tracking.
incidentId:
type:
- string
- "null"
title: incident_id
minLength: 1
description: |-
ID of an incident to link the report to (optional). Linked in the same
step: a closed incident, or one already linked to a report, fails the create.
title: CreateStatusReportRequest
additionalProperties: false
description: CreateStatusReportRequest is the request to create a new status report.
openstatus.status_report.v1.CreateStatusReportResponse:
type: object
properties:
statusReport:
title: status_report
description: The created status report.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'
title: CreateStatusReportResponse
additionalProperties: false
description: CreateStatusReportResponse is the response after creating a status report.
openstatus.status_report.v1.DeleteStatusReportRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the status report to delete (required).
title: DeleteStatusReportRequest
additionalProperties: false
description: DeleteStatusReportRequest is the request to delete a status report.
openstatus.status_report.v1.DeleteStatusReportResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteStatusReportResponse
additionalProperties: false
description: DeleteStatusReportResponse is the response after deleting a status report.
openstatus.status_report.v1.DeleteStatusReportUpdateRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the update to remove (required).
title: DeleteStatusReportUpdateRequest
additionalProperties: false
description: DeleteStatusReportUpdateRequest is the request to remove a status report update.
openstatus.status_report.v1.DeleteStatusReportUpdateResponse:
type: object
properties:
success:
type: boolean
title: success
description: Whether the deletion was successful.
title: DeleteStatusReportUpdateResponse
additionalProperties: false
description: DeleteStatusReportUpdateResponse is the response after removing a status report update.
openstatus.status_report.v1.GetStatusReportRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the status report to retrieve (required).
title: GetStatusReportRequest
additionalProperties: false
description: GetStatusReportRequest is the request to get a status report by ID.
openstatus.status_report.v1.GetStatusReportResponse:
type: object
properties:
statusReport:
title: status_report
description: The requested status report.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'
title: GetStatusReportResponse
additionalProperties: false
description: GetStatusReportResponse is the response containing the status report with its full update timeline.
openstatus.status_report.v1.ListStatusReportsRequest:
type: object
properties:
limit:
type:
- integer
- "null"
title: limit
maximum: 100
minimum: 1
format: int32
description: Maximum number of reports to return (1-100, defaults to 50).
offset:
type:
- integer
- "null"
title: offset
minimum: 0
format: int32
description: Number of reports to skip for pagination (defaults to 0).
statuses:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
title: statuses
description: Filter by status (optional). If empty, returns all statuses.
title: ListStatusReportsRequest
additionalProperties: false
description: ListStatusReportsRequest is the request to list status reports.
openstatus.status_report.v1.ListStatusReportsResponse:
type: object
properties:
statusReports:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportSummary'
title: status_reports
description: List of status reports (metadata only, use GetStatusReport for full details).
totalSize:
type: integer
title: total_size
format: int32
description: Total number of reports matching the filter.
title: ListStatusReportsResponse
additionalProperties: false
description: ListStatusReportsResponse is the response containing status report summaries.
openstatus.status_report.v1.PageComponentImpact:
type: string
title: PageComponentImpact
enum:
- PAGE_COMPONENT_IMPACT_UNSPECIFIED
- PAGE_COMPONENT_IMPACT_OPERATIONAL
- PAGE_COMPONENT_IMPACT_DEGRADED_PERFORMANCE
- PAGE_COMPONENT_IMPACT_PARTIAL_OUTAGE
- PAGE_COMPONENT_IMPACT_MAJOR_OUTAGE
description: |-
PageComponentImpact is the per-component impact a status report update sets.
UNSPECIFIED means the caller doesn't speak impact (legacy) — it is NOT operational.
openstatus.status_report.v1.StatusReport:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the status report.
status:
title: status
description: Current status of the report.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
title:
type: string
title: title
description: Title of the status report.
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: IDs of affected page components.
updates:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportUpdate'
title: updates
description: Timeline of updates for this report (only included in GetStatusReport).
createdAt:
type: string
title: created_at
description: Timestamp when the report was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the report was last updated (RFC 3339 format).
incidentId:
type:
- string
- "null"
title: incident_id
description: ID of the incident this report communicates (unset when not linked).
title: StatusReport
additionalProperties: false
description: StatusReport represents an incident or maintenance report with full details.
openstatus.status_report.v1.StatusReportStatus:
type: string
title: StatusReportStatus
enum:
- STATUS_REPORT_STATUS_UNSPECIFIED
- STATUS_REPORT_STATUS_INVESTIGATING
- STATUS_REPORT_STATUS_IDENTIFIED
- STATUS_REPORT_STATUS_MONITORING
- STATUS_REPORT_STATUS_RESOLVED
description: StatusReportStatus represents the current state of a status report.
openstatus.status_report.v1.StatusReportSummary:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the status report.
status:
title: status
description: Current status of the report.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
title:
type: string
title: title
description: Title of the status report.
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: IDs of affected page components.
createdAt:
type: string
title: created_at
description: Timestamp when the report was created (RFC 3339 format).
updatedAt:
type: string
title: updated_at
description: Timestamp when the report was last updated (RFC 3339 format).
incidentId:
type:
- string
- "null"
title: incident_id
description: ID of the incident this report communicates (unset when not linked).
title: StatusReportSummary
additionalProperties: false
description: StatusReportSummary represents metadata for a status report (used in list responses).
openstatus.status_report.v1.StatusReportUpdate:
type: object
properties:
id:
type: string
title: id
description: Unique identifier for the update.
status:
title: status
description: Status at the time of this update.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
date:
type: string
title: date
description: Timestamp when this update occurred (RFC 3339 format).
message:
type: string
title: message
description: Message describing the update.
createdAt:
type: string
title: created_at
description: Timestamp when the update was created (RFC 3339 format).
componentImpacts:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'
title: component_impacts
description: Per-component impacts this update set (empty for legacy reports).
title: StatusReportUpdate
additionalProperties: false
description: StatusReportUpdate represents a single update entry in a status report timeline.
openstatus.status_report.v1.UpdateStatusReportRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the status report to update (required).
title:
type:
- string
- "null"
title: title
description: New title for the report (optional).
pageComponentIds:
type: array
items:
type: string
title: page_component_ids
description: New list of page component IDs (optional, replaces existing list).
updatePageComponentIds:
type:
- boolean
- "null"
title: update_page_component_ids
description: |-
Set to true to update page component associations.
When true, page_component_ids replaces the existing list (empty clears all).
When false or unset, page_component_ids is ignored and existing associations are preserved.
title: UpdateStatusReportRequest
additionalProperties: false
description: UpdateStatusReportRequest is the request to update a status report's metadata.
openstatus.status_report.v1.UpdateStatusReportResponse:
type: object
properties:
statusReport:
title: status_report
description: The updated status report.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'
title: UpdateStatusReportResponse
additionalProperties: false
description: UpdateStatusReportResponse is the response after updating a status report.
openstatus.status_report.v1.UpdateStatusReportUpdateRequest:
type: object
properties:
id:
type: string
title: id
minLength: 1
description: ID of the update to edit (required).
status:
oneOf:
- $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'
- type: "null"
title: status
description: New status for this entry (optional).
message:
type:
- string
- "null"
title: message
minLength: 1
description: New message (optional).
date:
type:
- string
- "null"
title: date
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
description: New date for this entry (RFC 3339 format, optional).
componentImpacts:
type: array
items:
$ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'
title: component_impacts
description: Replacement impact set for this update (optional, see update_component_impacts).
updateComponentImpacts:
type:
- boolean
- "null"
title: update_component_impacts
description: |-
Set to true to replace the update's component impacts with component_impacts
(empty clears them). When false or unset, component_impacts is ignored.
title: UpdateStatusReportUpdateRequest
additionalProperties: false
description: UpdateStatusReportUpdateRequest is the request to edit a status report update.
openstatus.status_report.v1.UpdateStatusReportUpdateResponse:
type: object
properties:
statusReportUpdate:
title: status_report_update
description: The edited timeline entry.
$ref: '#/components/schemas/openstatus.status_report.v1.StatusReportUpdate'
title: UpdateStatusReportUpdateResponse
additionalProperties: false
description: UpdateStatusReportUpdateResponse is the response after editing a status report update.
security:
- ApiKeyAuth: []
tags:
- name: MonitorService
description: |
Create, update, delete, and query monitors. Supports HTTP, TCP, and DNS monitor types
with configurable check intervals, regions, assertions, and alerting thresholds.
- name: StatusPageService
description: |
Manage public status pages with components, component groups, and email subscribers.
Includes endpoints for retrieving full page content and aggregated status.
- name: NotificationService
description: |
Configure notification channels (Slack, Discord, PagerDuty, email, webhooks, etc.)
and associate them with monitors. Supports 12 notification providers.
- name: StatusReportService
description: |
Create and manage public status reports with status updates. Reports follow a lifecycle:
investigating -> identified -> monitoring -> resolved.
- name: IncidentService
description: |
Declare and run incidents: lifecycle (open -> mitigated -> resolved, or canceled),
timeline notes, a linked status report, and the postmortem.
- name: MaintenanceService
description: |
Schedule maintenance windows for status page components. Subscribers can be
notified automatically when maintenance is created.
- name: HealthService
description: Health check endpoint for load balancer probes. No authentication required.
- name: PrivateLocationService
description: |-
PrivateLocationService provides CRUD operations for private locations —
self-hosted checker agents that run monitors from your own network.
paths:
/rpc/openstatus.health.v1.HealthService/Check:
get:
tags:
- HealthService
summary: Check
description: Check returns the current serving status of the service.
operationId: HealthService_Check.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.health.v1.CheckRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.health.v1.CheckResponse'
post:
tags:
- HealthService
summary: Check
description: Check returns the current serving status of the service.
operationId: HealthService_Check
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.health.v1.CheckRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.health.v1.CheckResponse'
/rpc/openstatus.incident.v1.IncidentService/AddIncidentNote:
post:
tags:
- IncidentService
summary: AddIncidentNote
description: AddIncidentNote appends a note to the incident timeline.
operationId: IncidentService_AddIncidentNote
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.AddIncidentNoteRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.AddIncidentNoteResponse'
/rpc/openstatus.incident.v1.IncidentService/ApprovePostmortem:
post:
tags:
- IncidentService
summary: ApprovePostmortem
description: Approves the draft postmortem of a resolved incident. With close set to true the incident is closed in the same step. Fails with not_found when no postmortem has been written, and with failed_precondition when the incident is not resolved or the postmortem is already approved. Allowed for workspace owners and admins and for the incident commander. The API key acts as its creator, with the creator's current role; keys without a creator cannot call this.
operationId: IncidentService_ApprovePostmortem
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.ApprovePostmortemRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.ApprovePostmortemResponse'
/rpc/openstatus.incident.v1.IncidentService/CloseIncident:
post:
tags:
- IncidentService
summary: CloseIncident
description: Closes a resolved incident, after which only its postmortem can change. Requires an approved postmortem, or skip_postmortem set to true. Allowed for workspace owners and admins and for the incident commander. The API key acts as its creator, with the creator's current role; keys without a creator cannot call this.
operationId: IncidentService_CloseIncident
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.CloseIncidentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.CloseIncidentResponse'
/rpc/openstatus.incident.v1.IncidentService/DeclareIncident:
post:
tags:
- IncidentService
summary: DeclareIncident
description: Declares a new incident in the open status. The commander is set by email and must be a member of the workspace; without one the incident is unassigned. A newly assigned commander is emailed unless they own the API key. When open_slack_channel is true and Slack is connected, a dedicated channel is created and the team invited. started_at defaults to now and can be set in the past for a retroactive declare. A status_report_id that does not exist in the workspace fails with not_found; one already linked to another incident fails with failed_precondition.
operationId: IncidentService_DeclareIncident
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.DeclareIncidentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.DeclareIncidentResponse'
/rpc/openstatus.incident.v1.IncidentService/DeleteIncident:
post:
tags:
- IncidentService
summary: DeleteIncident
description: Deletes an incident declared by mistake. Only allowed while the incident is open and was never mitigated, resolved or closed (Incident.deletable); cancel it otherwise. Allowed for workspace owners and admins only. The API key acts as its creator, with the creator's current role; keys without a creator cannot call this.
operationId: IncidentService_DeleteIncident
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.DeleteIncidentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.DeleteIncidentResponse'
/rpc/openstatus.incident.v1.IncidentService/GetIncident:
get:
tags:
- IncidentService
summary: GetIncident
description: GetIncident retrieves an incident by ID, including its timeline.
operationId: IncidentService_GetIncident.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetIncidentRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetIncidentResponse'
post:
tags:
- IncidentService
summary: GetIncident
description: GetIncident retrieves an incident by ID, including its timeline.
operationId: IncidentService_GetIncident
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetIncidentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetIncidentResponse'
/rpc/openstatus.incident.v1.IncidentService/GetPostmortem:
get:
tags:
- IncidentService
summary: GetPostmortem
description: GetPostmortem retrieves the postmortem of an incident, if any.
operationId: IncidentService_GetPostmortem.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetPostmortemRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetPostmortemResponse'
post:
tags:
- IncidentService
summary: GetPostmortem
description: GetPostmortem retrieves the postmortem of an incident, if any.
operationId: IncidentService_GetPostmortem
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetPostmortemRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.GetPostmortemResponse'
/rpc/openstatus.incident.v1.IncidentService/LinkStatusReport:
post:
tags:
- IncidentService
summary: LinkStatusReport
description: |-
LinkStatusReport links a public status report to the incident.
A report already linked to another incident fails with failed_precondition.
operationId: IncidentService_LinkStatusReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.LinkStatusReportRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.LinkStatusReportResponse'
/rpc/openstatus.incident.v1.IncidentService/ListIncidents:
get:
tags:
- IncidentService
summary: ListIncidents
description: ListIncidents returns the incidents of the workspace (metadata only), newest declared first.
operationId: IncidentService_ListIncidents.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.ListIncidentsRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.ListIncidentsResponse'
post:
tags:
- IncidentService
summary: ListIncidents
description: ListIncidents returns the incidents of the workspace (metadata only), newest declared first.
operationId: IncidentService_ListIncidents
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.ListIncidentsRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.ListIncidentsResponse'
/rpc/openstatus.incident.v1.IncidentService/SetIncidentStatus:
post:
tags:
- IncidentService
summary: SetIncidentStatus
description: 'Moves an incident to a new status. Allowed transitions: open -> mitigated, resolved or canceled; mitigated -> resolved, open or canceled; resolved -> open. Canceled is terminal and closes the incident. The same status, a forbidden transition or a closed incident fail with failed_precondition; Incident.allowed_transitions lists what is valid. A linked status report is never updated: post the public update with StatusReportService.AddStatusReportUpdate.'
operationId: IncidentService_SetIncidentStatus
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.SetIncidentStatusRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.SetIncidentStatusResponse'
/rpc/openstatus.incident.v1.IncidentService/UnlinkStatusReport:
post:
tags:
- IncidentService
summary: UnlinkStatusReport
description: UnlinkStatusReport removes the link to the incident's status report.
operationId: IncidentService_UnlinkStatusReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.UnlinkStatusReportRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.UnlinkStatusReportResponse'
/rpc/openstatus.incident.v1.IncidentService/UpdateIncident:
post:
tags:
- IncidentService
summary: UpdateIncident
description: UpdateIncident edits the title, severity, summary, commander or start time of an incident.
operationId: IncidentService_UpdateIncident
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.UpdateIncidentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.UpdateIncidentResponse'
/rpc/openstatus.incident.v1.IncidentService/UpdatePostmortem:
post:
tags:
- IncidentService
summary: UpdatePostmortem
description: UpdatePostmortem creates or replaces the postmortem body of a resolved incident.
operationId: IncidentService_UpdatePostmortem
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.UpdatePostmortemRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.incident.v1.UpdatePostmortemResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/AddMaintenanceUpdate:
post:
tags:
- MaintenanceService
summary: AddMaintenanceUpdate
description: AddMaintenanceUpdate appends a public update to a maintenance timeline.
operationId: MaintenanceService_AddMaintenanceUpdate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance:
post:
tags:
- MaintenanceService
summary: CreateMaintenance
description: CreateMaintenance creates a new maintenance window.
operationId: MaintenanceService_CreateMaintenance
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenance:
post:
tags:
- MaintenanceService
summary: DeleteMaintenance
description: DeleteMaintenance removes a maintenance window.
operationId: MaintenanceService_DeleteMaintenance
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenanceUpdate:
post:
tags:
- MaintenanceService
summary: DeleteMaintenanceUpdate
description: DeleteMaintenanceUpdate removes an existing maintenance update.
operationId: MaintenanceService_DeleteMaintenanceUpdate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance:
get:
tags:
- MaintenanceService
summary: GetMaintenance
description: GetMaintenance retrieves a specific maintenance window by ID.
operationId: MaintenanceService_GetMaintenance.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'
post:
tags:
- MaintenanceService
summary: GetMaintenance
description: GetMaintenance retrieves a specific maintenance window by ID.
operationId: MaintenanceService_GetMaintenance
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/ListMaintenances:
get:
tags:
- MaintenanceService
summary: ListMaintenances
description: ListMaintenances returns all maintenance windows for the workspace.
operationId: MaintenanceService_ListMaintenances.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'
post:
tags:
- MaintenanceService
summary: ListMaintenances
description: ListMaintenances returns all maintenance windows for the workspace.
operationId: MaintenanceService_ListMaintenances
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenance:
post:
tags:
- MaintenanceService
summary: UpdateMaintenance
description: UpdateMaintenance updates a maintenance window.
operationId: MaintenanceService_UpdateMaintenance
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenanceUpdate:
post:
tags:
- MaintenanceService
summary: UpdateMaintenanceUpdate
description: UpdateMaintenanceUpdate edits an existing maintenance update.
operationId: MaintenanceService_UpdateMaintenanceUpdate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse'
/rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor:
post:
tags:
- MonitorService
summary: CreateDNSMonitor
description: CreateDNSMonitor creates a new DNS monitor.
operationId: MonitorService_CreateDNSMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/CreateGRPCMonitor:
post:
tags:
- MonitorService
summary: CreateGRPCMonitor
description: CreateGRPCMonitor creates a new gRPC health check monitor.
operationId: MonitorService_CreateGRPCMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/CreateHTTPMonitor:
post:
tags:
- MonitorService
summary: CreateHTTPMonitor
description: Creates a new HTTP monitor in the authenticated workspace. Configure the target URL, HTTP method, request headers and body, response assertions (status code, body content, headers), check periodicity, geographic regions, and optional OpenTelemetry export. The monitor starts checking immediately if set to active.
operationId: MonitorService_CreateHTTPMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/CreateICMPMonitor:
post:
tags:
- MonitorService
summary: CreateICMPMonitor
description: CreateICMPMonitor creates a new ICMP monitor.
operationId: MonitorService_CreateICMPMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/CreateTCPMonitor:
post:
tags:
- MonitorService
summary: CreateTCPMonitor
description: CreateTCPMonitor creates a new TCP monitor.
operationId: MonitorService_CreateTCPMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/DeleteMonitor:
post:
tags:
- MonitorService
summary: DeleteMonitor
description: DeleteMonitor removes a monitor.
operationId: MonitorService_DeleteMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/GetMonitor:
get:
tags:
- MonitorService
summary: GetMonitor
description: |-
GetMonitor returns a single monitor by ID within the authenticated workspace.
Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.
operationId: MonitorService_GetMonitor.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'
post:
tags:
- MonitorService
summary: GetMonitor
description: |-
GetMonitor returns a single monitor by ID within the authenticated workspace.
Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.
operationId: MonitorService_GetMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/GetMonitorHTTPResponseLog:
get:
tags:
- MonitorService
summary: GetMonitorHTTPResponseLog
description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.
operationId: MonitorService_GetMonitorHTTPResponseLog.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'
post:
tags:
- MonitorService
summary: GetMonitorHTTPResponseLog
description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.
operationId: MonitorService_GetMonitorHTTPResponseLog
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'
/rpc/openstatus.monitor.v1.MonitorService/GetMonitorStatus:
get:
tags:
- MonitorService
summary: GetMonitorStatus
description: GetMonitorStatus returns the current status of all regions for a monitor.
operationId: MonitorService_GetMonitorStatus.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'
post:
tags:
- MonitorService
summary: GetMonitorStatus
description: GetMonitorStatus returns the current status of all regions for a monitor.
operationId: MonitorService_GetMonitorStatus
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'
/rpc/openstatus.monitor.v1.MonitorService/GetMonitorSummary:
get:
tags:
- MonitorService
summary: GetMonitorSummary
description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.
operationId: MonitorService_GetMonitorSummary.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'
post:
tags:
- MonitorService
summary: GetMonitorSummary
description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.
operationId: MonitorService_GetMonitorSummary
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'
/rpc/openstatus.monitor.v1.MonitorService/ListMonitorHTTPResponseLogs:
get:
tags:
- MonitorService
summary: ListMonitorHTTPResponseLogs
description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.
operationId: MonitorService_ListMonitorHTTPResponseLogs.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'
post:
tags:
- MonitorService
summary: ListMonitorHTTPResponseLogs
description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.
operationId: MonitorService_ListMonitorHTTPResponseLogs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'
/rpc/openstatus.monitor.v1.MonitorService/ListMonitors:
get:
tags:
- MonitorService
summary: ListMonitors
description: ListMonitors returns a paginated list of all monitors in the workspace.
operationId: MonitorService_ListMonitors.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'
post:
tags:
- MonitorService
summary: ListMonitors
description: ListMonitors returns a paginated list of all monitors in the workspace.
operationId: MonitorService_ListMonitors
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'
/rpc/openstatus.monitor.v1.MonitorService/TriggerMonitor:
post:
tags:
- MonitorService
summary: TriggerMonitor
description: Manually triggers an immediate check for the specified monitor across all configured regions. This operation is rate-limited under the synthetic-checks quota. A monitor run record is created and the check is dispatched to the checker service.
operationId: MonitorService_TriggerMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/UpdateDNSMonitor:
post:
tags:
- MonitorService
summary: UpdateDNSMonitor
description: UpdateDNSMonitor updates an existing DNS monitor.
operationId: MonitorService_UpdateDNSMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/UpdateGRPCMonitor:
post:
tags:
- MonitorService
summary: UpdateGRPCMonitor
description: UpdateGRPCMonitor updates an existing gRPC monitor.
operationId: MonitorService_UpdateGRPCMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/UpdateHTTPMonitor:
post:
tags:
- MonitorService
summary: UpdateHTTPMonitor
description: UpdateHTTPMonitor updates an existing HTTP monitor.
operationId: MonitorService_UpdateHTTPMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/UpdateICMPMonitor:
post:
tags:
- MonitorService
summary: UpdateICMPMonitor
description: UpdateICMPMonitor updates an existing ICMP monitor.
operationId: MonitorService_UpdateICMPMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorResponse'
/rpc/openstatus.monitor.v1.MonitorService/UpdateTCPMonitor:
post:
tags:
- MonitorService
summary: UpdateTCPMonitor
description: UpdateTCPMonitor updates an existing TCP monitor.
operationId: MonitorService_UpdateTCPMonitor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorResponse'
/rpc/openstatus.notification.v1.NotificationService/CheckNotificationLimit:
get:
tags:
- NotificationService
summary: CheckNotificationLimit
description: CheckNotificationLimit checks if the workspace has reached its notification limit.
operationId: NotificationService_CheckNotificationLimit.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'
post:
tags:
- NotificationService
summary: CheckNotificationLimit
description: CheckNotificationLimit checks if the workspace has reached its notification limit.
operationId: NotificationService_CheckNotificationLimit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'
/rpc/openstatus.notification.v1.NotificationService/CreateNotification:
post:
tags:
- NotificationService
summary: CreateNotification
description: CreateNotification creates a new notification channel.
operationId: NotificationService_CreateNotification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationResponse'
/rpc/openstatus.notification.v1.NotificationService/DeleteNotification:
post:
tags:
- NotificationService
summary: DeleteNotification
description: DeleteNotification removes a notification channel.
operationId: NotificationService_DeleteNotification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationResponse'
/rpc/openstatus.notification.v1.NotificationService/GetNotification:
get:
tags:
- NotificationService
summary: GetNotification
description: GetNotification retrieves a notification channel by ID.
operationId: NotificationService_GetNotification.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'
post:
tags:
- NotificationService
summary: GetNotification
description: GetNotification retrieves a notification channel by ID.
operationId: NotificationService_GetNotification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'
/rpc/openstatus.notification.v1.NotificationService/ListNotifications:
get:
tags:
- NotificationService
summary: ListNotifications
description: ListNotifications returns a list of notification channels.
operationId: NotificationService_ListNotifications.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'
post:
tags:
- NotificationService
summary: ListNotifications
description: ListNotifications returns a list of notification channels.
operationId: NotificationService_ListNotifications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'
/rpc/openstatus.notification.v1.NotificationService/SendTestNotification:
post:
tags:
- NotificationService
summary: SendTestNotification
description: Sends a test notification to the specified provider to verify that the configuration is correct. This does not require an existing notification channel - just provide the provider type and its configuration data. Returns success status and an error message if the test failed.
operationId: NotificationService_SendTestNotification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationResponse'
/rpc/openstatus.notification.v1.NotificationService/UpdateNotification:
post:
tags:
- NotificationService
summary: UpdateNotification
description: UpdateNotification updates an existing notification channel.
operationId: NotificationService_UpdateNotification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationResponse'
/rpc/openstatus.private_location.v1.PrivateLocationService/CreatePrivateLocation:
post:
tags:
- PrivateLocationService
summary: CreatePrivateLocation
description: Creates a private location. The agent token is generated by the server and returned in the response - it cannot be supplied by the caller. Use the token to configure the agent so it can pull its monitors and report results.
operationId: PrivateLocationService_CreatePrivateLocation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationResponse'
/rpc/openstatus.private_location.v1.PrivateLocationService/DeletePrivateLocation:
post:
tags:
- PrivateLocationService
summary: DeletePrivateLocation
description: DeletePrivateLocation removes a private location.
operationId: PrivateLocationService_DeletePrivateLocation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationResponse'
/rpc/openstatus.private_location.v1.PrivateLocationService/GetPrivateLocation:
get:
tags:
- PrivateLocationService
summary: GetPrivateLocation
description: |-
GetPrivateLocation retrieves a single private location by ID, including
its agent token.
operationId: PrivateLocationService_GetPrivateLocation.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'
post:
tags:
- PrivateLocationService
summary: GetPrivateLocation
description: |-
GetPrivateLocation retrieves a single private location by ID, including
its agent token.
operationId: PrivateLocationService_GetPrivateLocation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'
/rpc/openstatus.private_location.v1.PrivateLocationService/ListPrivateLocations:
get:
tags:
- PrivateLocationService
summary: ListPrivateLocations
description: |-
ListPrivateLocations returns a paginated list of private location
summaries. Agent tokens are not included - use GetPrivateLocation.
operationId: PrivateLocationService_ListPrivateLocations.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'
post:
tags:
- PrivateLocationService
summary: ListPrivateLocations
description: |-
ListPrivateLocations returns a paginated list of private location
summaries. Agent tokens are not included - use GetPrivateLocation.
operationId: PrivateLocationService_ListPrivateLocations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'
/rpc/openstatus.private_location.v1.PrivateLocationService/UpdatePrivateLocation:
post:
tags:
- PrivateLocationService
summary: UpdatePrivateLocation
description: UpdatePrivateLocation updates a private location.
operationId: PrivateLocationService_UpdatePrivateLocation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationResponse'
/rpc/openstatus.status_page.v1.StatusPageService/AddMonitorComponent:
post:
tags:
- StatusPageService
summary: AddMonitorComponent
description: AddMonitorComponent adds a monitor-based component to a status page.
operationId: StatusPageService_AddMonitorComponent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentResponse'
/rpc/openstatus.status_page.v1.StatusPageService/AddStaticComponent:
post:
tags:
- StatusPageService
summary: AddStaticComponent
description: AddStaticComponent adds a static component to a status page.
operationId: StatusPageService_AddStaticComponent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentResponse'
/rpc/openstatus.status_page.v1.StatusPageService/CreateComponentGroup:
post:
tags:
- StatusPageService
summary: CreateComponentGroup
description: CreateComponentGroup creates a new component group.
operationId: StatusPageService_CreateComponentGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupResponse'
/rpc/openstatus.status_page.v1.StatusPageService/CreatePageSubscription:
post:
tags:
- StatusPageService
summary: 'CreatePageSubscription: operator-added subscriber (email or webhook), no verification.'
description: Operator-added subscriber (email or webhook) with no verification flow — the partner starts receiving notifications immediately. Supports Slack and Discord webhook URLs in addition to email. A management token is still generated so the subscriber can self-manage (update scope, unsubscribe) without operator involvement. Use this for vendor/partner integrations where consent is established out-of-band; use SubscribeToPage for subscriber-initiated signups that require double opt-in.
operationId: StatusPageService_CreatePageSubscription
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionResponse'
/rpc/openstatus.status_page.v1.StatusPageService/CreateStatusPage:
post:
tags:
- StatusPageService
summary: CreateStatusPage
description: CreateStatusPage creates a new status page.
operationId: StatusPageService_CreateStatusPage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageResponse'
/rpc/openstatus.status_page.v1.StatusPageService/DeleteComponentGroup:
post:
tags:
- StatusPageService
summary: DeleteComponentGroup
description: DeleteComponentGroup removes a component group.
operationId: StatusPageService_DeleteComponentGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupResponse'
/rpc/openstatus.status_page.v1.StatusPageService/DeleteStatusPage:
post:
tags:
- StatusPageService
summary: DeleteStatusPage
description: DeleteStatusPage removes a status page.
operationId: StatusPageService_DeleteStatusPage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageResponse'
/rpc/openstatus.status_page.v1.StatusPageService/GetOverallStatus:
get:
tags:
- StatusPageService
summary: GetOverallStatus
description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'
operationId: StatusPageService_GetOverallStatus.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'
post:
tags:
- StatusPageService
summary: GetOverallStatus
description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'
operationId: StatusPageService_GetOverallStatus
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'
/rpc/openstatus.status_page.v1.StatusPageService/GetPageComponent:
get:
tags:
- StatusPageService
summary: GetPageComponent
description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.
operationId: StatusPageService_GetPageComponent.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'
post:
tags:
- StatusPageService
summary: GetPageComponent
description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.
operationId: StatusPageService_GetPageComponent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'
/rpc/openstatus.status_page.v1.StatusPageService/GetPageComponentDailySummary:
get:
tags:
- StatusPageService
summary: GetPageComponentDailySummary
description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'
operationId: StatusPageService_GetPageComponentDailySummary.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'
post:
tags:
- StatusPageService
summary: GetPageComponentDailySummary
description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'
operationId: StatusPageService_GetPageComponentDailySummary
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'
/rpc/openstatus.status_page.v1.StatusPageService/GetStatusPage:
get:
tags:
- StatusPageService
summary: GetStatusPage
description: GetStatusPage retrieves a specific status page by ID.
operationId: StatusPageService_GetStatusPage.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'
post:
tags:
- StatusPageService
summary: GetStatusPage
description: GetStatusPage retrieves a specific status page by ID.
operationId: StatusPageService_GetStatusPage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'
/rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageContent:
get:
tags:
- StatusPageService
summary: GetStatusPageContent
description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'
operationId: StatusPageService_GetStatusPageContent.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'
post:
tags:
- StatusPageService
summary: GetStatusPageContent
description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'
operationId: StatusPageService_GetStatusPageContent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'
/rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageOverview:
get:
tags:
- StatusPageService
summary: GetStatusPageOverview
description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'
operationId: StatusPageService_GetStatusPageOverview.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'
post:
tags:
- StatusPageService
summary: GetStatusPageOverview
description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'
operationId: StatusPageService_GetStatusPageOverview
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'
/rpc/openstatus.status_page.v1.StatusPageService/ListStatusPages:
get:
tags:
- StatusPageService
summary: ListStatusPages
description: ListStatusPages returns all status pages for the workspace.
operationId: StatusPageService_ListStatusPages.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'
post:
tags:
- StatusPageService
summary: ListStatusPages
description: ListStatusPages returns all status pages for the workspace.
operationId: StatusPageService_ListStatusPages
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'
/rpc/openstatus.status_page.v1.StatusPageService/ListSubscribers:
get:
tags:
- StatusPageService
summary: ListSubscribers
description: ListSubscribers returns all subscribers for a status page.
operationId: StatusPageService_ListSubscribers.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'
post:
tags:
- StatusPageService
summary: ListSubscribers
description: ListSubscribers returns all subscribers for a status page.
operationId: StatusPageService_ListSubscribers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'
/rpc/openstatus.status_page.v1.StatusPageService/RemoveComponent:
post:
tags:
- StatusPageService
summary: RemoveComponent
description: RemoveComponent removes a component from a status page.
operationId: StatusPageService_RemoveComponent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentResponse'
/rpc/openstatus.status_page.v1.StatusPageService/SubscribeToPage:
post:
tags:
- StatusPageService
summary: 'SubscribeToPage: end-user email self-signup with double opt-in verification.'
description: End-user email self-signup with double opt-in verification. A verification email is sent and the subscription activates only after the recipient confirms. If the email was previously unsubscribed, the existing row is reactivated instead of a duplicate being created. Use this for subscriber-initiated signups on the public status page; use CreatePageSubscription for operator-initiated (vendor) subscriptions that should skip verification.
operationId: StatusPageService_SubscribeToPage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageResponse'
/rpc/openstatus.status_page.v1.StatusPageService/UnsubscribeFromPage:
post:
tags:
- StatusPageService
summary: UnsubscribeFromPage
description: UnsubscribeFromPage removes a subscription from a status page.
operationId: StatusPageService_UnsubscribeFromPage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageResponse'
/rpc/openstatus.status_page.v1.StatusPageService/UpdateComponent:
post:
tags:
- StatusPageService
summary: UpdateComponent
description: UpdateComponent updates an existing component.
operationId: StatusPageService_UpdateComponent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentResponse'
/rpc/openstatus.status_page.v1.StatusPageService/UpdateComponentGroup:
post:
tags:
- StatusPageService
summary: UpdateComponentGroup
description: UpdateComponentGroup updates an existing component group.
operationId: StatusPageService_UpdateComponentGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupResponse'
/rpc/openstatus.status_page.v1.StatusPageService/UpdateStatusPage:
post:
tags:
- StatusPageService
summary: UpdateStatusPage
description: UpdateStatusPage updates an existing status page.
operationId: StatusPageService_UpdateStatusPage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageResponse'
/rpc/openstatus.status_report.v1.StatusReportService/AddStatusReportUpdate:
post:
tags:
- StatusReportService
summary: AddStatusReportUpdate
description: 'Adds a new update entry to an existing status report and transitions the report to the specified status. Status reports follow a lifecycle: investigating -> identified -> monitoring -> resolved. If notify is true, subscribers of the associated page are notified by email about the update.'
operationId: StatusReportService_AddStatusReportUpdate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateResponse'
/rpc/openstatus.status_report.v1.StatusReportService/CreateStatusReport:
post:
tags:
- StatusReportService
summary: CreateStatusReport
description: Creates a new status report with an initial update entry. The report is associated with a status page and optionally specific page components. An initial StatusReportUpdate is created automatically with the provided status, message, and date. If notify is true, subscribers of the associated page are notified by email.
operationId: StatusReportService_CreateStatusReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportResponse'
/rpc/openstatus.status_report.v1.StatusReportService/DeleteStatusReport:
post:
tags:
- StatusReportService
summary: DeleteStatusReport
description: DeleteStatusReport removes a status report and all its updates.
operationId: StatusReportService_DeleteStatusReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportResponse'
/rpc/openstatus.status_report.v1.StatusReportService/DeleteStatusReportUpdate:
post:
tags:
- StatusReportService
summary: DeleteStatusReportUpdate
description: 'Removes a status report update. The report''s status is re-derived from the remaining updates. Deleting the last remaining update is rejected with INVALID_ARGUMENT: delete the status report instead.'
operationId: StatusReportService_DeleteStatusReportUpdate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportUpdateRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportUpdateResponse'
/rpc/openstatus.status_report.v1.StatusReportService/GetStatusReport:
get:
tags:
- StatusReportService
summary: GetStatusReport
description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).
operationId: StatusReportService_GetStatusReport.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'
post:
tags:
- StatusReportService
summary: GetStatusReport
description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).
operationId: StatusReportService_GetStatusReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'
/rpc/openstatus.status_report.v1.StatusReportService/ListStatusReports:
get:
tags:
- StatusReportService
summary: ListStatusReports
description: ListStatusReports returns all status reports for the workspace (metadata only).
operationId: StatusReportService_ListStatusReports.get
parameters:
- name: message
in: query
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'
post:
tags:
- StatusReportService
summary: ListStatusReports
description: ListStatusReports returns all status reports for the workspace (metadata only).
operationId: StatusReportService_ListStatusReports
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'
/rpc/openstatus.status_report.v1.StatusReportService/UpdateStatusReport:
post:
tags:
- StatusReportService
summary: UpdateStatusReport
description: UpdateStatusReport updates the metadata of a status report (title, page components).
operationId: StatusReportService_UpdateStatusReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportResponse'
/rpc/openstatus.status_report.v1.StatusReportService/UpdateStatusReportUpdate:
post:
tags:
- StatusReportService
summary: UpdateStatusReportUpdate
description: Edits an existing status report update in place. Editing the status or date of the latest update re-derives the report's overall status. Subscribers are not notified.
operationId: StatusReportService_UpdateStatusReportUpdate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportUpdateRequest'
required: true
responses:
"429":
$ref: '#/components/responses/RateLimited'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportUpdateResponse'