Request a restart of a node
POST /snaplex/restart/{plex_path}/{hostname}
Overview
This API requests a restart of the specified JCC node.
Prerequisites
- Org admin (Environment admin) permissions
Request
POST https://{pod_path}/api/1/rest/public/snaplex/restart/{plex_path}/{hostname}
Path Parameters
Key | Description |
---|---|
pod_path |
Required. The path to your SnapLogic pod.
Example: |
plex_path |
Required.
The path to the Snaplex.
The path comparison is case-sensitive.
Format: Example: |
hostname |
Required. The JCC node path.
Example: |
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.