v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Maintenances

Cancel team maintenance

This endpoint is used to stop an ongoing maintenance plan of a specific team early. The functionality allows you to end the maintenance period before the initially set end time.

post/api/{cloudId}/v1/teams/{teamId}/maintenances/{id}/cancel

Path parameters

teamIdstring required

Identifier of the maintenance owning team.

idstring required

Identifier of the maintenance.

Response

Returned if the request is successful.

teamIdstring

Identifier of the maintenance owning team.

idstring

Identifier of the maintenance.

status'cancelled' | 'past' | 'active' | 'planned'

Current status of the maintenance plan.

descriptionstring

Description or name for the maintenance plan. This can be any text that helps identify the purpose or characteristics of the maintenance plan.

startDatestring date-time

Date and time when the maintenance plan starts.

endDatestring date-time

Date and time when the maintenance plan ends.

Example response

{
  "teamId": "77b933c9-92bb-46e7-a73c-764b8d7c3c25",
  "id": "0762db96-f795-4246-90be-edd295af8fca",
  "status": "cancelled",
  "description": "Maintenance Plan",
  "startDate": "2023-12-11T11:37:40.501Z",
  "endDate": "2023-12-11T11:42:40.501Z",
  "rules": [
    {
      "state": "disabled",
      "entity": {
        "id": "51e9e162-767b-47a6-a00a-4cd8b6f94829",
        "type": "integration"
      }
    }
  ]
}