Jump to

• Request
• Response
• Examples

Get Plug-in Information

get

/rest/{versionId}/admin/plugins/{pluginId}

Use this (GET) method to display information for a plug-in, such as its status (installed, uploaded, etc.), server IP, version, vendor, and product.

Request

Path Parameters

• pluginId: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : pluginInfo

Type: object

Show Source

• clusterMembers(optional): array pluginClusterMembers
• description(optional): string
• emPluginAPIVersion(optional): string
• id(optional): string
• name(optional): string
• packageName(optional): string
• previousVersion(optional): string
• product(optional): string
• restPrefixName(optional): string
• type(optional): string
• vendor(optional): string
• version(optional): string

{
    "properties":{
        "clusterMembers":{
            "items":{
                "$ref":"#/definitions/RestPluginClusterMember",
                "xml":{
                    "name":"pluginClusterMember"
                }
            },
            "type":"array",
            "xml":{
                "name":"pluginClusterMembers",
                "wrapped":true
            }
        },
        "description":{
            "type":"string"
        },
        "emPluginAPIVersion":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "packageName":{
            "type":"string"
        },
        "previousVersion":{
            "type":"string"
        },
        "product":{
            "type":"string"
        },
        "restPrefixName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "vendor":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"pluginInfo"
    }
}

Nested Schema : pluginClusterMembers

Type: array

Show Source

• Array of: object pluginClusterMember

{
    "items":{
        "$ref":"#/definitions/RestPluginClusterMember",
        "xml":{
            "name":"pluginClusterMember"
        }
    },
    "type":"array",
    "xml":{
        "name":"pluginClusterMembers",
        "wrapped":true
    }
}

Nested Schema : pluginClusterMember

Type: object

Show Source

• clusterMemberStatus(optional): string
• ipAddress(optional): string
• lastModifiedDate(optional): string
• pluginStatus(optional): string
• uploadedDate(optional): string

{
    "properties":{
        "clusterMemberStatus":{
            "type":"string"
        },
        "ipAddress":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string"
        },
        "pluginStatus":{
            "type":"string"
        },
        "uploadedDate":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"pluginClusterMember"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get plug-in information by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/admin/plugins/ID1"

Example of Accessing the API with Python

The following example shows how to get plug-in information by submitting a GET request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate.

import requests
url = "https://example.com:8443/rest/v1.3/admin/plugins/ID1"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 08 May 2019 10:14:35 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
vary: Origin,Accept-Encoding
Content-Length: 662
Content-Type: application/xml

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pluginInfo>
  <pluginClusterMembers>
    <pluginClusterMember>
      <clusterMemberStatus>ACTIVE</clusterMemberStatus>
      <ipAddress>10.0.0.55</ipAddress>
      <lastModifiedDate>2019-04-25 06:55:19</lastModifiedDate>
      <pluginStatus>INSTALLED</pluginStatus>
      <uploadedDate>2019-04-25 06:52:20</uploadedDate>
    </pluginClusterMember>
  </pluginClusterMembers>
  <description/>
  <emPluginAPIVersion>2B18.3</emPluginAPIVersion>
  <id>ID1</id>
  <name>Enterprise Edge &amp; Core</name>
  <packageName>ent_edge_core2.2_Package.zip</packageName>
  <product>ESBC/ECB</product>
  <type>EMS</type>
  <vendor>Oracle</vendor>
  <version>2.2</version>
</pluginInfo>

Back to Top