Skip to main content

Python SDK used to interact and develop with Rapid7 Surface Command

Project description

Surface Command SDK

The surcom-sdk helps you build Surface Command data connectors for the Rapid7 platform.

Installation

  • Install the surcom-sdk:

    pip install r7-surcom-sdk
    
  • Verify the installed version:

    surcom --version
    
  • Install the SDK with debugging dependencies:

    pip install 'r7-surcom-sdk[debug]'
    

Configuration

  • To configure the surcom-sdk you will need an API key. Please read our documentation to get setup and then run:

    surcom config init
    

Documentation

  • View detailed help for any SDK command by adding --help:

    surcom connector --help
    

Additional Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

r7_surcom_sdk-0.11.14.tar.gz (633.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

r7_surcom_sdk-0.11.14-py3-none-any.whl (685.0 kB view details)

Uploaded Python 3

File details

Details for the file r7_surcom_sdk-0.11.14.tar.gz.

File metadata

  • Download URL: r7_surcom_sdk-0.11.14.tar.gz
  • Upload date:
  • Size: 633.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for r7_surcom_sdk-0.11.14.tar.gz
Algorithm Hash digest
SHA256 21f08bd0447e7deafcf3fbb803dc2ce6748b86c3e7a1fbfad7a956992c772f11
MD5 4a0ccbecb58e73815690d8c5a0c33c62
BLAKE2b-256 ea9415d72a556a4dac4224ccfdc1a02e32651a69a21b493c10ac585f5c2496d4

See more details on using hashes here.

File details

Details for the file r7_surcom_sdk-0.11.14-py3-none-any.whl.

File metadata

  • Download URL: r7_surcom_sdk-0.11.14-py3-none-any.whl
  • Upload date:
  • Size: 685.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for r7_surcom_sdk-0.11.14-py3-none-any.whl
Algorithm Hash digest
SHA256 1e1cda20a4fd459b5c063d6f1dc899a70b6db7f27ad7e7ff05407db5d2ccbe0b
MD5 17d7030bfcbf236c200c82959b28e899
BLAKE2b-256 570fc4066ba306501d0f047f89f3e91a6f20c72abb1dcfe010283d0ff4a42357

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page