API Reference

Katapult Core API

Resources & Endpoints

Delete file storage volume

Delete a file storage volume.

DELETE
https://api.katapult.io/core/v1/file_storage_volumes/{file_storage_volume}

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

file_storage_volume Required

The file storage volume to destroy.

 File Storage Volume Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

file_storage_volume_not_found

No file storage volume was found matching any of the criteria provided in the arguments.

 404 Not Found

object_in_trash

The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.

 406 Not Acceptable

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

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
    }
    file_storage_volume: FileStorageVolume {
        id: String
        name: String
        data_center: DataCenter {
            id: String
            name: String
            permalink: String?
        }
        associations: [ String ]
        state: FileStorageVolumeStateEnum
        nfs_location: String?
        size: Integer?
    }
}