Create Jira Integration

Description: Creates a new Jira integration.

Security: Requires admin access permissions.

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.
The skip_proxy option determines if a proxy should be ignored during the connection.
Available from Xray version 3.129 and above.

API Version: V.1

Usage: POST /xray/api/v1/ticketing/jira-integrations

Consumes: application/json

Produces : application/json

Path Parameters: none

Query Parameters: none

Request Body:

Name	Type	Mandatory/Optional	Description
`connection_name`	string	Mandatory	A unique identifier for the connection.
`auth_type`	string	Mandatory	The authentication method to be utilized. Valid values: `basic`
`username`	string	Mandatory	The username for authentication.
`password`	string	Mandatory	The password for authentication.
`installation_type`	string	Mandatory	Specifies the type of installation. Valid values: `cloud`, `server`
`jira_server_url`	string	Mandatory	The URL of the Jira server where tickets will be generated.
`skip_proxy`	boolean	Optional	Indicates whether proxy settings should be bypassed. Default: `false`.

Response body

Name	Type	Mandatory/Optional	Description
`info`	string	Optional	Provides information when the request is successful.
`error`	string	Optional	Contains error details when the request fails (non-200 response).

Response codes

Status Code	Description
200	Success - Integration created
400	One or more fields are missing/invalid
403	Permission denied
500	Failed to create 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",
  "auth_type": "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 created"
}

Sample error response

400 Bad Request
{
  "error": "We were not able to connect to your Jira based on the credentials you provided, please check all the values and try again."
}