The Transaction API allows you to perform multiple operations on key-value pairs and/or custom entities in a single atomic transaction. This ensures that either all operations succeed or none do, maintaining data integrity.

Operations

POST/v1/transaction

POST

Execute transaction

Lets you perform a series of Key-Value Store and/or Custom Entity Store operations that must all succeed or fail together. This method supports 3 types of operations:

create or update data
delete data
check whether a specific Custom Entity condition is true

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

set

array<anyOf [SetTransactionTypedItemSchema, SetTransactionUntypedItemSchema]>

delete

array<anyOf [BaseTransactionTypedItemSchema, BaseTransactionUntypedItemSchema]>

check

array<allOf [BaseTransactionTypedItemSchema, object]>

Responses

Successfully completed all the node operations

POST/v1/transaction

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/forge/storage/kvs/v1/transaction' \
  --header 'Content-Type: application/json' \
  --data '{
  "set": [
    {
      "key": "<string>",
      "value": "<string>",
      "entityName": "<string>",
      "conditions": {}
    }
  ],
  "delete": [
    {
      "key": "<string>",
      "entityName": "<string>",
      "conditions": {}
    }
  ],
  "check": [
    {
      "key": "<string>",
      "entityName": "<string>",
      "conditions": {}
    }
  ]
}'