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: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.elastic.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

Basic authentication

In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type. For more details on accounts refer to Manage accounts.


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json

Example of Basic authenthication using Postman

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.