On this Page
The following SnapLogic APIs enable you to programmatically manage Snaplex nodes.
You must be an Org admin to use these APIs.
<snaplex_path> refers to the complete absolute path of the Snaplex. It should be in the following syntax:
|
Requests a restart of the specified node.
https://elastic.snaplogic.com/api/1/rest/public/snaplex/restart/<org>/shared/<plexname>/portal-jcc7.fullsail.snaplogic.com
Requests a rolling restart of a Snaplex.
Only an Org admin can use this API.
https://elastic.snaplogic.com/api/1/rest/public/snaplex/restart/<org>/shared/<snaplex_name>
Requests putting the JCC node into maintenance mode.
https://elastic.snaplogic.com/api/1/rest/public/snaplex/maintenance/shared/host_vm154
Retrieve information needed to install and configure a node on a Groundplex. This API can be used when automating the installation of Groundplex nodes.
The optional expire_hours
parameter allows you to set an expiration for the URL, where n
is the number of hours that the link is valid. The default time is 1 hour if the parameter is not specified, and the minimum value is 1 hour.
https://elastic.snaplogic.com/api/1/rest/public/snaplex/config/snaplogic/shared/InstallationTest/?expire_hours=2
.slpropz
file that holds the configuration for a Snaplex node. If you are an administrator for the organization, the configuration contains the generic CC credentials. Otherwise, the caller's credentials are included in the configuration.plex-rpm
, plex-deb
, and plex-win
. Each type is a separate object with the following field: