UpCloud

Database Integrations

Service integrations allow you to connect Managed Database services to external services for logging, metrics, and data pipelines. Integration endpoints define the external service connection details.


GET/1.3/database/{uuid}/integrations

List integrations

Returns a list of integrations for a Managed Database service.

Request

GET
/1.3/database/{uuid}/integrations
curl -X GET https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/integrations \
  -u your_username:your_password

GET/1.3/database/{uuid}/integrations/{integration_uuid}

Get integration details

Returns details of a specific integration.

Request

GET
/1.3/database/{uuid}/integrations/{integration_uuid}
curl -X GET https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/integrations/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -u your_username:your_password

POST/1.3/database/{uuid}/integrations

Create integration

Creates a new integration for a Managed Database service.

Attributes

  • Name
    integration_type
    Type
    string
    Description

    Type of integration: "datadog", "prometheus", etc.

  • Name
    dest_endpoint_id
    Type
    string
    Description

    UUID of the destination integration endpoint.

Request

POST
/1.3/database/{uuid}/integrations
curl -X POST https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/integrations \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "integration_type": "datadog",
    "dest_endpoint_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012"
  }'

PATCH/1.3/database/{uuid}/integrations/{integration_uuid}

Modify integration

Modifies an existing integration.

Attributes

  • Name
    active
    Type
    boolean
    Description

    Enable or disable the integration.

Request

PATCH
/1.3/database/{uuid}/integrations/{integration_uuid}
curl -X PATCH https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/integrations/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "active": false
  }'

DELETE/1.3/database/{uuid}/integrations/{integration_uuid}

Delete integration

Deletes an integration from a Managed Database service.

Request

DELETE
/1.3/database/{uuid}/integrations/{integration_uuid}
curl -X DELETE https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/integrations/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -u your_username:your_password

GET/1.3/database/integration-endpoints

List integration endpoints

Returns a list of all integration endpoints in the account.

Request

GET
/1.3/database/integration-endpoints
curl -X GET https://api.upcloud.com/1.3/database/integration-endpoints \
  -u your_username:your_password

GET/1.3/database/integration-endpoints/{endpoint_uuid}

Get endpoint details

Returns details of a specific integration endpoint.

Request

GET
/1.3/database/integration-endpoints/{endpoint_uuid}
curl -X GET https://api.upcloud.com/1.3/database/integration-endpoints/b2c3d4e5-f6a7-8901-bcde-f23456789012 \
  -u your_username:your_password

POST/1.3/database/integration-endpoints

Create endpoint

Creates a new integration endpoint.

Attributes

  • Name
    endpoint_name
    Type
    string
    Description

    Name for the endpoint (1-64 characters).

  • Name
    endpoint_type
    Type
    string
    Description

    Type of endpoint: "datadog", "prometheus", "rsyslog", etc.

  • Name
    endpoint_config
    Type
    object
    Description

    Configuration specific to the endpoint type.

Request

POST
/1.3/database/integration-endpoints
curl -X POST https://api.upcloud.com/1.3/database/integration-endpoints \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint_name": "my-datadog-endpoint",
    "endpoint_type": "datadog",
    "endpoint_config": {
      "datadog_api_key": "your-datadog-api-key",
      "site": "datadoghq.com"
    }
  }'

PATCH/1.3/database/integration-endpoints/{endpoint_uuid}

Modify endpoint

Modifies an existing integration endpoint.

Attributes

  • Name
    endpoint_name
    Type
    string
    Description

    New name for the endpoint.

  • Name
    endpoint_config
    Type
    object
    Description

    Updated configuration.

Request

PATCH
/1.3/database/integration-endpoints/{endpoint_uuid}
curl -X PATCH https://api.upcloud.com/1.3/database/integration-endpoints/b2c3d4e5-f6a7-8901-bcde-f23456789012 \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint_name": "updated-datadog-endpoint"
  }'

DELETE/1.3/database/integration-endpoints/{endpoint_uuid}

Delete endpoint

Deletes an integration endpoint. The endpoint must not be in use by any integrations.

Request

DELETE
/1.3/database/integration-endpoints/{endpoint_uuid}
curl -X DELETE https://api.upcloud.com/1.3/database/integration-endpoints/b2c3d4e5-f6a7-8901-bcde-f23456789012 \
  -u your_username:your_password