Maintenance schedules

Represents maintenance schedules for an organisation.

List all maintenance schedules for an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "List all maintenance schedules for an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/organisations/{organisationSlug}/maintenance-schedule

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/MaintenanceScheduleResponse"
  },
  "type": "array"
}

Create a maintenance schedule for an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Create a maintenance schedule for an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowRequest

Related Objects

MaintenanceWindowRequest
  • day string

    The day on which the window takes place, can only be one of the following: mon, tue, wed, thu, fri, sat, sun

  • duration int32

    The duration in minutes of this window

  • startTime string

    The start time of this window

    Pattern: HH:mm

MaintenanceWindowResponse
  • day string
    One of MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
  • duration int32
  • startTime string
POST /api/v1/organisations/{organisationSlug}/maintenance-schedule

Response

  • identity uuid
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowResponse
                
{
  "properties": {
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "windows": {
      "items": {
        "$ref": "#/components/schemas/MaintenanceWindowResponse"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Delete a maintenance schedule for an organisation.

Path Parameters:

  • organisationSlug
  • maintenanceScheduleIdentity
HTTP Responses codes for "Delete a maintenance schedule for an organisation."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/organisations/{organisationSlug}/maintenance-schedule/{maintenanceScheduleIdentity}

Response

    No Content

Get a maintenance schedule for an organisation.

Path Parameters:

  • organisationSlug
  • maintenanceScheduleIdentity
HTTP Responses codes for "Get a maintenance schedule for an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

MaintenanceWindowResponse
  • day string
    One of MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
  • duration int32
  • startTime string
GET /api/v1/organisations/{organisationSlug}/maintenance-schedule/{maintenanceScheduleIdentity}

Response

  • identity uuid
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowResponse
                
{
  "properties": {
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "windows": {
      "items": {
        "$ref": "#/components/schemas/MaintenanceWindowResponse"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Update a maintenance schedule for an organisation.

Path Parameters:

  • organisationSlug
  • maintenanceScheduleIdentity
HTTP Responses codes for "Update a maintenance schedule for an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowRequest

Related Objects

MaintenanceWindowRequest
  • day string

    The day on which the window takes place, can only be one of the following: mon, tue, wed, thu, fri, sat, sun

  • duration int32

    The duration in minutes of this window

  • startTime string

    The start time of this window

    Pattern: HH:mm

MaintenanceWindowResponse
  • day string
    One of MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
  • duration int32
  • startTime string
PATCH /api/v1/organisations/{organisationSlug}/maintenance-schedule/{maintenanceScheduleIdentity}

Response

  • identity uuid
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowResponse
                
{
  "properties": {
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "windows": {
      "items": {
        "$ref": "#/components/schemas/MaintenanceWindowResponse"
      },
      "type": "array"
    }
  },
  "type": "object"
}
← Audit Events
Cloud Profiles →