Snaplex APIs

Snaplex APIs allow you to do the following:

  • Node Management. Configure or manage a JCC node.

  • Monitoring. Retrieve information about a Snaplex.

  • Version Management. Retrieve information about installed versions or upgrade to a specific version.

Node Management APIs

Node Management APIs

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

Requests a restart of the specified JCC node.

POST /snaplex/maintenance/{plex_path}/{hostname}

Requests that the specified JCC node be switched to maintenance mode.

GET /snaplex/config/{plex_path}

Retrieves the information needed to install and configure a node on a Groundplex.

Monitoring APIs

GET /snaplex/{org}

Retrieves Snaplex and JCC wrapper information about all nodes or about the node, specified by the Snaplex path or the hostname.

Version Management APIs

GET /snaplex/version

Retrieves information about all versions of the Snaplex packages.

GET /snaplex/version/latest

Determines the latest active version of the Snaplex package.

POST /snaplex/version/{plex_path}

Updates the Snaplex to the specified version.

POST /snaplex/version/latest/{plex_path}

Updates the Snaplex to the latest version.