Oracle Cloud Infrastructure Documentation

Updating a Digital Twin Instance

Update a digital twin instance's adapter ID, model ID, model spec URI, authentication, external key, description, free form tags, defined tags, or a display name for your Internet of Things (IoT).

When you update an existing option applied to a digital twin instance, you change only the value you can not add a new value to the digital twin instance using this update option. If you did not include the parameter you want to update when you created the digital twin instance, you can not update the value. Instead create a new digital twin instance to add a new parameter.

For example, if you create a digital twin instance without an authentication parameter for testing, you need to create a new digital twin instance with the authentication parameter when you want to send or receive data from the digital twin instance.

  • If you do not include the external key, then it's generated.

    Use the oci iot digital-twin-instance update command and required parameter to update a digital twin instance's existing parameter.

    For example, use this command to update a digital twin instance's external key. Avoid quoting issues by not using quotes with an external key value. You can replace <your-device-id> with a serial number, MAC address, or a device name as the external key to associate the device to the digital twin instance: 

    oci iot digital-twin-instance update --digital-twin-instance-id <digital-twin-instance-OCID> --external-key <your-device-id>

    Use this command and required <digital-twin-instance-OCID> parameter to update the optional authentication parameter for a digital twin instance. Update the value with the secret or certificate OCID, this is the device password when you send data to the device: 

    oci iot digital-twin-instance update --digital-twin-instance-id <digital-twin-instance-OCID> --auth "<updated-auth-ocid>"

    For a complete list of digital twin instance parameters, see oci iot digital-twin-instance update and for a complete list of all OCI CLI commands, see CLI Command Reference.

  • Run the UpdateDigitalTwinInstance operation to update a digital twin instance.