Skip to content
Developers
Get an API token

Revoke a plan share

Disable a share immediately.

Revoke a plan share

DELETE/plans/{id}/shares/{share_id}

Disable a share immediately. Revoking it again also returns 204. An unknown plan or share, or another tenant, is 404. No state store or repeated concurrent changes is 409; retry a concurrent change.

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

Parameters

Path parameters

  • idstringRequired

    Format uuid

    Plan id from POST /plans.

  • share_idstringRequired

    Format uuid

    Share id from createPlanShare or listPlanShares.

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

204 No Content

Revoked, including an already revoked share.

Errors

StatusWhen
404

No such well, grid, plan or route.

409

The request conflicts with the state of the plan or resource it names, and message says how: for example a plan still running or failed, a stale If-Match, an Idempotency-Key reused with another body, or a server without a state store.

Shared errors400401403500503What they mean