Some options are limited.

This site uses cookies and other tracking technologies to make possible your usage of the website, assist with navigation and your ability to provide feedback, analyse your use of our products and services, assist with our promotional and marketing efforts, and provide better user experience.

By using the website, you agree to our Privacy policy

Sign in Sign Up

Project Settings (getSettings)

getSettings — method returns a list of settings in a specific project.

Request parameters
Parameters Value Description
id any number or string Request id
method getSettings API method name
params {...} Array of parameters


Response parameters
Parameter Description
id Request id
result Contains the answer
domain Project domain
name Project name
subdomainsCheck Subdomains check
pagesLimit Scan pages limit
scanSpeed Scan speed
autoSpeed Auto speed control
autoUserAgent User Agent auto switches at unsuccessful server response
scanNoIndex No-index pages scanning
scanWrongCanonical Wrong canonical pages scanning
scanDuration Scan duration
folderDepth Scan folder depth
urlDepth URL depth
userAgent User Agent
robotsTxt Robots.txt regulations check
dontScanKeywordsBlock Don’t scan pages with keywords in URL
onlyScanKeywordsBlock Scan only pages with keywords in URL
baseAuthBlock Access to websites shut down with BaseAuth
login BaseAuth login
password BaseAuth password
mailTriggerSettings Trigger mail settings
emails Array of emails trigger mail to be sent
interval Interval of trigger mailing
enabled Trigger mail enabling
scheduleSettings Scan schedule settings
scheduleRepeatOption Scan interval id
scanSetting Scan type settings
type Scan type mode id
list Arrays of URL to be scanned
importedFilename URL File name of previously imported URL

Example PHP Python
Request data:
 "method": "AuditSite.getSettings",
  "jsonrpc": "2.0"

Response data:
    "id": "1",
    "result": {
        "mainSettings": {
            "domain": "",
            "name": "",
            "subdomainsCheck": true,
            "pagesLimit": 5000,
            "scanSpeed": 200,
            "autoSpeed": true,
            "autoUserAgent": true,
            "scanDuration": 0,
            "folderDepth": 0,
            "urlDepth": 0,
            "userAgent": 0,
            "robotsTxt": true
        "dontScanKeywordsBlock": {
            "checked": false,
            "keywords": ""
        "onlyScanKeywordsBlock": {
            "checked": false,
            "keywords": ""
        "baseAuthBlock": {
            "login": "",
            "password": ""
        "mailTriggerSettings": {
            "emails": [],
            "interval": 1,
            "enabled": false
        "scheduleSettings": {
            "scheduleRepeatOption": 0
        "scanSetting": {
            "type": 1,
            "list": [],
            "importedFilename": null
    "jsonrpc": "2.0"

Share this article with your friends

Sign In Free Sign Up

You’ve reached your query limit.

Or email
Forgot password?
Or email
Back To Login

Don’t worry! Just fill in your email and we’ll send over your password.

Are you sure?


To complete your registration you need to enter your phone number


We sent confirmation code to your phone number

Your phone Resend code Queries left

Something went wrong.

Contact our support team
Or confirm the registration using the Telegram bot Follow this link
Please pick the project to work on

Personal demonstration

Serpstat is all about saving time, and we want to save yours! One of our specialists will contact you and discuss options going forward.

These may include a personal demonstration, a trial period, comprehensive training articles & webinar recordings, and custom advice from a Serpstat specialist. It is our goal to make you feel comfortable while using Serpstat.




We are glad of your comment
Upgrade your plan

Upgrade your plan

Export is not available for your account. Please upgrade to Lite or higher to get access to the tool. Learn more

Sign Up Free

Спасибо, мы с вами свяжемся в ближайшее время

View Editing


You have run out of limits

You have reached the limit for the number of created projects. You cannot create new projects unless you increase the limits or delete existing projects.

I want more limits