2.3. Open API

2.3.1. Accessor Service

2.3.1.1. Internal API / Bucket

GET /ccs/internal

List all buckets in repository

List all buckets in repository

Example request:

GET /ccs/internal HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

GET /ccs/internal/{bucketName}

Get bucket metadata

Get bucket metadata

Parameters:

• bucketName (string) –

Example request:

GET /ccs/internal/{bucketName} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Bucket not found

• 410 Gone – Bucket deleted

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

HEAD /ccs/internal/{bucketName}

Check if bucket exist

Check if bucket exist (fullcheck true implies check down to Storage) and return BUCKET/NONE in header

Parameters:

• bucketName (string) –

Query Parameters:

• fullCheck (boolean) – If True implies Storage checking

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Bucket not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-type – Type as StorageType

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

2.3.1.2. Internal API / Directory or Object

PUT /ccs/internal/{bucketName}

List objects from filter

List objects from filter as a Stream of Json lines

Parameters:

• bucketName (string) –

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Bucket not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-namePrefix – Filter based on name prefix

• x-clonecloudstore-statuses – Filter based on list of status

• x-clonecloudstore-creationBefore – Filter based on creation before

• x-clonecloudstore-creationAfter – Operation Filter based on creation after

• x-clonecloudstore-expiresBefore – Operation Filter based on expires before

• x-clonecloudstore-expiresAfter – Operation Filter based on expires after

• x-clonecloudstore-sizeLT – Operation Filter based on size less than

• x-clonecloudstore-sizeGT – Operation Filter based on size greater than

• x-clonecloudstore-metadataEq – Filter based on metadatata containing

• Accept-Encoding –

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

GET /ccs/internal/{bucketName}/{objectName}

Get object

Get object binary with type application/octet-stream and get object metadata with type application/json

Parameters:

• bucketName (string) –

• objectName (string) –

Example request:

GET /ccs/internal/{bucketName}/{objectName} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "site": "string",
      "bucket": "string",
      "name": "string",
      "hash": "string",
      "status": "UNKNOWN",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "size": 1,
      "metadata": {}
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Object not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

• Accept-Encoding – May contain ZSTD for compression

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-id – Id

• x-clonecloudstore-site – Site

• x-clonecloudstore-bucket – Bucket Name

• x-clonecloudstore-name – Object Name

• x-clonecloudstore-creation – Creation Date

• x-clonecloudstore-size – Object Size

• x-clonecloudstore-hash – Object Hash SHA-256

• x-clonecloudstore-metadata – Object Metadata

• x-clonecloudstore-status – Object Status

• x-clonecloudstore-expires – Expiration Date

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

HEAD /ccs/internal/{bucketName}/{pathDirectoryOrObject}

Check if object or directory exist

Check if object or directory exist (fullCheck true implies check down to Storage)

Parameters:

• bucketName (string) –

• pathDirectoryOrObject (string) –

Query Parameters:

• fullCheck (boolean) – If True implies Storage checking

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-type – Type as StorageType

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

2.3.1.3. Public API / Bucket

GET /cloudclonestore

List all buckets in repository

List all buckets in repository

Example request:

GET /cloudclonestore HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

GET /cloudclonestore/{bucketName}

Get bucket metadata

Get bucket metadata

Parameters:

• bucketName (string) –

Example request:

GET /cloudclonestore/{bucketName} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Bucket not found

• 410 Gone – Bucket deleted

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

POST /cloudclonestore/{bucketName}

Create bucket

Create bucket in storage

Parameters:

• bucketName (string) –

Status Codes:

• 201 Created –

  Bucket created

  Example response:

  HTTP/1.1 201 Created
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad request

• 401 Unauthorized – Unauthorized

• 409 Conflict – Bucket already exist

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

DELETE /cloudclonestore/{bucketName}

Delete bucket

Delete bucket in storage

Parameters:

• bucketName (string) –

Status Codes:

• 204 No Content – Bucket deleted

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Bucket not found

• 406 Not Acceptable – Bucket found but not empty

• 410 Gone – Bucket deleted

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

HEAD /cloudclonestore/{bucketName}

Check if bucket exist

Check if bucket exist and return BUCKET/NONE in header

Parameters:

• bucketName (string) –

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Bucket not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-type – Type as StorageType

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

2.3.1.4. Public API / Directory or Object

PUT /cloudclonestore/{bucketName}

List objects from filter

List objects from filter as a Stream of Json lines

Parameters:

• bucketName (string) –

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Bucket not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-namePrefix – Filter based on name prefix

• x-clonecloudstore-statuses – Filter based on list of status

• x-clonecloudstore-creationBefore – Filter based on creation before

• x-clonecloudstore-creationAfter – Operation Filter based on creation after

• x-clonecloudstore-expiresBefore – Operation Filter based on expires before

• x-clonecloudstore-expiresAfter – Operation Filter based on expires after

• x-clonecloudstore-sizeLT – Operation Filter based on size less than

• x-clonecloudstore-sizeGT – Operation Filter based on size greater than

• x-clonecloudstore-metadataEq – Filter based on metadatata containing

• Accept-Encoding –

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

GET /cloudclonestore/{bucketName}/{objectName}

Get object

Get object binary with type application/octet-stream and get object metadata with type application/json

Parameters:

• bucketName (string) –

• objectName (string) –

Example request:

GET /cloudclonestore/{bucketName}/{objectName} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "site": "string",
      "bucket": "string",
      "name": "string",
      "hash": "string",
      "status": "UNKNOWN",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "size": 1,
      "metadata": {}
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Object not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

• Accept-Encoding – May contain ZSTD for compression

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-id – Id

• x-clonecloudstore-site – Site

• x-clonecloudstore-bucket – Bucket Name

• x-clonecloudstore-name – Object Name

• x-clonecloudstore-creation – Creation Date

• x-clonecloudstore-size – Object Size

• x-clonecloudstore-hash – Object Hash SHA-256

• x-clonecloudstore-metadata – Object Metadata

• x-clonecloudstore-status – Object Status

• x-clonecloudstore-expires – Expiration Date

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

POST /cloudclonestore/{bucketName}/{objectName}

Create object

Create object

Parameters:

• bucketName (string) –

• objectName (string) –

Status Codes:

• 201 Created –

  OK

  Example response:

  HTTP/1.1 201 Created
  Content-Type: application/json
  
  {
      "id": "string",
      "site": "string",
      "bucket": "string",
      "name": "string",
      "hash": "string",
      "status": "UNKNOWN",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "size": 1,
      "metadata": {}
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 406 Not Acceptable – Object already in creation

• 409 Conflict – Conflict since Object already exist or invalid

• 500 Internal Server Error – Internal Error

Request Headers:

• Content-Encoding – May contain ZSTD for compression

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-bucket – Bucket Name

• x-clonecloudstore-name – Object Name

• x-clonecloudstore-size – Object Size

• x-clonecloudstore-hash – Object Hash

• x-clonecloudstore-metadata – Object Metadata as Json from Map<String,String>

• x-clonecloudstore-expires – Expiration Date

• x-clonecloudstore-id –

• x-clonecloudstore-site –

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

DELETE /cloudclonestore/{bucketName}/{objectName}

Delete object

Delete object

Parameters:

• bucketName (string) –

• objectName (string) –

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Object not found

• 406 Not Acceptable – Bucket is not empty

• 409 Conflict – Conflict since Object status not compatible with Operation

• 410 Gone – Object already deleted

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

HEAD /cloudclonestore/{bucketName}/{pathDirectoryOrObject}

Check if object or directory exist

Check if object or directory exist

Parameters:

• bucketName (string) –

• pathDirectoryOrObject (string) –

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-type – Type as StorageType

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

2.3.2. Accessor Simple Gateway Service

2.3.2.1. Public API / Bucket

GET /cloudclonestore

List all buckets in repository

List all buckets in repository

Example request:

GET /cloudclonestore HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

GET /cloudclonestore/{bucketName}

Get bucket metadata

Get bucket metadata

Parameters:

• bucketName (string) –

Example request:

GET /cloudclonestore/{bucketName} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Bucket not found

• 410 Gone – Bucket deleted

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

POST /cloudclonestore/{bucketName}

Create bucket

Create bucket in storage

Parameters:

• bucketName (string) –

Status Codes:

• 201 Created –

  Bucket created

  Example response:

  HTTP/1.1 201 Created
  Content-Type: application/json
  
  {
      "id": "string",
      "clientId": "string",
      "site": "string",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "status": "UNKNOWN"
  }
  

• 400 Bad Request – Bad request

• 401 Unauthorized – Unauthorized

• 409 Conflict – Bucket already exist

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

DELETE /cloudclonestore/{bucketName}

Delete bucket

Delete bucket in storage

Parameters:

• bucketName (string) –

Status Codes:

• 204 No Content – Bucket deleted

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Bucket not found

• 406 Not Acceptable – Bucket found but not empty

• 410 Gone – Bucket deleted

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

HEAD /cloudclonestore/{bucketName}

Check if bucket exist

Check if bucket exist and return BUCKET/NONE in header

Parameters:

• bucketName (string) –

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Bucket not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-type – Type as StorageType

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

2.3.2.2. Public API / Directory or Object

PUT /cloudclonestore/{bucketName}

List objects from filter

List objects from filter as a Stream of Json lines

Parameters:

• bucketName (string) –

Example request:

PUT /cloudclonestore/{bucketName} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "sSL": true,
    "paramsCharset": "string",
    "expectMultipart": true,
    "ended": true
}

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Bucket not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-namePrefix – Filter based on name prefix

• x-clonecloudstore-statuses – Filter based on list of status

• x-clonecloudstore-creationBefore – Filter based on creation before

• x-clonecloudstore-creationAfter – Operation Filter based on creation after

• x-clonecloudstore-expiresBefore – Operation Filter based on expires before

• x-clonecloudstore-expiresAfter – Operation Filter based on expires after

• x-clonecloudstore-sizeLT – Operation Filter based on size less than

• x-clonecloudstore-sizeGT – Operation Filter based on size greater than

• x-clonecloudstore-metadataEq – Filter based on metadatata containing

• Accept-Encoding –

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

GET /cloudclonestore/{bucketName}/{objectName}

Get object

Get object binary with type application/octet-stream and get object metadata with type application/json

Parameters:

• bucketName (string) –

• objectName (string) –

Example request:

GET /cloudclonestore/{bucketName}/{objectName} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "sSL": true,
    "paramsCharset": "string",
    "expectMultipart": true,
    "ended": true
}

Example request:

GET /cloudclonestore/{bucketName}/{objectName} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "site": "string",
      "bucket": "string",
      "name": "string",
      "hash": "string",
      "status": "UNKNOWN",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "size": 1,
      "metadata": {}
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Object not found

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

• Accept-Encoding – May contain ZSTD for compression

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-id – Id

• x-clonecloudstore-site – Site

• x-clonecloudstore-bucket – Bucket Name

• x-clonecloudstore-name – Object Name

• x-clonecloudstore-creation – Creation Date

• x-clonecloudstore-size – Object Size

• x-clonecloudstore-hash – Object Hash SHA-256

• x-clonecloudstore-metadata – Object Metadata

• x-clonecloudstore-status – Object Status

• x-clonecloudstore-expires – Expiration Date

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

POST /cloudclonestore/{bucketName}/{objectName}

Create object

Create object

Parameters:

• bucketName (string) –

• objectName (string) –

Status Codes:

• 201 Created –

  OK

  Example response:

  HTTP/1.1 201 Created
  Content-Type: application/json
  
  {
      "id": "string",
      "site": "string",
      "bucket": "string",
      "name": "string",
      "hash": "string",
      "status": "UNKNOWN",
      "creation": "2024-02-21T11:27:52.867506",
      "expires": "2024-02-21T11:27:52.867506",
      "size": 1,
      "metadata": {}
  }
  

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 406 Not Acceptable – Object already in creation

• 409 Conflict – Conflict since Object already exist or invalid

• 500 Internal Server Error – Internal Error

Request Headers:

• Content-Encoding – May contain ZSTD for compression

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-bucket – Bucket Name

• x-clonecloudstore-name – Object Name

• x-clonecloudstore-size – Object Size

• x-clonecloudstore-hash – Object Hash

• x-clonecloudstore-metadata – Object Metadata as Json from Map<String,String>

• x-clonecloudstore-expires – Expiration Date

• x-clonecloudstore-id –

• x-clonecloudstore-site –

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

DELETE /cloudclonestore/{bucketName}/{objectName}

Delete object

Delete object

Parameters:

• bucketName (string) –

• objectName (string) –

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 404 Not Found – Object not found

• 406 Not Acceptable – Bucket is not empty

• 409 Conflict – Conflict since Object status not compatible with Operation

• 410 Gone – Object already deleted

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

HEAD /cloudclonestore/{bucketName}/{pathDirectoryOrObject}

Check if object or directory exist

Check if object or directory exist

Parameters:

• bucketName (string) –

• pathDirectoryOrObject (string) –

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 403 Forbidden – Forbidden

• 500 Internal Server Error – Internal Error

Request Headers:

• x-clonecloudstore-client-id – Client ID (Required)

• x-clonecloudstore-op-id – Operation ID

Response Headers:

• x-clonecloudstore-type – Type as StorageType

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message

• x-clonecloudstore-op-id – Operation ID

• x-clonecloudstore-module – Module Id

• x-clonecloudstore-error – Error Message