Skip to content

Latest commit

 

History

History
288 lines (198 loc) · 7.77 KB

AdministrationApi.md

File metadata and controls

288 lines (198 loc) · 7.77 KB
Raw

rapid7vmconsole.AdministrationApi

All URIs are relative to https://localhost:3780

Method HTTP request Description
activate_license POST /api/3/administration/license License
execute_command POST /api/3/administration/commands Console Commands
get_info GET /api/3/administration/info Information
get_license GET /api/3/administration/license License
get_properties GET /api/3/administration/properties Properties
get_settings GET /api/3/administration/settings Settings

activate_license

Links activate_license(license=license, key=key)

License

Licenses the product with an activation key or a provided license file. If both are provided, the license file is preferred. <span class="authorization">Global Administrator

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AdministrationApi()
license = '/path/to/file.txt' # file | The contents of a license (.lic) file. (optional)
key = 'key_example' # str | A license activation key. (optional)

try:
    # License
    api_response = api_instance.activate_license(license=license, key=key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->activate_license: %s\n" % e)

Parameters

Name Type Description Notes
license file The contents of a license (.lic) file. [optional]
key str A license activation key. [optional]

Return type

Links

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

execute_command

ConsoleCommandOutput execute_command(command=command)

Console Commands

Executes a console command against the Security Console. <span class="authorization">Global Administrator

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AdministrationApi()
command = 'command_example' # str | The console command to execute. (optional)

try:
    # Console Commands
    api_response = api_instance.execute_command(command=command)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->execute_command: %s\n" % e)

Parameters

Name Type Description Notes
command str The console command to execute. [optional]

Return type

ConsoleCommandOutput

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_info

Info get_info()

Information

Returns system details, including host and version information.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AdministrationApi()

try:
    # Information
    api_response = api_instance.get_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->get_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Info

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_license

License get_license()

License

Returns the enabled features and limits of the current license. <span class="authorization">Global Administrator

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AdministrationApi()

try:
    # License
    api_response = api_instance.get_license()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->get_license: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

License

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_properties

EnvironmentProperties get_properties()

Properties

Returns system details, including host and version information.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AdministrationApi()

try:
    # Properties
    api_response = api_instance.get_properties()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->get_properties: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

EnvironmentProperties

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_settings

Settings get_settings()

Settings

Returns the current administration settings. <span class="authorization">Global Administrator

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AdministrationApi()

try:
    # Settings
    api_response = api_instance.get_settings()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->get_settings: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Settings

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]