Loading...

REST API - GET Instance

This operation returns a list of instances for a client.

Request

Syntax

Send the request using either the ID or the name:

  • ID

    GET <webservice>/instance?clientId={clientId} HTTP/1.1
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>

  • Name

    GET <webservice>/instance?clientName={clientName} HTTP/1.1
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

clientId

The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it.

Yes-for the request by ID

clientName

The client name for the client. If the client name is not known, use the GET Client API to retrieve it.

Yes-for the request by name

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

instanceId

The system-generated ID assigned to the instance.

instance

instanceName

The name of the instance.

instance

appName

The name of the application.

Valid values for the applicationId and appName parameters:

 

  • 41, Active Directory
  • 21, AIX File System
  • 64, Big Data Apps
  • 134, Cloud Apps
  • 37, DB2
  • 103, DB2 MultiNode
  • 62, DB2 on Unix
  • 128, Documentum
  • 90, Domino Mailbox Archiver
  • 91, DPM
  • 67, Exchange Compliance Archiver
  • 53, Exchange Database
  • 45, Exchange Mailbox
  • 54, Exchange Mailbox (Classic)
  • 56, Exchange Mailbox Archiver
  • 82, Exchange PF Archiver
  • 35, Exchange Public Folder
  • 73, File Share Archiver
  • 33, File System
  • 74, FreeBSD
  • 71, GroupWise DB
  • 17, HP-UX Files System
  • 65, Image Level
  • 75, Image Level On Unix
  • 76, Image Level ProxyHost
  • 87, Image Level ProxyHost on Unix
  • 3, Informix Database
  • 29, Linux File System
  • 89, MS SharePoint Archiver
  • 104, MySQL
  • 13, NAS
  • 83, Netware File Archiver
  • 12, Netware File System
  • 10, Novell Directory Services
  • 124, Object Link
  • 131, Object Store
  • 86, OES File System on Linux
  • 22, Oracle
  • 80, Oracle RAC
  • 130, Other External Agent
  • 125, PostgreSQL
  • 38, Proxy Client File System
  • 87, ProxyHost on Unix
  • 61, SAP for Oracle
  • 135, SAP HANA
  • 78, SharePoint Server
  • 20, Solaris 64bit File System
  • 19, Solaris File System
  • 81, SQL Server
  • 5, Sybase Database
  • 66, Unix File Archiver
  • 36, Unix Tru64 64-bit File System
  • 106, Virtual Server
  • 58, Windows File Archiver

 

instance

applicationId

The ID of the application. For a list of application IDs, see the valid values for the appName parameter.

instance

clientId

The system-generated ID assigned to the client.

instance

clientName

The name of the client.

instance

activityType

The instance activity control settings.

Valid values are:

  • 1, for backup
  • 2, for restore
  • 4, for auxiliary copy
  • 8, for disaster recovery backup
  • 16, archive pruning
  • 32, for media recycle
  • 64, for synthetic full
  • 28, all activity
  • 256, for schedule
  • 1024, for offline content indexing

activityControlOptions

enableActivityType

The option to enable or disable an activity for an instance.

JSON valid values are:

  • true, to enable
  • false, to disable

    XML valid values are:

  • 1, to enable
  • 0, to disable

activityControlOptions

enableAfterADelay

The option to enable an activity for an instance on a date and time defined in the Enable Backup dialog box.

JSON valid values are:

  • true, to enable
  • false, to disable

    XML valid values are:

  • 1, to enable
  • 0, to disable

activityControlOptions

Examples

Sample Request

GET <webservice>/instance?clientId=2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

XML

<?xml version='1.0' encoding='utf-8' ?>
<App_GetInstancePropertiesResponse>
  <instanceProperties>
    <instance instanceId="1" instanceName="DefaultInstanceName" applicationId="33" appName="Windows File System" clientId="2" clientName="client001"/>
    <instanceActivityControl>
      <activityControlOptions activityType="1" enableActivityType="1" enableAfterADelay="0"/>
    </instanceActivityControl>
  </instanceProperties>
</App_GetInstancePropertiesResponse>

JSON

{
  "instanceProperties": [{
    "instance": {
      "clientId": 2,
      "clientName": "client001",
      "instanceName": "DefaultInstanceName",
      "appName": "Windows File System",
      "instanceId": 1,
      "applicationId": 33
    },
    "instanceActivityControl": {
      "activityControlOptions": [{
        "activityType": 2,
        "enableAfterADelay": false,
        "enableActivityType": true
      }, {
        "activityType": 1,
        "enableAfterADelay": false,
        "enableActivityType": true
      }]
    }
  }]
}

Last modified: 6/1/2018 5:10:57 PM