API Documentation

Key-value Store

Simple key-value data store as a service for serverless apps, small apps, metrics, and IoT.

POST Set Key

Set Key

Save or Update a Key, You can store a maximum of (500 keys free account or 50,000 Premium account) per space and 50,000 spaces.
Keys not updated expire after "expire_in" value (timestamp)

POST https://api.happi.dev/v1/store/:space/

Parameters

API Key * Text
You can also send your API key using the header x-happi-key.

Get your free API key here

space * string
ℹ️ Space Name
key * string
ℹ️ Key Name (Max 15 Chars)
value * string
ℹ️ Value (Max [16K Free / 512K Premiun] Chars)
Headers
JSON Response

Response Definition

{
  "success": boolean,
  "data": {
    "space": text,
    "key": text,
    "value": text,
    "expire_in": timestamp
  }
}

Error Response

Check http response code
{
  "success": boolean,
  "error": text
}
POST Rename Space

Rename Space

Update space name to another

POST https://api.happi.dev/v1/store/:space/:newspace

Parameters

API Key * Text
You can also send your API key using the header x-happi-key.

Get your free API key here

space * string
ℹ️ Space Name
newspace * string
ℹ️ New space name
Headers
JSON Response

Response Definition

{
  "success": boolean,
  "renamed": {
    "from": text,
    "to": text
  }
}

Error Response

Check http response code
{
  "success": boolean,
  "error": text
}
GET Get Key

Get Key

Get key

GET https://api.happi.dev/v1/store/:space/:key

Parameters

API Key * Text
You can also send your API key using the header x-happi-key.

Get your free API key here

space * string
ℹ️ Space Name
key * string
ℹ️ Key Name
Headers
JSON Response

Response Definition

{
  "success": boolean,
  "data": {
    "space": text,
    "key": text,
    "value": text,
    "expire_in": timestamp
  }
}

Error Response

Check http response code
{
  "success": boolean,
  "error": text
}
GET Get Space

Get Space

Get all keys into space

GET https://api.happi.dev/v1/store/:space

Parameters

API Key * Text
You can also send your API key using the header x-happi-key.

Get your free API key here

space * string
ℹ️ Space Name
detailsboolean
ℹ️ Return Details
Headers
JSON Response

Response Definition

Details = false

{
  "success": boolean,
  "space": text,
  "length": integer,
  "keys": {
    text:text
  }
}

Details = true

{
  "success": boolean,
  "space": text,
  "length": integer,
  "keys": [
    {
      "key": text,
      "value": text,
      "expire_in": timestamp
    },
 ]
}

Error Response

Check http response code
{
  "success": boolean,
  "error": text
}
GET Get list of spaces

Get list of spaces

Get all spaces created

GET https://api.happi.dev/v1/store/

Parameters

API Key * Text
You can also send your API key using the header x-happi-key.

Get your free API key here

Headers
JSON Response

Response Definition

Details = false

{
  "success": boolean,
  "spaces": array,
  "length": integer
}

Error Response

Check http response code
{
  "success": boolean,
  "error": text
}
DELETE Delete Space

Delete Space

Delete all keys into space

DELETE https://api.happi.dev/v1/store/:space

Parameters

API Key * Text
You can also send your API key using the header x-happi-key.

Get your free API key here

space * string
ℹ️ Space Name
Headers
JSON Response

Response Definition

{
  "success": boolean,
  "deleted": integer
}

Error Response

Check http response code
{
  "success": boolean,
  "error": text
}
DELETE Delete Key

Delete Key

Delete key from space

DELETE https://api.happi.dev/v1/store/:space/:key

Parameters

API Key * Text
You can also send your API key using the header x-happi-key.

Get your free API key here

space * string
ℹ️ Space Name
key * string
ℹ️ Key Name
Headers
JSON Response

Response Definition

{
  "success": boolean,
  "deleted": integer
}

Error Response

Check http response code
{
  "success": boolean,
  "error": text
}
Title Messsage