REST Resources

/api/space/debuglog-management/categories/{packageName}

The following operations are supported on this resource:

  • GET - Get log level for a single category/package
  • PUT - Update log level for a category/package
  • DELETE - Revert category/package log level back to default (WARN)
GET /categories/{packageName} Version 1

This API retrieves information about a category specified by package name.

Sample Usage

GET /categories/{packageName}


  • Parameters:
    Name Type URI Type Description Required
    package-name String Path Package name of the category whose information is to be retrieved. Y
  • Sample Output XML:
    <category>
      <packageName>net.juniper.provisioning</packageName>
      <priority>WARN</priority>
      <handler>net_juniper_provisioning</handler>
    </category>

  • Sample Output JSON:
    {
      "category": {
          "packageName":"net.juniper.provisioning",
          "priority":"WARN",
          "handler":"net_juniper_provisioning"
      }
    }

    • Access Control

    The following capabilities are required to access this API: LogLevelConfiguration

    PUT /categories/{packageName} Version 1

    This API is used to modify the category log level.

    Note: The Package name passed in the 'packageName' path parameter should be the same as the package name passed in the request body. If they are not the same, then the package name which is in the request body will be used. This API will create a default log file handler. It will setup a handler for the specified category, which writes the log to the <handler-name>.log file in /var/log/jboss/server/server1 directory.
    For example: if the category name is "org.apache", the handler name will be "org_apache" and the log file will be "org_apache.log".

    Sample Usage

    PUT /categories/{packageName}


    • Parameters:
      Name Type URI Type Description Required
      package-name String Path Package name of the category whose information is to be modified. Y
  • Sample Input XML:
    <category>
      <packageName>net.juniper.provisioning</packageName>
      <priority>INFO</priority>
    </category>

  • Sample Output XML:
    <category>
      <packageName>net.juniper.provisioning</packageName>
      <priority>INFO</priority>
    </category>

  • Sample Input JSON:

    {
      "category":
          {
            "packageName": "net.juniper.provisioning",
            "priority":"INFO"
          }
      }

  • Sample Output JSON:

    {
      "category":
          {
            "packageName": "net.juniper.provisioning",
            "priority":"INFO"
          }
      }

    • Access Control

    The following capabilities are required to access this API: LogLevelConfiguration

    DELETE /categories/{packageName} Version 1

    This API is used to delete a category. Deleting a category reverts the level back to default log level (WARN) for that category.

    Sample Usage

    DELETE /categories/{packageName}


    • Parameters:
      Name Type URI Type Description Required
      package-name String Path Package name of the category to be deleted. Y

    Access Control

    The following capabilities are required to access this API: LogLevelConfiguration