Route: https://api.cytrix.io/DeleteProject
This function deletes an existing project.
Note : marking “Recursive” as true\false determines whether the scans associated with the project will\won’t be deleted.
Roles Required: Admin. Users and Private Users can only Delete Projects they created.
Request Syntax
{
"apiKey": "String",
"projectName": "String",
"recursive": 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 :
recursive
Parameter Usage and Options :
Enabling recursive means that the scans associated with the project will be deleted also.
Value :
True/False
Type :
Boolean
Is it Optional ? :
Yes.
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.
Successful Response
{
"Error": 0,
"Function": "DeleteProject",
"Data": "Project deleted."
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.