Route: https://api.cytrix.io/AddJiraConnection
Using this function allows you to add a connection to Jira.
Roles Required: Admin.
Request Syntax
{
"apiKey": "string","serverName": "String","projectKey": "String","projectName": "String","jiraApiKey": "String","email": "String",",onHigh": True/False",onMedium": True/False"onLow": ,True/False"onInformative": True/False
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your CYTRIX given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
serverName
Parameter Usage and Options :
The name of your Jira server. Will appear as: https://”servername“.atlassian.net/ .
Type :
String
Is it Optional ? :
No.
Parameter Name :
projectKey
Parameter Usage and Options :
Navigate to the “Projects” section in your Jira account, from the table being displayed, take the “Key” value of the desired project.
Type :
String
Is it Optional ? :
No.
Parameter Name :
projectName
Parameter Usage and Options :
This parameter will allow you to set your project’s name that will be used to tag your integration.
Type :
String
Is it Optional ? :
No.
Parameter Name :
jiraApiKey
Parameter Usage and Options :
Navigate to https://id.atlassian.com/manage-profile/security/api-tokens and take the API key from there. If there isn’t one, create a new one (Create API token).
Type :
String
Is it Optional ? :
No.
Parameter Name :
Parameter Usage and Options :
The Email address being used in the creation of the API key.
Type :
String
Is it Optional ? :
No.
Parameter Name :
onHigh
Parameter Usage and Options :
Enabling the onHigh toggle ensures that you receive notifications for vulnerabilities classified as High severity during scans.
Type:
Boolean – True / False
Is it Optional ? :
No.
Parameter Name :
onMedium
Parameter Usage and Options :
Enabling the onMedium Medium
Type:
Boolean – True / False
Is it Optional ? :
No.
Parameter Name :
onLow
Parameter Usage and Options :
Enabling the onLow toggle ensures that you receive notifications for vulnerabilities classified as Low severity during scans.
Type:
Boolean – True / False
Is it Optional ? :
No.
Parameter Name :
onInformative
Parameter Usage and Options :
Enabling the onInformative Informative
Type:
Boolean – True / False
Is it Optional ? :
No.
Successful Response
{
"Error": 0,
"Function": "AddJiraConnection",
"Data": "Success"
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.