Enabling access to URL routes for topology observer APIs

To access the URL routes for the topology Swagger documentation, you need to update the IBM ASM Operator configuration.

About this task

The URL to access an observer API consists of {HOST}/{PATH} and the Swagger UI URL consists of {HOST}/{PATH}/swagger.

Procedure

Complete the following configuration to expose all observers for both full and listen jobs.

  1. Run the following command to edit the ASM operator configuration:

    oc edit asm aiops-topology
    
  2. Search for the string helmValuesASM: within the spec section of the operator custom resource. Add global.enableAllRoutes: true to the list of values to enable the routes. The following example, shows this setting:

    spec:
      helmValuesASM:
        global.enableAllRoutes: true
    
  3. Save your changes and wait for the ASM operator to reload.

  4. Use the oc get route | grep command to view the route details for an observer API to check whether the topology routes are enabled:

    oc get route | grep topology
    

    Output:

    aiops-topology-topology-cp4aiops.apps.aiops.xxxxxx.xxxxxx.com /1.0/topology/
    

Examples

Example: View AppDynamics observer route details

The following example uses the AppDynamics observer:

oc get route | grep appdynamics

Output:

NAME                                      HOST/PORT                                                                      PATH                            SERVICES                                  PORT    TERMINATION          WILDCARD
aiops-topology-appdynamics-observer       aiops-topology-appdynamics-observer-aiops.apps.myibm.com       /1.0/appdynamics-observer       aiops-topology-appdynamics-observer       9148    reencrypt/Redirect   None

Example: cURL command to the AppDynamic Observer (or job) endpoint

curl -k -X GET --header 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" https://aiops-topology-appdynamics-observer-aiops.apps.myibm.com/1.0/appdynamics-observer/jobs --header 'X-TenantID: cfd95b7e-3bc7-4006-a4a8-a73a79c71255'
{"_items":[],"_limit":100}

Note: To obtain your access token, see Accessing APIs.

Example Swagger UI URL: https://aiops-topology-appdynamics-observer-aiops.apps.myibm.com/1.0/appdynamics-observer/swagger

Next steps

For more information on the available API and related Swagger documentation, see the additional topics under APIs.