Update Jira Integration

Description: Updates an existing Jira integration’s configuration.

Security: Requires admin access permissions to perform the operation.

Notes:

Ensure that the given Jira Server URL is valid and accessible.
The username and password should have the necessary permissions to create tickets in the specified Jira instance.
skip_proxy controls whether a proxy is bypassed during connection checks.
Available from Xray version 3.129 and above.

API Version: V.1

Usage: PUT /xray/api/v1/ticketing/jira-integrations/{connection_name}

Consumes: application/json

Produces : application/json

Query Parameters: none

Request Body:

Name	Type	Mandatory/Optional	Description
`connection_name`	string	Mandatory	Name of the connection to update
`auth_type`	string	Optional	Authentication method. Valid values: `basic`
`username`	string	Optional	Username for authentication.
`password`	string	Optional	Password for authentication.
`installation_type`	string	Optional	Type of Jira installation. Valid values: `cloud`, `server`
`jira_server_url`	string	Optional	Jira server URL to use for ticketing.
`skip_proxy`	boolean	Optional	Bypass proxy settings when connecting. Default: `false`.

Response body

Name	Type	Mandatory/Optional	Description
`info`	string	Optional	Message confirming a successful update.
`error`	string	Optional	Error details if the update fails.

Response codes

Status Code	Description
200	Success - Integration updated
400	One or more fields are missing/invalid
403	Permission denied
404	No integration found with the given `connection_name`
500	Failed to update integration

Sample request

Example 1 – Connecting with Jira Cloud

{
      "connection_name": "cloudProjectABC",
      "auth_type": "basic",
      "username": "customer@gmail.com",
      "password": "password",
      "installation_type": "cloud",
      "jira_server_url": "https://customer.atlassian.net",
      "skip_proxy": false
  }

Example 2 – Connecting with a self-hosted Jira Server

{
      "connection_name": "ServerProjectXYZ",
      "authType": "basic",
      "username": "customer@gmail.com",
      "password": "password",
      "installation_type": "server",
      "jira_server_url": "http://10.35.12.11",
      "skip_proxy": true
  }

Sample successful response

200 OK
{
  "info": "Integration has been successfully updated"
}

Sample error response

404 Not Found
{
  "error": "No integration found with the given connection name"
}