Request a restart of a node

POST /snaplex/restart/{plex_path}/{hostname}

Overview

This API requests a restart of the specified JCC node.

Prerequisites

  • Environment (Org) admin permissions

Request

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

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: cdn.elastic.snaplogic.com

For other control planes, substitute the subdomain name for elastic. For example:
  • cdn.uat.snaplogic.com
  • cdn.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

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


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

Request Body

 {
  "msg" : "...",
  "force" : true
}
Key Type Description
msg string The reason for the restart.
force Boolean If true, restarts the JCC node immediately. Otherwise, waits for other executions to complete, if any, or for the Snaplex's maximum waiting time.

Response

Status code only.