Skip to content
Developers
Get an API token

Cancel or remove an export

Cancels a queued or running export, or removes a finished one with its file.

Cancel or remove an export

DELETE/exports/{id}

Cancels a queued or running export, or removes a finished one with its file. status is the export's status when the request arrived.

Send a Novi API token as a bearer token on every request. Authentication
Cancel or remove

A cancelled export stops, any partial file is removed, and it reads cancelled. A removed one (done, failed, cancelled or expired) is then not found.

Tenant

Exports belong to the request's tenant: lists hold only its exports, and another tenant's export is a 404 to read, download or delete. A signed-in user's tenant is their customer; a configured user's, the server's default tenant.

Parameters

Path parameters

Query parameters

  • model_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches the base dataset; once the server retires it, a 400 naming the set answering instead.
    • An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in details.allowed (published sets only once default is retired); a set that can't load, a 503 with the reason.
    • Plans and exports stay in their set: a call naming them (by path, plan, ids, source.plan, a scenario's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

Cancelled or removed.

  • idstringRequired

    Format uuid

    Export id.

  • deletedanyRequired

    Always true

    Always true.

  • statusstringRequired

    Its status when the request came: queued or running, which this call cancelled; or done, error, cancelled or expired, which it removed.

    "queued""running""done""error""cancelled""expired"

Errors

StatusWhen
404

No such well, grid, plan or route.

Shared errors400401403500503What they mean