GET /snaplex/config/{plex_path}
Overview
This API retrieves the information needed to install and configure a node on a Groundplex.
You can use this API when automating the installation of Groundplex nodes.
Prerequisites
You need:
Org Admin permissions
Request
Path Parameters
Key | Description |
---|---|
| Required. The path to your SnapLogic pod. Example: |
| Required. The path to the Snaplex. Format: Example: |
Query Parameters
Key | Type | Description |
---|---|---|
| integer | The number of hours before the returned URL expires. The URL is a link to the Snaplex configuration file. Default: 1 hour |
Request Header
Specify Basic
for authorization and application/json
for content type.
Request Body
None.
Response
Response Body
{ "response_map": { "config": "...", "pkgs": { "plex-rpm": { "comment": "...", "status": "...", "kind": "...", "signatures": { "md5": "..." }, "pkg_file": "...", "driver": ..., "uri": "...", "version": "...", "compatible_version": "...", "create_time": "...", "_id": "..." }, "plex-deb": { ... }, "plex-win": { ... } } }, "http_status_code": 200 }
Key | Type | Description |
---|---|---|
config | string | The signed URL where you can download the configuration file ( Note: If you are an Org administrator, the configuration file contains generic credentials for the Snaplex node. Otherwise, the configuration file contains the caller's credentials. |
pkgs | object | The Snaplex software packages that are available for installation. The following metadata is included for each package type:
|