For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set Database Integration As Default

Sets integration as default.

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.

Sets the database integration as default.

Sets integration as default

put
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
IdstringRequired

Database integration id to set as default, 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

Sets integration as default

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}/default
PUT /{version}/database/integrations/{Id}/default 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 Set Database Integration As Default in the SDK reference, with examples in every language.

Last updated