Instance

Delete Instance

Changed on

Delete an Instance by ID

Org must have a Tenant entity. Instance must belong to Tenant. User must have authorization role with TENANT_ADMIN suffix.

delete/v2/org/{org}/nico/instance/{instanceId}

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/instance/{instanceId}
  • Auth
    HTTP bearer

Request body

isRepairTenantboolean nullable

Should be set to true for Tenants who are performing investigation/repairing the Machine. Otherwise omit or set to false

Example request

{
  "machineHealthIssue": {
    "category": "Network",
    "summary": "Machine has DPU connectivity error",
    "details": "Tenant observed repeated link flaps on the DPU uplink."
  },
  "isRepairTenant": false
}

Response

Deletion request was accepted

messagestring required

Human-readable outcome of the request

Example response

{
  "message": "Deletion request was accepted"
}

Changes

  • 273aadbf1c41Revision changes
    • breaking

      the request property / became not nullable

    • breaking

      removed the enum value Software of the request property /

    • breaking

      removed the enum value Storage of the request property /

    • breaking

      the / request property's minLength was increased from 0 to 1

    • info

      the request property / became optional

    • info

      the / request property's maxLength was increased from 512 to 1024

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status