IBM API Hub
Maximo Application Suite Admin APIs 9.0.x

By IBM Maximo

Provides REST APIs for performing Suite administration operations.


API reference

Get the current Mongo configuration

GET

/config/mongo/

Requires System Administration permission.

Request URL
https://api.{mas-instance-id}.{mas-domain}/config/mongo/
Security
apiKey
x-access-token
required in header
Responses
  • 200

    MongoDB configuration

  • 400

    Bad Request

  • 401

    Authentication token is empty or invalid

  • 403

    Authenticated user is not permitted to make the request

  • 404

    The requested resource could not be found

  • 500

    An internal server error occured

Code snippet
    1curl --request GET \
    2  --url https://api.replace_mas-instance-id_variable.replace_mas-domain_variable/config/mongo/ \
    3  --header 'accept: application/json' \
    4  --header 'x-access-token: REPLACE_THIS_VALUE'

      Example response

        1{
        2  "metadata": {
        3    "creationTimestamp": "2020-02-20T13:54:00",
        4    "deletionTimestamp": "2020-02-20T13:58:00"
        5  },
        6  "spec": {
        7    "displayName": "Harriet Cortez",
        8    "type": "ozpuci",
        9    "config": {
        10      "configDb": "admin",
        11      "credentials": {
        12        "secretName": "mongodb-ibmcloud-admin"
        13      },
        14      "hosts": [
        15        {
        16          "host": "host1",
        17          "port": 6724
        18        }
        19      ],
        20      "retryWrites": true,
        21      "authMechanism": "DEFAULT"
        22    },
        23    "certificates": [
        24      {
        25        "alias": "intermediate",
        26        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
        27      }
        28    ]
        29  },
        30  "status": {
        31    "conditions": [
        32      {
        33        "lastTransitionTime": "2020-08-10T16:45:47Z",
        34        "reason": "Ready",
        35        "message": "Configuration was updated successfully",
        36        "status": "True",
        37        "type": "Ready"
        38      }
        39    ],
        40    "config": {
        41      "configDb": "admin",
        42      "credentials": {
        43        "secretName": "mongodb-ibmcloud-admin"
        44      },
        45      "hosts": [
        46        {
        47          "host": "host1",
        48          "port": 6724
        49        }
        50      ],
        51      "retryWrites": true,
        52      "authMechanism": "DEFAULT"
        53    },
        54    "certificates": [
        55      {
        56        "alias": "intermediate",
        57        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
        58      }
        59    ],
        60    "version": {
        61      "reconciled": "8.4.0"
        62    }
        63  }
        64}