Skip to content

Public Maintenance Announcements

Operations Summary

Method Endpoint Description
GET /api/public-maintenance-announcements/ List public maintenance announcements
GET /api/public-maintenance-announcements/{uuid}/ Retrieve a public maintenance announcement

List public maintenance announcements

Returns a paginated list of public maintenance announcements. Only announcements that are 'Scheduled', 'In progress', or 'Completed' are visible. This endpoint is accessible to unauthenticated users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/public-maintenance-announcements/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.public_maintenance_announcements import public_maintenance_announcements_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = public_maintenance_announcements_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: public_maintenance_announcements_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { publicMaintenanceAnnouncementsList } from 'waldur-js-client';

try {
  const response = await publicMaintenanceAnnouncementsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
maintenance_type integer Maintenance type
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scheduled_end_after string (date-time) Scheduled end after
scheduled_end_before string (date-time) Scheduled end before
scheduled_start_after string (date-time) Scheduled start after
scheduled_start_before string (date-time) Scheduled start before
service_provider_uuid string (uuid) Service provider UUID
state array Maintenance state

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
maintenance_type_display string
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string

Retrieve a public maintenance announcement

Returns the details of a specific public maintenance announcement.

1
2
3
4
http \
  GET \
  https://api.example.com/api/public-maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.public_maintenance_announcements import public_maintenance_announcements_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = public_maintenance_announcements_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: public_maintenance_announcements_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { publicMaintenanceAnnouncementsRetrieve } from 'waldur-js-client';

try {
  const response = await publicMaintenanceAnnouncementsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
maintenance_type_display string
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string