Skip to navigation

Delete a printer

View as Markdown

Deletes a printer: its URL stops working at once and the jobs waiting for it are cancelled. Its past jobs stay listed until they expire. The dashboard calls it with the access token of a signed-in owner or developer instead of a key, naming the organization in Tillcast-Organization; the answer is the same, and a call by a person writes an audit entry. A person is refused with permission_denied (a viewer), organization_suspended, organization_required (no header) or resource_missing (not a member of that organization).

Scope: printers:write.

Authentication

AuthorizationBearer

A restricted API key, tc_rk_live_ and 32 characters. Send it as Authorization: Bearer <key>. A key lists its scopes, and each operation below names the one it needs; a key may also be limited to one customer. An owner or a developer of the organization makes a key in the dashboard, under API keys, after a code sent to their e-mail. The key is shown once, when it is made. An owner or a developer can revoke it there, and a revoked key stops working within a minute.

OR
AuthorizationBearer

The access token of a person signed in to the dashboard, from the dashboard Cognito pool. Dashboard only, except that POST /v1/customers, POST /v1/customers/{customer}/locations, POST /v1/locations/{location}/printers, PATCH /v1/printers/{printer}, DELETE /v1/printers/{printer}, POST /v1/printers/{printer}/rotate-secret and POST /v1/printers/{printer}/test-print also take it, by role (an owner or a developer, with the organization named in Tillcast-Organization).

Path parameters

printerstringRequired
The printer's id.

Response

The printer was deleted.
cancelled_jobslist of strings
deletedboolean
idstring
jobs_leftlist of strings
objectstring

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error