API Reference

Katapult Core API

Resources & Endpoints

Restore a trash object

Restore a trashed object to its original location.

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

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 restore

 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

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.

{
    trash_object: TrashObject {
        id: String
        keep_until: Unix Timestamp
        object_id: String
        object_type: String
    }
}