Key Value | flxbl docs

flxbl docs

slack GitHub

Get the value for a given key

get

Authorizations

Path parameters

keystringRequired

Responses

200

The value has been successfully retrieved.

404

The key was not found.

500

Internal server error.

get

GET /sfp/api/key-value/{key} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Delete a key-value pair

delete

Authorizations

Path parameters

keystringRequired

Responses

204

The key-value pair has been successfully deleted.

404

The key was not found.

500

Internal server error.

delete

DELETE /sfp/api/key-value/{key} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Create a new key-value pair

post

Authorizations

Body

keystringOptional

valuestringOptional

Responses

201

The key-value pair has been successfully created.

application/json

409

The key already exists.

500

Internal server error.

post

POST /sfp/api/key-value HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "key": "text",
  "value": "text"
}

{
  "key": "text",
  "value": "text"
}

Create or update a key-value pair

post

Authorizations

Body

keystringOptional

valuestringOptional

Responses

200

The key-value pair has been successfully created or updated.

application/json

500

Internal server error.

post

POST /sfp/api/key-value/upsert HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "key": "text",
  "value": "text"
}

{
  "key": "text",
  "value": "text"
}

Update the value for a given key

put

Authorizations

Path parameters

keystringRequired

Body

valuestringOptional

Responses

200

The value has been successfully updated.

application/json

404

The key was not found.

500

Internal server error.

put

PUT /sfp/api/key-value/{key} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}

{
  "key": "text",
  "value": "text"
}