Skip to main content

SetupActions

Read-only installed forms, revision fences and bounded retained progress.

nodeIdNodeid (string)required

Persistent installed node ID.

Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9._:@-]+$

revisionRevision (integer)required

Current configuration revision.

Possible values: >= 0

schemaDigestSchemadigest (string)required

Configuration schema fence.

Possible values: Value must match regular expression ^[a-f0-9]{64}$

credentialRevisionCredentialrevision (integer)required

Current credential revision.

Possible values: >= 0

credentialSchemaDigestCredentialschemadigest (string)required

Credential declaration fence; never a secret fingerprint.

Possible values: Value must match regular expression ^[a-f0-9]{64}$

actions object[]required

Installed forms.

Possible values: <= 8

  • Array [
    • actionIdActionid (string)required

    Stable installed action ID.

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9._:@-]+$

    titleTitle (string)required

    Owner-facing label.

    Possible values: non-empty and <= 128 characters

    descriptionDescription (string)required

    Setup effect.

    Possible values: non-empty and <= 512 characters

    requiresApprovalRequiresapproval (boolean)

    Setup also requires explicit plugins:approve authority.

    Default value: false
    parametersSchema objectrequired

    Ordinary-input JSON Schema; credentials are supplied separately.

    schemaDigestSchemadigest (string)required

    Exact action schema fence.

    Possible values: Value must match regular expression ^[a-f0-9]{64}$

  • ]
    • operations object[]

    Retained safe progress after reconnect.

    Possible values: <= 32

  • Array [
    • operationIdOperationid (string)required

    Durable accepted operation ID.

    Possible values: Value must match regular expression ^[a-f0-9]{32}$

    nodeIdNodeid (string)required

    Persistent installed node ID.

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9._:@-]+$

    actionIdActionid (string)required

    Selected installed action ID.

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9._:@-]+$

    requiresApprovalRequiresapproval (boolean)

    Retained approval requirement for original intent.

    Default value: false
    phasePhase (string)required

    Last durable setup observation; unfinished work is reconciled.

    Possible values: [queued, running, complete, failed]

    code object

    Safe error code.

    anyOf
    string

    Possible values: Value must match regular expression ^[a-z][a-z0-9_]{0,127}$

    correctiveAction object

    Safe owner recovery guidance.

    anyOf
    string

    Possible values: <= 512 characters

  • ]
    • SetupActions
    {
      "nodeId": "string",
      "revision": 0,
      "schemaDigest": "string",
      "credentialRevision": 0,
      "credentialSchemaDigest": "string",
      "actions": [
        {
          "actionId": "string",
          "title": "string",
          "description": "string",
          "requiresApproval": false,
          "parametersSchema": {},
          "schemaDigest": "string"
        }
      ],
      "operations": [
        {
          "operationId": "string",
          "nodeId": "string",
          "actionId": "string",
          "requiresApproval": false,
          "phase": "queued",
          "code": "string",
          "correctiveAction": "string"
        }
      ]
    }