Save Database Integration

Saves database integration.

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

This endpoint creates the database integration and returns its id.

Saves the copy of the request's environment; each environment copy has its own connection string. An environment the project does not have is refused. For a managed Atlas Flex integration Norbix provisions the database <env>_<integrationId> in the project's Flex cluster.

Saves database integration

post

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

VersionstringRequired

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

Body

Saves database integration

correlationIdstringOptional

CorrelationId for each request

cultureCodestringOptional

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

timeZoneIdstringOptional

TimeZone

versionstringRequired

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

envstringOptional

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.

projectIdstringRequired

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

Responses

200

Success

application/json

IdResponse

idstring · nullableOptional

statusstring · nullableOptional

post/{version}/database/integrations

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

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "integration": {
    "integrationId": "text",
    "provider": "MongoDbConnectionString",
    "integrationName": "text",
    "isEnabled": true
  },
  "version": "text"
}

200

Success

{
  "responseStatus": {
    "isSuccess": true
  },
  "id": "text",
  "status": "text"
}

In Cloud

Manage this visually in Cloud — see Database.

Use it from code

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