Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Delete archive

POST /archives/{aid}/delete

Initializes process of purging an archive. First, the archived data is deleted from the storage, then all the information concerning the archive is deleted. The process may be time consuming therefore it is possible to pass callback URL on which the POST request will be performed to notify that the process has finished. The callback request will include JSON {"archiveId": $ARCHIVE_ID} as a body to determine which archive has been deleted.

This operation requires space_manage_datasets and space_remove_archives privileges.

Example cURL requests

Delete archive

curl -H "X-Auth-Token: $TOKEN" -X POST "https://$PROVIDER_HOST/api/v3/oneprovider/archives/$ARCHIVE_ID/delete" \
-H "Content-Type: application/json" -d '{
    "deletedCallback": "https://example.org/deleted_archives"
}'

Path parameters

Parameter	Type & Description
aid required	string Id of a specific archive to be deleted.

Request body

application/json

Parameters for initializing purging of an archive.

Property Type & Description

Property	Type & Description
deletedCallback string (ArchiveDeletedCallback) URL on which POST request will be performed to notify that process of purging an archive has finished. The callback request will include body in the following JSON format: `{ "archiveId": "$ARCHIVE_ID", "datasetId": "$DATASET_ID", "error": "Error description" }` `"error"` field will have `null` value if purging of an archive has been finished successfully. Requested server should response with one of `2xx` HTTP codes. If the request fails or returns any other HTTP code, it will be retried.

deletedCallback

string (ArchiveDeletedCallback)

URL on which POST request will be performed to notify that process of purging an archive has finished. The callback request will include body in the following JSON format:

{
    "archiveId": "$ARCHIVE_ID",
    "datasetId": "$DATASET_ID",
    "error": "Error description"
}

"error" field will have null value if purging of an archive has been finished successfully.

Requested server should response with one of 2xx HTTP codes. If the request fails or returns any other HTTP code, it will be retried.

Request Examples

application/json

{
  "deletedCallback": "https://example.org/deleted_archives"
}

Responses

application/json

204

The request has been accepted and the process of purging an archive has started.

400

Invalid request.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

403

Forbidden request.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

404

Archive not found.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

500

Internal server error.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}