API Reference

Katapult Core API

Resources & Endpoints

Purge a trash object

Purge a specific trash object.

DELETE
https://api.katapult.io/core/v1/trash_objects/{trash_object}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

trash_object Required

The trash object to purge

 Trash Object Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

task_queueing_error

This error means that a background task that was needed to complete your request could not be queued

 406 Not Acceptable

trash_object_not_found

No trash object was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    task: Task {
        id: String
        name: String
        status: TaskStatusEnum
        created_at: Unix Timestamp
        started_at: Unix Timestamp?
        finished_at: Unix Timestamp?
        progress: Integer
    }
}