Disable Database Integration

Disable integration for particular project.

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 disables the module for your project.

This action is destructive or irreversible. Make sure you target the right item and confirm before running it.

Disable integration for particular project

put

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

Idstring · nullableRequired

Database integration id to disable, from get_database_integrations.

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

Disable integration for particular project

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

EmptyResponse

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

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

{
  "projectId": "text",
  "env": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text",
  "version": "text"
}

200

Success

{
  "success": {
    "responseStatus": {
      "isSuccess": 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 Disable Database Integration in the SDK reference, with examples in every language.