database

Create integration

Creates a new integration by given {service-uuid}.

post/1.3/database/{uuid}/integrations

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/database/{uuid}/integrations
  • Auth: HTTP bearer

Path parameters

uuidstring uuid required

The unique identifier for the integration.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

Request body

type'logs' | 'prometheus' | 'rsyslog' required

The type of service integration.

destination_uuidstring uuid

The UUID of the destination where the service integration will send data.

propertiesobject

Example request

{
  "type": "logs",
  "destination_uuid": "09e86f48-2dcd-4a43-843d-3532ab112c1d",
  "properties": {
    "opensearch_index_days_max": 30,
    "opensearch_index_prefix": "mysql_logs"
  }
}

Response

Created

uuidstring uuid

The UUID of the service integration.

typestring

The type of service integration.

source_namestring

The name of the source service.

source_uuidstring uuid

The UUID of the source service.

destination_namestring

The name of the destination service.

destination_uuidstring uuid

The UUID of the destination service.

statestring

The current state of the service integration.

propertiesobject

A map of additional properties for the service integration.

Example response

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "rsyslog",
  "source_name": "my-database",
  "source_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "destination_name": "my-rsyslog-server",
  "destination_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "state": "active",
  "state_error": [],
  "node_states": [
    {
      "name": "node-1",
      "status": "running",
      "errors": [
        "some error"
      ],
      "likely_error_cause": null
    }
  ],
  "properties": {
    "key1": "value1",
    "key2": 2,
    "key3": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.