This page applies toApigee, but not toApigee hybrid.

View Apigee Edge documentation.

This section has procedures for finding and setting maintenance windows for Apigee resources. To learn more about how and why Apigee performs maintenance, seeMaintenance overview.

Set a preferred window for maintenance

If you make changes to your maintenance window setting while the resource is already undergoing maintenance or is scheduled for maintenance, then the changes don't take effect immediately. These changes are reflected in the future maintenance events.

If you've opted in to maintenance notifications, then Apigee sends you notifications after a resource has been scheduled for maintenance, with the exact date and time when the maintenance is scheduled to happen. Apigee sends these notifications based on your resource maintenance window order of update settings, as follows:

• If the order of update setting is set to Week 1, then Apigee sends maintenance notifications at least one week in advance.
• If the order of update setting is set to Week 2, then Apigee sends maintenance notifications at least two weeks in advance.

You can only specify one maintenance window per Apigee instance. Requests with more than one maintenance window will be rejected.

If you would like to set maintenance windows for multiple instances in the same organization you should ensure at least 12 hours between the maintenance windows to avoid overlapping maintenance operations.

When updating the maintenance window, the previous window will be overwritten.

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"curl -X PATCH \  -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{    "maintenanceUpdatePolicy": {      "maintenanceWindows": [        {          "day": "SUNDAY",          "startTime": {            "hours": 23          }        }      ],      "maintenanceChannel": "WEEK1"    }  }' \  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID?updateMask=maintenanceUpdatePolicy.maintenanceWindows,maintenanceUpdatePolicy.maintenanceChannel"

Where:

• MaintenancestartTime is configured in UTC.
• ORGANIZATION_ID is your Apigee organization ID.
• INSTANCE_ID is your Apigee instance ID.

Find existing maintenance settings and maintenance schedules

You can retrieve your current maintenance settings and view any upcoming maintenance by checking themaintenanceUpdatePolicy andscheduledMaintenance fields, as shown in the following API example:

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"curl -H "$AUTH" \  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID"

{  ...  "scheduledMaintenance": {    "startTime": "2025-01-28T23:00:00Z"  },  "maintenanceUpdatePolicy": {    "maintenanceWindows": [      {        "day": "SUNDAY",        "startTime": {          "hours": 23        }      }    ]  }}

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"curl -X PATCH \  -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{    "maintenanceUpdatePolicy": null  }' \  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID?updateMask=maintenanceUpdatePolicy"

Where:

• ORGANIZATION_ID is your Apigee organization ID.
• INSTANCE_ID is your Apigee instance ID.

Opt-in to maintenance notifications

Before you opt-in for maintenance notifications, you mustset a preferred window for maintenance on a resource.

1. In the Google Cloud console, go to theUser preferences> Communication page.

   Go to Communications

2. In the row forApigee, Maintenance window, select the radio button underEmail to turn itOn.

Each user that needs to receive notifications must opt in separately by following the above instructions.