Administration

Returns system details, including host and version information.

get/api/3/administration/info

Request

Response

OK

distinguishedNamestring

The distinguished name of the console.

fqdnstring

The fully-qualified domain name of the local host the service is running on.

hoststring

The name of the local host the service is running on.

ipstring

The IP address of the local host the service is running on.

operatingSystemstring

The operating system of the host the service is running on.

serialstring

The serial number of the console.

superuserboolean

Whether the service is running a super-user.

userstring

The user running the service.

Example response

{
  "cpu": {
    "clockSpeed": 2600,
    "count": 8
  },
  "disk": {
    "free": {
      "bytes": 166532222976,
      "formatted": "155.1 GB"
    },
    "installation": {
      "backups": {
        "formatted": "0 bytes"
      },
      "database": {
        "bytes": 5364047843,
        "formatted": "5 GB"
      },
      "reports": {
        "bytes": 24789050,
        "formatted": "23.6 MB"
      },
      "scans": {
        "bytes": 1370433223,
        "formatted": "1.3 GB"
      },
      "total": {
        "bytes": 12125933077,
        "formatted": "11.3 GB"
      }
    },
    "total": {
      "bytes": 499004735488,
      "formatted": "464.7 GB"
    }
  },
  "distinguishedName": "CN=Rapid7 Security Console/ O=Rapid7",
  "fqdn": "server.acme.com",
  "host": "SERVER",
  "ip": "192.168.1.99",
  "jvm": {
    "name": "OpenJDK 64-Bit Server VM",
    "startTime": "2018-02-13T20:35:35.076Z",
    "uptime": "PT8H21M7.978S",
    "vendor": "Azul Systems, Inc.",
    "version": "25.102-b14"
  },
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "memory": {
    "free": {
      "bytes": 45006848,
      "formatted": "42.9 MB"
    },
    "total": {
      "bytes": 17179869184,
      "formatted": "16 GB"
    }
  },
  "operatingSystem": "Ubuntu Linux 16.04",
  "serial": "729F31B1C92F3C91DFA8A649F4D5C883C269BD45",
  "superuser": true,
  "user": "root",
  "version": {
    "build": "2017-12-10-14-11",
    "changeset": "7061fb4e7c355160df79a77d8983bed2af01f2bf",
    "platform": "Linux64",
    "semantic": "6.4.65",
    "update": {
      "content": "3192129162",
      "contentPartial": "723680177",
      "id": {
        "productId": "281474976711146",
        "versionId": "490"
      },
      "product": "2200922472"
    }
  }
}

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