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

DetailsProject

Using this function will allow you to view details of an existing project.

Request Syntax

{
    "apiKey": "String",
    "projectName": "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.


Successful Response

{
    "Error": 0,
    "Function": "DetailsProject",
    "Data": "{\"id\": 123456789, \"proj_name\": \"Testytest\", \"company_name\": \"Name\", \"description\": \"Description\", \"targets\": 0}"
}

  

Errors and their Possible Causes

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