Description: Retrieves the full configuration details of an existing Jira integration by its connection name.
Security: Requires admin access permissions.
Since: Xray version 3.129 and above.
API Version: V.1
Usage: GET /xray/api/v1/ticketing/jira-integrations/{connection_name}/details
Consumes: application/json
Produces : application/json
Query Parameters: none
Path Parameters:
Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| string | Mandatory | The name of the integration to retrieve. |
Response body
Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| string | Mandatory | Name of the Jira integration connection. |
| string | Mandatory | Type of authentication used Valid values: |
| string | Mandatory | Username configured for this integration. |
| string | Mandatory | Type of Jira installation ( |
| string | Mandatory | URL of the JIRA server associated with the integration |
| boolean | Optional | Indicates whether to skip proxy settings |
Response codes
Status Code | Description |
|---|---|
200 | Integration details retrieved successfully |
403 | Permission denied |
404 | No integration found for the given |
500 | Server error retrieving integration details |
Sample success response
200 OK
{
"auth_type": "basic",
"connection_name": "jira-connection-1",
"jira_server_url": "https://jira.example.com",
"username": "adminUser",
"installation_type": "cloud",
"skip_proxy": false
}
Sample error response
404 Not Found
{
"error": "Integration not found"
}