Jump to

• Request
• Response

Retrieve Server Logs

get

http://{host}:{port}/veridata/v1/services/logs/server

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

Retrieves Server Logs For Specific Log Type (e.g. PERF, API, ALL) And Allows Filtering By Log Level And Number Of Lines

Request

Query Parameters

• level: string
  Filter logs by level (e.g., `SEVERE`, `WARNING`, `INFO`, `FINE`, `FINER`, `FINEST`, `ALL`)

  Allowed Values: [ "SEVERE", "WARNING", "INFO", "FINE", "FINER", "FINEST", "ALL" ]
• lines: integer
  Minimum Value: 1

  Number of log lines to retrieve from the end of the log file
• logType: string
  Filter logs by log type (e.g., `ALL`, `API`, `PERF`)

  Allowed Values: [ "ALL", "API", "PERF" ]

Header Parameters

• Accept: string
  Media type to return.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Logs Retrieved Successfully

Body ()

Root Schema : ServerLogsResponse

Type: object

Show Source

• content: array content

{
    "type":"object",
    "properties":{
        "content":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":{
        "content":[
            "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile",
            "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile",
            "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile"
        ]
    }
}

Example:

{
    "content":[
        "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile",
        "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile",
        "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile"
    ]
}

Nested Schema : content

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

Back to Top