$customHeader
Skip to end of banner
Go to start of banner

Request a Restart of a Node

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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

Overview

This API requests a restart of the specified JCC node.

Prerequisites

You need:

  • Org Admin permissions

Request

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.

Request Body

{
  "msg" : "...",
  "force" : ...
}

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

Response Header

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

  • No labels