On this Page

SnapLogic APIs

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:

<org>/<project_space>/<project>/<snaplex_name>

For example:
test_org/Projects/my_project/my_snaplex
test_org/Projects/my_snaplex


POST /api/1/rest/public/snaplex/restart/<snaplex_path>/<hostname>

Requests a restart of the specified node.

Parameters

Example

https://elastic.snaplogic.com/api/1/rest/public/snaplex/restart/<org>/shared/<plexname>/portal-jcc7.fullsail.snaplogic.com

POST /api/1/rest/public/snaplex/restart/<snaplex_path>

Requests a rolling restart of a Snaplex.

Only an Org admin can use this API.

Example

https://elastic.snaplogic.com/api/1/rest/public/snaplex/restart/<org>/shared/<snaplex_name>

POST /api/1/rest/public/snaplex/maintenance/<snaplex_path>/<hostname>

Requests putting the JCC node into maintenance mode.

Parameters

Example

https://elastic.snaplogic.com/api/1/rest/public/snaplex/maintenance/shared/host_vm154


GET /api/1/rest/public/snaplex/config/<snaplex_path>?expire_hours=n

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.

Example

https://elastic.snaplogic.com/api/1/rest/public/snaplex/config/snaplogic/shared/InstallationTest/?expire_hours=2

Related Links