Displaying applications, REST APIs, and integration services by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to display the applications, REST APIs, and integration services that are deployed in an integration server.

Before you begin

Read the following topics:

About this task

This topic describes:

Displaying applications in an integration server
Displaying REST APIs in an integration server
Displaying integration services in an integration server

Displaying applications in an integration server

Procedure

Display the applications.

For an independent integration server:

GET http://hostname:port/apiv2/applications

For example, use the following curl command:

curl -X GET http://hostname:port/apiv2/applications

If the command is successful and there are applications deployed in the integration server, an HTTP status code 200 and a response similar to the following are returned. In this example, there are 2 applications deployed in the integration server: HTTPInputApplication and Transformation_Map:

{
  "hasChildren": true,
  "name": "applications",
  "type": "applications",
  "uri": "/apiv2/ applications",
  "properties": {},
  "descriptiveProperties": {},
  "active": {},
  "actions": {},
  "children": [
    {
      "hasChildren": true,
      "name": "HTTPInputApplication",
      "type": "application",
      "uri": "/apiv2/applications/HTTPInputApplication"
    },
    {
      "hasChildren": true,
      "name": "Transformation_Map",
      "type": "application",
      "uri": "/apiv2/ applications/Transformation_Map"
    }
  ],
  "links": []
}

If the command is successful but there are no applications deployed in the integration server, an HTTP status code 200 and a response similar to the following are returned:

{
  "hasChildren": false,
  "name": "applications",
  "type": "applications",
  "uri": "/apiv2/applications",
  "properties": {},
  "descriptiveProperties": {},
  "active": {},
  "actions": {},
  "children": [],
  "links": []
}

Additionally, you can use the depth query parameter in the API call to obtain more information about the applications. For example, use the following curl command:

curl -X GET http://hostname:port/apiv2/applications?depth=2

For an example of the response that is returned for such an API call, see Display applications on an independent integration server.

For an integration server that is managed by an integration node:

GET http://hostname:port/apiv2/servers/integrationServerName/applications

For example, to display the applications that are deployed on integration server ACESERV1, which is managed by an integration node, use the following curl command:

curl -X GET http://hostname:port/apiv2/servers/ACESERV1/applications

{
  "hasChildren": true,
  "name": "applications",
  "type": "applications",
  "uri": "/apiv2/servers/ACESERV1/applications",
  "properties": {},
  "descriptiveProperties": {},
  "active": {},
  "actions": {},
  "children": [
    {
      "hasChildren": true,
      "name": "HTTPInputApplication",
      "type": "application",
      "uri": "/apiv2/servers/ACESERV1/applications/HTTPInputApplication"
    },
    {
      "hasChildren": true,
      "name": "Transformation_Map",
      "type": "application",
      "uri": "/apiv2/servers/ACESERV1/applications/Transformation_Map"
    }
  ],
  "links": []
}

If the command is successful but there are no applications deployed in the integration server, an HTTP status code 200 and a response similar to the following are returned:

{
  "hasChildren": false,
  "name": "applications",
  "type": "applications",
  "uri": "/apiv2/servers/ACESERV1/applications",
  "properties": {},
  "descriptiveProperties": {},
  "active": {},
  "actions": {},
  "children": [],
  "links": []
}

Additionally, you can use the depth query parameter in the API call to obtain more information about the applications. For example, use the following curl command:

curl -X GET http://hostname:port/apiv2/servers/integrationServerName/applications?depth=2

For an example of the response that is returned for such an API call, see Display applications on an integration server that is managed by an integration node.

Displaying REST APIs in an integration server

Procedure

Display the REST APIs.

For an independent integration server:
```
GET http://hostname:port/apiv2/rest-apis
```
If the command is successful, an HTTP status code 200 and information about the REST APIS that are deployed, if any, in the integration server are returned.
For an integration server that is managed by an integration node:
```
GET http://hostname:port/apiv2/servers/integrationServerName/rest-apis
```
If the command is successful, an HTTP status code 200 and information about the REST APIS that are deployed, if any, in the integration server are returned.

Displaying integration services in an integration server

Procedure

Display the integration services.

For an independent integration server:
```
GET http://hostname:port/apiv2/services
```
If the command is successful, an HTTP status code 200 and information about the integration services that are deployed, if any, in the integration server are returned.
For an integration server that is managed by an integration node:
```
GET http://hostname:port/apiv2/servers/integrationServerName/services
```
If the command is successful, an HTTP status code 200 and information about the integration services that are deployed, if any, in the integration server are returned.