The Key-Value Store provides simple storage for key/value pairs. Use this to persistently store data that you'd like to retrieve through the Query operation.
Gets a value by key.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccessfully retrieved the value corresponding to the key
1
2
3
4
5
6
7
curl --request POST \
--url 'https://api.atlassian.com/forge/storage/kvs/v1/get' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>"
}'1
2
3
4
{
"key": "<string>",
"value": "<string>"
}Stores a JSON value with a specified key. Forge resolves write conflicts using a last-write-wins strategy.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredoneOf [string, boolean, number, array<undefined>, object]
RequiredSuccessfully set the value to the corresponding key
1
2
3
4
5
6
7
curl --request POST \
--url 'https://api.atlassian.com/forge/storage/kvs/v1/set' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"value": "<string>"
}'Deletes a value by key. Write conflicts are resolved using a last-write-wins strategy.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccessfully deleted the key and the corresponding value
1
2
3
4
5
6
curl --request POST \
--url 'https://api.atlassian.com/forge/storage/kvs/v1/delete' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>"
}'Retrieve key-value pairs matching the provided list of criteria. This method does not return secret values set by Set secret value.
Forge and OAuth2 apps cannot access this REST resource.
number
string
array<WhereCondition>
Successfully retrieved the data from storage
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request POST \
--url 'https://api.atlassian.com/forge/storage/kvs/v1/query' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"limit": 2154,
"after": "<string>",
"where": [
{
"condition": "BEGINS_WITH",
"property": "key",
"values": [
"<string>"
]
}
]
}'1
2
3
4
5
6
7
8
9
{
"cursor": "<string>",
"data": [
{
"key": "<string>",
"value": "<string>"
}
]
}Gets a value by key, which was stored using Set secret value by key. The value is decrypted before being returned.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccessfully retrieved the decrypted value corresponding to the key
1
2
3
4
5
6
7
curl --request POST \
--url 'https://api.atlassian.com/forge/storage/kvs/v1/secret/get' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>"
}'1
2
3
4
{
"key": "<string>",
"value": "<string>"
}Store sensitive credentials in JSON format, with encryption. Values set with this method can only be accessed with Get secret value by key. Write conflicts are resolved using a last-write-wins strategy.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredoneOf [string, boolean, number, array<undefined>, object]
RequiredSuccessfully set the value to the corresponding key with encryption
1
2
3
4
5
6
7
curl --request POST \
--url 'https://api.atlassian.com/forge/storage/kvs/v1/secret/set' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"value": "<string>"
}'Deletes a secret value by key.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccessfully deleted the key and the corresponding encrypted value
1
2
3
4
5
6
curl --request POST \
--url 'https://api.atlassian.com/forge/storage/kvs/v1/secret/delete' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>"
}'Rate this page: