Response (GET)

A CloudPRNT server responds to this GET request from a printer as defined below.

Response header	Response Body
HTTP Status Code	JSON data defined in CloudPRNT

HTTP Status Code

HTTP Status Code	Description
200	If the operation succeeded and returned the server setting information as expected.
404	Server only supports CloudPRNT Version HTTP

Response Body

The response body returned by a CloudPRNT server is in JSON format.

Please set up according to the following JSON specifications.

Key	Type	Required	Decsription
title	string	true	Fixed to "star_cloudprnt_server_setting".
version	string	true	Version information of this JSON. Please specify 1.0.0.
nextUrl	string	false	If this key is defined, a printer will execute this GET request again for the URL of the value. If this key is defined, you do not need to define any subsequent keys. Even if defined, the printer ignores them. Max Character Length : 511
reloadIntervalMin	number	false	At the specified interval [minutes], a printer will make this GET request again and update the information. Default : 60 Domain : 0 - 1440 (0 : No periodic inquiry)
setID	string	false	Set the ID that the client will use within the “uniqueID” field. Unlike SetID of Client Action , it is not saved in non-volatile memory. Max Character Length : 31
serverSupportProtocol	[string]	true	List the CloudPRNT communication protocols supported by a server. "HTTP" : Server supports CloudPRNT Version HTTP "MQTT" : Server supports CloudPRNT Version MQTT If both are specified, a printer will operate with CloudPRNT Version MQTT .
settingForHTTP	object	false	An object that summarizes values related to CloudPRNT Version HTTP .
settingForMQTT	object	false	An object that summarizes values related to CloudPRNT Version MQTT . This key is required if "MQTT" is included in the value of the serverSupportProtocol key.

settingForHTTP object specification

Key	Type	Required	Decsription
url	string	false	A server URL that replaces the [CloudPRNT URL] set on the printer. If this value is defined, it will be used for URLs for Polling the server (POST) , Print job requests (GET) , Print job confirmation (DELETE) . It is not used for URL of Server setting information request (GET) . Default : Value set in Web Config Max Character Length : 511
pollingTimeSec	number	false	At the specified interval [seconds], a printer performs Polling the server (POST) Default : Value set in Web Config Domain : 1 - 7200
username	string	false	Username used by the printer for Basic authentication of HTTP requests. This value is not saved in non-volatile memory. Default : Value set in Web Config Max Character Length : 63
password	string	false	Password used by the printer for Basic authentication of HTTP requests. This value is not saved in non-volatile memory. Default : Value set in Web Config Max Character Length : 63

settingForMQTT object specification

Key	Type	Required	Decsription
useTriggerPOST	boolean	true	true : Use Trigger POST. false : Use Pass URL /Full MQTT.
pollingTimeSec	number	false	At the specified interval [seconds], a printer performs the following operations. For Trigger POST : do Polling the server (POST) For Full MQTT / Pass URL : Publish client-status message Default : 0 Domain : 0 - 7200
mqttConnectionSetting	object	true	An object that summarizes the values related to connecting a printer to a MQTT broker.

mqttConnectionSetting object specification

Key	Type	Required	Decsription
hostName	string	true	Host name of a MQTT broker that a printer connects to. Max Character Length : 511
portNumber	number	true	Port number of a MQTT broker that a printer connects to.
useTls	boolean	false	Indicates whether TLS is used for connection with a MQTT broker. Default : true
keepAliveSec	number	false	Specify the interval [seconds] for a printer to send a ping while connecting to a MQTT broker. Default : 60 Domain : 30 - 1200
deviceSubscribeTopicName	string	false	Sets the prefix for MQTT topic name that a printer subscribes to. Subscribes to the specified prefix with /# appended. Default Topic name for Subscribe (if omitted): star/cloudprnt/to-device/{MAC}/# Max Character Length : 511
devicePublishTopicName	string	false	Sets the topic name prefix for messages published by a printer. Publish a message with /{method} for the specified prefix. {method} varies depending on the message type. Default Topic name for Publish (if omitted): star/cloudprnt/to-server/{MAC}/{method} Max Character Length : 511
authenticationSetting	object	false	An object that summarizes the authentication information used by the printer when connecting to the MQTT broker.
tlsSetting	object	false	An object that summarizes the settings when the printer connects with the MQTT broker via TLS. This setting takes effect only when the value of the useTls key is true.

authenticationSetting object specification

Key	Type	Required	Decsription
clientId	string	false	Client ID when a printer connects to a MQTT broker. Default : Printer Ethernet MAC address Max Character Length : 255
username	string	false	User name when a printer connects to a MQTT broker. Max Character Length : 511
password	string	false	Password when the printer connects to the MQTT broker. Max Character Length : 511

tlsSetting object specification

Key	Type	Required	Decsription
alpn	[string]	false	Specify the protocol list for protocol negotiation using ALPN when the printer connects to the MQTT broker via TLS. Max List Size : 5 Max Character Length : 31

Environment variables that can be used in response body JSON

The following strings can be included in the response body JSON.

A printer converts the following strings contained in JSON into its own values.

{MAC} : Replaced with the Ethernet MAC address of a printer. Example: 00:11:22:33:44:55
{SN} : Replaced with the product serial number of a printer. Example: 2602319010600001
{SERIESNAME} : Replaced with a printer series name. Examples : mC-Print3, TSP100IV, mC-Label3…
{USERNAME} : Replaced with the user name for HTTP Basic authentication set on a printer. This environment variable is only available for the value of the authenticationSetting.username key.
{PASSWORD} : Replaced with the password for HTTP Basic authentication set in a printer. This environment variable is only available for the value of the authenticationSetting.password key.

Response body setting example

Supports only CloudPRNT Version HTTP

{
    "title" : "star_cloudprnt_server_setting",
    "version" : "1.0.0",
    "serverSupportProtocol" : ["HTTP"]
}

Supports CloudPRNT Version HTTP and CloudPRNT Version MQTT (Trigger POST)

It also specifies the URL to which a printer makes HTTP requests.

{
    "title" : "star_cloudprnt_server_setting",
    "version" : "1.0.0",
    "serverSupportProtocol" : ["HTTP", "MQTT"],
    "settingForHTTP" : {
        "url" : "http://cloudprnt.net/sample.php"
    },
    "settingForMQTT" : {
        "useTriggerPOST" : true,
        "mqttConnectionSetting" : {
            "hostName" : "your.mqtt.broker",
            "portNumber" : 8883,
            "useTls" : true
        }
    }
}

Supports CloudPRNT Version HTTP and CloudPRNT Version MQTT (Full MQTT / Pass URL)

{
    "title" : "star_cloudprnt_server_setting",
    "version" : "1.0.0",
    "serverSupportProtocol" : ["HTTP", "MQTT"],
    "settingForMQTT" : {
        "useTriggerPOST" : false,
        "mqttConnectionSetting" : {
            "hostName" : "your.mqtt.broker",
            "portNumber" : 8883,
            "useTls" : true
        }
    }
}

Supports only CloudPRNT Version MQTT (Full MQTT / Pass URL)

{
    "title" : "star_cloudprnt_server_setting",
    "version" : "1.0.0",
    "serverSupportProtocol" : ["MQTT"],
    "settingForMQTT" : {
        "useTriggerPOST" : false,
        "mqttConnectionSetting" : {
            "hostName" : "your.mqtt.broker",
            "portNumber" : 8883,
            "useTls" : true
        }
    }
}

Retry GET request to another URL

{
    "title" : "star_cloudprnt_server_setting",
    "version" : "1.0.0",
    "nextUrl" : "http://sampleserver/test/cloudprnt-setting.json"
}