StediDOCS
This product is in Developer Preview

Stash

Stash API specification.

For more information, read the Getting Started Guide.

All API endpoints are POST operations and any parameters must be fully contained in the request body.

Download OpenAPI

Create Keyspace

POST/CreateKeyspace
Create a new Keyspace. Keyspace names are unique to a Stedi account.
Request body

application/json

keyspaceName
Requiredstring
The name that identifies the Keyspace

Example

POST
https://stash.stedi.com/2022-04-20/CreateKeyspace

Delete Keyspace

POST/DeleteKeyspace
Delete a Keyspace.
Request body

application/json

keyspaceName
Requiredstring
The name that identifies the Keyspace

Example

POST
https://stash.stedi.com/2022-04-20/DeleteKeyspace

Delete Value

POST/DeleteValue

Delete a value in a table. This operation also returns the value as it existed in the moment before it was deleted.

Request body

application/json

key
Requiredstring
The Key to set or get a Value with
keyspaceName
Requiredstring
The name that identifies the Keyspace

Example

POST
https://stash.stedi.com/2022-04-20/DeleteValue

Get Keyspace

POST/GetKeyspace
Get a Keyspace.
Request body

application/json

keyspaceName
Requiredstring
The name that identifies the Keyspace

Example

POST
https://stash.stedi.com/2022-04-20/GetKeyspace

Get Value

POST/GetValue

Get a Value from a Keyspace. Always returns the latest Value that has been stored. Empty object is returned when the given key does not exist.

Request body

application/json

key
Requiredstring
The Key to set or get a Value with
keyspaceName
Requiredstring
The name that identifies the Keyspace

Example

POST
https://stash.stedi.com/2022-04-20/GetValue

List Keyspaces

POST/ListKeyspaces
List all the Keyspaces.
Request body

application/json

nextPageToken
Optionalstring

Example

POST
https://stash.stedi.com/2022-04-20/ListKeyspaces

List Values

POST/ListValues
List all the Values in a Keyspace.
Request body

application/json

keyspaceName
Requiredstring
The keyspace name
nextPageToken
Optionalstring

Example

POST
https://stash.stedi.com/2022-04-20/ListValues

Set Value

POST/SetValue

Set a Value in a Keyspace.

This operation will overwrite any previous Values that have been stored in the same Key.

Request body

application/json

key
Requiredstring
The Key to set or get a Value with
keyspaceName
Requiredstring
The name that identifies the Keyspace
value
RequiredAny

The value associated with the key.

Can be any one of:

  • string
  • number
  • boolean
  • array
  • object

Only numbers that can be represented using 64-bit floats are supported (IEEE-754). For larger numbers or higher precision, consider storing them as a string instead.

Example

POST
https://stash.stedi.com/2022-04-20/SetValue