Platform
Forge / Reference / KVS/Custom Entity Store API

Forge provides hosted storage capabilities that let you store data in your app installation. The following hosted storage capabilities can be accessed by your remote via REST API calls:

  • Key-value store: lets you store data in key-value pairs.

  • Custom Entity Store : lets you store data based on custom data structures specific to your app’s needs and query patterns.

For detailed information about prerequisites, request shape, and error handling, see Accessing Forge storage via REST API.

Each installation of your app is subject to the API’s quotas and limits. See Storage quotas and Storage limits for more details.

Authentication and authorization

Requests to this API are processed by an authentication service that only accepts OAuth bearer tokens as authentication.

This service will return either of the following statuses in case of an error:

  • 401: Unauthorized: either your request provided an invalid or expired token, or was missing an Authorization header.

  • 403 Forbidden: your request used an invalid route. Either the route doesn't exist, or it points to a resource that can't be accessed by non-Atlassian services.

Your app must supply the OAuth token in the Authorization: Bearer {bearerToken} header of the request.

Quotas and limits

Forge hosted storage capabilities are subject to limits, usage, and syntax constraints. These include limits to the number of operations, key lengths, and object depth. Any request that exceeds a quota or limit will return a 429 status with an error code of RATE_LIMIT_EXCEEDED.

See Storage quotas and Storage limits for details about relevant constraints.

Rate this page: