Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET /snaplex/{org}

Overview

This API retrieves Snaplex and JCC wrapper information about all nodes or about the

...

node, specified by the Snaplex path or the hostname.

  • If called without parameters, the API returns information about all the nodes in the Org.

  • If plex_path or hostname is specified, the API returns information about the specified nodes only.

Prerequisites

You need:

  • Org Admin permissions

...

Request

Appsplus panel macro confluence macro
data{"features":["

...

rounded"],"title":"

...

","titleColor":"

...

#FFFFFF","titleColorBG":"

...

#0052CC","titleSize":16,"titleBold":

...

false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"

...

#172B4D","panelColorBG":"

...

#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

...

Table of Contents
minLevel1
maxLevel1
classtocsidebar

Request

...

...

GET

...

https://{pod_path}/api/1/rest/public/snaplex/{org}?{query_parameters}

Path Parameters

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org

...

.

Query Parameters

Key

Type

Description

plex_path

string

...

The path to the Snaplex

...

.

Format: /{org}/{project_space}/{project_name}/{snaplex_name}

hostname

string

Required. A single JCC node path or a comma-separated list of JCC node paths.

Example:canxl-jcc8.clouddev.snaplogic.com,canxl-jcc9.clouddev.snaplogic.com

Request Header

Specify Basic Auth for authorization.

...

appsplus-panel-macro-confluence-macro

...

themeAscetic

...

data{"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

Authorization: Basic {your_encoded_security_credentials}

Request Body

None.

Response

Response Header

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

...

Response Body

...