Get pending installation configuration

1 parameter

plugin_installation_idstringrequired

The UUID of the installation whose pending configuration to retrieve.

1 status code

200Returns the pending configuration data.

dataobjectoptional

Error handling

The plugin_installation_id path parameter must be a UUID identifying the installation whose pending configuration you want to retrieve.

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

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

const result = await client.configuration.list({ pluginInstallationId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "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,
            "constraints": null,
            "help": null,
            "label": null,
            "nullable": null,
            "path": null,
            "read_only": null,
            "required": null,
            "type": null
          }
        ],
        "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