Route: https://api.cytrix.io/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",
"jiraProjectName": "String"
}
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 :
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 CYTRIX.
Type :
String
Is it Optional ? :
No.
Parameter Name :
jiraProjectName
Parameter Usage and Options :
Name of the project you’ve created in Jira.
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.