Jump to

• Request
• Response

Observe Health

get

/observe/health

Health observation endpoint.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Health status retrieved successfully.

Body ()

Root Schema : HealthStatus

Type: object

Show Source

• details: object details
  Additional Properties Allowed: true
• status: string
  Example: ok
• timestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"ok"
        },
        "timestamp":{
            "type":"string",
            "format":"date-time"
        },
        "details":{
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : details

Type: object

Additional Properties Allowed: true

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

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

Back to Top