The Jira API provides comprehensive access to issues, projects, users, workflows, and other Jira resources. Use the /jira/{target} endpoint to proxy requests to the Jira REST API.

Operations

GET/jira/{target}PUT/jira/{target}POST/jira/{target}DEL/jira/{target}OPT/jira/{target}HEAD/jira/{target}PATCH/jira/{target}

GET

Proxy GET request to Jira API

Proxies requests to the Jira Cloud Platform REST API v3. The target parameter specifies the Jira API endpoint.

API Documentation: Jira Cloud Platform REST API v3

Examples:

/jira/rest/api/3/issue/ISSUE-123 - Get issue details
/jira/rest/api/3/project - List projects
/jira/rest/api/3/myself - Get current user info

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Jira API

application/json

object

GET/jira/{target}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url '{FORGE_EGRESS_PROXY_URL}/jira/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

PUT

Proxy PUT request to Jira API

Proxies PUT requests to the Jira Cloud Platform REST API v3. The target parameter specifies the Jira API endpoint.

API Documentation: Jira Cloud Platform REST API v3

Examples:

/jira/rest/api/3/issue/ISSUE-123 - Update issue
/jira/rest/api/3/project/PROJECT-123 - Update project

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied to Jira API

application/json

object

PUT/jira/{target}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url '{FORGE_EGRESS_PROXY_URL}/jira/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'

POST

Proxy POST request to Jira API

Proxies POST requests to the Jira Cloud Platform REST API v3. The target parameter specifies the Jira API endpoint.

API Documentation: Jira Cloud Platform REST API v3

Examples:

/jira/rest/api/3/issue - Create new issue
/jira/rest/api/3/issue/ISSUE-123/comment - Add comment to issue

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied to Jira API

application/json

object

POST/jira/{target}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url '{FORGE_EGRESS_PROXY_URL}/jira/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'

DEL

Proxy DELETE request to Jira API

Proxies DELETE requests to the Jira Cloud Platform REST API v3. The target parameter specifies the Jira API endpoint.

API Documentation: Jira Cloud Platform REST API v3

Examples:

/jira/rest/api/3/issue/ISSUE-123 - Delete issue
/jira/rest/api/3/issue/ISSUE-123/comment/123 - Delete comment

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Jira API

application/json

object

DEL/jira/{target}

curl

Node.js

Java

Python

PHP

curl --request DELETE \
  --url '{FORGE_EGRESS_PROXY_URL}/jira/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

OPT

Proxy OPTIONS request to Jira API

Proxies OPTIONS requests to the Jira Cloud Platform REST API v3. Used for CORS preflight requests and method discovery.

API Documentation: Jira Cloud Platform REST API v3

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Jira API

application/json

object

OPT/jira/{target}

curl

Node.js

Java

Python

PHP

curl --request OPTIONS \
  --url '{FORGE_EGRESS_PROXY_URL}/jira/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

HEAD

Proxy HEAD request to Jira API

Proxies HEAD requests to the Jira Cloud Platform REST API v3. Returns headers without response body, useful for checking resource existence.

API Documentation: Jira Cloud Platform REST API v3

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Jira API

application/json

object

HEAD/jira/{target}

curl

Node.js

Java

Python

PHP

curl --request HEAD \
  --url '{FORGE_EGRESS_PROXY_URL}/jira/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

PATCH

Proxy PATCH request to Jira API

Proxies PATCH requests to the Jira Cloud Platform REST API v3. The target parameter specifies the Jira API endpoint.

API Documentation: Jira Cloud Platform REST API v3

Examples:

/jira/rest/api/3/issue/ISSUE-123 - Partially update issue

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied to Jira API

application/json

object

PATCH/jira/{target}

curl

Node.js

Java

Python

PHP

curl --request PATCH \
  --url '{FORGE_EGRESS_PROXY_URL}/jira/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'