API - Get Instance Information

Purpose

A post API to get a list of instances in Sectona PAM.

Accessing the API

XML
Endpoint: /API/APP/APP007/GetInstances

HTTP METHOD

XML
POST


Parameters

Parameters

Data Type

Required

Description

Filter

String

YES

All/Active/Disabled


Sample Request (JSON)

XML
{
  "Filter":"All/Active/Disabled"
}

Sample Response (JSON)

XML
{
	“Version”:”6.0.0.0”,
	"IsSuccess": true,
	"LogCode":"0",
	"Result":"[
{
		 "Instance":"Instance1",
		 "ShortCode":"IN1",
		 "Description":"String",
		 "TimeZone":"String",
		 "CreatedBy":"String",
		 "CreatedOn":"String",
		 "Status":true/false,
	},{

		 "Instance":"String",
		 "ShortCode":"String",
		 "Description":"String",
		 "TimeZone":"String",
		 "CreatedBy":"String",
		 "CreatedOn":"String",
		 "Status":true/false,
	}
	],
	"StatusCode":"Accepted",
	"Timestamp":"03 Jun 2019 10:32:12 GMT 05:30:00"
}


Standard Error Response Codes

Error Code

Error Description

011649

Current user does not have permission to take an action

011651

The authorization header is either empty or not basic

011673

Invalid credentials

011674

Invalid credentials

011675

Unable to validate request

011683

Invalid instance name

011803

Unable to insert API log details

032403

The system was unable to create account

011806

Unable to get instance