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.12.15.tar.gz (639.4 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.12.15-py3-none-any.whl (690.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: r7_surcom_sdk-0.12.15.tar.gz
  • Upload date:
  • Size: 639.4 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.12.15.tar.gz
Algorithm Hash digest
SHA256 75e7d9e83394e0a4e2df81e95c697f45eb9b46499f984b57fd49fbc4c69ecbd1
MD5 f98f9623fa4c0fa9b0801a3fe5df6731
BLAKE2b-256 a44aeb1f0372eee7eb30f3108972cb2187ce9d4eaddcc5d40bd967840deb6ce7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: r7_surcom_sdk-0.12.15-py3-none-any.whl
  • Upload date:
  • Size: 690.8 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.12.15-py3-none-any.whl
Algorithm Hash digest
SHA256 f33bc817dc9bb589a5cd9116069476d4cdeae5b3ef5c51165e93fdd58c1a9b91
MD5 bc98c61246d10d5c6c1becc3e7954c6f
BLAKE2b-256 bf7d0766727f8e7e81408fcd3ca4a4115cca046fccccc7870e8399de39990250

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