Toggling the site in and out of maintenance mode

You can put the Developer Portal site into maintenance mode for short periods of time. During maintenance mode only an administrator is able to access the site, and all other users who enter the site URL get a maintenance message set by the administrator.

Before you begin

You must have administrator access to complete this task.

Important: Maintenance mode is designed for short-term site maintenance; it is not meant for long-term usage. While a site is in maintenance mode, the database is not updated with new content from API Manager.

Procedure

To put the site into maintenance mode, complete the following steps:

  1. Click Configuration in the administrator dashboard.
  2. Under the DEVELOPMENT heading, click Maintenance mode.
  3. Select the Put site into maintenance mode check box.
  4. Enter a site message or, alternatively, leave the default site maintenance text.
    This message is what will be seen by those who visit the site while it is in maintenance mode.
  5. Click Save configuration.
    Your site is now in maintenance mode.

To take the site out of maintenance mode, complete the following steps:

  1. Enter your site URL in a web browser by using the following format: https://my_site_url/user/login.
  2. Log in to your site as the admin user.
  3. Click Configuration in the administrator dashboard.
  4. Under the DEVELOPMENT heading, click Maintenance mode.
  5. Clear the Put site into maintenance mode check box.
    Your site is now available to users and out of maintenance mode.