Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Evict existing replica by file Id Deprecated

DELETE /replicas-id/{id}

This enpoint is deprecated, please use this one.

Evicts a replica of a file specified by file Id in id parameter. This operation is asynchronous. Optional argument migration_provider_id can be used to specify where the repliace has to be replicated before being evicted from this provider.

If the id parameter specifies a directory, entire directory is evicted.

This operation requires space_schedule_eviction privilege when scheduling eviction and also space_schedule_replication when scheduling migration.

Example cURL requests

Evict file replica by Id from specific storage provider

curl -X DELETE -H "X-Auth-Token: $TOKEN" -H 'Content-type: application/json' \
"https://$HOST/api/v3/oneprovider/replicas-id/$FILE_ID?provider_id=$PROVIDER_ID"


{ "transferId": "b3c85b99-44db-4277-8c66-2ccd50888565" }

Path parameters

Parameter Type & Description
id required
string

Id of the file.

Query parameters

Parameter Type & Description
provider_id
string

The Id of the provider from which the replica will be evicted. By default the replica will be evicted in the provider handling this REST call.
migration_provider_id
string

The Id of the provider to which the file should be replicated before being evicted.

Request Examples

Shell
oneprovider-rest-cli evictReplicaById id=$FILE_ID migration_provider_id=$MIGRATION_PROVIDER_ID

Responses

application/json
201

The replica removal has been accepted and the result is the transfer Id, which can be used for monitoring the transfer status. Also URI of the new transfer in form https://$HOST/api/v3/oneprovider/transfers/{tid} is returned in the response Location header.

PropertyType & Description
transferId
string

Transfer Id.

400

Invalid request.

PropertyType & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
403

Forbidden request.

PropertyType & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
404

Oneprovider REST API not available.

PropertyType & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
500

Internal server error.

PropertyType & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}