Reference > PyDo > Library Reference > databases > list_logsink()

Was this page helpful?

Give Feedback

pydo.databases.list_logsink()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To list logsinks for a database cluster, send a GET request to /v2/databases/$DATABASE_ID/logsink.

Parameters

Name	Type	Required	Description	Default Value
`database_cluster_uuid`	string	True	A unique identifier for a database cluster.

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

201
401
404
429
500
default

A JSON object with a key of sinks.

Click to expand an example response.

{
  "sinks": [
    {
      "sink_id": "799990b6-d551-454b-9ffe-b8618e9d6272",
      "sink_name": "logs-sink-1",
      "sink_type": "rsyslog",
      "config": {
        "server": "192.168.0.1",
        "port": 514,
        "tls": false,
        "format": "rfc5424"
      }
    },
    {
      "sink_id": "d6e95157-5f58-48d0-9023-8cfb409d102a",
      "sink_name": "logs-sink-2",
      "sink_type": "rsyslog",
      "config": {
        "server": "192.168.10.1",
        "port": 514,
        "tls": false,
        "format": "rfc3164"
      }
    }
  ]
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

The resource was not found.

Click to expand an example response.

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}