Delete a File
DELETE/files/:file_id
Delete a file uploaded by the authenticated client or user.
Request
Path Parameters
DELETE /files/:file_id parameter
Responses
- 200
- 400
DELETE /files/:file_id Successful response
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [1.0
]
The version of the response schema
Possible values: [deleted
]
Returns a single object of the file resource which was deleted.
Possible values: [file
]
Data contains the file resource.
data objectrequired
The resource data that was deleted.
The unique identifier of the file
Possible values: [file
]
Possible values: non-empty
The complete filename including the file extension
Possible values: non-empty
The mime type of the file
The signed read url of the file
metadata object
A provided lookup key provided by you to help you identify the file.
UTC datetime ISO string
UTC datetime ISO string
{
"version": "1.0",
"result_type": "deleted",
"resource_type": "file",
"data": {
"id": "ceucrxwph3adg4wozujexample",
"resource_type": "file",
"filename": "my-file.pdf",
"mime_type": "application/pdf",
"url": "https://zigned.se",
"metadata": {
"lookup_key": "file_tag"
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-01-01T00:00:00.000Z"
}
}
DELETE /files/:file_id Error response
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [error
]
error objectrequired
Possible values: >= 400
and <= 599
{
"status": "error",
"error": {
"code": 0,
"message": "string",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}