Viewing configuration details of objects that can be named by using REST Administration APIs

System administrators can view configuration details of configuration objects for which the name can be configured.

You can use the Eclipse Amlen REST API GET method to view configuration details of a specified configuration object or all instances of a configuration object type. If the name of the configuration object is specified in the request, then the configuration details of that object are displayed. If the name of the configuration object is not specified in the request, then the response includes configuration details of all instances of that object type.

You can view the configuration details of the following object types by using the Eclipse Amlen REST API GET method:
  • CertificateProfile
  • ClientCertificate
  • ClientSet
  • ConfigurationPolicy
  • ConnectionPolicy
  • DestinationMappingRule
  • EndPoint
  • LTPAProfile
  • MessageHub
  • MQTTClient
  • OAuthProfile
  • Plugin
  • Protocol
  • Queue
  • QueueManagerConnection
  • QueuePolicy
  • SecurityProfile
  • SubscriptionPolicy
  • TopicPolicy
  • TrustedCertificate
Note: If a value has not been specified for a filter property, you might see that filter property returned with empty string values. The empty string value means that the particular property is not used to filter messages.
To view configuration details of a specified configuration object or all instances of a configuration object type, use the Eclipse Amlen REST API GET method with the following Eclipse Amlen URI:

http://<admin-endpoint-IP:Port>/ima/v1/configuration/<ObjectType>/<ObjectName>

where:
ObjectType
Specifies the type of configuration object.
A valid list of object types is displayed in the "About this task" section.
ObjectName
Optional.
Specifies the name of the configuration object.
If ObjectName is not specified, the configuration details of all instances of the object type are returned.

The following example shows a GET method to view configuration details of all endpoint objects by using cURL: 

curl -X GET http://127.0.0.1:9089/ima/v1/configuration/Endpoint

The following example shows a successful response to the GET method to view configuration details of all endpoint objects by using cURL: 

{
  "Version": "v1",
  "Endpoint": {
    "DemoEndpoint": {
      "Port": 10002,
      "Enabled": false,
      "Protocol": "All",
      "Interface": "All",
      "InterfaceName": "All",
      "ConnectionPolicies": "DemoConnectionPolicy",
      "TopicPolicies": "DemoTopicPolicy",
      "SubscriptionPolicies": "DemoSubscriptionPolicy",
      "MaxMessageSize": "4096KB",
      "MessageHub": "DemoHub",
      "EnableAbout": true,
      "Description": "Unsecured endpoint for demonstration use only. By default,
 both JMS and MQTT protocols are accepted."
    },
    "DemoMqttEndpoint": {
      "Port": 1883,
      "Enabled": false,
      "Protocol": "MQTT",
      "Interface": "All",
      "InterfaceName": "All",
      "ConnectionPolicies": "DemoConnectionPolicy",
      "TopicPolicies": "DemoTopicPolicy",
      "MaxMessageSize": "4096KB",
      "MessageHub": "DemoHub",
      "EnableAbout": true,
      "Description": "Unsecured endpoint for demonstration use with MQTT protoco
l only. By default, it uses port 1003."
    }
  }
}

The following example shows a GET method to view configuration details of an endpoint called "MyEndpoint" by using cURL: 

curl -X GET http://127.0.0.1:9089/ima/v1/configuration/Endpoint/MyEndpoint

The following example shows a successful example response to the GET method that was used to view configuration details of an endpoint called "MyEndpoint" :


     {   
       "Version": "v1",
        "EndPoint": {
          "MyEndpoint": {
            "Port": 16102,
            "Enabled": false,
            "Protocol": "All",
            "Interface": "All",
            "ConnectionPolicies": "MyConnectionPolicy",
            "TopicPolicies": "MyTopicPolicy",
            "MaxMessageSize": "4096KB",
            "MessageHub": "MyHub",
            "Description": "Unsecured endpoint for demonstration use only."
            "InterfaceName": "",
            "SecurityProfile": "",
            "MaxSendSize": 16384,
            "BatchMessages": true
          }
        }
      }

The following example shows an unsuccessful example response to the GET method that was used to view configuration details of an endpoint called "MyEndpoint1" which does not exist :


              curl -X GET  \
                 -H  'Content-Type: application/json'  \
                 http://127.0.0.1:9089/ima/v1/configuration/Endpoint/MyEndpoint1


       {        
         "Version": "v1",
         "Code": "CWLNA0113",
         "Message": "The requested item is not found."
       }