vStor 4.10
Catalogic SoftwareKnowledge BaseMySupport
  • Welcome to vStor!
  • Introduction
  • Installation
    • Deploying Catalogic vStor on Physical Appliances
    • Deploying Catalogic vStor Virtual Appliance for VMware
    • Deploying Catalogic vStor Virtual Appliance for Microsoft Hyper-V
    • Required Ports for Catalogic vStor
    • Updating Catalogic vStor
  • Quick Start
    • Catalogic vStor for VMware
    • Catalogic vStor for Hyper-V
  • Basic Configuration
    • Initializing vStor
    • Adding Catalogic vStor Node to Catalogic DPX
      • Using vStor API Keys with Catalogic DPX
    • Configuring vStor System Settings
      • Basic System Configuration
      • Security and Network
      • Data Management and Optimization
      • System Monitoring and Maintenance
    • Configuring Network Settings of Catalogic vStor
    • Backing up Configuration Settings of Catalogic vStor
    • Restoring Configuration Settings of Catalogic vStor
  • Storage Management
    • Adding Disks to Catalogic vStor
    • Managing Storage Pools in Catalogic vStor
    • Managing Volumes in Catalogic vStor
      • Migrating Volumes in Catalogic vStor
    • Managing Shares in Catalogic vStor
    • Managing Hosts for LUN Volumes in Catalogic vStor
  • Data Protection
    • Catalogic vStor Backup and Recovery
    • Creating vStor Partnerships
      • Creating Replication Groups
    • Enabling Volume Encryption
  • Advanced Configuration
    • Using Multipath Storage for Catalogic vStor
    • Certificates in Catalogic vStor
    • Adding Encryption URLs to Catalogic vStor
    • MinIO Buckets in Catalogic vStor
    • Assigning an E-mail to the vStor Account
    • Managing vStor User Accounts
    • Using Multi-factor Authentication (MFA) in vStor
  • vStor Command Line Interface
    • Catalogic vStor Server CLI Overview
  • Best Practices
    • Hardware Configurations: Best Practices
    • Data Backup: Best Practices
    • Data Archiving: Best Practices
    • Backup Storage: Best Practices
    • Frequently Asked Questions: Best Practices
Powered by GitBook
On this page
  • Generating an API Key
  • Connecting to DPX with API Key
  1. Basic Configuration
  2. Adding Catalogic vStor Node to Catalogic DPX

Using vStor API Keys with Catalogic DPX

PreviousAdding Catalogic vStor Node to Catalogic DPXNextConfiguring vStor System Settings

vStor allows generating API keys that can be used to authenticate with DPX instead of a username and password. This provides an alternative way to connect vStor nodes to DPX.

Generating an API Key

To generate an API key:

  1. Click on your account name in the top navigation bar and select Manage API Keys.

  2. In the popup dialog, click Generate New API Key.

  1. Specify a name for the API key.

  2. Click Generate API Key.

This will generate a unique API key and token that can be used to authenticate as your user account.

Attention! The API key and token are only shown once after generating them. Make sure to copy and save them in a secure place.

Connecting to DPX with API Key

To use the API key for connecting a vStor node to DPX:

  1. Add a new vStor node in DPX.

  2. Provide the details for your new node.

  3. Enter the API key as the username.

  4. Enter the API token as the password.

  1. Click Test to verify the entered details.

  2. Click Save to add the node

The node will now connect to DPX using the API key instead of your vStor username and password.

You can generate multiple API keys if needed. Each key can be independently revoked in the Manage API Keys section.