Versions Compared

Version Old Version 6 New Version Current
Changes made by

Sebastian Koch

Sebastian Koch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width300px

Table of Contents
 

Introduction

The SONARPLEX REST API offers an easy way to gather information and even post information to the SONARPLEX. 

API Basics

Base URIhttp(s)://example.com/{version}/{location}/{resource}/
AuthenticationBasic HTTP Auth
Encryption

HTTPS with certificate can be configured in the

administrative web interface Configuration :: Network :: HTTP Configuration

EncodingUTF-8
MethodsGET and POST depending on the resource
Response content typeapplication/json
WildcardAsterisk '*' or 'all'
Restrictions
Note

Access is restricted to the admin interface (usually port 81) and to user 'admin'

Column
width300px
Panel
bgColor#f4f4f4
borderStylesolid

In this article:

Table of Contents

Resource Path

The reosurce path specifies which location information should be accessed.

Especially if the device receives data from remote satellites (See Distributed Monitoring and Integration Interfaces).

Level1234
DescriptionVersionTenantLocationResources
Example 1
/v1
/all
/local
/hosts/*
Example 2
/v1
/aeg
/berlin
/services/ping
Example 3
/v1
/siemens
/site382
/problems

...

These commands support arguments which must be defined in an escaped manner.

Info

The '/' Some commands require a file system path as argument which contains slashes, like '/mnt/hd/daaz/var/addons'. These slashes within the path must be given as backslash backslashes, like '\' and further arguments for the commands are separated through slashes.mnt\hd\daaz\var\addons'. Some browser such as Googles Chrome will automatically turn any backslash into a slash.

Therefore try to specify backslashes as "%5C" if your browser does not allow backslashes.

Example

http://<IP>:81/v1/*/local/oscmd/ls/-l/%5Cmnt%5Chd%5Cdaaz%5Cvar

Syntax

Code Block
/oscmd/{command}/argument_1/argument_2/

...