Enable Database Integration

Enable integration for particular project.

An integration connects an external provider to this module. Configure the provider and its secrets in the dashboard; the API lets you list, create or update, enable, disable, set a default, and test integrations.

This endpoint enables the module for your project.

Enable integration for particular project

put

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

IdstringRequired

Database integration id to enable, from get_database_integrations.

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

Enable integration for particular project

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

correlationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

put/{version}/database/integrations/{Id}/enable

PUT /{version}/database/integrations/{Id}/enable HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 142

{
  "projectId": "text",
  "env": "text",
  "resolvedEnv": {
    "value": "text",
    "isProd": true
  },
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text"
}

200

OK

{
  "responseStatus": {
    "isSuccess": true
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Enable Database Integration in the SDK reference, with examples in every language.