Skip to main content
GET
/
project
/
{project_id}
/
location
/
{location}
/
postgres
/
{postgres_database_reference}
/
logs
Get PostgreSQL database logs
curl --request GET \
  --url https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/logs \
  --header 'Authorization: Bearer <token>'
{
  "logs": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "server_ubid": "<string>",
      "context": {}
    }
  ],
  "pagination_key": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
location
string
required

The Ubicloud location/region

Example:

"eu-central-h1"

​
postgres_database_reference
string
required

Postgres database ID or name Resource ID or name

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
​
project_id
string
required

ID of the project

Pattern: ^pj[0-9a-hj-km-np-tv-z]{24}$
Example:

"pjkkmx0f2vke4h36nk9cm8v8q0"

Query Parameters

​
start
string

Start time for log query (rfc3339 format, default 30 minutes ago)

Example:

"2025-05-12T11:27:24.000Z"

​
end
string

End time for log query (rfc3339 format, default now)

Example:

"2025-05-12T11:57:24.000Z"

​
stream_name
enum<string>

Filter by log stream (postgres, pgbouncer, or upgrade)

Available options:
postgres,
pgbouncer,
upgrade
Example:

"postgres"

​
severity_level
enum<string>

Filter by log severity level

Available options:
DEBUG,
INFO,
WARN,
ERROR,
FATAL
Example:

"INFO"

​
server_role
enum<string>

Filter by server role (primary or standby)

Available options:
primary,
standby
Example:

"primary"

​
query_pattern
string

Pattern for substring match against log message body

​
max_log_lines
integer
default:50

Number of log lines to return (default 50, max 500)

​
pagination_key
string

Pagination key returned from a previous response

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Log entries for a Postgres Database

​
logs
object[]
required
​
pagination_key
string

Pass as pagination_key to retrieve the next page of results

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$