Sample of using JIRA Rest API via bash, curl and sed.

wti

#!/bin/bash

usage() {
	echo "
Usage: wti [-h?] [-l LOGIN] ISSUE...

wti = \"(W)hat (T)he (I)ssue?\". Script tries to get description of the specified 
ISSUE(es) from jira. For each ISSUE in list script will ouput the line in 
the following format: ISSUE_ID — ISSUE_DESC

options:

 -h -?	Print this message and exit

 -l	LOGIN	Jira-user login. Will be promted if not specified."
}

shortusage() {
	echo "
Usage: wti [-h?] [-l LOGIN] ISSUE...

See wti -h for help"
}

error() {
	if [[ -n $1 ]];
	then
		echo -e "\nERROR: $1"
		if [[ -n $2 ]];
		then
			shortusage
		fi
		exit 1
	fi	
}

JIRA_URL="https://jira.atlassian.com"
JIRA_AUTH_URI="/rest/auth/latest/session"
JIRA_API_URI="/rest/api/latest/"

OPTIND=1

# Parsing flags
while getopts "h?l:" opt
do
	case $opt in
		h|\?)
			usage
			exit 0
			;;
		l)
			JIRA_LOGIN=$OPTARG
			;;
	esac
done

# getting list of braches
if [[ -z ${!OPTIND} ]]; then
	error "You must specified at least one issue!" 1
else
	for ((ARG=$OPTIND, NUM=0; ARG>0; ARG++));
	do
		if [[ -z ${!ARG} ]];
		then
			break
		fi
		ISSUES[$NUM]=${!ARG}
		NUM=$[NUM+1]
	done
fi

# getting login fo JIRA
if [[ -z $JIRA_LOGIN ]]; then
	read -p "Enter your login for JIRA: " JIRA_LOGIN
fi
# getting password for JIRA
read -sp "Enter your password for JIRA: " JIRA_PASSWORD
echo ""

# authentication in JIRA
JIRA_SESSION_ID=`curl -s -H "Content-Type: application/json" -d "{\"username\":\"${JIRA_LOGIN}\",\"password\":\"${JIRA_PASSWORD}\"}" -X POST ${JIRA_URL}${JIRA_AUTH_URI} | sed -r 's/^.+JSESSIONID","value":"([^"]+).+$/\1/ig'`

if [[ -n $(echo $JIRA_SESSION_ID | grep error) ]]
then
	error "Wrong login or password!"
fi

# getting info about branches
for ((I=0; I<${#ISSUES[@]}; I++));
do
	SED=`curl -s -H "Content-Type: application/json" -b JSESSIONID=${JIRA_SESSION_ID} ${JIRA_URL}${JIRA_API_URI}issue/${ISSUES[$I]}?fields=summary | sed -n -re 's@\\\["]([^\\\]+)\\\["]@«\1»@ig' -e 's/^.+key":"([^"]+)".+summary":"([^"]+).+$/\1 - \2\n/igp'`
	if [[ -z $SED ]]
	then
		echo "Issue \"${ISSUES[$I]}\" not found or unknown error has occured!"
	else
		echo $SED
	fi
done

always I am getting Issue "BOLT-13360" not found or unknown error has occured!
what are the depended library required for running this bash script?
How to check restAPI is available or not? looks like below two things are related to restAPI.
How to install it?
JIRA_AUTH_URI="/rest/auth/latest/session"
JIRA_API_URI="/rest/api/latest/"

@SwarnalataPanda, the script doesn't have any dependencies. You should just download it, change JIRA_URL to your own and it should work. To validate an API, just open in your browser, which has an authorized session, the following: https://YOUR_JIRA_DOMAIN/rest/api/latest/issue/BOLT-13360

Hi RomiC, I am getting the below error while running this script. I have removed the '-s' option to know more about the error. my authorized session is https://${JIRA_URL}/browse/BOLT-3360 , which is validated on the browser. *for Authentication in JIRA* JIRA_SESSION_ID=`curl -s -H "Content-Type: application/json" -d "{\"username\":\"${JIRA_LOGIN}\",\"password\":\"${JIRA_PASSWORD}\"}" -X POST ${JIRA_URL} | sed -r 's/^.+JSESSIONID","value":"([^"]+).+$/\1/ig'` *for getting info about branches* SED=`curl -s -H "Content-Type: application/json" -b JSESSIONID=${JIRA_SESSION_ID} ${JIRA_URL}/browse/${ISSUES[$I]}?fields=summary | sed -n -re 's@\\\["]([^\\\]+)\\\["]@***@***.***' -e 's/^.+key":"([^"]+)".+summary":"([^"]+).+$/\1 - \2\n/igp'` ~$ sh jira.sh BOLT-3360 Enter your login for JIRA: swarna.panda Enter your password for JIRA: % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- 0:00:01 --:--:-- 0 curl: (60) SSL certificate problem: certificate has expired More details here: http://curl.haxx.se/docs/sslcerts.html curl performs SSL certificate verification by default, using a "bundle" of Certificate Authority (CA) public keys (CA certs). If the default bundle file isn't adequate, you can specify an alternate file using the --cacert option. If this HTTPS server uses a certificate signed by a CA represented in the bundle, the certificate verification probably failed due to a problem with the certificate (it might be expired, or the name might not match the domain name in the URL). If you'd like to turn off curl's verification of the certificate, use the -k (or --insecure) option. % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- 0:00:01 --:--:-- 0 curl: (60) SSL certificate problem: certificate has expired More details here: http://curl.haxx.se/docs/sslcerts.html curl performs SSL certificate verification by default, using a "bundle" of Certificate Authority (CA) public keys (CA certs). If the default bundle file isn't adequate, you can specify an alternate file using the --cacert option. If this HTTPS server uses a certificate signed by a CA represented in the bundle, the certificate verification probably failed due to a problem with the certificate (it might be expired, or the name might not match the domain name in the URL). If you'd like to turn off curl's verification of the certificate, use the -k (or --insecure) option. Issue "BOLT-3360" not found or unknown error has occured! Please let me know if there is anything wrong. Regards Swarna

…

On Wed, May 12, 2021 at 3:22 PM Roman Charugin ***@***.***> wrote: ***@***.**** commented on this gist. ------------------------------ @SwarnalataPanda <https://github.com/SwarnalataPanda>, the script doesn't have any dependencies. You should just download it, change JIRA_URL <https://gist.github.com/RomiC/7232293#file-wti-L37> to your own and it should work. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <https://gist.github.com/7232293#gistcomment-3739874>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJPVW2UQN2CSKU2GGZ5NHDDTNJFW3ANCNFSM44VG5ONA> .

-- *Regards,* *Swarna*

@RomiC,
API is "https://${JIRA_URL}/browse/BOLT-13360," according to this, I have updated the authorization command is
JIRA_SESSION_ID=curl -s -H "Content-Type: application/json" -d "{\"username\":\"${JIRA_LOGIN}\",\"password\":\"${JIRA_PASSWORD}\"}" -X POST ${JIRA_URL} | sed -r 's/^.+JSESSIONID","value":"([^"]+).+$/\1/ig'
and to getting info from branch
SED=curl -s -H "Content-Type: application/json" -b JSESSIONID=${JIRA_SESSION_ID} ${JIRA_URL}/browse/${ISSUES[$I]}?fields=summary | sed -n -re 's@\\\["]([^\\\]+)\\\["]@«\1»@ig' -e 's/^.+key":"([^"]+)".+summary":"([^"]+).+$/\1 - \2\n/igp'

Even I am getting same error as Issue "BOLT-13360" not found or unknown error has occured!

Hi RomiC, After running this script, How will we confirm as we are successfully loged into JIRA? I want to download the attached log whose Mime Type is "application/octet-stream" from that ticket(BOLT-3360)., could you please help on this also? Regards Swarna

…

On Thu, May 13, 2021 at 7:06 PM Swarna Panda ***@***.***> wrote: Hi RomiC, I am getting the below error while running this script. I have removed the '-s' option to know more about the error. my authorized session is https://${JIRA_URL}/browse/BOLT-3360 , which is validated on the browser. *for Authentication in JIRA* JIRA_SESSION_ID=`curl -s -H "Content-Type: application/json" -d "{\"username\":\"${JIRA_LOGIN}\",\"password\":\"${JIRA_PASSWORD}\"}" -X POST ${JIRA_URL} | sed -r 's/^.+JSESSIONID","value":"([^"]+).+$/\1/ig'` *for getting info about branches* SED=`curl -s -H "Content-Type: application/json" -b JSESSIONID=${JIRA_SESSION_ID} ${JIRA_URL}/browse/${ISSUES[$I]}?fields=summary | sed -n -re 's@\\\["]([^\\\]+)\\\["]@***@***.***' -e 's/^.+key":"([^"]+)".+summary":"([^"]+).+$/\1 - \2\n/igp'` ~$ sh jira.sh BOLT-3360 Enter your login for JIRA: swarna.panda Enter your password for JIRA: % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- 0:00:01 --:--:-- 0 curl: (60) SSL certificate problem: certificate has expired More details here: http://curl.haxx.se/docs/sslcerts.html curl performs SSL certificate verification by default, using a "bundle" of Certificate Authority (CA) public keys (CA certs). If the default bundle file isn't adequate, you can specify an alternate file using the --cacert option. If this HTTPS server uses a certificate signed by a CA represented in the bundle, the certificate verification probably failed due to a problem with the certificate (it might be expired, or the name might not match the domain name in the URL). If you'd like to turn off curl's verification of the certificate, use the -k (or --insecure) option. % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- 0:00:01 --:--:-- 0 curl: (60) SSL certificate problem: certificate has expired More details here: http://curl.haxx.se/docs/sslcerts.html curl performs SSL certificate verification by default, using a "bundle" of Certificate Authority (CA) public keys (CA certs). If the default bundle file isn't adequate, you can specify an alternate file using the --cacert option. If this HTTPS server uses a certificate signed by a CA represented in the bundle, the certificate verification probably failed due to a problem with the certificate (it might be expired, or the name might not match the domain name in the URL). If you'd like to turn off curl's verification of the certificate, use the -k (or --insecure) option. Issue "BOLT-3360" not found or unknown error has occured! Please let me know if there is anything wrong. Regards Swarna On Wed, May 12, 2021 at 3:22 PM Roman Charugin ***@***.***> wrote: > ***@***.**** commented on this gist. > ------------------------------ > > @SwarnalataPanda <https://github.com/SwarnalataPanda>, the script > doesn't have any dependencies. You should just download it, change > JIRA_URL <https://gist.github.com/RomiC/7232293#file-wti-L37> to your > own and it should work. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <https://gist.github.com/7232293#gistcomment-3739874>, or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AJPVW2UQN2CSKU2GGZ5NHDDTNJFW3ANCNFSM44VG5ONA> > . > -- *Regards,* *Swarna*

-- *Regards,* *Swarna*

@SwarnalataPanda, you don't need to touch anything except JIRA_URL -value on line 37. Let's say, your Jira hostname is https://myjira.com, then you need to change line 37 to the following:

JIRA_URL="https://myjira.com"

That's actually everything you need to change in the script. Pls, try this way.

To obtain the list of the attachments, you may use something like this one:

curl -H "Authorization: Basic $JIRA_AUTH" -H "Content-Type: application/json" https://YOUR_JIRA_HOST/rest/api/2/issue/JIRA_ITEM_KEY\?fields\=attachment | jq '.fields.attachment[].content'

Pay attention, that it requires jq utility to be installed on your machine.

Hi RomiC, But after changing the JIRA_URL in the script, I am getting same error "Issue "BOLT-13360" not found or unknown error has occured!" https://JIRA_URL/browse/BOLT-13360( here, i can able to access the issue) Regards Swarna

…

On Fri, May 14, 2021 at 4:23 PM Roman Charugin ***@***.***> wrote: ***@***.**** commented on this gist. ------------------------------ @SwarnalataPanda <https://github.com/SwarnalataPanda>, you don't need to touch anything except JIRA_URL -value on line 37. Let's say, your Jira hostname is https://myjira.com, then you need to change line 37 to the following: JIRA_URL="https://myjira.com" That's actually everything you need to change in the script. Pls, try this way. To obtain the list of the attachments, you may use something like this one: curl -H "Authorization: Basic $JIRA_AUTH" -H "Content-Type: application/json" https://YOUR_JIRA_HOST/rest/api/2/issue/JIRA_ITEM_KEY\?fields\=attachment | jq '.fields.attachment[].content' Pay attention, that it requires jq utility to be installed on your machine. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <https://gist.github.com/7232293#gistcomment-3742569>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJPVW2T523PDUTUBUMQZF3LTNT6KZANCNFSM44VG5ONA> .

-- *Regards,* *Swarna*

Hi RomiC, But after changing the JIRA_URL in the script, I am getting same error "Issue "BOLT-13360" not found or unknown error has occured!" https://JIRA_URL/browse/BOLT-13360( here, i can able to access the issue) Regards Swarna
…
On Fri, May 14, 2021 at 4:23 PM Roman Charugin @.***> wrote: @RomiC commented on this gist. ------------------------------ @SwarnalataPanda https://github.com/SwarnalataPanda, you don't need to touch anything except JIRA_URL -value on line 37. Let's say, your Jira hostname is https://myjira.com, then you need to change line 37 to the following: JIRA_URL="https://myjira.com" That's actually everything you need to change in the script. Pls, try this way. To obtain the list of the attachments, you may use something like this one: curl -H "Authorization: Basic $JIRA_AUTH" -H "Content-Type: application/json" https://YOUR_JIRA_HOST/rest/api/2/issue/JIRA_ITEM_KEY?fields=attachment | jq '.fields.attachment[].content' Pay attention, that it requires jq utility to be installed on your machine. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://gist.github.com/7232293#gistcomment-3742569, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJPVW2T523PDUTUBUMQZF3LTNT6KZANCNFSM44VG5ONA .
-- Regards, Swarna

make sure you don't have '/' at the end of JIRA_URL.

@RomiC its very slow as it tries to login every time I run it, is there anyway that it can store the session id and use it so not to login again.
UPDATE - I observed that even if we use the existing session ID its still slow, it has something to parse issue description.

@SwarnalataPanda, in order to debug add you need to add the following string echo $JIRA_SESSION_ID into line 82. Than make a request and store the output session ID somewhere. After that try the following command in your console: curl -H "Content-Type: application/json" -b JSESSIONID=JIRA_SESSION_ID https://JIRA_URL/rest/api/latest/issue/BOLT-13360?fields=summary.

@DineshSolanki you may request several items per time: wti JIRA-1 JIRA-2 JIRA-3. To be honest, never had performance issues to start investigating the problem.

@SwarnalataPanda, in order to debug add you need to add the following string echo $JIRA_SESSION_ID into line 82. Than make a request and store the output session ID somewhere. After that try the following command in your console: curl -H "Content-Type: application/json" -b JSESSIONID=JIRA_SESSION_ID https://JIRA_URL/rest/api/latest/issue/BOLT-13360?fields=summary.

@DineshSolanki you may request several items per time: wti JIRA-1 JIRA-2 JIRA-3. To be honest, never had performance issues to start investigating the problem.

yeah might have to do something with my work vpn, but it's helping, thanks a lot,