$customHeader
Skip to end of banner
Go to start of banner

GET /snaplex/{org}

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This topic is in technical review.

Overview

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

  • 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

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org to access.

Query Parameters

Key

Type

Description

plex_path

string

Required. The path to the Snaplex to access.

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.

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

Related Links

  • No labels
$customFooter