Skip to main content

Update an Integration App CLI by internalId

Updates the latest version of the CLI. If the latest version is PUBLISHED, a new IN_PROGRESS version is created and changes are applied to it; PUBLISHED rows are never mutated. Acquires a per-entity lock; returns 409 if held.

Path Parameters
internalId string — REQUIRED
Request Body — REQUIRED
name string

New display name. null = don't change.

description string

New description. null = don't change.

documentationURL string

New documentation URL. null = don't change.

installationCommand string

New installation command. null = don't change.

postInstallCommands string[]

New post-install commands. null = don't change.

invokeCommand string

New invoke command. null = don't change.

cliAuth string

Possible values: [ENV_VARIABLE, CONFIG_FILE, CLI_FLAG, LOGIN_COMMAND, TOKEN_FILE]

New CLI auth mechanism. null = don't change.

authConfig object[]

New auth config key-value pairs. null = don't change. Empty list = explicitly clear.

key string
value string
id string
metadata string
environmentVariables object[]

New environment variables. null = don't change.

key string
value string
id string
metadata string
requiredLibraries object[]

New required libraries. null = don't change.

itemId string
packageManager string

Possible values: [NPM, PIP, APT, APK, CURL, SNAP]

packages object
contextVariableType object

The type of the column

variableType string

Possible values: [STRING, INTEGER, REAL, BOOLEAN, DATE, TIME, DATE_TIME, IMAGE, AUDIO, VIDEO, FILE, CATEGORY, NLU_ENTITY, BLUEPRINT, LIST, SET, HASHMAP, RICHTEXT]

categoryValues object[]
label string
value string
nluEntityId string
blueprintId string
enumId string
t1Type (circular)
t2Type (circular)
blueprintFields (circular)[]
otherDateTypeBaseType (circular)
dynamicFieldDateMapperType string

Possible values: [UNIX_TIMESTAMP_IN_SECONDS, UNIX_TIMESTAMP_IN_MILLISECONDS, UNIX_TIMESTAMP_IN_NANOSECONDS, STRING_FORMAT]

otherDateStringFormat string
variableDataType string

Possible values: [VALUE, VARIABLE, HYBRID]

referredVariable string
value string
permittedAuthMechanisms string[]

New auth mechanism IDs. null = don't change. Empty list = explicitly clear.

fieldsPatches object[]

RFC-6902 patch operations applied to the CLI's top-level fields list. Caller writes paths against the user-visible (non-auth) fields; service translates indices past the auth-field prefix before applying. After patches apply, parent auth fields are re-merged via mergeAuthFieldsIntoCLI. null or empty = no fields changes.

operationId string
op string
path string
value object
from string
match object
Responses
200

Returns the updated CLI

Schema — OPTIONAL
object