Application APIs

GET /api/v2/iman/storage

Description

Get the hierarchy representation of the compute devices included in a particular application.

Header Parameters

Name	Description	Type	Required	Default
Authorization	Bearer API token/key. The format is Bearer <API_key>	String	Yes
orgId	The ID of the organization. The format is OrgId:OrgName	String	Yes

Query Parameters

Name	Description	Type	Required	Default
appId	Application ID	String	Yes

CURL Example

The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID>, <API-TOKEN> & <APP-ID> are variables.

curl --location 'https://<NCE-IP>/api/v2/iman/storage?appId=<APP-ID>' \
--header 'orgId: <ORG-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'

Response

Upon a successful request, the API returns Status code 200 with the following body:

Name	Description	Type
storageNode	Hierarchy node	Object
- orgId	Organization ID	String
- siteId	Site ID	String
- name	Node name - application name or compute device ID	String
- hostName	Device hostname	String
- vmName	Device VM name	String
- vendor	Device vendor name	String
- fqdn	Device fully qualified domain name (FQDN)	String
- fqdnList	Device fully qualified domain names list	Array of strings
- deviceType	Device type	String
- type	Device subtype	String
- icon	Icon name for the device subtype used in the UI	String
- details	Device additional details	Array
- colorCode		String
- status	Node status	String
- children	List of compute devices linked with parent-child relationship to this compute device. The children objects are with the same structure as for storageNode	Array of objects
span	Hierarchy span	Integer
depth	Hierarchy depth	Integer
status	Hierarchy status	String

GET /api/v2/iman/topology/default

Description

Get the links and relationships between all devices in a particular application.

Header Parameters

Name	Description	Type	Required	Default
Authorization	Bearer API token/key. The format is Bearer <API_key>	String	Yes
orgId	The ID of the organization. The format is OrgId:OrgName	String	Yes
siteId	The ID of the site. The format is SiteId:SiteName	String	Yes

Query Parameters

Name	Description	Type	Required	Default
appId	Application ID	String	Yes

CURL Example

The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID>, <SITE-ID>, <API-TOKEN> & <APP-ID> are variables.

curl --location 'https://<NCE-IP>/api/v2/iman/topology/default?appId=<APP-ID>' \
--header 'orgId: <ORG-ID>' \
--header 'siteId: <SITE-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'

Response

Upon a successful request, the API returns Status code 200. The response model is the same as the response for ::title

GET /api/v2/applications/flows/dynamic

Description

Get the dynamic flows running between the devices in a particular application.

Header Parameters

Name	Description	Type	Required	Default
Authorization	Bearer API token/key. The format is Bearer <API_key>	String	Yes
orgId	The ID of the organization. The format is OrgId:OrgName	String	Yes

Query Parameters

Name	Description	Type	Required	Default
appId	Application ID	String	Yes

CURL Example

The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID>, <API-TOKEN> & <APP-ID> are variables.

curl --location 'https://<NCE-IP>/api/v2/applications/flows/dynamic?appId=<APP-ID>' \
--header 'orgId: <ORG-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'

Response

Upon a successful request, the API returns Status code 200 with the following body:

Name	Description	Type
nodes	List of service flow nodes included in the application	Array of objects
- nodeId	Node ID	String
- deviceId	Device ID	String
- hostName	Device hostname	String
- siteId	Site ID	String
- fqdnList	Device fully qualified domain names list	Array of strings
- fqdn	Device fully qualified domain name (FQDN)	String
- ipAddresses	List of IPv4 addresses associated with the device	Array of strings
- service	List of services running on the device	Array of objects
-- fsAppRole	Service role	String
-- fsService	Service name	String
-- serviceNames	Service description	String
-- port	Port on which the service is running	String
- deviceStatus	Device status	String
links	List of service flow links included in the application	Array of objects
- sourceApps	Application name of the flow source	String
- destApps	Application name of the flow destination	String
- sourceIp	Flow source IP	String
- sourcePort	Flow source port	String
- destinationIp	Flow destination IP	String
- destinationPort	Flow destination port	String
- srcDeviceId	Flow source device ID	String
- srcHostname	Flow source device hostname	String
- srcFqdnList	Flow source device FQDN list	Array of strings
- srcFqdn	Flow source device FQDN	String
- dstDeviceId	Flow destination device ID	String
- dstHostname	Flow destination device hostname	String
- dstFqdnList	Flow destination device FQDN list	Array of strings
- dstFqdn	Flow destination device FQDN	String
- sourceServices	List of the services from the flow source. Each object in the array contains the name of the service and a list of service definitions/path	Array of objects
- flow	Service flow ID	String
- flowStatus	Service flow status	String
- lastUpdateTime	Last time when the service flow was updated. The format is timeyyyy-MM-ddThh:mm:ss.tttZ	String
newNode	Boolean true/false if new nodes have been found	Boolean
newNodes	List of newly identified nodes that are not included in the application. The new nodes objects are with the same structure as for the nodes	Array of objects
newFlows	List of newly identified service flows that are not included in the application. The new flow objects are with the same structure as for the links	Array of objects
notNowFlow	Boolean true/false if new not now flows have been found	Boolean
notNowFlows	List of not-now flows that are not included in the application. The new flow objects are with the same structure as for the links	Array of objects
staleFlows	List of stale flows that are not included in the application. The new flow objects are with the same structure as for the links	Array of objects