Cluster API Tokens

A cluster API token is a token that allows a component, such as a dynamic host, to become part of MarkLogic Server and to access part of its functionality.

Generate cluster API tokens

Use the instructions for the type of cluster API token that you want to generate:

Generate a dynamic host token

A dynamic host token allows a dynamic host to join a group through the Admin app server of the join host, an already existing static host in the same cluster as the group that the dynamic host is to join.

To generate a dynamic host token, follow these steps:

1. Browse to the Generate tab (Security > Cluster API Tokens > Generate).

2. Complete the fields:

   Field	Value
   Purpose (Required)	Select Dynamic Host.
   Comment (Optional)	Enter a comment that will differentiate this token.
   Duration (minutes) (Required)	Enter or choose the number of minutes that the token should last. (Default: 10. Min: 1. Max: 15).
   Group (Required)	Select the group that any dynamic hosts using this token are to join.
   Join Host (Required)	Choose a host through which any dynamic hosts using this token are to join the Group.
   Port (Display field only)	Displays the Join Host Admin app server port number. This port number was automatically set when the join host was created. It cannot be changed.

3. Click OK. The generated dynamic host token appears in a popup:

   1. Click Copy and Close to copy the new token elsewhere. The Manage tab appears, which allows you to manage your new token. You can also copy your new token from the Manage tab.

   2. Click Generate Another to generate another token. The Generate tab reappears, reset for generating another token. You can copy your new tokens from the Manage tab.

Manage Cluster API Tokens

The table on the Manage tab (Security > Cluster API Tokens > Manage) allows you to view and manage cluster API tokens created through the Generate tab or programmatically. These are its elements:

• Refresh Icon: Click to refresh the table. It will not automatically refresh, so a token may appear in the table that has expired since the Last refreshed time. You can generate another token through the Generate tab.

• Purpose: The purpose selected for this token when it was generated.

• Comment: The optional comment entered for this token when it was generated.

• Date/Time Granted: The date and time that the token was activated shortly after it was generated.

• Remaining Duration: The time remaining before this token expires. The duration is based on the time that the page was last refreshed.

• Action:

  • Click Copy in a row to copy a token.

  • Click Revoke in a row to revoke a token. After you click OK to confirm, Token revoked appears in the upper right corner of the page, and the token is removed from the table. The cluster API token can no longer be used.

• The No records available message indicates that there are currently no valid tokens. You can generate a token through the Generate tab.