Skip to main content
Skip table of contents

Create and edit printer and configuration profiles

POST /v3/printers/

Create a printer.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ printers ]

Request body:
{
  "name": "string",
  "ipAddress": "string",
  "notes": "string",
  "type": "local",
  "enforcedModel": "string",
  "configurationId": 0
}

Response body:
{
  "id": 0,
  "name": "string",
  "state": "active",
  "mode": "online",
  "ipAddress": "string",
  "serialNumber": "string",
  "mac": "string",
  "terminalId": "string",
  "brand": "string",
  "model": "string",
  "notes": "string",
  "location": "string",
  "enforcedModel": "string",
  "configurationId": 0
}


GET /v3/printers/configurationProfiles

Get printer configuration profiles list.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ printers ]

Response body:
{
  "profiles": [
    {
      "id": 0,
      "name": "string",
      "terminalType": "string",
      "automaticConfiguration": true,
      "loginMethod": {
        "twoFactor": true,
        "methods": [
          "pin"
        ]
      },
      "coverageAccounting": true,
      "faxPresent": true,
      "useServerHostname": true,
      "ipFilters": true,
      "guestLoginEnabled": true,
      "idleTimeout": 0
    }
  ],
  "count": 0
}


POST /v3/printers/configurationProfiles

Create configuration profiles.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ printers ]

Request body:
{
  "profiles": [
    {
      "name": "string",
      "terminal": true,
      "automaticConfiguration": true,
      "loginMethod": {
        "twoFactor": true,
        "methods": [
          "pin"
        ]
      },
      "faxPresent": true,
      "ipFilters": true,
      "languageSelectionEnabled": true,
      "numericKeyboardEnabled": true,
      "cardReader": "string",
      "adminUser": "string",
      "adminPwd": "string",
      "idleTimeout": 0
    }
  ]
}

Response body:
{
  "profiles": [
    {
      "id": 0,
      "name": "string",
      "terminalType": "string",
      "automaticConfiguration": true,
      "loginMethod": {
        "twoFactor": true,
        "methods": [
          "pin"
        ]
      },
      "coverageAccounting": true,
      "faxPresent": true,
      "useServerHostname": true,
      "ipFilters": true,
      "guestLoginEnabled": true,
      "idleTimeout": 0
    }
  ],
  "count": 0
}


DELETE /v3/printers/configurationProfiles/{id}

Delete configuration profile.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ printers ]

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.