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

EditProject

Route: https://kayran.live/api/EditProject

This feature allows you to edit an existing project.

Roles Required: Admin. Users and Private Users can only Edit Projects they created.

Request Syntax

{
    "apiKey": "String",
    "projectName": "String",
    "companyName": "String"
    "description": Enter text as you like,
    "jiraProjectKey": "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


Successful Response

{
    "Error": 0,
    "Function": "EditProject",
    "Data": "Updated"
}

Errors and their Possible Causes

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