Administration

Returns the current administration settings. <br>Privileges: Global Administrator

get/api/3/administration/settings

Request

Response

OK

assetLinkingboolean

Whether asset linking is enabled.

directorystring

The root directory of the console.

insightPlatformboolean

Whether the usage of the VM platform is enabled.

insightPlatformRegionstring

The region used for the VM platform, if enabled.

serialNumberstring

The console serial number.

uuidstring

The universally unique identifier (UUID) of the console.

Example response

{
  "assetLinking": true,
  "database": {
    "connection": {
      "maximumAdministrationPoolSize": -1,
      "maximumPoolSize": -1,
      "maximumPreparedStatementPoolSize": 256
    },
    "host": "127.0.0.1",
    "maintenanceThreadPoolSize": 20,
    "port": 5432,
    "url": "//127.0.0.1:5432/nexpose",
    "user": "nxpgsql",
    "vendor": "postgresql"
  },
  "directory": "/opt/rapid7/nexpose",
  "insightPlatform": true,
  "insightPlatformRegion": "us-east-1",
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "risk": {
    "adjustWithCriticality": true,
    "criticalityModifiers": {
      "high": 1.5,
      "low": 0.75,
      "medium": 1,
      "veryHigh": 2,
      "veryLow": 0.5
    },
    "model": "risk_score_v2"
  },
  "scan": {
    "connectionTimeout": "PT15S",
    "incremental": true,
    "maximumThreads": -1,
    "readTimeout": "PT15M",
    "statusIdleTimeout": "PT3M",
    "statusThreads": 3
  },
  "serialNumber": "729F31B1C92F3C91DFA8A649F4D5C883C269BD45",
  "smtp": {
    "host": "mail@acme.com",
    "port": 25,
    "sender": "security@acme.com"
  },
  "updates": {
    "contentAutoUpdate": true,
    "enabled": true,
    "productAutoUpdate": true
  },
  "uuid": "7231036a-e052-11e7-80c1-9a214cf093ae",
  "web": {
    "maxThreads": 100,
    "minThreads": 10,
    "port": 3780,
    "sessionTimeout": "PT10M"
  }
}

Changes

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status