IncidentIo.MaintenanceWindowsV2 (IncidentIo v0.3.1)

Manage maintenance windows for your organisation.

Maintenance windows suppress alerts during scheduled downtime, preventing unnecessary incident creation during planned maintenance periods.

Summary

Functions

create(client \\ %Client{}, body)

Create a new maintenance window.

destroy(client \\ %Client{}, id)

Delete a maintenance window.

list(client \\ %Client{}, opts \\ [])

List all maintenance windows for an organisation.

show(client \\ %Client{}, id)

Get a single maintenance window.

update(client \\ %Client{}, id, body)

Update an existing maintenance window.

Functions

create(client \\ %Client{}, body)

@spec create(IncidentIo.Client.t(), map()) :: IncidentIo.response()

Create a new maintenance window.

Example

IncidentIo.MaintenanceWindowsV2.create(client, %{
  name: "Weekly maintenance",
  starts_at: "2021-08-17T13:00:00.000000Z",
  ends_at: "2021-08-17T14:00:00.000000Z"
})

More information at: https://api-docs.incident.io/tag/Maintenance-Windows-V2#operation/Maintenance%20Windows%20V2_Create

destroy(client \\ %Client{}, id)

@spec destroy(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Delete a maintenance window.

Example

IncidentIo.MaintenanceWindowsV2.destroy(client, "some-maintenance-window-id")

More information at: https://api-docs.incident.io/tag/Maintenance-Windows-V2#operation/Maintenance%20Windows%20V2_Delete

list(client \\ %Client{}, opts \\ [])

@spec list(
  IncidentIo.Client.t(),
  keyword()
) :: IncidentIo.response()

List all maintenance windows for an organisation.

Accepts optional pagination parameters:

:after - Cursor for pagination
:page_size - Number of items per page (default: 25, max: 250)

Example

IncidentIo.MaintenanceWindowsV2.list(client)

IncidentIo.MaintenanceWindowsV2.list(client, page_size: 50)

More information at: https://api-docs.incident.io/tag/Maintenance-Windows-V2#operation/Maintenance%20Windows%20V2_List

show(client \\ %Client{}, id)

@spec show(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Get a single maintenance window.

Example

IncidentIo.MaintenanceWindowsV2.show(client, "some-maintenance-window-id")

More information at: https://api-docs.incident.io/tag/Maintenance-Windows-V2#operation/Maintenance%20Windows%20V2_Show

update(client \\ %Client{}, id, body)

@spec update(IncidentIo.Client.t(), binary(), map()) :: IncidentIo.response()

Update an existing maintenance window.

Example

IncidentIo.MaintenanceWindowsV2.update(client, "some-maintenance-window-id", %{
  name: "Updated maintenance window"
})

More information at: https://api-docs.incident.io/tag/Maintenance-Windows-V2#operation/Maintenance%20Windows%20V2_Update