# truecommand.update

Update Truecommand service settings.

api_key is a valid API key generated by iX Portal.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: truecommand_update

#### truecommand_update

Type: object

TruecommandUpdateArgs parameters.

No Additional Properties

##

#### Enabled

Type: boolean

Whether to enable TrueCommand integration.

##

#### Api Key

16-character API key for TrueCommand authentication. `null` to disable integration.

## Any of

Type: string

Must be at least `16` characters long

Must be at most `16` characters long

Type: null

##

#### TruecommandEntry

Type: object

The updated TrueCommand configuration with current connection status.

No Additional Properties

##

#### Id

Type: integer

Unique identifier for the TrueCommand configuration.

##

#### Api Key

API key for authenticating with TrueCommand services. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Status

Type: enum (of string)

Current connection status with TrueCommand service.

##### Must be one of:

- "CONNECTED"
- "CONNECTING"
- "DISABLED"
- "FAILED"

##

#### Status Reason

Type: enum (of string)

Explanation of the current TrueCommand connection status.

##### Must be one of:

- "Truecommand service is connected."
- "Pending Confirmation From iX Portal for Truecommand API Key."
- "Truecommand service is disabled."
- "Truecommand API Key Disabled by iX Portal."
- "Waiting for connection from Truecommand."

##

#### Remote Url

URL of the connected TrueCommand instance. `null` if not connected.

## Any of

Type: string
Type: null

##

#### Remote Ip Address

IP address of the connected TrueCommand instance. `null` if not connected.

## Any of

Type: string
Type: null

##

#### Enabled

Type: boolean

Whether TrueCommand integration is enabled.

Required roles: TRUECOMMAND_WRITE