Access the API

📌 Available on Basic & Plus plans only.

Overview

The RackManage API is a RESTful API that allows you to manage racks, slots, rooms, teams, and more programmatically. The API is available at https://api.rackmanage.io/v1 and provides interactive documentation at https://api.rackmanage.io/v1/ui.

The interactive documentation allows you to send test requests to the Rack Manage API from your browser, just click the “Test Request” button and enter your API key or credentials.

The API is OpenAPI 3.0 compliant with the specification available at https://api.rackmanage.io/v1/spec.

Enabling API Access

Before you can use the API, you need to enable API access in your account settings:

1. Navigate to your settings page at https://rackmanage.io/app/settings?tab=2

2. Under "Authentication Methods", choose one or both of:

   • API Key: For token-based authentication (recommended for programmatic access)

   • Username / Password: For Basic authentication

3. If using API Key authentication, copy your API key from the settings page for use in requests

Authentication

The API supports two authentication methods, API Key Authentication, and Basic Authentication.

API Key Authentication

Include your API key in the X-API-Key header with every request:

X-API-Key: your-api-key-here

Basic Authentication

Use your email and password with standard HTTP Basic Auth:

Authorization: Basic base64(email:password)

Subscription Plans and Permissions

Access to the API is controlled by your subscription plan:

• Basic Plan: Read-only access (GET requests only)

• Plus Plan: Full read and write access (all operations)

Team Mode

By default, API requests access your personal resources. To access team resources instead, include the X-Team-ID header:

X-Team-ID: your-team-id-here

To find your team ID, navigate to https://rackmanage.io/app/settings?tab=4 and copy the team ID field.

When using team mode:

• All operations are scoped to the team's resources

• Access is limited by your team member role (Admin, Editor, or Viewer)

• The team's subscription plan determines API access level

Making Your First Request

Here's a simple example to retrieve your user information:

curl -H "X-API-Key: your-api-key-here" \  
  https://api.rackmanage.io/v1/user

The API returns responses in a consistent format:

{  
  "success": true,  
  "code": 200,  
  "errors": [],  
  "messages": [],  
  "result": { ... }  
}