/scalemgmt/v3/config/admin/{name}: GET

Lists information about the configuration data of the administration daemon for the specified attribute.

Availability

Available on all IBM Storage Scale editions.

Description

The GET config/admin/{name} request lists the information about the configuration data of the administration daemon for an specified attribute. To run this request, you must have the RBAC permission for the get action on the /scalemgmt/v3/config/admin/{name} resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/config/admin/{name}

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
name Specifies the attribute name. Required.
running Displays the configuration value that is running on the node. Optional.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.c
    {
      "configs": [
        {
          "name": "string",
          "node_id": "string",
          "node_name": "string",
          "value": "string"
        }
      ],
      "next_page_token": "string"
    }
  • default: An unexpected error response.
    {
      "code": 0,
      "details": [
        {
          "@type": "string",
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      ],
      "message": "string"
    }

Examples

The following example lists information about the log.level attribute for the administration daemon:

Request data:
curl -k -X  'GET' 'https://localhost:8001/scalemgmt/v3/config/admin/log.level' -n
Response data:
{
        "configs": [
                {
                        "name": "log.level",
                        "value": "info"
                }
        ]
}