N1Developer docsv1

Machines · v1

MUTATION

deleteMachine

Mock

Mock. This operation is part of the approved contract but its module is not built yet. Run Core with N1_API_MODE=mock N1_DEV_AUTH=stub to get deterministic demo-shop data from it. The real server answers NOT_IMPLEMENTED until it ships; the schema and examples here will not change when it does.

Remove a machine from the shop’s lists

Soft-delete a machine: it leaves every list and machine(id) answers MACHINE_NOT_FOUND, but the row and its history are kept and its name can be used again. Owner and admin. MACHINE_IN_USE while it has an open assignment.

POST/graphqlapp audience

Who can call this. Owner, admin.

Headers

  • AuthorizationstringRequired

    Bearer <token>, issued for this endpoint's audience. The token decides the shop and roles; nothing in the request body can change them.

    Example: Bearer eyJhbGciOiJFZERTQSJ9…

  • Content-TypestringRequired

    Always application/json. Only POST is accepted.

    Example: application/json

  • Idempotency-KeystringRequired

    A key you generate once per user action (a UUID). Retrying with the same key never applies the change twice.

    Example: 0192f0c1-9b2a-7d40-8c3e-1f5a6b7c8d9e

  • X-Request-IdstringOptional

    Your id for this request (8–128 characters of A–Z a–z 0–9 . _ : -). Echoed back in the response header and in every error, so you can quote it when reporting a problem. Core makes one if you send none.

    Example: app-7f3c2a9e-checkout

Arguments

  • idID!Required

    The machine id.

    Example: "0192f0c1-0000-7000-8000-000000d40007"

Returns

  • deleteMachineBoolean!Required

    Soft-delete a machine: it leaves every list and machine(id) answers MACHINE_NOT_FOUND, but the row and its history are kept and its name can be used again. Owner and admin. MACHINE_IN_USE while it has an open assignment.

Errors

CodeHTTPWhen
MACHINE_IN_USE409Assigning a machine that is already running a job operation, setting one to maintenance, or deleting one that is. Release it first.
MACHINE_NOT_FOUND404The id is unknown in this shop (another shop's ids answer the same).
FORBIDDEN403Signed in, but the role or tenant does not allow the action.

Every error has the same body. See Errors.

Rate limit tier

Tier: per user. Over the limit you get RATE_LIMITED (HTTP 429) with a Retry-After header. See Response handling.

Search documentation

Search operations, types and errors from the generated contract.