Volumes

Retrieve all volumes

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
site	string Send the request to the specfifed site
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/volumes

Response samples

200

- id: myapp:mysvc-1:persistent-storage
  sites:
    - name: gothenburg-bergakungen
      type: persistent
      size: 1GB
      used-by:
        - application: myapp
          service-instance: mysvc-1

Retrieve a volume

SecurityaccessToken

Request

path Parameters

volume-id

required

string

The identifier is a string of format application:service-I:volume, where application is an application name, service is a service name, I is an instance index and volume is the name of the volume declared by the service.

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
site	string Send the request to the specfifed site

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/volumes/{volume-id}

Response samples

200

id: myapp:mysvc-1:persistent-storage
sites:
  - name: gothenburg-bergakungen
    type: persistent
    size: 1GB
    used-by:
      - application: myapp
        service-instance: mysvc-1

Invoke the delete-from-all-sites operation

Explicitly delete the volume from all the sites where this volume is identified as persistent and unused (the corresponding service instance is not running).

SecurityaccessToken

Request

path Parameters

volume-id

required

string

The identifier is a string of format application:service-I:volume, where application is an application name, service is a service name, I is an instance index and volume is the name of the volume declared by the service.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/volumes/{volume-id}/delete-from-all-sites

Response samples

200

successful:
  - site: gothenburg-bergakungen
  - site: helsingborg-roda-kvarn
skipped:
  - site: stockholm-sergel
    reason: the volume is in use

Invoke the delete operation

Explicitly delete the volume and all data stored in it from the site. Only valid for persistent volumes which are unused (the corresponding service instance is not running).

SecurityaccessToken

Request

path Parameters

volume-id required	string The identifier is a string of format `application:service-I:volume`, where `application` is an application name, `service` is a service name, `I` is an instance index and `volume` is the name of the volume declared by the service.
site-name required	string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$ name of site

query Parameters

site	string Send the request to the specfifed site

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/volumes/{volume-id}/sites/{site-name}/delete