1. Home
  2. Docs
  3. API Documentation
  4. Scans – Modify
  5. ChangeProject

ChangeProject

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

This feature will allow you to attach any existing scan, to a certain project.

Roles Required: Admin. Users and Private Users can only Change/Attach to Projects for Scans they initiated.

Request Syntax

{

"apiKey": "String",

"token": "String",

"projectName": "String“,

“ProjectId”: “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 :

token

Parameter Usage and Options :

The scan’s token.

How do I get it ? :

Simply use the “GetScan” or “GetAllScans” function, or navigate to a certain scan’s page, and in the address bar, you will notice “token=String”, use that String.

Type :

String

Is it Optional ? :

No.


Parameter Name :

projectName

Parameter Usage and Options :

The name of the project you would like to attach the scan to.

How do I get it ? :

Simply use the “GetProjects” function, or, navigate to the “Projects” section, in there, a table listing all of your projects can be found.

Type :

String

Is it Optional ? :

No.


Parameter Name :

projectId

Parameter Usage and Options :

The Id of the project you would like to attach the scan to.

How do I get it ? :

Simply use the “GetProjects” function, or, navigate to the “Projects” section, in there, go to one of your projects, The id of your project can be found in the url.

Type :

String

Is it Optional ? :

Yes.


Successful Response

{


“Error”: 0,
“Function”: “ChangeProject”,
“Data”: “Successfully updated”


}

Errors and their Possible Causes

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