Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
  • App Installations
  • Atlassian GraphQL
  • Confluence
  • Forge Context
  • Forge Dynamic Modules
  • Forge Events
  • Forge KVS
  • Forge LLM
  • Forge Object Store
  • Forge Proxy
  • Forge Realtime
  • Forge SQL
  • Jira
Platform
Forge / Reference / APIs for Forge Containers

Forge Context

Postman Collection
OpenAPI

APIs for retrieving Forge invocation Context

GET

Get invocation context

Returns contextual data associated with the invocation. This API retrieves data cached in the proxy and is expected to be low latency.

Forge and OAuth2 apps cannot access this REST resource.

Request

Header parameters

forge-proxy-authorization

string

Required

Responses

Invocation context retrieved successfully

application/json

InvocationContext

Contextual data associated with the invocation

GET/invocation/context
1 2 3 4 curl --request GET \ --url '{FORGE_EGRESS_PROXY_URL}/invocation/context' \ --header 'Accept: application/json' \ --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 { "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 } } }

Rate this page: