Route: https://api.kayran.live/NewProject
This feature allows you to create a new project.
Note : in order to be able to assign targets\scans to the project, use the appropriate parameter when you initiate a new scan.
Roles Required: Admin, User and Private User.
Request Syntax
{
"apiKey": "String",
"projectName": "String",
"companyName": "String",
"description": "String",
"jiraProjectKey": "String",
"img": "String",
}Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your Kayran 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 :
projectName
Parameter Usage and Options :
This parameter will allow you to set your project’s name that will be used to tag your targets while scanning with Kayran.
Type :
String
Is it Optional ? :
No.
Parameter Name :
companyName
Parameter Usage and Options :
The name of the company you wish to set for the project.
Type :
String
Is it Optional ? :
No.
Parameter Name :
description
Parameter Usage and Options :
There is an option to write a description for the project.
Value :
Any text you wish to use.
Type :
String
Is it Optional ? :
Yes
Parameter Name :
jiraProjectKey
Parameter Usage and Options :
Key of the project you’ve created in Jira.
Type :
String
Is it Optional ? :
Yes
Parameter Name :
img
Parameter Usage and Options :
In case Users wish to attach a Logo to the Project. Insert the exact full name of the File as it’s being saved in the Storage.
For example: image1.png –> image1.png.
Type :
String
Is it Optional ? :
Yes.
Successful Response
{
"Error": 0,
"Function": "NewProject",
"Data": "Project created."
}Errors and their Possible Causes
For more information, please refer to the General Errors section.