Retrieve Info About Nodes

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

Path Parameters

Key

Description

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

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 for authorization and application/json for content type.

Request Body

None.

Response

Response Header

Key

Description

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry