Administration7

Asset25

Asset Discovery10

Asset Group22

Credential6

Policy26

Policy Override8

Remediation1

Report13

Root1

Scan5

Scan Engine22

Scan Template5

Site84

Tag21

User32

Vulnerability24

Vulnerability Check4

Vulnerability Exception7

Vulnerability Result7

Administration

Console Commands

Changed on Aug 6, 2026

Executes a console command against the Security Console. <br>Privileges: Global Administrator

post/api/3/administration/commands

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/administration/commands/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body text/plain

string required

Response

OK

outputstring

The output of the command that was executed.

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}

Changes

Aug 6, 20263a8197c22d71 Revision changes
- breaking
  added required request body
- 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

Operation history