Create a Groundplex

POST /snaplex


This API creates a Groundplex.


  • Environment (Org) admin permissions


   POST https://{controlplane_path}/api/1/rest/public/snaplex

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.


For other control planes, substitute the subdomain name for elastic. For example:

Query Parameters


Request Header

Specify Basic for authorization and application/json for content type.

Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

Required fields


Notification settings

Note: The images displayed below are from Classic IIP and added for reference to check the Snaplex settings details.
    "recipients":"[email protected]",
    "user":"[email protected]",
Create Snaplex dialog - Classic IIP Create Snaplex page - Admin manager

Create Snaplex

Dynamic settings

     "max_file_size":"500 MB",
Dynamic settings - Classic IIP Dynamic settings - Admin manager

Dynamic settings

Node settings

         {"server-type":"jcc", "hostname":"122.11.11"},
         {"server-type":"feed_master", "hostname":"127.111.1"}
   "extra":[{'key': 'hello', 'value': 'world'}]
Node settings - Classic IIP Node settings - Admin manager

Update Manager

Key Type Description
container_path string The path to the Snaplex.
label string The name of the Snaplex.
environment string The environment of the Snaplex.
min_jcc string The minimum number of JCC nodes in the Snaplex.
pkg_version string The SnapLogic package version that is installed in the Snaplex.
notification string A comma-separated list of email addresses to send notifications to.
reserved_slots string The percentage of slots to reserve for interactively executed pipelines.
max_slots string The maximum number of slots available on the nodes in the Snaplex.
max_mem string The maximum percentage of memory that can be in use on the nodes in the Snaplex before they will be considered overloaded.
node_settings array The settings for the nodes in the Snaplex.
restart_max_waiting_time integer The maximum waiting time for JCC restart if a pipeline is running.
feed_master_load_balancer string The URL to the FeedMaster nodes which serves as the load balancer. (Ultra Load Balancer in the UI)
jcc_load_balancer string The URL to the JCC node which serves as the load balancer.
dynamic_settings string Settings that can be changed on the JCC without requiring a restart.
duplicate_check Boolean

If true, throws an exception if a Snaplex with the same name already exists at the destination path.

If false, overwrites any existing Sanplexwith the same name at the destination path.

Default: true

Important: The parameters container_path, container_type, label, and environment are required/non-optional.

The parameters container_type, cluster_details, plexfs_min_free, plexfs_retention_time, queue_size, Org can have default value which is not visible in the UI or accessible by public API.


Response Body

        "snode_id": "660d9dcabee896d1fb6ebafb"
      "http_status_code": 201