1. Home
  2. Docs
  3. API Documentation
  4. Scans – Get
  5. GetForms

GetForms

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

This function will allow you to view Forms that were found on a specific Scan.

Roles Required: Admin and User. Private Users can only fetch Forms from Scans they initiated.

Request Syntax

{

"apiKey": "string",

"token": "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.


Successful Response

{

    “Error”: 0,

    “Function”: “GetForms”,

    “Data”: [

        {

            “id”: 123,

            “url”: “https://example.com/”,

            “action”: “https://example.com/robots.txt”,

            “parameters”: [

                {

                    “mode”: “String”,

                    “param”: “String”,

                    “value”: “String”

                }

            ],

            “method”: “POST”,

            “label”: “String”,

            “request”: “”

         }
]
}

Errors and their Possible Causes

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