Source Files

Delete File

Required scopes: project.source.file (Read and Write).

delete/projects/{projectId}/files/{fileId}

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

fileIdinteger required

File Identifier. Get via List Files

Headers

Preferstring
Example:respond-async

[Recommended] Set to respond-async (RFC 7240) to delete asynchronously. The endpoint then returns 202 with a delete operation to poll.

Response

Accepted for asynchronous processing (when Prefer: respond-async is sent)

Example response

{
  "data": {
    "identifier": "50fb3506-4127-4ba8-8296-f97dc7e3e0c3",
    "status": "finished",
    "progress": 100,
    "attributes": {
      "branchId": 12000
    },
    "createdAt": "2019-09-23T11:26:54+00:00",
    "updatedAt": "2019-09-23T11:26:54+00:00",
    "startedAt": "2019-09-23T11:26:54+00:00",
    "finishedAt": "2019-09-23T11:26:54+00:00",
    "error": {
      "message": "2 files are being processed by another process and could not be deleted."
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.