Endpoint

/v1/frozen/bridges/{filesystem_uuid}/deletes/{id}

GET

Returns the delete: what it covers, its state, and how many files and bytes it has deleted. A delete that was canceled or failed stays CANCELED or FAILED, and never becomes FINISHED. Returns HTTP 404 if no Frozen bridge has this UUID or the bridge has no delete with this ID.

Parameters

Name Description Required
filesystem_uuid The Frozen bridge's filesystem UUID, as `GET /v1/frozen/bridges/` reports it. Yes
id The delete's ID, as starting or listing the delete reports it. Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_frozen_delete",
  "type": "object",
  "properties": {
    "id": {
      "description": "The delete's ID. Deletes take their IDs from the same sequence as the bridge's freeze and thaw jobs, so the deletes' IDs have gaps.",
      "type": "string"
    },
    "subtree": {
      "description": "The directory, with everything under it, or the one file the delete covers, as a path relative to the bridge, such as `/projects/2019`. Absent when the delete has `files`.",
      "type": "string"
    },
    "files": {
      "type": "array",
      "items": {
        "description": "The paths the delete covers, relative to the bridge, in the order given. A directory covers everything under it. Absent when the delete has a `subtree`.",
        "type": "string"
      }
    },
    "state": {
      "type": "string",
      "enum": [
        "IN_PROGRESS",
        "FINISHED",
        "CANCELED",
        "FAILED"
      ],
      "description": "The delete's state.:\n * `CANCELED` - The delete was canceled. What it already deleted stays deleted, and it deletes nothing more.,\n * `FAILED` - The delete stopped before it finished; `failure_message` says what to do.,\n * `FINISHED` - Everything its paths covered is deleted, the paths themselves included.,\n * `IN_PROGRESS` - The delete is removing what its paths cover."
    },
    "failure_message": {
      "description": "For a failed delete, where it stopped and what to do next.",
      "type": "string"
    },
    "start_time": {
      "description": "When the delete started, in RFC 3339 format.",
      "type": "string"
    },
    "end_time": {
      "description": "When the delete finished, was canceled or failed, in RFC 3339 format. Absent while it is in progress.",
      "type": "string"
    },
    "files_deleted": {
      "description": "Files the delete has deleted, not counting directories or symbolic links.",
      "type": "string"
    },
    "bytes_deleted": {
      "description": "Total size in bytes of the deleted files, each as large as it was when deleted.",
      "type": "string"
    }
  }
}

DELETE

Removes a delete that is FINISHED, CANCELED or FAILED, so it is no longer listed; removing it changes no files. Returns HTTP 409 for a delete in progress; cancel it first. A delete canceled or failed moments ago can answer HTTP 409 until the cluster has ended it; retry shortly. Returns HTTP 404 if no Frozen bridge has this UUID or the bridge has no delete with this ID.

Parameters

Name Description Required
filesystem_uuid The Frozen bridge's filesystem UUID, as `GET /v1/frozen/bridges/` reports it. Yes
id The delete's ID, as starting or listing the delete reports it. Yes

Response

Codes

Code Description
204 Return value on success