REST API Reference for Offline Mediation Controller

Get Administration Server Logs

get

/v1/logs/adminserver

This operation gets the logs of an admin server.

Request

Query Parameters

limit: integer(int64)

The size (in MB) of logs to retrieve.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The logs were retreived successfully.

Root Schema : schema

Type: object

401 Response

The client does not have the correct privileges.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

403 Response

The request was not authorized.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

404 Response

The requested resource cannot be found.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

405 Response

This method is not allowed.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

409 Response

The request could not be processed due to a conflict with the existing state of the resource.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

500 Response

The system has encountered an internal server error.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

Examples

The following example shows how to retrieve Administration Server logs by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://hostname:port/logs/adminserver'

Example of the Response Body

If successful, the response code 200 is returned with the following response body.

{     "logs": "2025-12-19 06:05:49;INFO ;Logger for : AdminServer.adminserver
      created!#EOR#\n2025-12-19 06:05:49;INFO ;JVM Resources: [\n\tAvailable processors: 1, \n\tFree
      memory: 2098669392 bytes, \n\tTotal memory: 2147483648 bytes, \n\tMax memory: 2147483648
      bytes]#EOR#\n2025-12-19 06:05:49;INFO ;readPropertiesFile()#EOR#\n2025-12-19 06:05:49;INFO ;
      ----- read in config from
      /home/ocomcuser/install/ocomc/config/adminserver/general.cfg#EOR#\n2025-12-19 06:05:49;WARN
      ;Security; User authentication disabled; User authentication disabled#EOR#\n2025-12-19
      06:05:49;INFO ;isHostBasedEnv in AdminServer true#EOR#\n2025-12-19 06:05:49;INFO
      ;isHostBasedEnv- reading from AdminServerImpl property file: true#EOR#\n2025-12-19
      06:05:49;WARN ;Initialization; Error starting node; AdminServer running with an empty
      SystemModel#EOR#\n2025-12-19 06:05:49;INFO ;RMI bind address:
      ocomc-admin-server#EOR#\n2025-12-19 06:05:49;INFO ;initRegistry() AdminServer is registering
      with url: rmi://ocomc-admin-server:31200/AdminServer#EOR#\n2025-12-19 06:05:50;INFO ;[ImportDirectoryManager] Maximum Retained Directory Count set to
      :: 5#EOR#\n2025-12-19 06:05:50;INFO ;Kubernetes probes are updated!#EOR#\n2025-12-19
      06:05:50;INFO ;Admin Server is ready#EOR#\n2025-12-19 06:05:50;INFO ;Statistics Reporting
      settings:\n\tPolling Interval:  60 minutes.\n\tReport Output Directory:
      /home/ocomcuser/install/ocomc/statistics/reports\n\tReport Format: CSV\n\tReport Retention:
      200 files.\n#EOR#\n2025-12-19 06:05:50;INFO ;Registered admin server shutdown
      hook!#EOR#\n2025-12-19 06:05:50;INFO ;Alerts service is disabled.#EOR#\n2025-12-19
      06:05:50;INFO ;AdminServer RMI exported and listening on port :: 31201#EOR#\n2025-12-19
      06:05:50;INFO ;admin server install dir=/home/ocomcuser/install/ocomc#EOR#\n2025-12-19
      06:06:34;INFO ;The url formed for retreiving remote reference is rmi://nm-epdc-0:55109/nodemgr#EOR#\n2025-12-19 06:06:34;INFO ;NODEMGR_API : registering for Events #EOR#\n2025-12-19
      06:06:34;INFO ;NODEMGR_API callback RMI Port : 31202#EOR#\n2025-12-19 06:06:34;INFO ;
      NodeMgrAPI.addAcctEventListener() ::  # of listeners = 1#EOR#\n2025-12-19 06:06:40;INFO ;The
      url formed for retreiving remote reference is rmi://nm-cc-0:55109/nodemgr#EOR#\n2025-12-19 06:06:40;INFO ;NODEMGR_API : registering for Events #EOR#\n2025-12-19
      06:06:40;INFO ;NODEMGR_API callback RMI Port : 31202#EOR#\n2025-12-19 06:06:40;INFO ;
      NodeMgrAPI.addAcctEventListener() ::  # of listeners = 1#EOR#\n" }