Retrieve config info for a Groundplex
GET /snaplex/config/{plex_path}?{query_parameters}
Overview
This API retrieves the information needed to install and configure a node on a Groundplex.
You can use this API to automate the installation of Groundplex nodes.
Prerequisites
- Environment (Org) admin permissions
Request
GET https://{controlplane_path}/api/1/rest/public/snaplex/config/{plex_path}?{query_parameters}
Path parameters
| Key | Description |
|---|---|
controlplane_path |
Required. The path to the SnapLogic Control Plane:
elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic. For
example:
|
plex_path |
Required.
The path to the Snaplex.
The path comparison is case-sensitive.
Format: Example: |
Query Parameters
| Key | Type | Description |
|---|---|---|
expire_hours |
integer | An optional value to configure the number of hours before the returned URL expires to download the slpropz file. The URL is a link to the Snaplex configuration file.
Default: 1 |
version |
string | If set to current, the returned configuration is based on the version that is currently installed on the Snaplex.
Otherwise, the returned configuration is based on the latest available version.
|
Request header
In the request header, specify Basic for authorization, add your credentials, and specify application/json for content type:
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
Request body
None.
Response
Response body
{
"response_map": {
"config": "...",
"pkgs": {
"plex-rpm": {
"comment": "...",
"status": "...",
"kind": "plex-rpm",
"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 (.slpropz) for the Snaplex node.
Note: If you are an Environment admin, 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:
|