1. Home
  2. Docs
  3. API Documentation
  4. Projects
  5. NewProject

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.

Request Syntax

{
    "apiKey": "String",
    "projectName": "String",
    "companyName": "String"
    "description": Enter text as you like,
}

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


Successful Response

{
    "Error": 0,
    "Function": "NewProject",
    "Data": "Project created."
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.