Asset Discovery

Discovery Connection

Changed on Aug 6, 2026

Returns a discovery connection.

get/api/3/discovery_connections/{id}

Request

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

Path parameters

idinteger required

The identifier of the discovery connection.

Response

accessKeyIdstring

The AWS credential access key identifier (only used for the AWS connection).

addressstring

The address used to connect to the discovery connection source.

arnstring

The AWS credential ARN (only used for the AWS connection).

awsSessionNamestring

The AWS credential session name (only used for the AWS connection).

connectionTypestring

The type of the discovery connection.

eventSourcestring

The event source type to use.

exchangeServerHostnamestring

The hostname of the exchange server to connect to.

exchangeUserstring

The username used to connect to the exchange server.

folderPathstring

The folder path to pull logs from.

idinteger

The identifier of the discovery connection.

ldapServerstring

The LDAP server to connect to.

namestring

The discovery connection name.

portinteger

The port used to connect to the discovery connection source.

protocolstring

The protocol used to connect to the discovery connection source.

regionstring

The AWS region (only used for the AWS connection).

scanEngineIsInsideAWSboolean

Flag denoting whether the scan engine is in AWS, this is used for AWS discovery connections for scanning purposes (only used for the AWS connection).

secretAccessKeystring

The AWS credential secret access key (only used for the AWS connection).

statusstring

The status of the discovery connection.

usernamestring

The username used to authenticate to the discovery connection source.

winRMServerstring

The WinRM server to connect to.

Example response

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

Changes

Aug 6, 20263a8197c22d71 Revision 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

Operation history