Swagger reference
Specific links to Agile Service Manager Swagger documentation are included in many of the topics, as and when useful. This topic summarizes some of that information in a single location, for example by listing the default ports and Swagger URLs for each Agile Service Manager service.
Swagger overview
Swagger is an open source software framework, which includes support for automated documentation and code generation. You can find more information on the Swagger website: https://swagger.io/docs/
- Swagger
- Agile Service Manager uses Swagger for automated documentation generation and utilizes a Swagger server for each micro-service.
For example
- To access the Topology Service via Swagger, use the following URL: https://<your host>/1.0/topology/swagger
- To access the Event Observer service via Swagger, use the following URL: https://<your host>/1.0/event-observer/swagger
Important:
For the on-prem version of Agile Service Manager, you access the micro-services through the proxy service (nasm-nginx), which requires a proxy user and password to be configured for Nginx.
The default values for the user name and password are:
- username
- asm
- password
- asm
Default Swagger URLs
The following tables show the default Swagger URLs for Agile Service Manager services and
observers.
| Service | Swagger URL | ICP |
|---|---|---|
| layout | https://<your host>/1.0/layout/swagger | yes |
| merge | https://<your host>/1.0/merge/swagger | yes |
| search | https://<your host>/1.0/search/swagger | yes |
| topology | https://<your host>/1.0/topology/swagger | yes |
| Observer | Swagger URL | ICP |
|---|---|---|
| alm-observer | https://<your host>/1.0/alm-observer/swagger | no |
| bigfixinventory-observer | https://<your host>/1.0/bigfixinventory-observer/swagger | yes |
| ciscoaci-observer | https://<your host>/1.0/ciscoaci-observer/swagger | yes |
| contrail-observer | https://<your host>/1.0/contrail-observer/swagger | yes |
| dns-observer | https://<your host>/1.0/dns-observer/swagger | yes |
| docker-observer | https://<your host>/1.0/docker-observer/swagger | yes |
| dynatrace-observer | https://<your host>/1.0/dynatrace-observer/swagger | yes |
| event-observer | https://<your host>/1.0/event-observer/swagger | yes |
| file-observer | https://<your host>/1.0/file-observer/swagger | yes |
| ibmcloud-observer | https://<your host>/1.0/ibmcloud-observer/swagger | yes |
| itnm-observer | https://<your host>/1.0/itnm-observer/swagger | yes |
| kubernetes-observer | https://<your host>/1.0/kubernetes-observer/swagger | yes |
| newrelic-observer | https://<your host>/1.0/newrelic-observer/swagger | yes |
| openstack-observer | https://<your host>/1.0/openstack-observer/swagger | yes |
| rest-observer | https://<your host>/1.0/rest-observer/swagger | yes |
| servicenow-observer | https://<your host>/1.0/servicenow-observer/swagger | yes |
| taddm-observer | https://<your host>/1.0/taddm-observer/swagger | yes |
| vmvcenter-observer | https://<your host>/1.0/vmvcenter-observer/swagger | yes |
| vmwarensx-observer | https://<your host>/1.0/vmwarensx-observer/swagger | yes |