Storage API¶

Overview¶

This document describes storage API

Version : 1.0.0

Schemes : HTTPS, HTTP

POST /api/storage/kv

Type	Name	Description	Schema
Body	Value required	Value to be inserted into the storage	Value

Type	Name
Unknown	basic_auth

/api/storage/kv

{
  "value" : "valueA"
}

{
  "value" : "ABCD-1234"
}

{
  "Incorrect value" : {
    "error_code" : 8002,
    "error_message" : "Storage value cannot be empty"
  }
}

{
  "Missing field" : {
    "error_code" : 1001,
    "error_message" : "API currently disabled"
  }
}

GET /api/storage/kv/{key_id}

Type	Name	Schema
Path	key_id required	string

HTTP Code	Description	Schema
200	Value successfully retrieved	Value
401	Unauthorized	No Content
404	Not found	ErrorResponse
405	Method not allowed	No Content
503	Feature disabled	ErrorResponse

Type	Name
Unknown	basic_auth

/api/storage/kv/string

{
  "value" : "valueA"
}

{
  "Non existing key" : {
    "error_code" : 8001,
    "error_message" : "A value for the given key does not exists"
  }
}

{
  "Missing field" : {
    "error_code" : 1001,
    "error_message" : "Storage API is disabled"
  }
}

Name	Description	Schema
error_code optional	Example : `8001`	integer (int32)
error_message optional	Example : `"Requested feature is currently not available"`	string

Name	Description	Schema
value optional	Key under which the provided value has been stored Example : `"ABCD-1234"`	string

Name	Description	Schema
value required	Value to be inserted into the storage Example : `"valueA"`	string