update_config

To update the retranslator configuration, use the retranslator/update_config method.

The configuration is replaced completely, not updated field by field. Specify all the fields you need in the request: the fields which aren’t specified are lost. The only exception is the debug field, which is kept from the previous configuration.

svc=retranslator/update_config&params={
    "itemId": <long>,
    "config": {
        "protocol": <text>,
        "server": <text>,
        "port": <ushort>
    }
}

The request can contain the following parameters. The required parameters are marked with an asterisk (*).

The set of fields inside config depends on the protocol. The protocol and server fields are required for all the protocols listed in the Protocols section, and the rest are listed in the same section. If a required field is missing, the request returns error 4.

The required fields are marked with an asterisk (*). The port values in parentheses are the values the interface suggests; the API doesn’t apply them automatically.

Not all the protocols listed above are available in every account, and an account can also have custom retranslation protocols with their own sets of fields. If the specified protocol isn’t available, the request returns error 4. To get the protocols available to the user together with their fields, use the list method.

If the request is completed successfully, the current configuration of the retranslator is returned in the following format:

{
    "rtrc":{
        "protocol":<text>,  /* Protocol. */
        "server":<text>,    /* Server for retransmission. */
        "port":<ushort>     /* Port. */
    }
}

The set of the returned fields depends on the protocol, as in the request. For details, see the Retranslators data format page.

Otherwise, an error code is returned.