Disconnect a provider grant from a plugin installation

2 parameters · 1 body field

plugin_installation_idstringrequired

The identifier of the plugin installation whose provider grant to disconnect.

connection_idstringrequired

The identifier of the exact connection target to disconnect.

The configuration revision for the disconnect request.

revisionstringrequired

The configuration revision associated with the connection being disconnected.

1 status code

200Returns the plugin installation configuration after the provider grant is disconnected, including its revision, values, connections, actions, readiness, and synchronization details.

dataobjectoptional

Error handling

revision is required. The plugin_installation_id path parameter must identify the plugin installation, and the connection_id path parameter must identify the exact target connection.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.connections.delete({
  pluginInstallationId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  connectionId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  revision: "example",
});

{
  "data": {
    "actions": [
      {}
    ],
    "connections": [
      {}
    ],
    "readiness": {
      "blocking_paths": [
        "example_value"
      ],
      "ready": true,
      "reason": "example_value"
    },
    "required_capabilities": [
      "example_value"
    ],
    "revision": "example_value",
    "schema_version": "1",
    "sections": [
      {
        "fields": [
          {
            "choices": null,
            "help": "example_value",
            "label": "example_value",
            "nullable": true,
            "path": "example_value",
            "read_only": true,
            "required": true,
            "type": "standard"
          }
        ],
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "Example Title"
      }
    ],
    "sync": {
      "action_id": "550e8400-e29b-41d4-a716-446655440000",
      "reason": "example_value",
      "source_kinds": [
        "example_value"
      ],
      "upload_allowed": true
    }
  }
}

Request

Response

Errors