This page is no longer maintained (). For the most current information, go to https://docs.snaplogic.com/public-apis/post-snaplex-maintenance-plexpath-hostname.html.

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

Overview

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

Prerequisites

You need:

Request

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

Path Parameters

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

plex_path

Required. The path to the Snaplex.

Format: /{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

Specify Basic for authorization and application/json for content type.

Authorization: Basic {your_encoded_security_credentials}

Content-Type: application/json

Request Body

{
  "mode" : true
}

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.