Get Database Integration

Gets integration by specified Id.

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 returns a single database integration by id.

Gets integration by specified Id

get

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

Query parameters

Idstring · nullableRequired

Database integration id from get_database_integrations.

Header parameters

norbix-project-idstring · nullableRequired

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

norbix-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

Success

application/json

GetDatabaseIntegrationResponse

get/{version}/database/integrations/{id}

GET /{version}/database/integrations/{id}?Id=text HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

Success

{
  "item": {
    "isSystemOwned": true,
    "viewId": "text",
    "integrationName": "text",
    "isEnabled": true,
    "env": "text",
    "lastIntegrationTestAtUtc": "text",
    "lastIntegrationTestSucceeded": true,
    "humanDeliveryConfirmedAtUtc": "text",
    "requiresHumanDeliveryConfirmation": true
  },
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Database.

Use it from code

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