Skip to main content

delete-allocation 

restish dci delete-allocation id

Deletes the allocation specified by the Id.

Responses​

200​

OK - Allocation deleted.

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

409 (application/json)​

Conflict - The allocation cannot be deleted because it is used by other resources.

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Allocation ID"
      },
      "type": {
        "type": "string",
        "description": "Type of allocation (single or group)",
        "enum": [
          "single",
          "group"
        ]
      },
      "error": {
        "type": "string",
        "description": "Error message explaining why deletion failed"
      },
      "resources": {
        "type": "object",
        "description": "Map of resources using this allocation, keyed by resource type",
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Resource identifier"
              },
              "name": {
                "type": "string",
                "description": "Resource name"
              },
              "owner": {
                "type": "string",
                "description": "Resource owner (only present if requester doesn't have access)"
              }
            }
          }
        }
      }
    }
  }
}

Aliases: delete-allocation, deleteallocation