Skip to content

[ResponseOps][MW] Get Maintenance Window API #208882

@adcoelho

Description

@adcoelho

Summary

Users should be able to get information on a specific maintenance window by ID.

Implementation Notes

  • The existing maintenance window client should be used.
    • x-pack/platform/plugins/shared/alerting/server/maintenance_window_client/maintenance_window_client.ts

DoD

  • A GET maintenance window API is implemented.
  • The API should accept a maintenance window ID as a parameter.
  • The API is properly documented.
  • The response will follow the schema below.

Request

MaintenanceWindowID: string

Response

title: string;
start: string; // including timezone
duration: string; // 30m, 1h, 2m, etc
end?: string;
every?: string; // 1d, 2w, etc

created_by?: string;
updated_by?: string;
created_at: string;
updated_at: string;

status: 'running' | 'upcoming' | 'upcoming' | 'archived';
scope?: {
  query: {
    kql?: string;
  }
}

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions