Switch a node to maintenance mode

POST /snaplex/maintenance/{plex_path}/{hostname}

Overview

This API requests that the specified JCC node be switched to maintenance mode.

Prerequisites

  • Environment (Org) admin permissions

Request

 POST https://{controlplane_path}/api/1/rest/public/snaplex/maintenance/{plex_path}/{hostname}

Path parameters

Key Description
controlplane_path Required. The path to the SnapLogic Control Plane: elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic. For example:
  • uat.snaplogic.com
  • emea.snaplogic.com
plex_path Required. The path to the Snaplex. The path comparison is case-sensitive.

Format: /{env_org}/{project_space}/{project_name}/{snaplex_name}

Example: /snaplogic/shared/My%20Cloud
hostname Required. The JCC node path.

Example: canxl-jcc8.clouddev.snaplogic.com,canxl-jcc9.clouddev.snaplogic.com

Query parameters

None.

Request header

In the request header, specify Basic for authorization, add your credentials, and specify application/json for content type:


Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request body

 { "mode" : ... }
Key Type Description
mode Boolean If true, the JCC node is set to maintenance mode. Otherwise, the JCC node is set to running mode.

Response

Status code only.