DocumentationAPI ReferenceRelease Notes
API Reference

Adds a new MongoDB Tunnel Jump Item.

post
https://{example.com}/api/config/v1/jump-item/mongodb-tunnel-jump

Creates a new MongoDB Tunnel Jump Item with the properties given in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 128

The name of the MongoDB Tunnel Jump Item.

int32
required
1 to 2147483647

The unique identifier of the Jumpoint through which connections are made.

string
required
length between 1 and 128

The hostname or IP address.

int32
required
1 to 2147483647

The unique identifier of the Jump Group or user that owns this Jump Item.

string
enum
Defaults to shared

The type of Jump Group that owns this Jump Item.

Allowed:
string
length between 0 and 64

The Jump Item's tag.

string
length between 0 and 1024

The Jump Item's comments.

int32 | null
1 to 2147483647

The unique identifier of the Jump Policy used to manage access to this Jump Item.

int32 | null
2 to 2147483647

The unique identifier of the Session Policy used to control the user's capabilities in the session.

string
length between 0 and 32
Defaults to 127.0.0.1

This is the IPv4 address on which the users should connect to start tunnels. The value must be within the 127.0.0.0/24 subnet.

string
length between 0 and 128

The database username for MongoDB Tunnel Jump Items.

string
length between 0 and 128

The database name for MongoDB Tunnel Jump Items.

Responses

Updated about 1 month ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.