Test Database Integration

Test database integration.

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.

Tests the database integration.

Test database integration

post

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

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

Test database integration

integrationIdstringRequired

Database integration id to test, from get_database_integrations.

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

post/{version}/database/integrations/test

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

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

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "items": [
    {}
  ]
}

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 Test Database Integration in the SDK reference, with examples in every language.