{"openapi":"3.0.3","info":{"title":"Forge Containers API","description":"The Forge Containers Public API\n\n**Important:** The API base URL should be read from the `FORGE_EGRESS_PROXY_URL` environment variable.\nThe localhost URL in the servers section is for documentation purposes only.\n","version":"1.0.0","contact":{"name":"Atlassian Forge Team"}},"servers":[{"url":"{FORGE_EGRESS_PROXY_URL}","variables":{"FORGE_EGRESS_PROXY_URL":{"default":"http://localhost:7072","description":"The base URL for the Egress Proxy."}},"description":"Egress Proxy\n\n**Note:** The actual URL should be read from the `FORGE_EGRESS_PROXY_URL` environment variable.\nThe localhost URL shown here is for documentation purposes only.\n"}],"security":[{"ForgeProxyAuthorization":[]}],"tags":[{"name":"App Installations","description":"APIs for accessing installations information."},{"name":"Atlassian GraphQL","description":"Atlassian GraphQL API endpoints for accessing cross-product data and relationships.\n\n**API Documentation:** [Atlassian GraphQL API](https://developer.atlassian.com/platform/atlassian-graphql-api/graphql/)\n\nThe Atlassian GraphQL API allows you to access all sorts of Atlassian data including Jira projects, Bitbucket repositories, \nOpsgenie teams, and cross-product work activities using one common mechanism through the Atlassian GraphQL Gateway.\nUse the `/atlassian/graphql/{target}` endpoint to proxy requests to the Atlassian GraphQL API.\n"},{"name":"Confluence","description":"Confluence API endpoints for accessing Confluence Cloud platform functionality.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n\nThe Confluence API provides comprehensive access to pages, spaces, users, comments, and other Confluence resources.\nUse the `/confluence/{target}` endpoint to proxy requests to the Confluence REST API.\n"},{"name":"Forge Context","description":"APIs for retrieving Forge invocation Context"},{"name":"Forge Dynamic Modules","description":"Forge Dynamic Modules API for managing dynamic modules"},{"name":"Forge Events","description":"Forge async events endpoints for submitting events to queues"},{"name":"Forge KVS","description":"Forge Key-Value Store (KVS) API endpoints for storing and retrieving data in key-value pairs.\n\nAPI Documentation: Forge REST API - KVS/Custom Entity Store\n\nThe Forge KVS API provides hosted storage capabilities that let you store data in your app installation. Use the /forge/storage/kvs/{target} endpoint to proxy requests to the Forge KVS REST API."},{"name":"Forge LLM","description":"This API is accessible only from Forge applications and requires platform-provided authentication headers. It enables Forge apps to interact with native Forge-supported LLMs.\nFor more information, see the [Forge LLMs documentation](https://go.atlassian.com/forge-llms-api-reference)"},{"name":"Forge Object Store","description":"Forge Object Store API for storing and retrieving objects"},{"name":"Forge Proxy","description":"External service proxying endpoints for forwarding requests to external services.\n\n**Important:** You can only egress to domains that are listed in the Runtime egress permissions in your Forge Manifest.\nSee [Runtime egress permissions](https://developer.atlassian.com/platform/forge/runtime-egress-permissions/#runtime-egress-permissions) for details.\n\nExternal domains must be declared in the `permissions.external.fetch.backend` section of your `manifest.yml` file.\nUse the `/proxy/{target}` endpoint to proxy requests to external services.\n"},{"name":"Forge Realtime","description":"Forge realtime service endpoints for publishing events"},{"name":"Forge SQL","description":"Forge SQL Storage REST API for containers"},{"name":"Jira","description":"Jira API endpoints for accessing Jira Cloud platform functionality.\n\n**API Documentation:** \n- [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n- [Jira Software Cloud REST API](https://developer.atlassian.com/cloud/jira/software/rest/intro)\n- [Jira Service Management Cloud REST API](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/)\n\nThe Jira API provides comprehensive access to issues, projects, users, workflows, and other Jira resources.\nUse the `/jira/{target}` endpoint to proxy requests to the Jira REST API.\n"}],"paths":{"/v0/installations":{"get":{"tags":["App Installations"],"summary":"Get app installations","description":"Returns all installations for the given app Id and environment.\n","responses":{"200":{"description":"Installations retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppInstallations"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/invocation/context":{"get":{"tags":["Forge Context"],"summary":"Get invocation context","description":"Returns contextual data associated with the invocation. This API retrieves data cached in the proxy and is expected to be low latency.\n","parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Invocation context retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvocationContext"},"example":{"app":{"id":"ari:cloud:ecosystem::app/d60dfafb-a14d-4d56-bf03-0c3823d39e2b","installationId":"ari:cloud:ecosystem::installation/8d5f651a-b2e9-4b38-aac6-30abc7f3effb","environment":{"type":"DEVELOPMENT","id":"ari:cloud:ecosystem::environment/d60dfafb-a14d-4d56-bf03-0c3823d39e2b/e62535ae-72f9-49da-a8d3-c0b82cab4ca1"},"module":{"key":"container-webtrigger","type":"core:webtrigger"}},"context":{"cloudId":"4869c4ef-cb0d-4108-8243-8929ac7cc1fa","moduleKey":"container-webtrigger","userAccess":{"enabled":false}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/proxy/{target}":{"get":{"tags":["Forge Proxy"],"summary":"Proxy GET request to external service","description":"Proxies requests to external services through the Forge Outbound Proxy (FOP).\nThe target parameter specifies the external service to proxy to.\n","parameters":[{"$ref":"#/components/parameters/TargetParameter"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"post":{"tags":["Forge Proxy"],"summary":"Proxy POST request to external service","description":"Proxies POST requests to external services through the Forge Outbound Proxy (FOP).\nThe target parameter specifies the external service to proxy to.\n","parameters":[{"$ref":"#/components/parameters/TargetParameter"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"put":{"tags":["Forge Proxy"],"summary":"Proxy PUT request to external service","description":"Proxies PUT requests to external services through the Forge Outbound Proxy (FOP).\nThe target parameter specifies the external service to proxy to.\n","parameters":[{"$ref":"#/components/parameters/TargetParameter"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"patch":{"tags":["Forge Proxy"],"summary":"Proxy PATCH request to external service","description":"Proxies PATCH requests to external services through the Forge Outbound Proxy (FOP).\nThe target parameter specifies the external service to proxy to.\n","parameters":[{"$ref":"#/components/parameters/TargetParameter"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Forge Proxy"],"summary":"Proxy DELETE request to external service","description":"Proxies DELETE requests to external services through the Forge Outbound Proxy (FOP).\nThe target parameter specifies the external service to proxy to.\n","parameters":[{"$ref":"#/components/parameters/TargetParameter"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"head":{"tags":["Forge Proxy"],"summary":"Proxy HEAD request to external service","description":"Proxies HEAD requests to external services through the Forge Outbound Proxy (FOP).\nReturns headers without response body, useful for checking resource existence.\n","parameters":[{"$ref":"#/components/parameters/TargetParameter"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"options":{"tags":["Forge Proxy"],"summary":"Proxy OPTIONS request to external service","description":"Proxies OPTIONS requests to external services through the Forge Outbound Proxy (FOP).\nUsed for CORS preflight requests and method discovery.\n","parameters":[{"$ref":"#/components/parameters/TargetParameter"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}}},"/jira/{target}":{"get":{"tags":["Jira"],"summary":"Proxy GET request to Jira API","description":"Proxies requests to the Jira Cloud Platform REST API v3.\nThe target parameter specifies the Jira API endpoint.\n\n**API Documentation:** [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n\n**Examples:**\n- `/jira/rest/api/3/issue/ISSUE-123` - Get issue details\n- `/jira/rest/api/3/project` - List projects\n- `/jira/rest/api/3/myself` - Get current user info\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Jira API endpoint path\n\n**Format:** `rest/api/3/{endpoint}`\n\n**Examples:**\n- `rest/api/3/issue/ISSUE-123` - Get issue details\n- `rest/api/3/project` - List projects\n- `rest/api/3/myself` - Get current user info\n- `rest/api/3/search` - Search issues using JQL\n- `rest/api/3/issue/ISSUE-123/comment` - Get issue comments\n","schema":{"type":"string","example":"rest/api/3/issue/ISSUE-123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Jira API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"post":{"tags":["Jira"],"summary":"Proxy POST request to Jira API","description":"Proxies POST requests to the Jira Cloud Platform REST API v3.\nThe target parameter specifies the Jira API endpoint.\n\n**API Documentation:** [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n\n**Examples:**\n- `/jira/rest/api/3/issue` - Create new issue\n- `/jira/rest/api/3/issue/ISSUE-123/comment` - Add comment to issue\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Jira API endpoint path\n\n**Format:** `rest/api/3/{endpoint}`\n\n**Examples:**\n- `rest/api/3/issue` - Create new issue\n- `rest/api/3/issue/ISSUE-123/comment` - Add comment to issue\n- `rest/api/3/search` - Search issues using JQL\n- `rest/api/3/project` - Create new project\n","schema":{"type":"string","example":"rest/api/3/issue"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied to Jira API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"put":{"tags":["Jira"],"summary":"Proxy PUT request to Jira API","description":"Proxies PUT requests to the Jira Cloud Platform REST API v3.\nThe target parameter specifies the Jira API endpoint.\n\n**API Documentation:** [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n\n**Examples:**\n- `/jira/rest/api/3/issue/ISSUE-123` - Update issue\n- `/jira/rest/api/3/project/PROJECT-123` - Update project\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Jira API endpoint path\n\n**Format:** `rest/api/3/{endpoint}`\n\n**Examples:**\n- `rest/api/3/issue/ISSUE-123` - Update issue\n- `rest/api/3/project/PROJECT-123` - Update project\n- `rest/api/3/issue/ISSUE-123/comment/123` - Update comment\n","schema":{"type":"string","example":"rest/api/3/issue/ISSUE-123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied to Jira API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"patch":{"tags":["Jira"],"summary":"Proxy PATCH request to Jira API","description":"Proxies PATCH requests to the Jira Cloud Platform REST API v3.\nThe target parameter specifies the Jira API endpoint.\n\n**API Documentation:** [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n\n**Examples:**\n- `/jira/rest/api/3/issue/ISSUE-123` - Partially update issue\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Jira API endpoint path\n\n**Format:** `rest/api/3/{endpoint}`\n\n**Examples:**\n- `rest/api/3/issue/ISSUE-123` - Partially update issue\n- `rest/api/3/project/PROJECT-123` - Partially update project\n","schema":{"type":"string","example":"rest/api/3/issue/ISSUE-123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied to Jira API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Jira"],"summary":"Proxy DELETE request to Jira API","description":"Proxies DELETE requests to the Jira Cloud Platform REST API v3.\nThe target parameter specifies the Jira API endpoint.\n\n**API Documentation:** [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n\n**Examples:**\n- `/jira/rest/api/3/issue/ISSUE-123` - Delete issue\n- `/jira/rest/api/3/issue/ISSUE-123/comment/123` - Delete comment\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Jira API endpoint path\n\n**Format:** `rest/api/3/{endpoint}`\n\n**Examples:**\n- `rest/api/3/issue/ISSUE-123` - Delete issue\n- `rest/api/3/issue/ISSUE-123/comment/123` - Delete comment\n- `rest/api/3/project/PROJECT-123` - Delete project\n","schema":{"type":"string","example":"rest/api/3/issue/ISSUE-123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Jira API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"head":{"tags":["Jira"],"summary":"Proxy HEAD request to Jira API","description":"Proxies HEAD requests to the Jira Cloud Platform REST API v3.\nReturns headers without response body, useful for checking resource existence.\n\n**API Documentation:** [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Jira API endpoint path\n\n**Format:** `rest/api/3/{endpoint}`\n\n**Examples:**\n- `rest/api/3/issue/ISSUE-123` - Check if issue exists\n- `rest/api/3/project/PROJECT-123` - Check if project exists\n","schema":{"type":"string","example":"rest/api/3/issue/ISSUE-123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Jira API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"options":{"tags":["Jira"],"summary":"Proxy OPTIONS request to Jira API","description":"Proxies OPTIONS requests to the Jira Cloud Platform REST API v3.\nUsed for CORS preflight requests and method discovery.\n\n**API Documentation:** [Jira Cloud Platform REST API v3](https://developer.atlassian.com/cloud/jira/platform/rest/)\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Jira API endpoint path\n\n**Format:** `rest/api/3/{endpoint}`\n\n**Examples:**\n- `rest/api/3/issue` - Discover available methods for issues\n- `rest/api/3/project` - Discover available methods for projects\n","schema":{"type":"string","example":"rest/api/3/issue"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Jira API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}}},"/confluence/{target}":{"get":{"tags":["Confluence"],"summary":"Proxy GET request to Confluence API","description":"Proxies requests to the Confluence Cloud REST API v2.\nThe target parameter specifies the Confluence API endpoint.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n\n**Examples:**\n- `/confluence/api/v2/pages/123` - Get page details\n- `/confluence/api/v2/spaces` - List spaces\n- `/confluence/api/v2/users/me` - Get current user info\n- `/confluence/api/v2/pages/123/comments` - Get page comments\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Confluence API endpoint path\n\n**Format:** `api/v2/{endpoint}`\n\n**Examples:**\n- `api/v2/pages/123` - Get page details\n- `api/v2/spaces` - List spaces\n- `api/v2/users/me` - Get current user info\n- `api/v2/pages/123/comments` - Get page comments\n- `api/v2/blogs/123` - Get blog post details\n","schema":{"type":"string","example":"api/v2/pages/123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Confluence API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"post":{"tags":["Confluence"],"summary":"Proxy POST request to Confluence API","description":"Proxies POST requests to the Confluence Cloud REST API v2.\nThe target parameter specifies the Confluence API endpoint.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n\n**Examples:**\n- `/confluence/api/v2/pages` - Create new page\n- `/confluence/api/v2/pages/123/comments` - Add comment to page\n- `/confluence/api/v2/blogs` - Create new blog post\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Confluence API endpoint path\n\n**Format:** `api/v2/{endpoint}`\n\n**Examples:**\n- `api/v2/pages` - Create new page\n- `api/v2/pages/123/comments` - Add comment to page\n- `api/v2/blogs` - Create new blog post\n- `api/v2/spaces` - Create new space\n","schema":{"type":"string","example":"api/v2/pages"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied to Confluence API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"put":{"tags":["Confluence"],"summary":"Proxy PUT request to Confluence API","description":"Proxies PUT requests to the Confluence Cloud REST API v2.\nThe target parameter specifies the Confluence API endpoint.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n\n**Examples:**\n- `/confluence/api/v2/pages/123` - Update page\n- `/confluence/api/v2/blogs/123` - Update blog post\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Confluence API endpoint path\n\n**Format:** `api/v2/{endpoint}`\n\n**Examples:**\n- `api/v2/pages/123` - Update page\n- `api/v2/blogs/123` - Update blog post\n- `api/v2/pages/123/comments/456` - Update comment\n","schema":{"type":"string","example":"api/v2/pages/123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied to Confluence API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"patch":{"tags":["Confluence"],"summary":"Proxy PATCH request to Confluence API","description":"Proxies PATCH requests to the Confluence Cloud REST API v2.\nThe target parameter specifies the Confluence API endpoint.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n\n**Examples:**\n- `/confluence/api/v2/pages/123` - Partially update page\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Confluence API endpoint path\n\n**Format:** `api/v2/{endpoint}`\n\n**Examples:**\n- `api/v2/pages/123` - Partially update page\n- `api/v2/blogs/123` - Partially update blog post\n","schema":{"type":"string","example":"api/v2/pages/123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied to Confluence API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"delete":{"tags":["Confluence"],"summary":"Proxy DELETE request to Confluence API","description":"Proxies DELETE requests to the Confluence Cloud REST API v2.\nThe target parameter specifies the Confluence API endpoint.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n\n**Examples:**\n- `/confluence/api/v2/pages/123` - Delete page\n- `/confluence/api/v2/pages/123/comments/456` - Delete comment\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Confluence API endpoint path\n\n**Format:** `api/v2/{endpoint}`\n\n**Examples:**\n- `api/v2/pages/123` - Delete page\n- `api/v2/pages/123/comments/456` - Delete comment\n- `api/v2/blogs/123` - Delete blog post\n","schema":{"type":"string","example":"api/v2/pages/123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Confluence API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"head":{"tags":["Confluence"],"summary":"Proxy HEAD request to Confluence API","description":"Proxies HEAD requests to the Confluence Cloud REST API v2.\nReturns headers without response body, useful for checking resource existence.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Confluence API endpoint path\n\n**Format:** `api/v2/{endpoint}`\n\n**Examples:**\n- `api/v2/pages/123` - Check if page exists\n- `api/v2/spaces/SPACE` - Check if space exists\n","schema":{"type":"string","example":"api/v2/pages/123"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Confluence API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}},"options":{"tags":["Confluence"],"summary":"Proxy OPTIONS request to Confluence API","description":"Proxies OPTIONS requests to the Confluence Cloud REST API v2.\nUsed for CORS preflight requests and method discovery.\n\n**API Documentation:** [Confluence Cloud REST API v2](https://developer.atlassian.com/cloud/confluence/rest/)\n","parameters":[{"name":"target","in":"path","required":true,"description":"Target Confluence API endpoint path\n\n**Format:** `api/v2/{endpoint}`\n\n**Examples:**\n- `api/v2/pages` - Discover available methods for pages\n- `api/v2/spaces` - Discover available methods for spaces\n","schema":{"type":"string","example":"api/v2/pages"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Request successfully proxied to Confluence API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}}},"/atlassian/graphql/":{"post":{"tags":["Atlassian GraphQL"],"summary":"Proxy POST request to Atlassian GraphQL API","description":"Proxies POST requests to the Atlassian GraphQL API.\n\n**API Documentation:** [Atlassian GraphQL API](https://developer.atlassian.com/platform/atlassian-graphql-api/graphql/)\n\n**Examples:**\n\n**Query Example:**\n```json\n{\n  \"query\": \"query GetProjects { projects { id name key } }\"\n}\n```\n\n**Mutation Example:**\n```json\n{\n  \"query\": \"mutation CreateIssue($input: CreateIssueInput!) { createIssue(input: $input) { issue { id key summary } } }\",\n  \"variables\": {\n    \"input\": {\n      \"projectId\": \"10001\",\n      \"summary\": \"New issue from GraphQL\",\n      \"description\": \"Issue description\"\n    }\n  }\n}\n```\n","parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/GenericRequestBody"},"responses":{"200":{"description":"Request successfully proxied to Atlassian GraphQL API","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"429":{"description":"Rate limit exceeded - See GraphQL API rate limiting"},"500":{"description":"Internal server error"}}}},"/atlassian/forge/events/v1/async-events":{"post":{"tags":["Forge Events"],"summary":"Publish Async Events to Forge","description":"Submit asynchronous events to the Forge events system.\nEvents are queued for processing and will be delivered to the specified queue.\n","parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"$ref":"#/components/requestBodies/AsyncEventsRequestBody"},"responses":{"200":{"description":"Events submitted successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid event format or queue name"},"500":{"description":"Internal server error"}}}},"/forge/storage/sql/v1/execute":{"post":{"x-experimental":true,"summary":"Execute a DML SQL statement","description":"Executes a SQL statement, and with optional params to be substituted in. This is to be used for DML (Data Manipulation) queries.\n\nDML queries are limited to SELECT, INSERT, UPDATE and DELETE statements.\n\nThis is recommended for all user facing requests, as the restrictive permissions limits the potential impact of a client being able to \nsuccessfully use a query injection attack on your app. Using params will use server side params to further mitigate against these attacks.\n\nThe DDL API is available for all other statements, and should be used sparingly, and avoid usage where client provided parameters are included.","operationId":"executeDML","tags":["Forge SQL"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryWithParamsRequestBody"},"examples":{"dmlQueryExample":{"$ref":"#/components/examples/DMLQueryWithParamsRequestBodyExample"}}}}},"responses":{"200":{"description":"Successful DML execution","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryWithParamsResponse"},"examples":{"selectQueryResponseExample":{"$ref":"#/components/examples/SelectQueryResponseExample"}}}}},"400":{"description":"Invalid request body"},"413":{"description":"Query size exceeds limit"},"500":{"description":"Internal server error"}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/sql/v1/execute/ddl":{"post":{"x-experimental":true,"summary":"Execute a DDL SQL statement","description":"Executes a SQL statement, and with optional params to be substituted in. This is to be used for DDL (Data Definition) queries.\n\nDDL refers to statements like CREATE, ALTER and DROP. This DDL endpoint is your schema management endpoint and is granted all * permissions to your schema.\n\nWe recommended to use this API only when modifying your schema in some way, and doesn’t include user generated params, as there is a \nchance for higher impact on failure to do so. Use the DML based endpoint for user based requests.\nThe API rate and connection limits are more restrictive than the DML endpoint.","operationId":"executeDDL","tags":["Forge SQL"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryWithParamsRequestBody"},"examples":{"ddlQueryExample":{"$ref":"#/components/examples/DDLQueryWithParamsRequestBodyExample"}}}}},"responses":{"200":{"description":"Successful DDL execution","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryWithParamsResponse"},"examples":{"ddlQueryResponseExample":{"$ref":"#/components/examples/DDLQueryResponseExample"}}}}},"400":{"description":"Invalid request body"},"413":{"description":"Query size exceeds limit"},"500":{"description":"Internal server error"}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/get":{"post":{"tags":["Forge KVS"],"summary":"Get value by key","description":"Gets a value by key.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRequestSchema"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetResponseSchema"}}},"description":"Successfully retrieved the value corresponding to the key."},"400":{"description":"Possible error codes:\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$/```.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"404":{"description":"Possible error codes:\n- ```KEY_NOT_FOUND``` - The provided key does not exist."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/set":{"post":{"tags":["Forge KVS"],"description":"Stores a JSON value with a specified key. Forge resolves write conflicts using a last-write-wins strategy by default, but this can be configured via the key policy option.\nOptionally, you can specify a TTL (Time To Live) to automatically expire the data after a specified duration.","summary":"Set value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValueSchema"}}}},"responses":{"200":{"description":"Successfully set the value with metadata fields returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetResponseSchema"}}}},"204":{"description":"Successfully set the value to the corresponding key"},"400":{"description":"Possible error codes:\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$```.\n- ```MAX_SIZE``` - The provided value has exceeded the maximum size limit.\n- ```MAX_DEPTH``` - The provided value has exceeded the maximum object depth (32) limit.\n- ```INVALID_KEY_POLICY_RETURN_VALUE_COMBINATION``` - The provided key policy and return value combination is not valid.\n\nSee [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"409":{"description":"Possible error codes:\n- ```KEY_CONFLICT``` - The provided key already exists and the key policy is set to ```FAIL_IF_EXISTS```"}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/delete":{"post":{"tags":["Forge KVS"],"description":"Deletes a value by key. Write conflicts are resolved using a last-write-wins strategy.","summary":"Delete value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeySchema"}}}},"responses":{"204":{"description":"Successfully deleted the key and the corresponding value"},"400":{"description":"Possible error codes:\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$```.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"404":{"description":"Possible error codes:\n- ```KEY_NOT_FOUND``` - The provided key does not exist."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/query":{"post":{"tags":["Forge KVS"],"description":"Retrieve key-value pairs matching the provided list of criteria. This method does not return secret values set by [Set secret value](/platform/forge/rest/v1/api-group-key-value-store/#api-v1-secret-set-post).","summary":"Query key-value pairs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequestSchema"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/QueryResponseSchema"}}},"description":"Successfully retrieved the data from storage"},"400":{"description":"Possible error codes:\n- ```INVALID_FILTER_CONDITION``` - The specified condition is not supported for filters.\n- ```INVALID_FILTER_VALUES``` - The specified number of values is not supported by the condition.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$```.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```LIST_QUERY_LIMIT_EXCEEDED``` - Limit for list query should be below 100.\n- ```QUERY_WHERE_FIELD_INVALID``` - The specified field is not supported for filters.\n- ```QUERY_WHERE_INVALID``` - Queries should contain only a single \"where\" clause.\n\n   See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/batch/set":{"post":{"tags":["Forge KVS"],"description":"Sets multiple Key-Value Store and/or Custom Entity Store values in a single operation. \nReturns a type ```BatchResponse``` which contains ```successfulKeys``` and ```failedKeys```.\nOptionally, you can specify a TTL (Time To Live) for each item to automatically expire the data after a specified duration.","summary":"Batch set key-value pairs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSetRequestSchema"}}}},"responses":{"200":{"description":"Successfully set the keys to their corresponding values, returns list of successful and failed keys. Failed keys will contain details of the failure error codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSetResponseSchema"}}}},"400":{"description":"Possible error codes:\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$```.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/secret/get":{"post":{"tags":["Forge KVS"],"description":"Gets a value by key, which was stored using [Set secret value by key](/platform/forge/rest/v1/api-group-key-value-store/#api-v1-secret-set-post). The value is decrypted before being returned.","summary":"Get secret value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRequestSchema"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetResponseSchema"}}},"description":"Successfully retrieved the decrypted value corresponding to the key"},"400":{"description":"Possible error codes:\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$/```.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"404":{"description":"Possible error codes:\n- ```KEY_NOT_FOUND``` - The provided key does not exist."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/secret/set":{"post":{"tags":["Forge KVS"],"description":"Stores sensitive credentials in JSON format, with encryption. \nValues set with this method can only be accessed with [Get secret value by key](/platform/forge/rest/v1/api-group-key-value-store/#api-v1-secret-get-post). \nWrite conflicts are resolved using a last-write-wins strategy by default, but this can be configured via the key policy option.\nOptionally, you can specify a TTL (Time To Live) to automatically expire the data after a specified duration.","summary":"Set secret value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValueSchema"}}}},"responses":{"200":{"description":"Successfully set the value with metadata fields returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetResponseSchema"}}}},"204":{"description":"Successfully set the value to the corresponding key with encryption"},"400":{"description":"Possible error codes:\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$```.\n- ```MAX_SIZE``` - The provided value has exceeded the maximum size limit.\n- ```INVALID_KEY_POLICY_RETURN_VALUE_COMBINATION``` - The provided key policy and return value combination is not valid.  \n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"409":{"description":"Possible error codes:\n- ```KEY_CONFLICT``` - The provided key already exists and the key policy is set to ```FAIL_IF_EXISTS```"}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/secret/delete":{"post":{"tags":["Forge KVS"],"description":"Deletes a secret value by key.","summary":"Delete secret value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeySchema"}}}},"responses":{"204":{"description":"Successfully deleted the key and the corresponding encrypted value"},"400":{"description":"Possible error codes:\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$```.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"404":{"description":"Possible error codes:\n- ```KEY_NOT_FOUND``` - The provided key does not exist."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/entity/get":{"post":{"tags":["Forge KVS"],"description":"Gets a custom entity value by key.","summary":"Get custom entity value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityGetRequestSchema"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityGetResponseSchema"}}},"description":"Successfully retrieved the value corresponding to the key and the entity"},"400":{"description":"Possible error codes:\n- ```EMPTY_KEY``` - Key cannot be empty.\n- ```ENTITY_TYPE_TOO_SHORT``` - The provided key needs to be more than 3 characters.\n- ```ENTITY_TYPE_TOO_LARGE``` - The provided key has exceeded the maximum 60 characters.\n- ```INVALID_ENTITY_TYPE``` - The provided key does not match the regex: ```/^(?![\\.\\-])(?!.*\\.{2})[a-z0-9:\\-.]*(?<![.])$/```\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$/```\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"404":{"description":"Possible error codes:\n- ```KEY_NOT_FOUND``` - The provided key does not exist."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/entity/set":{"post":{"tags":["Forge KVS"],"description":"Stores a JSON value with a specified key, for the selected entity.\nOptionally, you can specify a TTL (Time To Live) to automatically expire the data after a specified duration.","summary":"Set custom entity value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityKeyValueSchema"}}}},"responses":{"200":{"description":"Successfully set the value with metadata fields returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySetResponseSchema"}}}},"204":{"description":"Successfully set the value to the corresponding key and the entity"},"400":{"description":"Possible error codes:\n- ```EMPTY_KEY``` - Key cannot be empty.\n- ```ENTITY_TYPE_TOO_SHORT``` - The provided key needs to be more than 3 characters.\n- ```ENTITY_TYPE_TOO_LARGE``` - The provided key has exceeded the maximum 60 characters.\n- ```INVALID_ENTITY_TYPE``` - The provided key does not match the regex: ```/^(?![\\.\\-])(?!.*\\.{2})[a-z0-9:\\-.]*(?<![.])$/```\n- ```INVALID_ENTITY_VALUE``` - Entity values must match one of the types defined in [custom-entities](https://developer.atlassian.com/platform/forge/runtime-reference/custom-entities/#values).\n- ```INVALID_ENTITY_ATTRIBUTE``` - The specified attribute name is a reserved value and cannot be utilized.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$/```\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```MAX_SIZE``` - The provided attribute value has exceeded the maximum size limit.\n- ```MAX_DEPTH``` - The provided attribute value has exceeded the maximum object depth (32) limit.\n- ```INVALID_KEY_POLICY_RETURN_VALUE_COMBINATION``` - The provided key policy and return value combination is not valid.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code. "},"409":{"description":"Possible error codes:\n- ```KEY_CONFLICT``` - The provided key already exists and the key policy is set to ```FAIL_IF_EXISTS```"}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/entity/delete":{"post":{"tags":["Forge KVS"],"description":"Deletes a value by key, for the selected entity.","summary":"Delete custom entity value by key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityKeySchema"}}}},"responses":{"204":{"description":"Successfully deleted the key and the corresponding value of the entity"},"400":{"description":"Possible error codes:\n- ```EMPTY_KEY``` - Key cannot be empty.\n- ```ENTITY_TYPE_TOO_SHORT``` - The provided key needs to be more than 3 characters.\n- ```ENTITY_TYPE_TOO_LARGE``` - The provided key has exceeded the maximum 60 characters.\n- ```INVALID_ENTITY_TYPE``` - The provided key does not match the regex: ```/^(?![\\.\\-])(?!.*\\.{2})[a-z0-9:\\-.]*(?<![.])$/```\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$/```\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."},"404":{"description":"Possible error codes:\n- ```KEY_NOT_FOUND``` - The provided key does not exist."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/entity/query":{"post":{"tags":["Forge KVS"],"description":"Retrieves custom entities matching the provided list of criteria using query conditions. See [Querying the Custom Entity Store](https://developer.atlassian.com/platform/forge/runtime-reference/storage-api-query-complex/) for more information about building complex queries.","summary":"Query custom entities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityQueryRequestSchema"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/QueryResponseSchema"}}},"description":"Successfully retrieved the data from storage for an entity"},"400":{"description":"Possible error codes:\n- ```INVALID_ENTITY_INDEX``` - The custom entity index provided is invalid. The index name is a reserved value and cannot be utilized.\n- ```COMPLEX_QUERY_PAGE_LIMIT_NOT_IN_RANGE``` - The page limit must be set between 1 and 100.\n- ```INVALID_FILTER_OPERATORS_COMBINATION``` - Filter operators \"and\" and \"or\" cannot be present at the same level.\n- ```EMPTY_FILTER_OPERATOR``` - Filter operators \"and\" and \"or\" cannot be empty.\n- ```INSUFFICIENT_FILTER_VALUES``` - The specified condition needs at least two values.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/kvs/v1/transaction":{"post":{"tags":["Forge KVS"],"description":"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:\n- create or update data\n- delete data\n- check whether a specific Custom Entity condition is true\n(optionally with TTL for automatic expiration)","summary":"Execute transaction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionRequestSchema"}}}},"responses":{"204":{"description":"Successfully completed all the node operations"},"400":{"description":"Possible error codes:\n- ```EMPTY_KEY``` - Key cannot be empty.\n- ```KEY_TOO_SHORT``` - The provided key needs to be more than one character.\n- ```KEY_TOO_LONG``` - The provided key has exceeded the maximum 500 characters.\n- ```INVALID_KEY``` - The provided key does not match the regex: ```/^(?!\\s+$)[a-zA-Z0-9:._\\s-#]+$/```.\n- ```ENTITY_TYPE_TOO_SHORT``` - The provided entity name needs to be more than 3 characters.\n- ```ENTITY_TYPE_TOO_LARGE``` - The provided entity name has exceeded the maximum 60 characters.\n- ```INVALID_ENTITY_TYPE``` - The provided entity name does not match the regex: ```/^(?![\\.\\-])(?!.*\\.{2})[a-z0-9:\\-.]*(?<![.])$/```\n- ```INVALID_ENTITY_VALUE``` - Entity values must match one of the types defined in [custom-entities](https://developer.atlassian.com/platform/forge/runtime-reference/custom-entities/#values).\n- ```INVALID_ENTITY_ATTRIBUTE``` - The specified attribute name is a reserved value and cannot be utilized.\n- ```INVALID_FILTER_OPERATORS_COMBINATION``` - Filter operators \"and\" and \"or\" cannot be present at the same level.\n- ```EMPTY_FILTER_OPERATOR``` - Filter operators \"and\" and \"or\" cannot be empty.\n- ```INSUFFICIENT_FILTER_VALUES``` - The specified condition needs at least two values.\n- ```INVALID_TRANSACTION_REQUEST``` - Transaction request must include one of set, check or delete.\n- ```BAD_REQUEST``` - The provided request body is invalid.\n- ```UNPROCESSABLE_ENTITY``` - Request cannot be processed due to one or more semantic errors.\n- ```CONDITIONAL_CHECK_FAILED``` - Request failed due to conditional check specified or optimistic locking.\n\n See [Error handling](/platform/forge/remote/accessing-storage/#error-handling) for more information about each error code."}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/os/v1/delete":{"post":{"x-experimental":true,"summary":"Delete Object","description":"Deletes an object from the object store.","tags":["Forge Object Store"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsKeyRequestBody"}}}},"responses":{"204":{"description":"Object deleted successfully"},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/os/v1/metadata":{"post":{"x-experimental":true,"summary":"Get Metadata","description":"Get the metadata for the specified object in the payload.","tags":["Forge Object Store"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsKeyRequestBody"}}}},"responses":{"200":{"description":"Metadata retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsObjectMetadataResponse"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}},"404":{"description":"Object not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/os/v1/upload-url":{"post":{"x-experimental":true,"summary":"Get Upload URL","description":"Generates a pre-signed URL for uploading an object.","tags":["Forge Object Store"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"},"length":{"type":"integer"},"checksum":{"type":"string"},"checksumType":{"type":"string","enum":["SHA1","SHA256","CRC32","CRC32C"]},"ttlSeconds":{"type":"integer"},"overwrite":{"type":"boolean"}},"required":["key","length","checksum","checksumType"]}}}},"responses":{"200":{"description":"Upload URL generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsUrlResponse"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/forge/storage/os/v1/download-url":{"post":{"x-experimental":true,"summary":"Get Download URL","description":"Generates a pre-signed URL for downloading an object.","tags":["Forge Object Store"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsKeyRequestBody"}}}},"responses":{"200":{"description":"Download URL generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsUrlResponse"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}},"404":{"description":"Object not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgeError"}}}}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]}},"/atlassian/forge/installation/v1/dynamic/module":{"post":{"tags":["Forge Dynamic Modules"],"summary":"Create a dynamic module","operationId":"createDynamicModule","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicModuleRequest"}}}},"responses":{"201":{"description":"Dynamic module created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicModule"}}}},"400":{"description":"Invalid request body structure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"description":"Installation is being modified at the same time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable content - validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]},"put":{"tags":["Forge Dynamic Modules"],"summary":"Update a dynamic module","operationId":"updateDynamicModule","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicModuleRequest"}}}},"responses":{"200":{"description":"Dynamic module updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicModule"}}}},"400":{"description":"Invalid structure or other validation failures","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Installation is being modified at the same time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable content - validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"}},"parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}]},"get":{"tags":["Forge Dynamic Modules"],"summary":"List all dynamic modules","operationId":"listDynamicModules","parameters":[{"name":"nextPageToken","in":"query","description":"Token for the next page of results","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of items to return","required":false,"schema":{"type":"integer","default":100}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"List of dynamic modules","content":{"application/json":{"schema":{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/DynamicModule"}},"lastEvaluatedKey":{"type":"string","description":"Token to fetch the next page of results"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Installation is being modified at the same time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/atlassian/forge/installation/v1/dynamic/module/{key}":{"get":{"tags":["Forge Dynamic Modules"],"summary":"Get a dynamic module","operationId":"getDynamicModule","parameters":[{"name":"key","in":"path","description":"Key of the dynamic module","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"200":{"description":"Dynamic module retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicModule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["Forge Dynamic Modules"],"summary":"Delete a dynamic module","operationId":"deleteDynamicModule","parameters":[{"name":"key","in":"path","description":"Key of the dynamic module","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"responses":{"204":{"description":"Dynamic module deleted successfully"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Installation is being modified at the same time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/forge/llm/{model}":{"post":{"description":"Proxy endpoint to make requests to the native Forge supported LLMs.","security":[{"forgeProxyToken":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMResponsePayload"}}}},"400":{"description":"Invalid request body"},"403":{"description":"Forbidden error"},"404":{"description":"Unsupported LLM model | AI feature not enabled"},"429":{"description":"Rate limit exceeded"},"500":{"description":"Internal server error"}},"parameters":[{"in":"path","name":"model","required":true,"schema":{"$ref":"#/components/schemas/LLMs"},"description":"The model to use for the request"},{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMRequestPayload"}}}},"tags":["Forge LLM"]}},"/forge/realtime/v1/publish":{"post":{"summary":"Publish an event to a realtime channel","description":"Proxies POST requests to Forge realtime services for publishing events.\nAll clients in the same context as the sender and subscribed to this realtime channel will receive the event.\n\"Publish\" requests only work when the request originated from a UI context invocation. In the `forge-proxy-authorization` header you must specify the `id` of the invocation; you can't perform operations on behalf of an `installationId`.","operationId":"publishEvent","parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader1"}],"tags":["Forge Realtime"],"requestBody":{"description":"Event data to be published","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishRealtimeMessageRequestBody"},"examples":{"publishRealtimeMessageExample":{"$ref":"#/components/examples/PublishRealtimeMessageExample"}}}}},"responses":{"200":{"description":"Realtime message published successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}}},"/forge/realtime/v1/publish/global":{"post":{"summary":"Publish an event to a global realtime channel","description":"Proxies POST requests to Forge realtime services for publishing events.\nAll clients subscribed to this global realtime channel will receive the event.","operationId":"publishGlobalEvent","parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader1"}],"tags":["Forge Realtime"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishRealtimeMessageRequestBody"},"examples":{"publishGlobalRealtimeMessageExample":{"$ref":"#/components/examples/PublishGlobalRealtimeMessageExample"}}}}},"responses":{"200":{"description":"Global realtime message published successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}}},"/forge/realtime/v1/token":{"post":{"summary":"Sign a forge realtime token","description":"Signs a forge realtime token that can be used to securely publish events to realtime channels.","operationId":"signRealtimeToken","parameters":[{"$ref":"#/components/parameters/ForgeProxyAuthorizationHeader"},{"$ref":"#/components/parameters/ContentTypeHeader1"}],"tags":["Forge Realtime"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignRealtimeTokenRequestBody"},"examples":{"signRealtimeTokenExample":{"$ref":"#/components/examples/SignRealtimeTokenExample"}}}}},"responses":{"200":{"description":"Realtime token signed successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request - Invalid target URL or operation"},"500":{"description":"Internal server error"}}}}},"components":{"schemas":{"AppInstallations":{"type":"array","description":"Installations for the given app Id and environment","items":{"type":"object","properties":{"id":{"type":"string","description":"Installation ID"},"installationContext":{"type":"string","description":"Context name for the installation"}}}},"InvocationContext":{"type":"object","description":"Contextual data associated with the invocation","properties":{"app":{"type":"object","description":"Application information from the invocation context","properties":{"id":{"type":"string","description":"The application ID","example":"ari:cloud:ecosystem::app/d60dfafb-a14d-4d56-bf03-0c3823d39e2b"},"installationId":{"type":"string","description":"The installation ID","example":"ari:cloud:ecosystem::installation/8d5f651a-b2e9-4b38-aac6-30abc7f3effb"},"environment":{"type":"object","description":"Environment information","properties":{"type":{"type":"string","description":"The environment type","example":"DEVELOPMENT"},"id":{"type":"string","description":"The environment ID","example":"ari:cloud:ecosystem::environment/d60dfafb-a14d-4d56-bf03-0c3823d39e2b/e62535ae-72f9-49da-a8d3-c0b82cab4ca1"}}},"module":{"type":"object","description":"Module information","properties":{"key":{"type":"string","description":"The module key","example":"container-webtrigger"},"type":{"type":"string","description":"The module type","example":"core:webtrigger"}}}}},"context":{"type":"object","description":"Context information from the invocation","properties":{"cloudId":{"type":"string","description":"The cloud ID","example":"4869c4ef-cb0d-4108-8243-8929ac7cc1fa"},"moduleKey":{"type":"string","description":"The module key","example":"container-webtrigger"},"userAccess":{"type":"object","description":"User access information","properties":{"enabled":{"type":"boolean","description":"Whether user access is enabled","example":false}}}}}}},"AsyncEvent":{"type":"object","description":"An asynchronous event to be processed","required":["body"],"properties":{"body":{"type":"object","description":"The event body containing the payload","required":["payload"],"properties":{"payload":{"type":"object","description":"The event payload data","additionalProperties":true,"example":{"key":"value","userId":"123","action":"user_login"}}}}}},"QueryWithParamsRequestBody":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"The SQL statement to execute."},"params":{"type":"array","description":"Optional parameters for the SQL statement.","items":{}}}},"QueryWithParamsResponse":{"type":"object","properties":{"rows":{"oneOf":[{"$ref":"#/components/schemas/QueryWithParamsResponseResult"},{"$ref":"#/components/schemas/QueryWithParamsResponseRowItems"}]},"metadata":{"$ref":"#/components/schemas/QueryWithParamsResponseMetadata"}}},"QueryWithParamsResponseRowItems":{"type":"array","description":"An array of row items from the SQL execution when the query returns rows (e.g., SELECT statements).\nEach row is an object where the keys are the column names and the value is the row+column value.","items":{"type":"object","additionalProperties":true},"nullable":true},"QueryWithParamsResponseResult":{"type":"object","description":"Result from the SQL execution when the query does not return any rows (e.g., DDL statements).","nullable":true,"properties":{"fieldCount":{"type":"integer","description":"Number of fields in the result set."},"affectedRows":{"type":"integer","description":"Number of rows affected by the query."},"insertId":{"type":"integer","description":"ID of the last inserted row, if applicable."},"info":{"type":"string","description":"Additional information about the query execution."},"serverStatus":{"type":"integer","description":"Status of the server after executing the query."},"warningCount":{"type":"integer","description":"Number of warnings generated during query execution."}}},"QueryWithParamsResponseMetadata":{"type":"object","properties":{"dbExecutionTime":{"type":"number","description":"Time taken to execute the query in milliseconds."},"responseSize":{"type":"number","description":"Size of the response in bytes."},"fields":{"type":"array","description":"Column metadata for the result set.","items":{"$ref":"#/components/schemas/ForgeSqlFieldPacket"},"nullable":true}},"additionalProperties":true},"ForgeSqlFieldPacket":{"type":"object","description":"Describes a column in the result set, this is per the standard mysql response API.","properties":{"catalog":{"type":"string"},"name":{"type":"string"},"schema":{"type":"string"},"characterSet":{"type":"integer"},"decimals":{"type":"integer"},"table":{"type":"string"},"orgTable":{"type":"string"},"orgName":{"type":"string"},"flags":{"type":"integer"},"columnType":{"type":"integer"},"columnLength":{"type":"integer"}}},"GetRequestSchema":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"options":{"$ref":"#/components/schemas/GetOptions"}}},"GetOptions":{"type":"object","properties":{"metadataFields":{"$ref":"#/components/schemas/MetadataFields","description":"Array of metadata fields to include in the response"}}},"MetadataFields":{"type":"array","items":{"type":"string","enum":["CREATED_AT","UPDATED_AT","EXPIRE_TIME"]}},"GetResponseSchema":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"},"createdAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was created (only included when metadataFields includes CREATED_AT)"},"updatedAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was last updated (only included when metadataFields includes UPDATED_AT)"}}},"ValueSchema":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"},{"type":"array","items":{}},{"type":"object"}]},"KeyValueSchema":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"},"options":{"$ref":"#/components/schemas/ExtendedSetOptions"}}},"ExtendedSetOptions":{"type":"object","properties":{"ttl":{"$ref":"#/components/schemas/TTLSchema","description":"Optional TTL configuration to automatically expire the data after the specified duration"},"keyPolicy":{"$ref":"#/components/schemas/KeyPolicyEnum","description":"Optional key policy configuration for handling key conflicts when setting data"},"returnValue":{"$ref":"#/components/schemas/ReturnValueEnum","description":"Optional return value configuration to determine the value to return from successful Set operation"},"returnMetadataFields":{"$ref":"#/components/schemas/MetadataFields","description":"Optional array of metadata fields to include in the response when keyPolicy is OVERRIDE and returnValue is specified"}},"description":"Additional options for set operations"},"TTLSchema":{"type":"object","required":["value","unit"],"properties":{"value":{"type":"integer","description":"The numeric value for the TTL duration"},"unit":{"$ref":"#/components/schemas/TTLUnitEnum"}},"description":"Time To Live configuration for automatic data expiration"},"TTLUnitEnum":{"type":"string","enum":["SECONDS","MINUTES","HOURS","DAYS"],"description":"Time unit for TTL (Time To Live) specification"},"KeyPolicyEnum":{"type":"string","enum":["FAIL_IF_EXISTS","OVERRIDE"],"description":"Key policy configuration for handling key conflicts when setting data"},"ReturnValueEnum":{"type":"string","enum":["PREVIOUS","LATEST"],"description":"Return value configuration to determine the value to return from a successful Set operation"},"SetResponseSchema":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"},"createdAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was created (only included when returnMetadataFields includes CREATED_AT)"},"updatedAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was last updated (only included when returnMetadataFields includes UPDATED_AT)"},"expireTime":{"type":"string","description":"ISO 8601 timestamp when the key-value pair will expire (only included when returnMetadataFields includes EXPIRE_TIME)"}}},"KeySchema":{"type":"object","required":["key"],"properties":{"key":{"type":"string"}}},"QueryRequestSchema":{"type":"object","properties":{"limit":{"type":"number"},"after":{"type":"string"},"where":{"type":"array","items":{"$ref":"#/components/schemas/WhereCondition"}},"options":{"type":"object","properties":{"metadataFields":{"$ref":"#/components/schemas/MetadataFields"}}}}},"WhereCondition":{"type":"object","properties":{"condition":{"type":"string","enum":["BEGINS_WITH"]},"property":{"type":"string","enum":["key"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/ValueSchema"}}},"required":["condition","property","values"]},"QueryResponseSchema":{"type":"object","required":["data"],"properties":{"cursor":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/QueryResponseItemSchema"}}}},"QueryResponseItemSchema":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"}}},"BatchSetRequestSchema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BatchSetTypedItemSchema"},{"$ref":"#/components/schemas/BatchSetUntypedItemSchema"}]}},"BatchSetTypedItemSchema":{"type":"object","required":["key","value","entityName"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"},"entityName":{"type":"string"},"options":{"$ref":"#/components/schemas/SetOptions"}},"additionalProperties":false},"SetOptions":{"type":"object","properties":{"ttl":{"$ref":"#/components/schemas/TTLSchema","description":"Optional TTL configuration to automatically expire the data after the specified duration"}},"description":"Additional options for set operations"},"BatchSetUntypedItemSchema":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"},"options":{"$ref":"#/components/schemas/SetOptions"}},"additionalProperties":false},"BatchSetResponseSchema":{"type":"object","required":["successfulKeys","failedKeys"],"properties":{"successfulKeys":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BatchSetTypedResponseItemSchema"},{"$ref":"#/components/schemas/BatchSetUntypedResponseItemSchema"}]}},"failedKeys":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BatchSetTypedFailedKeySchema"},{"$ref":"#/components/schemas/BatchSetUntypedFailedKeySchema"}]}}}},"BatchSetTypedResponseItemSchema":{"type":"object","required":["key","entityName"],"properties":{"key":{"type":"string"},"entityName":{"type":"string"}},"additionalProperties":false},"BatchSetUntypedResponseItemSchema":{"type":"object","required":["key"],"properties":{"key":{"type":"string"}},"additionalProperties":false},"BatchSetTypedFailedKeySchema":{"type":"object","required":["key","entityName","error"],"properties":{"key":{"type":"string"},"entityName":{"type":"string"},"error":{"$ref":"#/components/schemas/BatchKeyErrorSchema"}},"additionalProperties":false},"BatchKeyErrorSchema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false},"BatchSetUntypedFailedKeySchema":{"type":"object","required":["key","error"],"properties":{"key":{"type":"string"},"error":{"$ref":"#/components/schemas/BatchKeyErrorSchema"}},"additionalProperties":false},"EntityGetRequestSchema":{"type":"object","required":["key","entityName"],"properties":{"key":{"type":"string"},"entityName":{"type":"string"},"options":{"$ref":"#/components/schemas/GetOptions"}}},"EntityGetResponseSchema":{"type":"object","required":["key","value","entityName"],"properties":{"key":{"type":"string"},"value":{"type":"object","additionalProperties":true},"entityName":{"type":"string"},"createdAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was created (only included when metadataFields includes CREATED_AT)"},"updatedAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was last updated (only included when metadataFields includes UPDATED_AT)"}}},"EntityKeyValueSchema":{"type":"object","required":["key","value","entityName"],"properties":{"key":{"type":"string"},"value":{"type":"object","additionalProperties":true},"entityName":{"type":"string"},"options":{"$ref":"#/components/schemas/ExtendedSetOptions"}}},"EntitySetResponseSchema":{"type":"object","required":["key","value","entityName"],"properties":{"key":{"type":"string"},"value":{"type":"object","additionalProperties":true},"entityName":{"type":"string"},"createdAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was created (only included when returnMetadataFields includes CREATED_AT)"},"updatedAt":{"type":"integer","format":"int64","description":"Milliseconds since epoch when the key-value pair was last updated (only included when returnMetadataFields includes UPDATED_AT)"},"expireTime":{"type":"string","description":"ISO 8601 timestamp when the key-value pair will expire (only included when returnMetadataFields includes EXPIRE_TIME)"}}},"EntityKeySchema":{"type":"object","required":["key","entityName"],"properties":{"key":{"type":"string"},"entityName":{"type":"string"}}},"EntityQueryRequestSchema":{"type":"object","properties":{"entityName":{"type":"string"},"indexName":{"type":"string"},"partition":{"type":"array","items":{"$ref":"#/components/schemas/PartitionSchema"}},"range":{"type":"object","properties":{"condition":{"type":"string","enum":["BEGINS_WITH","BETWEEN","EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","LESS_THAN","LESS_THAN_EQUAL_TO"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/ValueSchema"}}},"required":["condition","values"]},"filters":{"$ref":"#/components/schemas/FilterSchema"},"sort":{"type":"string","enum":["ASC","DESC"]},"cursor":{"type":"string"},"limit":{"type":"integer","format":"int32"},"options":{"type":"object","properties":{"metadataFields":{"$ref":"#/components/schemas/MetadataFields"}}}},"required":["entityName","indexName"]},"PartitionSchema":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"FilterSchema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AndFilterSchema"},{"$ref":"#/components/schemas/OrFilterSchema"}]},"AndFilterSchema":{"type":"object","required":["and"],"properties":{"and":{"type":"array","items":{"$ref":"#/components/schemas/FilterCondition"}}},"additionalProperties":false},"FilterCondition":{"type":"object","properties":{"condition":{"type":"string","enum":["BEGINS_WITH","BETWEEN","CONTAINS","EQUAL_TO","EXISTS","GREATER_THAN","GREATER_THAN_EQUAL_TO","LESS_THAN","LESS_THAN_EQUAL_TO","NOT_CONTAINS","NOT_EQUAL_TO","NOT_EXISTS"]},"property":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/ValueSchema"}}},"required":["condition","property","values"]},"OrFilterSchema":{"type":"object","required":["or"],"properties":{"or":{"type":"array","items":{"$ref":"#/components/schemas/FilterCondition"}}},"additionalProperties":false},"TransactionRequestSchema":{"type":"object","properties":{"set":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/SetTransactionTypedItemSchema"},{"$ref":"#/components/schemas/SetTransactionUntypedItemSchema"}]}},"delete":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BaseTransactionTypedItemSchema"},{"$ref":"#/components/schemas/BaseTransactionUntypedItemSchema"}]}},"check":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseTransactionTypedItemSchema"},{"type":"object","required":["entityName","conditions"]}]}}}},"SetTransactionTypedItemSchema":{"type":"object","required":["key","value","entityName"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"},"entityName":{"type":"string"},"conditions":{"$ref":"#/components/schemas/FilterSchema"},"options":{"$ref":"#/components/schemas/SetOptions"}},"additionalProperties":false},"SetTransactionUntypedItemSchema":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/ValueSchema"},"options":{"$ref":"#/components/schemas/SetOptions"}},"additionalProperties":false},"BaseTransactionTypedItemSchema":{"type":"object","required":["key","entityName"],"properties":{"key":{"type":"string"},"entityName":{"type":"string"},"conditions":{"$ref":"#/components/schemas/FilterSchema"}},"additionalProperties":false},"BaseTransactionUntypedItemSchema":{"type":"object","required":["key"],"properties":{"key":{"type":"string"}},"additionalProperties":false},"OsKeyRequestBody":{"type":"object","properties":{"key":{"type":"string"}},"required":["key"]},"ForgeError":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"suggestion":{"type":"string"}}},"OsObjectMetadataResponse":{"type":"object","properties":{"key":{"type":"string"},"currentVersion":{"type":"string"},"checksum":{"type":"string"},"size":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"OsUrlResponse":{"type":"object","properties":{"url":{"type":"string"}}},"DynamicModuleRequest":{"type":"object","required":["key","type","data"],"properties":{"key":{"type":"string"},"type":{"type":"string"},"data":{"type":"object"}}},"DynamicModule":{"type":"object","required":["key","type","data"],"properties":{"key":{"type":"string"},"type":{"type":"string"},"data":{"type":"object"}}},"ErrorResponse":{"type":"object","required":["code","type","message"],"properties":{"code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"tid":{"type":"string"}}},"LLMs":{"enum":["claude-opus-4-20250514","claude-3-5-haiku-20241022","claude-3-7-sonnet-20250219","claude-sonnet-4-20250514","claude-sonnet-4-5-20250929","claude-haiku-4-5-20251001","claude-opus-4-1-20250805"],"type":"string"},"LLMRequestPayload":{"title":"LLMs Request Payload","description":"Request Payload","type":"object","required":["messages"],"properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/LLMMessage"}},"top_p":{"type":"number","description":"The nucleus sampling probability"},"max_completion_tokens":{"type":"number","description":"The maximum number of tokens to generate in the chat completion. It is defaulted to the maximum possible input size available for the requested model"},"temperature":{"type":"number","description":"The temperature of the sampling distribution"},"tools":{"type":"array","description":"List of tools.","items":{"$ref":"#/components/schemas/LLMTool"}},"tool_choice":{"description":"Either \"auto\" or a tool object","oneOf":[{"type":"string","enum":["auto"]},{"$ref":"#/components/schemas/LLMToolObject"}]}},"example":{"messages":[{"role":"system","content":"You are a helpful assistant that helps people find out the weather."},{"role":"user","content":[{"type":"text","text":"What is the weather like in Boston today?"}]}],"top_p":0.5,"max_completion_tokens":200,"temperature":0.9,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}]}},"LLMToolObject":{"type":"object","properties":{"type":{"type":"string","default":"function","enum":["function"]},"function":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}},"required":["type","function"]},"LLMMessage":{"title":"Message","oneOf":[{"$ref":"#/components/schemas/LLMSystemMessage"},{"$ref":"#/components/schemas/LLMUserMessage"},{"$ref":"#/components/schemas/LLMAssistantMessage"},{"$ref":"#/components/schemas/LLMToolMessage"}]},"LLMAssistantMessage":{"title":"Assistant message","description":"Assistant message","type":"object","properties":{"content":{"$ref":"#/components/schemas/LLMContent"},"role":{"description":"The role of the messages author in this case `assistant`.","type":"string","default":"assistant","enum":["assistant"]},"tool_calls":{"type":"array","description":"List of tool calls returned by the assistant.","items":{"$ref":"#/components/schemas/LLMToolCall"}}},"required":["content","role"]},"LLMSystemMessage":{"title":"System message","description":"System message","type":"object","properties":{"content":{"$ref":"#/components/schemas/LLMContent"},"role":{"description":"The role of the messages author in this case `system`.","type":"string","default":"system","enum":["system"]}},"required":["content","role"]},"LLMUserMessage":{"title":"User message","description":"User message","type":"object","properties":{"content":{"$ref":"#/components/schemas/LLMContent"},"role":{"description":"The role of the messages author in this case `user`.","type":"string","default":"user","enum":["user"]}},"required":["content","role"]},"LLMToolMessage":{"title":"Tool message","description":"Tool message","type":"object","properties":{"content":{"$ref":"#/components/schemas/LLMContent"},"role":{"description":"The role of the messages author, in this case `tool`.","type":"string","default":"tool","enum":["tool"]},"tool_call_id":{"type":"string","description":"The id of the tool call corresponding to the assistant suggested tool usage"},"name":{"type":"string","description":"The name of the tool that produced this message"}},"required":["content","role"]},"LLMContent":{"title":"Content","description":"Content","oneOf":[{"type":"array","title":"List Content","items":{"$ref":"#/components/schemas/LLMTextContentPart"}},{"type":"string","title":"Text Content"}]},"LLMTextContentPart":{"title":"Text content part","description":"Text content part","type":"object","properties":{"type":{"title":"Type","description":"The type of the content.","type":"string","default":"text","enum":["text"]},"text":{"title":"Text","description":"The text content part.","type":"string"}}},"LLMToolFunction":{"type":"object","description":"The function to be called","properties":{"name":{"type":"string","description":"The name of the function"},"description":{"type":"string","description":"The description of the function"},"parameters":{"type":"object","description":"Relevant parameters to be passed to the function","additionalProperties":true}}},"LLMTool":{"type":"object","description":"Tool available to the model.","properties":{"type":{"type":"string","enum":["function"],"description":"Tool type."},"function":{"$ref":"#/components/schemas/LLMToolFunction"}},"required":["type","function"]},"LLMToolCallFunction":{"type":"object","description":"Executed function details.","properties":{"name":{"type":"string","description":"Name of the function invoked."},"arguments":{"type":"string","description":"Stringified JSON arguments passed to the function."}},"required":["name","arguments"]},"LLMToolCall":{"type":"object","description":"The tool requested.","properties":{"id":{"type":"string","description":"Unique identifier for the tool call."},"type":{"type":"string","enum":["function"],"description":"Tool call type."},"function":{"$ref":"#/components/schemas/LLMToolCallFunction"}},"required":["id","type","function"]},"LLMResponsePayload":{"description":"Response Payload from LLM requests","type":"object","properties":{"choices":{"type":"array","title":"List of response choices","description":"List of response choices","items":{"type":"object","title":"Choice","description":"Response choice","properties":{"message":{"$ref":"#/components/schemas/LLMAssistantMessage"},"finish_reason":{"type":"string","title":"Finish reason","description":"Finish reason for the choice"},"index":{"type":"number","title":"Index","description":"Index of the choice"}}}},"usage":{"title":"Usage","type":"object","description":"Token usage for the request","properties":{"input_tokens":{"title":"Input Tokens","type":"number","description":"Number of input tokens used in the request"},"output_tokens":{"title":"Output Tokens","type":"number","description":"Number of output tokens used in the request"},"total_tokens":{"title":"Total Tokens","type":"number","description":"Number of total tokens used in the request"}}}},"example":{"choices":[{"message":{"role":"assistant","content":[{"type":"text","text":"To help you find the weather in Boston today, I will use the get_current_weather function."}],"tool_calls":[{"id":"tooluse_BnyEynAYSwmA4rAjNy6sUA,","type":"function,","function":{"name":"get_current_weather,","arguments":"{\"location\": \"Boston, MA\", \"unit\": \"celsius\"}"}}]},"finish_reason":"stop","index":0}],"usage":{"input_tokens":20,"output_tokens":15,"total_tokens":35}}},"PublishRealtimeMessageRequestBody":{"type":"object","required":["name","payload"],"properties":{"name":{"type":"string","description":"The name of the channel to publish the event to.","example":"forge-container-realtime-channel"},"payload":{"type":"string","description":"The event data to be published.","example":"Realtime message sent from the container service, id=1"},"options":{"type":"object","properties":{"token":{"type":"string","description":"An optional forge realtime token used to add additional security when publishing to a channel.","example":"example-token"}}}}},"SignRealtimeTokenRequestBody":{"type":"object","required":["channelName","claims"],"properties":{"channelName":{"type":"string","description":"The name of the channel for which the token is being generated."},"claims":{"type":"object","description":"The token claims."}}}},"parameters":{"PathParameter":{"name":"path","in":"path","required":true,"description":"Any path to be forwarded to the app service","schema":{"type":"string"}},"TargetParameter":{"name":"target","in":"path","required":true,"description":"Target external service URL or operation\n\n**Example:** `httpbin.org/status/200`\n","schema":{"type":"string","example":"httpbin.org/status/200"}},"CapabilityParameter":{"name":"capability","in":"path","required":true,"description":"Storage capability type\n\n**Values:** `kvs`, `os`, `sql`\n\n**Example:** `kvs`\n","schema":{"type":"string","enum":["kvs","os","sql"],"example":"kvs"}},"ProductParameter":{"name":"product","in":"path","required":true,"description":"Atlassian product name\n\n**Values:** `jira`, `confluence`, `bitbucket`, `atlassian`\n\n**Example:** `jira`\n","schema":{"type":"string","enum":["jira","confluence","bitbucket","atlassian"],"example":"jira"}},"ContentTypeHeader":{"name":"Content-Type","in":"header","description":"Content type of the request body\n\n**Example:** `application/json`\n","schema":{"type":"string","example":"application/json"}},"ForgeProxyAuthorizationHeader":{"name":"forge-proxy-authorization","in":"header","required":true,"description":"Forge Proxy Authorization header. Must start with \"Forge \" followed by comma-separated key-value pairs.\n\n**Format:** `Forge [field1=value1,field2=value2,...]`\n\n**Required Fields:**\n- `id` - Invocation ID from the corresponding inbound request (x-forge-invocation-id)\n\n**Optional Fields:**\n- `as=<user|app>` - Specifies whether to call the API using either the app or its user as context\n- `accountId=<accountId>` - For user impersonation (only supported when as=user)\n\n**Examples:**\n- `Forge as=app,id=invocation-123` - Use app context with invocation ID\n- `Forge as=user,id=invocation-123` - Use user context with invocation ID  \n- `Forge as=user,accountId=user-123,id=invocation-123` - User impersonation\n","schema":{"type":"string","example":"Forge as=app,id=invocation-123"}},"ContentTypeHeader1":{"name":"Content-Type","in":"header","description":"Content type of the request body","schema":{"type":"string","example":"application/json"}}},"requestBodies":{"GenericRequestBody":{"description":"Generic request body","content":{"application/json":{"schema":{"type":"object"}}}},"AsyncEventsRequestBody":{"description":"Async events data to be submitted","content":{"application/json":{"schema":{"type":"object","required":["queueName","events"],"properties":{"queueName":{"type":"string","description":"The name of the queue to submit events to","example":"my-app-events"},"events":{"type":"array","description":"Array of events to be submitted","items":{"$ref":"#/components/schemas/AsyncEvent"},"example":[{"body":{"payload":{"key":"value","userId":"123","action":"user_login"}}}]}}}}}}},"securitySchemes":{"ForgeProxyAuthorization":{"type":"apiKey","in":"header","name":"forge-proxy-authorization","description":"Forge Proxy Authorization header for egress authentication"}},"examples":{"DMLQueryWithParamsRequestBodyExample":{"summary":"Example DML Query with Parameters","value":{"query":"SELECT name, age FROM users WHERE name = ? AND age = ?","params":["Alice",30]}},"DDLQueryWithParamsRequestBodyExample":{"summary":"Example DDL Query","value":{"query":"CREATE TABLE IF NOT EXISTS users (id INT PRIMARY KEY, name TEXT NOT NULL, age INT NOT NULL);","params":[]}},"SelectQueryResponseExample":{"summary":"Example Response for SELECT Query","value":{"rows":[{"name":"Alice","age":30}],"metadata":{"dbExecutionTime":5,"responseSize":12,"fields":[{"catalog":"def","name":"name","schema":"public","characterSet":33,"decimals":0,"table":"users","orgTable":"users","orgName":"name","flags":0,"columnType":1,"columnLength":255},{"catalog":"def","name":"age","schema":"public","characterSet":33,"decimals":0,"table":"users","orgTable":"users","orgName":"age","flags":0,"columnType":3,"columnLength":11}]}}},"DDLQueryResponseExample":{"summary":"Example Response for DDL Query","value":{"rows":{"fieldCount":0,"affectedRows":1,"insertId":0,"info":"","serverStatus":2,"warningCount":0},"metadata":{"dbExecutionTime":10.5,"responseSize":1234,"fields":[]}}},"PublishRealtimeMessageExample":{"value":{"name":"forge-container-realtime-channel","payload":"Realtime message sent from the container service, id=1","options":{"token":"example-token"}}},"PublishGlobalRealtimeMessageExample":{"value":{"name":"forge-container-realtime-channel","payload":"Realtime message sent from the container service, id=1"}},"SignRealtimeTokenExample":{"value":{"channelName":"forge-container-realtime-channel","claims":{"allowedUsers":["user1","user2"]}}}},"responses":{"Unauthorized":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"User does not have permissions to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"x-atlassian-narrative":{"documents":[{"title":"Forge Containers REST API (EAP)","anchor":"about","body":"This is a comprehensive reference for all Atlassian and Forge resources that you can access through their respective REST APIs. At present, these REST APIs can only be called by Forge Containers, which is currently only available under Forge's Early Access Program (EAP)."},{"title":"API contract","anchor":"apicontract","body":"To make outbound requests from your containerised service, you'll need to send requests through an _egress sidecar_. You can retrieve this sidecar's URL from the `FORGE_EGRESS_PROXY_URL` environment variable. \n[Learn more about sending API requests](/platform/forge/containers-reference/ref-api/#outbound-requests)"},{"title":"Early Access Program","anchor":"eap","body":"Like Forge Containers, the REST APIs endpoints provided in this references are currently also available under EAP. As such, they are only available for testing and feedback purposes. They are not supported for use in production or customer environments. \n[Learn more about Forge EAP](/platform/forge/whats-coming/#forge-early-access-program--eap-)"}]}}