Access Private Endpoints

Before you begin

You need:

About this task

In this task, you will access private endpoints in your service. To access private endpoints, you need a bastion host inside the client-side VNet that can access the MarkLogic VNet. Set up SSH tunneling to your bastion host to access private endpoints from your local machine. Otherwise, you must access private endpoints directly from the bastion host.
Important: You must create one or more service users in your service before you can access endpoints.
Important: For this task, you need the SERV-ADMIN portal role. See Portal Roles.

Procedure

  1. Go to the MarkLogic Data Hub Service home page.
  2. Navigate to your DHS to access the endpoints.
    • In the Service column, click the service name.

    Private standard MarkLogic Data Hub Service instance

    Tip: You can customize your dashboard with column sorting, column configuring, and services searching and filtering. See Customize DHS Dashboard.
  3. In the Data Hub Service page, click Action to open the drop-down menu.

    Data Hub Service action button

  4. In the Action drop-down menu, click Copy Endpoints to copy the endpoints to your clipboard.
    Tip: Paste the endpoints to a blank text file for later use.

    Data Hub Service copy endpoints for Standard service

  5. Access your endpoints in a command-line window or a web browser.
    • Open a command-line window, and go to your local machine or bastion host.
      Remember: If you set up SSH tunneling to your bastion host, you can access the private endpoints from your local machine. If you did not set up SSH tunneling, you must access the private endpoints directly from the bastion host.

      Using the -u (or --user) user:password option, you must specify the username and password of your service user to authenticate against the DHS endpoints.

      Example:

       
        $ curl -u SERVICE-USER-NAME:SERVICE-USER-PASSWORD "https://HOSTNAME:PORT-NUMBER"
      

      For additional details about the MarkLogic REST API, see REST Application Developer's Guide.

    • In a web browser, navigate to one of the URLs. Example: https://HOSTNAME:PORT-NUMBER