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 Kafka configuration

GET

/config/kafka

Requires System Administration permission.

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

    Kafka configuration

  • 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/kafka \
    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": "Russell Gardner",
        8    "type": "gomobigifo",
        9    "config": {
        10      "saslMechanism": "SCRAM-SHA-512",
        11      "hosts": [
        12        {
        13          "host": "host1",
        14          "port": 6724
        15        }
        16      ],
        17      "credentials": {
        18        "secretName": "objectstorage-ibmcloud-admin"
        19      }
        20    },
        21    "certificates": [
        22      {
        23        "alias": "intermediate",
        24        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
        25      }
        26    ]
        27  },
        28  "status": {
        29    "conditions": [
        30      {
        31        "lastTransitionTime": "2020-08-10T16:45:47Z",
        32        "reason": "Ready",
        33        "message": "Configuration was updated successfully",
        34        "status": "True",
        35        "type": "Ready"
        36      }
        37    ],
        38    "config": {
        39      "saslMechanism": "SCRAM-SHA-512",
        40      "hosts": [
        41        {
        42          "host": "host1",
        43          "port": 6724
        44        }
        45      ],
        46      "credentials": {
        47        "secretName": "objectstorage-ibmcloud-admin"
        48      }
        49    },
        50    "certificates": [
        51      {
        52        "alias": "intermediate",
        53        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
        54      }
        55    ],
        56    "version": {
        57      "reconciled": "8.4.0"
        58    }
        59  }
        60}