StarIO.Online Web API

The StarIO.Online service exposes a REST style http API that can be used to control and manage your printers, send and monitor print jobs, and receive event notifications.
First, generate an API key that can be used to securely call the API from your application. API keys are granted permissions for their respective API keys, so the API may not be invoked depending on whether or not the authorisation is granted.

HOST: https://api.stario.online/v1

HOST: https://eu-api.stario.online/v1

Copied to clipboard!

Device Groups ¶

Retrieve a list of device groups ¶

Retrieve device group list
GET`/a`

Returns a list of device groups.

Required permission: ViewDeviceGroups

Example URI

GET /a

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

[
          {
            "Name": "SampleName",
            "MatchPath": "SampleMatchPath",
            "MatchDomain": "null",
            "AutoCreateDeviceQueue": true,
            "Enabled": true,
            "RequireDeviceKey": true,
            "Created": "2024-12-09T05:18:05.97638Z",
            "Owner": "null",
            "DeviceCount": "null"
          }
        ]

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Name": {
                "type": "string",
                "description": "Device group name"
              },
              "MatchPath": {
                "type": "string",
                "description": "Path used to identify the device group"
              },
              "MatchDomain": {
                "type": "string",
                "description": "Domain name, always null"
              },
              "AutoCreateDeviceQueue": {
                "type": "boolean",
                "description": "Indicates whether new devices connecting to the CloudPRNT endpoint URL are automatically registered"
              },
              "Enabled": {
                "type": "boolean",
                "description": "Indicates whether the device group is available"
              },
              "RequireDeviceKey": {
                "type": "boolean",
                "description": "Indicates whether a device-specific key is required to connect devices to this group"
              },
              "Created": {
                "type": "string",
                "description": "UTC date/time when the group was created"
              },
              "Owner": {
                "type": "string",
                "description": "Name of the account that owns this device group, always null"
              },
              "DeviceCount": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Number of devices belonging to this device group, always null"
              }
            },
            "required": [
              "Name",
              "MatchPath",
              "MatchDomain",
              "AutoCreateDeviceQueue",
              "Enabled",
              "RequireDeviceKey",
              "Created",
              "Owner",
              "DeviceCount"
            ]
          }
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Retrieve and update device group details ¶

Retrieve device group details
GET`/a/{groupPath}`

Returns detailed information about the device group.
The device group must belong to the account authenticated by the API key.

Required permission: ViewDeviceGroups

Example URI

GET /a/ SampleGroupPath

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

{
          "Name": "SampleName",
          "MatchPath": "SampleMatchPath",
          "MatchDomain": "null",
          "AutoCreateDeviceQueue": true,
          "Enabled": true,
          "RequireDeviceKey": true,
          "ContactEMail": "null",
          "ContactName": "null",
          "AutoBuzzBeforePrint": 0,
          "AutoBuzzAfterPrint": 0,
          "Copies": 1,
          "AutoClaimBCR": false,
          "Owner": "SampleOwnerName",
          "Created": "2024-12-09T05:18:05.97638Z",
          "JobExpirationTime": 4320,
          "WelcomePrint": true,
          "EmailPrint": false
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Name": {
              "type": "string",
              "description": "Device group name"
            },
            "MatchPath": {
              "type": "string",
              "description": "Path used to identify the device group"
            },
            "MatchDomain": {
              "type": "string",
              "description": "Domain name, always null"
            },
            "AutoCreateDeviceQueue": {
              "type": "boolean",
              "description": "Indicates whether new devices connecting to the CloudPRNT endpoint URL are automatically registered"
            },
            "Enabled": {
              "type": "boolean",
              "description": "Indicates whether the device group is available"
            },
            "RequireDeviceKey": {
              "type": "boolean",
              "description": "Indicates whether a device-specific key is required to connect devices to this group"
            },
            "ContactEMail": {
              "type": "string",
              "description": "Contact email address"
            },
            "ContactName": {
              "type": "string",
              "description": "Contact name"
            },
            "AutoBuzzBeforePrint": {
              "type": "number",
              "description": "Default number of times to buzz the external buzzer before printing"
            },
            "AutoBuzzAfterPrint": {
              "type": "number",
              "description": "Default number of times to buzz the external buzzer after printing"
            },
            "Copies": {
              "type": "number",
              "description": "Default number of copies to print for this device group"
            },
            "AutoClaimBCR": {
              "type": "boolean",
              "description": "Indicates whether to automatically claim the connected barcode reader to receive barcode scan notifications"
            },
            "Owner": {
              "type": "string",
              "description": "Name of the account that owns this device group, always null"
            },
            "Created": {
              "type": "string",
              "description": "UTC date/time when the group was created"
            },
            "JobExpirationTime": {
              "type": "number",
              "description": "Parameter to set the job expiration time (in minutes)"
            },
            "WelcomePrint": {
              "type": "boolean",
              "description": "Setting value to enable or disable welcome printing"
            },
            "EmailPrint": {
              "type": "boolean",
              "description": "Setting value to enable or disable the email printing feature"
            }
          },
          "required": [
            "Name",
            "MatchPath",
            "AutoCreateDeviceQueue",
            "Enabled",
            "RequireDeviceKey",
            "AutoBuzzBeforePrint",
            "AutoBuzzAfterPrint",
            "Copies",
            "AutoClaimBCR",
            "Owner",
            "Created",
            "JobExpirationTime",
            "WelcomePrint",
            "EmailPrint"
          ]
        }

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Update device group
PUT`/a/{groupPath}`

Updates the information of the specified device group. The device group must belong to the account authenticated by the API key.

Required permission: ModifyDeviceGroup

Example URI

PUT /a/ SampleGroupPath

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Body

{
          "Name": "SampleGroupName",
          "MatchDomain": "null",
          "AutoCreateDeviceQueue": true,
          "Enabled": true,
          "RequireDeviceKey": true,
          "ContactEMail": "null",
          "ContactName": "null",
          "AutoBuzzBeforePrint": 0,
          "AutoBuzzAfterPrint": 0,
          "Copies": 1,
          "AutoClaimBCR": false,
          "Owner": "sample",
          "JobExpirationTime": 4320,
          "WelcomePrint": true,
          "EmailPrint": false
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Name": {
              "type": "string",
              "description": "Device group name"
            },
            "MatchDomain": {
              "type": "string",
              "description": "Domain name, always null"
            },
            "AutoCreateDeviceQueue": {
              "type": "boolean",
              "description": "Indicates whether new devices connecting to the CloudPRNT endpoint URL are automatically registered"
            },
            "Enabled": {
              "type": "boolean",
              "description": "Indicates whether the device group is available"
            },
            "RequireDeviceKey": {
              "type": "boolean",
              "description": "Indicates whether a device-specific key is required to connect devices to this group"
            },
            "ContactEMail": {
              "type": "string",
              "description": "Contact email address"
            },
            "ContactName": {
              "type": "string",
              "description": "Contact name"
            },
            "AutoBuzzBeforePrint": {
              "type": "number",
              "description": "Default number of times to buzz the external buzzer before printing"
            },
            "AutoBuzzAfterPrint": {
              "type": "number",
              "description": "Default number of times to buzz the external buzzer after printing"
            },
            "Copies": {
              "type": "number",
              "description": "Default number of copies to print for this device group"
            },
            "AutoClaimBCR": {
              "type": "boolean",
              "description": "Indicates whether to automatically claim the connected barcode reader to receive barcode scan notifications"
            },
            "Owner": {
              "type": "string",
              "description": "Name of the account that owns this device group, always null"
            },
            "JobExpirationTime": {
              "type": "number",
              "description": "Parameter to set the job expiration time (in minutes)"
            },
            "WelcomePrint": {
              "type": "boolean",
              "description": "Setting value to enable or disable welcome printing"
            },
            "EmailPrint": {
              "type": "boolean",
              "description": "Setting value to enable or disable the email printing feature"
            }
          }
        }

Response 200

Hide Show

Headers

Content-Type: application/json

Body

{
          "Name": "SampleGroupName",
          "MatchPath": "SampleGroupPath"
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Name": {
              "type": "string",
              "description": "Device group name"
            },
            "MatchPath": {
              "type": "string",
              "description": "Path used to identify the device group"
            }
          },
          "required": [
            "Name",
            "MatchPath"
          ]
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Devices ¶

Retrieve a list of devices ¶

Retrieve device list
GET`/a/{groupPath}/d{?notes}{&s}{&metaInfo}`

Returns a list of devices connected to the specified device group. The device group must belong to the account authenticated by the API key.

Required permission: EnumDevices

Example URI

GET /a/ SampleGroupPath/d? notes= true& s= sample& metaInfo= {"1": [100], "2": "abc"}

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group
notes: boolean (optional) Example: true
Whether to include Notes in the response
s: string (optional) Example: sample
Partial match search for Device Name, Serial Number, Application access ID, MAC based on the entered string
metaInfo: string (optional) Example: {"1": [100], "2": "abc"}
Search meta information based on the entered string. Refer to herefor obtaining meta information

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

[
          {
            "Mac": "xxxxxxxxxxxx",
            "Id": "Sample",
            "Status": {
              "Online": true,
              "CoverOpen": false,
              "CompulsionSwitch": false,
              "OverTemperature": false,
              "Recoverable": false,
              "CutterError": false,
              "MechanicalError": false,
              "ReceiveBufferOverflow": false,
              "BlackMarkError": false,
              "PresenterPaperJam": false,
              "VoltageError": false,
              "PaperEmpty": false,
              "PaperLow": false
            },
            "AccessIdentifier": "12345678",
            "HorizontalResolution": 8,
            "VerticalResolution": 8,
            "PrintableWidthMM": 72,
            "PaperWidthMM": 80,
            "PollingInterval": 1,
            "ClientType": "Star mC-Print3",
            "LastConnection": 24627231.566811,
            "QueuedJobs": 0,
            "GroupInfo": {
              "Name": "SampleName",
              "MatchPath": "SampleMatchPath",
              "Owner": "SampleOwnerName"
            },
            "SerialNumber": "xxxxxxxxxxxxxxxx",
            "Notes": "SampleNotes",
            "DeleteFlag": false,
            "MetaInfo": [
              {
                "MetaInfoKeyId": 4,
                "MetaInfoValueId": 3
              },
              {
                "MetaInfoKeyId": 9,
                "CustomValue": "SampleCustomValue"
              }
            ]
          }
        ]

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Mac": {
                "type": "string",
                "description": "Unique Mac address of the printer device"
              },
              "Id": {
                "type": "string",
                "description": "ID/name assigned to the device"
              },
              "Status": {
                "type": "object",
                "properties": {
                  "Online": {
                    "type": "boolean"
                  },
                  "CoverOpen": {
                    "type": "boolean"
                  },
                  "CompulsionSwitch": {
                    "type": "boolean"
                  },
                  "OverTemperature": {
                    "type": "boolean"
                  },
                  "Recoverable": {
                    "type": "boolean"
                  },
                  "CutterError": {
                    "type": "boolean"
                  },
                  "MechanicalError": {
                    "type": "boolean"
                  },
                  "ReceiveBufferOverflow": {
                    "type": "boolean"
                  },
                  "BlackMarkError": {
                    "type": "boolean"
                  },
                  "PresenterPaperJam": {
                    "type": "boolean"
                  },
                  "VoltageError": {
                    "type": "boolean"
                  },
                  "PaperEmpty": {
                    "type": "boolean"
                  },
                  "PaperLow": {
                    "type": "boolean"
                  }
                }
              },
              "AccessIdentifier": {
                "type": "string",
                "description": "Application access ID of the device"
              },
              "HorizontalResolution": {
                "type": "number",
                "description": "Horizontal print resolution of the device (dots/mm)"
              },
              "VerticalResolution": {
                "type": "number",
                "description": "Vertical print resolution of the device (dots/mm)"
              },
              "PrintableWidthMM": {
                "type": "number",
                "description": "Printable area of the device (mm)"
              },
              "PaperWidthMM": {
                "type": "number",
                "description": "Width of the paper set in the device (mm)"
              },
              "PollingInterval": {
                "type": "number",
                "description": "Interval to send polling requests to CloudPRNT"
              },
              "ClientType": {
                "type": "string",
                "description": "Client type identifier"
              },
              "LastConnection": {
                "type": "number",
                "description": "Time (seconds) since the server last received an update from the device"
              },
              "QueuedJobs": {
                "type": "number",
                "description": "Number of pending jobs in the device's print queue"
              },
              "GroupInfo": {
                "type": "object",
                "properties": {
                  "Name": {
                    "type": "string"
                  },
                  "MatchPath": {
                    "type": "string"
                  },
                  "Owner": {
                    "type": "string"
                  }
                },
                "description": "Information about the group to which the device belongs"
              },
              "SerialNumber": {
                "type": "string",
                "description": "Serial number of device"
              },
              "Notes": {
                "type": "string",
                "description": "Optional string that can be set for the device"
              },
              "DeleteFlag": {
                "type": "boolean",
                "description": "Delete flag"
              },
              "MetaInfo": {
                "type": "array",
                "description": "Meta information assigned to the device"
              }
            },
            "required": [
              "Mac",
              "Id",
              "Status",
              "AccessIdentifier",
              "HorizontalResolution",
              "VerticalResolution",
              "PrintableWidthMM",
              "PaperWidthMM",
              "PollingInterval",
              "LastConnection",
              "QueuedJobs",
              "GroupInfo",
              "SerialNumber",
              "DeleteFlag",
              "MetaInfo"
            ]
          }
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Retrieve, update, and delete device details ¶

Retrieve device details
GET`/a/{groupPath}/d/{appId}{?notes}`

Returns detailed information about the device connected to the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: ViewDevice

Example URI

GET /a/ SampleGroupPath/d/ 12345678? notes= true

URI Parameters

Hide Show

appId: string (required) Example: 12345678
Application access ID of the device
groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group
notes: boolean (optional) Example: true
Whether to include Notes in the response

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

{
          "Mac": "xxxxxxxxxxxx",
          "Id": "Sample",
          "Status": {
            "Online": true,
            "CoverOpen": false,
            "CompulsionSwitch": false,
            "OverTemperature": false,
            "Recoverable": false,
            "CutterError": false,
            "MechanicalError": false,
            "ReceiveBufferOverflow": false,
            "BlackMarkError": false,
            "PresenterPaperJam": false,
            "VoltageError": false,
            "PaperEmpty": false,
            "PaperLow": false,
            "HoldPrint": false,
            "Description": "null",
            "MinWarningLevel": 0
          },
          "AccessIdentifier": "12345678",
          "HorizontalResolution": 8,
          "VerticalResolution": 8,
          "PrintableWidthMM": 50.8,
          "PaperWidthMM": 58,
          "PollingInterval": 1,
          "ClientType": "Star mC-Print2",
          "LastConnection": 922370.225284,
          "QueuedJobs": 0,
          "GroupInfo": {
            "Name": "SampleName",
            "MatchPath": "SampleMatchPath",
            "Owner": "SampleOwnerName"
          },
          "SerialNumber": "xxxxxxxxxxxxxxxx",
          "Notes": "SampleNotes",
          "MetaInfo": [
            {
              "MetaInfoKeyId": 4,
              "MetaInfoValueId": 3
            },
            {
              "MetaInfoKeyId": 9,
              "CustomValue": "SampleCustomValue"
            }
          ]
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Mac": {
              "type": "string",
              "description": "Unique Mac address of the device"
            },
            "Id": {
              "type": "string",
              "description": "ID/name assigned to the device"
            },
            "Status": {
              "type": "object",
              "properties": {
                "Online": {
                  "type": "boolean"
                },
                "CoverOpen": {
                  "type": "boolean"
                },
                "CompulsionSwitch": {
                  "type": "boolean"
                },
                "OverTemperature": {
                  "type": "boolean"
                },
                "Recoverable": {
                  "type": "boolean"
                },
                "CutterError": {
                  "type": "boolean"
                },
                "MechanicalError": {
                  "type": "boolean"
                },
                "ReceiveBufferOverflow": {
                  "type": "boolean"
                },
                "BlackMarkError": {
                  "type": "boolean"
                },
                "PresenterPaperJam": {
                  "type": "boolean"
                },
                "VoltageError": {
                  "type": "boolean"
                },
                "PaperEmpty": {
                  "type": "boolean"
                },
                "PaperLow": {
                  "type": "boolean"
                },
                "HoldPrint": {
                  "type": "boolean"
                },
                "Description": {
                  "type": "string"
                },
                "MinWarningLevel": {
                  "type": "number"
                }
              },
              "description": "Printer status object representing the last uploaded status of the device"
            },
            "AccessIdentifier": {
              "type": "string",
              "description": "Application access ID of the device"
            },
            "HorizontalResolution": {
              "type": "number",
              "description": "Horizontal print resolution of the device (dots/mm)"
            },
            "VerticalResolution": {
              "type": "number",
              "description": "Vertical print resolution of the device (dots/mm)"
            },
            "PrintableWidthMM": {
              "type": "number",
              "description": "Printable area of the device (mm)"
            },
            "PaperWidthMM": {
              "type": "number",
              "description": "Width of the paper set in the device (mm)"
            },
            "PollingInterval": {
              "type": "number",
              "description": "Interval to send polling requests to CloudPRNT"
            },
            "ClientType": {
              "type": "string",
              "description": "Client type identifier"
            },
            "LastConnection": {
              "type": "number",
              "description": "Time (seconds) since the server last received an update from the device"
            },
            "QueuedJobs": {
              "type": "number",
              "description": "Number of pending jobs in the device's print queue"
            },
            "GroupInfo": {
              "type": "object",
              "properties": {
                "Name": {
                  "type": "string"
                },
                "MatchPath": {
                  "type": "string"
                },
                "Owner": {
                  "type": "string"
                }
              },
              "description": "Information about the group to which the device belongs"
            },
            "SerialNumber": {
              "type": "string",
              "description": "Serial number of the device"
            },
            "Notes": {
              "type": "string",
              "description": "Optional string that can be set for the device"
            },
            "MetaInfo": {
              "type": "array",
              "description": "Meta information assigned to the device"
            }
          },
          "required": [
            "Mac",
            "Id",
            "Status",
            "AccessIdentifier",
            "HorizontalResolution",
            "VerticalResolution",
            "PrintableWidthMM",
            "PaperWidthMM",
            "PollingInterval",
            "ClientType",
            "LastConnection",
            "QueuedJobs",
            "GroupInfo",
            "SerialNumber",
            "MetaInfo"
          ]
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Update device
PUT`/a/{groupPath}/d/{appId}`

Updates the information of the device connected to the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: ModifyDevice

Example URI

PUT /a/ SampleGroupPath/d/ 12345678

URI Parameters

Hide Show

appId: string (required) Example: 12345678
Application access ID of the device
groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Body

{
          "Name": "SampleDeviceName",
          "Notes": "SampleNotes",
          "MetaInfo": "{\"1\": [100], \"2\": \"abc\"}"
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Name": {
              "type": "string",
              "description": "Device name"
            },
            "Notes": {
              "type": "string",
              "description": "Notes about the device"
            },
            "MetaInfo": {
              "type": "string",
              "description": "Meta information about the device in JSON format"
            }
          }
        }

Response 200

Hide Show

Headers

Content-Type: application/json

Body

{}

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {}
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Delete device
DELETE`/a/{groupPath}/d/{appId}`

Deletes the device connected to the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: DeleteDevice

If “Auto-create new device queue” is enabled in the device group, the deleted printer will be re-added to the device group the next time it polls the service, as long as it is online and still polling the service.

Example URI

DELETE /a/ SampleGroupPath/d/ 12345678

URI Parameters

Hide Show

appId: string (required) Example: 12345678
Application access ID of the device
groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Response 403

Hide Show

Headers

Content-Type: application/json

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Print Queue ¶

Print and delete documents ¶

Print document
POST`/a/{groupPath}/d/{appId}/q{?name}{&copies}{&startbuzzer}{&endbuzzer}{&drawer}{&endcut}{&endfeed}`

Sends a document to the device’s print queue.
The sent document is queued as a job and printed as soon as possible in the order it was queued.

Required permission: PrintToDevice

Do not specify the “Star-Pre-Buzzer or Star-Post-Buzzer” header and the “Star-Cash-Drawer” header at the same time as they may not work as expected.

Star-End-Doc-Cut/endcut applies only to print jobs provided in a format that cannot specify the cut method as part of the document. For example, it applies to HTML, Jpeg, PNG, and plain text-based print jobs, but is ignored for Star Document Markup-based jobs that already provide cutter operations as markup tags.

Star-End-Doc-Feed/endfeed applies only to print jobs provided in a format that cannot specify cut/feed operations as part of the document. For example, it applies to HTML, Jpeg, PNG, and plain text-based print jobs, but is ignored for Star Document Markup-based jobs that already provide cutter/feed operations as markup tags.

Example URI

POST /a/ SampleGroupPath/d/ 12345678/q? name= sample& copies= 1& startbuzzer= 1& endbuzzer= 1& drawer= none& endcut= none& endfeed= none

URI Parameters

Hide Show

appId: string (required) Example: 12345678
Application access ID of the device
groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group
name: string (optional) Example: sample
The name of the print job can be specified as the Star-Job-Name header or the star query parameter. This name is used to identify the print result of this job in Webhook event notifications
copies: number (optional) Example: 1
The number of copies to print can be specified in the range of 1 to 10 via the Star-Copies header or the copies query option
startbuzzer: number (optional) Example: 1
The number of times to buzz the device’s connected buzzer before printing can be specified in the range of 0 to 3 as the Star-Pre-Buzzer header or the startbuzzer query parameter
endbuzzer: number (optional) Example: 1
The number of times to buzz the device’s connected buzzer after printing can be specified in the range of 0 to 3 as the Star-Post-Buzzer header or the endbuzzer query parameter
drawer: string (optional) Example: none
Specifies none, start, or end to open the cash drawer connected to the printer at the start or end of the job using the Star-Cash-Drawer header or the drawer query option
endcut: string (optional) Example: none
Specifies the type of cut to perform at the end of the print job from none, partial, or full. This can be controlled via the Star-End-Doc-Cut header or the endcut query option
endfeed: string (optional) Example: none
Specifies whether to feed the end of the document over the auto-cutter before cutting from none, false, true, feed. This can be controlled via the Star-End-Doc-Feed header or the endfeed query option

Request

Hide Show

Headers

Content-Type: text/vnd.star.markup, text/html, text/plain, image/png, image/jpeg
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC
Star-Job-Name: `sample-job` (string) - Optional job name
Star-Copies: `1` (number) - Optional number of copies
Star-Pre-Buzzer: `1` (number) - Optional number of pre-print buzzer sounds
Star-Post-Buzzer: `1` (number) - Optional number of post-print buzzer sounds
Star-Cash-Drawer: `false` (boolean) - Optional cash drawer setting
Star-End-Doc-Cut: `false` (boolean) - Optional cut setting at the end of the document
Star-End-Doc-Feed: `false` (boolean) - Optional feed setting at the end of the document

Body

Binary data

Response 201

Hide Show

Headers

Content-Type: application/json

Body

{
          "Endpoint": "/a/SampleGroupPath/d/12345678/q/1234567",
          "JobId": "1234567",
          "Name": "xxxxxxxx"
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Endpoint": {
              "type": "string",
              "description": "Endpoint to access the created resource"
            },
            "JobId": {
              "type": "string",
              "description": "Print job ID"
            },
            "Name": {
              "type": "string",
              "description": "Print job name"
            }
          }
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Response 411

Hide Show

Headers

Content-Type: text/plain

Body

Length Required

Response 415

Hide Show

Headers

Content-Type: text/plain

Body

Unsupported Media Type

Response 422

Hide Show

Headers

Content-Type: text/plain

Body

Unprocessable Entity

Response 429

Hide Show

Headers

Content-Type: text/plain

Body

Too Many Requests

Delete document
DELETE`/a/{groupPath}/d/{appId}/q`

Deletes all pending jobs from the device’s print queue.
This is typically used to delete unnecessary jobs that accumulate when the printer is offline.

Required permission: FlushQueue

Example URI

DELETE /a/ SampleGroupPath/d/ 12345678/q

URI Parameters

Hide Show

appId: string (required) Example: 12345678
Application access ID of the device
groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

[
          "Hello, world!"
        ]

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "array",
          "items": {
            "type": "string"
          }
        }

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Response 409

Hide Show

Headers

Content-Type: application/json

Body

{
          "error": {
            "message": "Conflict"
          }
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "error": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "Error details"
                }
              },
              "required": [
                "message"
              ],
              "additionalProperties": false,
              "description": "Error information"
            }
          },
          "required": [
            "error"
          ],
          "additionalProperties": false
        }

Print Welcome page ¶

Print Welcome page
PUT`/a/{groupPath}/d/{appId}/welcome`

Regenerates the Welcome page and adds it to the print queue.

Required permission: PrintToDevice

Example URI

PUT /a/ SampleGroupPath/d/ 12345678/welcome

URI Parameters

Hide Show

appId: string (required) Example: 12345678
Application access ID of the device
groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Response 429

Hide Show

Headers

Content-Type: text/plain

Body

Too Many Requests

Response 507

Hide Show

Headers

Content-Type: text/plain

Body

Insufficient Storage

Send StarConfiguration ¶

Send StarConfiguration
POST`/a/{groupPath}/d/{appId}/configuration`

Sends StarConfiguration to the device.

Required permission: ConfigureDevice

Example URI

POST /a/ SampleGroupPath/d/ 12345678/configuration

URI Parameters

Hide Show

appId: string (required) Example: 12345678
Application access ID of the device
groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Body

{
          "Configuration": "Base64EncodedConfiguration"
        }

Response 201

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Response 415

Hide Show

Headers

Content-Type: text/plain

Body

Unsupported Media Type

Response 429

Hide Show

Headers

Content-Type: text/plain

Body

Too Many Requests

Webhook Notifications ¶

Retrieve and create Webhooks ¶

Retrieve Webhook list
GET`/v1/a/{groupPath}/n`

Returns a list of Webhooks for the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: ManageNotifications

Example URI

GET /v1/a/ SampleGroupPath/n

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

[
          {
            "NotificationId": "12345678-1234-1234-1234-123456789ABC",
            "Url": "https://example.com/webhook",
            "ReportJobEvents": true
          }
        ]

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "NotificationId": {
                "type": "string",
                "description": "Webhook ID"
              },
              "Url": {
                "type": "string",
                "description": "Webhook URL"
              },
              "ReportJobEvents": {
                "type": "boolean",
                "description": "Indicates whether to notify on printer status changes"
              }
            },
            "required": [
              "NotificationId",
              "Url",
              "ReportJobEvents"
            ]
          }
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Create Webhook
POST`/v1/a/{groupPath}/n`

Creates a Webhook for the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: ManageNotifications

Example URI

POST /v1/a/ SampleGroupPath/n

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Body

{
          "Url": "https://example.com/webhook",
          "ReportJobEvents": true
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Url": {
              "type": "string",
              "description": "Webhook URL"
            },
            "ReportJobEvents": {
              "type": "boolean",
              "description": "Indicates whether to notify on printer status changes"
            }
          },
          "required": [
            "Url",
            "ReportJobEvents"
          ]
        }

Response 201

Hide Show

Headers

Content-Type: application/json

Body

{
          "NotificationId": "12345678-1234-1234-1234-123456789ABC",
          "Url": "https://example.com/webhook",
          "ReportJobEvents": true
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "NotificationId": {
              "type": "string",
              "description": "Webhook ID"
            },
            "Url": {
              "type": "string",
              "description": "Webhook URL"
            },
            "ReportJobEvents": {
              "type": "boolean",
              "description": "Indicates whether to notify on printer status changes"
            }
          },
          "required": [
            "NotificationId",
            "Url",
            "ReportJobEvents"
          ]
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Retrieve, update, and delete Webhook details ¶

Retrieve Webhook details
GET`/v1/a/{groupPath}/n/{notificationId}`

Returns detailed information about the Webhook for the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: ManageNotifications

Example URI

GET /v1/a/ SampleGroupPath/n/ 12345678-1234-1234-1234-123456789ABC

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group
notificationId: string (required) Example: 12345678-1234-1234-1234-123456789ABC
Webhook ID

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

{
          "NotificationId": "12345678-1234-1234-1234-123456789ABC",
          "Url": "https://example.com/webhook",
          "ReportJobEvents": true
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "NotificationId": {
              "type": "string",
              "description": "Webhook ID"
            },
            "Url": {
              "type": "string",
              "description": "Webhook URL"
            },
            "ReportJobEvents": {
              "type": "boolean",
              "description": "Indicates whether to notify on printer status changes"
            }
          },
          "required": [
            "NotificationId",
            "Url",
            "ReportJobEvents"
          ]
        }

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Update Webhook
PUT`/v1/a/{groupPath}/n/{notificationId}`

Updates the information of the Webhook for the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: ManageNotifications

Example URI

PUT /v1/a/ SampleGroupPath/n/ 12345678-1234-1234-1234-123456789ABC

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group
notificationId: string (required) Example: 12345678-1234-1234-1234-123456789ABC
Webhook ID

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Body

{
          "Url": "https://example.com/webhook",
          "ReportJobEvents": true
        }

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "properties": {
            "Url": {
              "type": "string",
              "description": "Webhook URL"
            },
            "ReportJobEvents": {
              "type": "boolean",
              "description": "Indicates whether to notify on printer status changes"
            }
          },
          "required": [
            "Url",
            "ReportJobEvents"
          ]
        }

Response 200

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Delete Webhook
DELETE`/v1/a/{groupPath}/n/{notificationId}`

Deletes the Webhook for the specified device group.
The device group must belong to the account authenticated by the API key.

Required permission: ManageNotifications

Example URI

DELETE /v1/a/ SampleGroupPath/n/ 12345678-1234-1234-1234-123456789ABC

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
Path used to identify the device group
notificationId: string (required) Example: 12345678-1234-1234-1234-123456789ABC
Webhook ID

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

History ¶

The History API allows you to retrieve historical information about printers.

Export historical information ¶

Export historical information
GET`/history/export`

Exports the retrieved historical information about printers.

Required permission: ViewDeviceGroups

The date and time format is output in the format yyyy-MM-dd HH:mm:ss.ffffff in UTC.

startDate and endDate can be specified within a maximum range of 7 days. Additionally, startDate can be specified up to 90 days prior to the request time.

Example URI

GET /history/export

URI Parameters

Hide Show

startDate: DateTimeOffSet (required) Example: 2025-01-01T00:00:00+09:00
Start date of the data to be exported
endDate: DateTimeOffSet (required) Example: 2025-01-02T00:00:00+09:00
End date of the data to be exported
type: string (required) Example: both
Query to narrow down the target data to be exported. Specify from job (print history only), status (printer status history), both (both). The default value is both

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: text/csv
Content-Disposition: attachment; filename="export.csv"

Body

Date,Status,StatusDisplay,DeviceMAC,SerialNumber,AccessIdentifier,GroupPath,Message,JobLength,JobName,JobPrintAttempts
        2025-01-01 00:00:00.000000,0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0,Offline,xxxxxxxxxxxx,xxxxxxxxxxxxxxxx,xxxxxxxx,sample,,,,
        2025-01-01 00:00:00.000000,,Complete,xxxxxxxxxxxx,xxxxxxxxxxxxxxxx,xxxxxxxx,sample,,66954,9b815853,0
        2025-01-01 00:00:00.000000,,Received,xxxxxxxxxxxx,xxxxxxxxxxxxxxxx,xxxxxxxx,sample,,66954,9b815853,0

Response 400

Hide Show

Headers

Content-Type: text/plain

Body

Bad Request

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

MetaInfo ¶

Retrieve device meta information list ¶

Retrieve device meta information list
GET`/v1/a/{groupPath}/meta-info`

Returns a list of meta information for devices connected to the specified device group.
The device group must belong to the account authenticated by the API key.

Required Permission: ViewDeviceGroups

Example URI

GET /v1/a/ SampleGroupPath/meta-info

URI Parameters

Hide Show

groupPath: string (required) Example: SampleGroupPath
The path used to identify the device group.

Request

Hide Show

Headers

Content-Type: application/json
Star-Api-Key: 12345678-1234-1234-1234-123456789ABC

Response 200

Hide Show

Headers

Content-Type: application/json

Body

[
          {
            "MetaInfoKeyId": 1,
            "Name": "Country",
            "Kind": "List",
            "MetaInfoValues": [
              {
                "MetaInfoValueId": 1,
                "Name": "Japan"
              },
              {
                "MetaInfoValueId": 2,
                "Name": "USA"
              },
              {
                "MetaInfoValueId": 3,
                "Name": "UK"
              }
            ]
          },
          {
            "MetaInfoKeyId": 2,
            "Name": "Contact (phone number)",
            "Kind": "String"
          }
        ]

Schema

{
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "array"
        }

Response 403

Hide Show

Headers

Content-Type: text/plain

Body

Forbidden

Response 404

Hide Show

Headers

Content-Type: text/plain

Body

Not Found

Device Groups ¶

Retrieve a list of device groups ¶

Retrieve device group list GET/a

Example URI

Headers

Headers

Body

Schema

Headers

Body

Headers

Body

Retrieve and update device group details ¶

Retrieve device group details GET/a/{groupPath}

Example URI

Headers

Headers

Body

Schema

Headers

Body

Headers

Body

Update device group PUT/a/{groupPath}

Example URI

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Headers

Body

Headers

Body

Devices ¶

Retrieve a list of devices ¶

Retrieve device list GET/a/{groupPath}/d{?notes}{&s}{&metaInfo}

Example URI

Headers

Headers

Body

Schema

Headers

Body

Headers

Body

Retrieve, update, and delete device details ¶

Retrieve device details GET/a/{groupPath}/d/{appId}{?notes}

Example URI

Headers

Headers

Body

Schema

Headers

Body

Headers

Body

Headers

Body

Update device PUT/a/{groupPath}/d/{appId}

Example URI

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Headers

Body

Headers

Body

Delete device DELETE/a/{groupPath}/d/{appId}

If “Auto-create new device queue” is enabled in the device group, the deleted printer will be re-added to the device group the next time it polls the service, as long as it is online and still polling the service.

Example URI

Headers

Retrieve device group list
GET`/a`

Retrieve device group details
GET`/a/{groupPath}`

Update device group
PUT`/a/{groupPath}`

Retrieve device list
GET`/a/{groupPath}/d{?notes}{&s}{&metaInfo}`

Retrieve device details
GET`/a/{groupPath}/d/{appId}{?notes}`

Update device
PUT`/a/{groupPath}/d/{appId}`

Delete device
DELETE`/a/{groupPath}/d/{appId}`

Print document
POST`/a/{groupPath}/d/{appId}/q{?name}{&copies}{&startbuzzer}{&endbuzzer}{&drawer}{&endcut}{&endfeed}`

Delete document
DELETE`/a/{groupPath}/d/{appId}/q`

Print Welcome page
PUT`/a/{groupPath}/d/{appId}/welcome`

Send StarConfiguration
POST`/a/{groupPath}/d/{appId}/configuration`