5.3. Open API

5.3.1. Administration API / Ownership

DELETE /administration/ownerships/{bucket}

Delete an Ownership for all client for this bucket

Delete an Ownership for all client for this bucket

Parameters:

• bucket (string) –

Status Codes:

• 204 No Content – Successfully deleted Ownership

• 400 Bad Request – Ownership not valid

• 404 Not Found – Ownership not found

• 500 Internal Server Error – Internal server error

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 /administration/ownerships/{client}

Get list of ownerships

Get list of ownerships in the administration

Parameters:

• client (string) –

Query Parameters:

• ownership (string) –

Example request:

GET /administration/ownerships/{client} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  Successfully retrieved list of ownerships

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {
          "client": "string",
          "bucket": "string",
          "ownership": "e"
      }
  ]
  

• 500 Internal Server Error – Internal server error

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

GET /administration/ownerships/{client}/{bucket}

Get an Ownership

Get an Ownership

Parameters:

• bucket (string) –

• client (string) –

Example request:

GET /administration/ownerships/{client}/{bucket} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  Successfully retrieved Ownership

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  e
  

• 400 Bad Request – Ownership not valid

• 404 Not Found – Ownership not found

• 500 Internal Server Error – Internal server error

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

DELETE /administration/ownerships/{client}/{bucket}

Delete an Ownership

Delete an Ownership

Parameters:

• bucket (string) –

• client (string) –

Status Codes:

• 204 No Content – Successfully deleted Ownership

• 400 Bad Request – Ownership not valid

• 404 Not Found – Ownership not found

• 500 Internal Server Error – Internal server error

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

PUT /administration/ownerships/{client}/{bucket}/{ownership}

Update an Ownership

Update an Ownership

Parameters:

• bucket (string) –

• client (string) –

• ownership (string) –

Status Codes:

• 202 Accepted – Successfully update Ownership

• 400 Bad Request – Ownership not valid

• 404 Not Found – Ownership not found

• 500 Internal Server Error – Internal server error

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

POST /administration/ownerships/{client}/{bucket}/{ownership}

Add an Ownership

Add an Ownership

Parameters:

• bucket (string) –

• client (string) –

• ownership (string) –

Status Codes:

• 201 Created – Successfully added ownership

• 400 Bad Request – Ownership not valid

• 500 Internal Server Error – Internal server error

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

5.3.2. Administration API / Topology

GET /administration/topologies

Get list of remote sites from topology

Get list of remote sites from topology

Query Parameters:

• status (string) –

Example request:

GET /administration/topologies HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  Successfully retrieved list from topology

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {
          "id": "string",
          "name": "string",
          "uri": "string",
          "status": "UP"
      }
  ]
  

• 500 Internal Server Error – Internal server error

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

PUT /administration/topologies

Update a remote site into topology

Update a remote site into topology

Example request:

PUT /administration/topologies HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": "string",
    "name": "string",
    "uri": "string",
    "status": "UP"
}

Status Codes:

• 202 Accepted – Successfully updated remote site status

• 400 Bad Request – Remote site not valid

• 404 Not Found – Remote site not found

• 500 Internal Server Error – Internal server error

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

POST /administration/topologies

Add a remote site to topology

Add a remote site to topology

Example request:

POST /administration/topologies HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": "string",
    "name": "string",
    "uri": "string",
    "status": "UP"
}

Status Codes:

• 201 Created – Successfully added remote site

• 400 Bad Request – Remote site not valid

• 500 Internal Server Error – Internal server error

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

GET /administration/topologies/{site}

Get a remote site from topology

Get a remote site from topology based on its site

Parameters:

• site (string) –

Example request:

GET /administration/topologies/{site} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  Successfully retrieved Remote site

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "id": "string",
      "name": "string",
      "uri": "string",
      "status": "UP"
  }
  

• 400 Bad Request – Remote site id not valid

• 404 Not Found – Remote site not found

• 500 Internal Server Error – Internal server error

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

DELETE /administration/topologies/{site}

Delete a remote site from topology

Delete a remote site from topology

Parameters:

• site (string) –

Status Codes:

• 204 No Content – Successfully deleted Remote site

• 400 Bad Request – Remote site not valid

• 404 Not Found – Remote site not found

• 500 Internal Server Error – Internal server error

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