Get Jira Integration Status

Description: Retrieves the latest status of an existing Jira integration by its connection name. This endpoint checks the health and operational status of the integration, including connectivity, authentication, and configuration validation.

Security: Requires admin access permissions.

Since: Xray version 3.136 and above.

API Version: V.1

Usage: GET /xray/api/v1/ticketing/integrations/status/check

Consumes: application/json

Produces : application/json

Query Parameters:

Name	Type	Mandatory/Optional	Description
`integrationName`	string	Mandatory	The name of the integration to check the status for.

Path Parameters:None

Response body

Name	Type	Mandatory/Optional	Description
`status`	string	Mandatory	Status of the integration. Valid values: `HEALTHY_INTEGRATION`, `INTEGRATION_NOT_FOUND`, `INTERNAL_SERVER_ERROR`, `FAULTY_CONFIGURATION`
`reason`	string	Mandatory	Descriptive message explaining the status.
`time`	string	Mandatory	The date and time at which the status was most recently verified, expressed in RFC 3339 timestamp format (for example, `2024-01-01T00:00:00Z`).
`integration_name`	string	Mandatory	Name of the integration that was checked.

Response codes

Status Code	Description
200	Integration status retrieved successfully
400	Bad request (e.g., missing integrationName parameter)
404	No integration found for the given `integrationName`
500	Server error retrieving integration status

Sample Success Response

200 OK
{
  "status": "HEALTHY_INTEGRATION",
  "reason": "Integration is healthy and operational.",
  "time": "2024-01-01T12:00:00Z",
  "integration_name": "jira-connection-1"
}

Request Example

GET  xray/api/v1/ticketing/integrations/status/check?integrationName=test

Response Example

{
    "status": "HEALTHY_INTEGRATION",
    "reason": "Integration is healthy and operational.",
    "time": "2025-12-22T08:18:02Z",
    "integration_name": "test"
}

Sample error response

200 OK (Faulty Configuration)
{
  "status": "FAULTY_CONFIGURATION",
  "reason": "The system is unable to connect to Jira.",
  "time": "2024-01-01T12:00:00Z",
  "integration_name": "jira-connection-1"
}

404 Not Found
{
  "status": "INTEGRATION_NOT_FOUND",
  "reason": "The integration does not exist or cannot be located.",
  "time": "2024-01-01T12:00:00Z",
  "integration_name": "non-existent-integration"
}

500 Internal Server Error
{
  "status": "INTERNAL_SERVER_ERROR",
  "reason": "The system is temporarily unable to retrieve integration details. Please try again later.",
  "time": "2024-01-01T12:00:00Z",
  "integration_name": "jira-connection-1"
}