Skip to content
Management API Reference

Create a log drain for a project

post/v2/projects/{ref}/analytics/log-drains

OAuth scopes

  • analytics_config:write

This endpoint is only available on the following plans:

  • Pro
  • Team
  • Enterprise

The fine-grained token must include the following permissions to access this endpoint:

  • analytics_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • data
    Required
    object

Response codes

  • 201
  • 401
  • 402
  • 403
  • 429
  • 500

Response (201)

{
  "data": {
    "type": "log_drain",
    "id": "lorem",
    "attributes": {
      "name": "lorem",
      "description": "lorem",
      "config": {
        "url": "lorem",
        "schema": "lorem",
        "username": "lorem",
        "password": "lorem",
        "port": 42,
        "hostname": "lorem"
      },
      "backend_type": "postgres"
    }
  }
}