Complete API Endpoints Reference

Comprehensive index of all available RackNap API endpoints.

Last Updated: June 2026 | Total Endpoints: 280+

Overview

This page provides a complete reference of all available API endpoints across both RackNap services. Endpoints are organized by feature area and service. Most endpoints support OData filtering, pagination, and sorting.

Authentication (detailed docs)

Base: /api/auth

Method Endpoint Description
GET /api/auth Get access token via Basic Auth
POST /api/auth/logout Logout user
POST /api/auth/forgot-password Request password reset
POST /api/auth/reset-password Reset password with token
GET /api/auth/user Get user token (Admin)
GET /api/auth/account Get account-scoped token
POST /api/auth/access-token Refresh access token
GET /api/auth/transient Get token from transient code

Users (detailed docs)

Base: /api/users

Method Endpoint Description
POST /api/users/signup New user signup
GET /api/users List users
GET /api/users/{id} Get user by ID
GET /api/users/{name} Get user by name
POST /api/users Create user (Admin)
PATCH /api/users/{id} Edit user (Admin)
DELETE /api/users/{id} Delete user
PUT /api/users/password Change own password
POST /api/users/{id}/profile/image Upload profile image

Accounts (detailed docs)

Base: /api/accounts

Method Endpoint Description
POST /api/accounts/signup Account signup
POST /api/accounts Create account
GET /api/accounts List accounts
GET /api/accounts/{id} Get account by ID
PUT /api/accounts/{id} Update account
POST /api/accounts/{id}/users Add user to account
PUT /api/accounts/{id}/users/{userId} Update user roles
DELETE /api/accounts/{id}/users/{userId} Remove user from account
DELETE /api/accounts/{id} Delete account

Additional Identity Service Endpoints

Controller Base Path Key Operations
Organizations /api/organizations Create, list, get, update, delete, hierarchy, settings, currencies, exchange rates
Roles /api/roles Get all, get by ID, create, update, delete, export
Permissions /api/permissions Get modules, get accessible visualizations
Customers /api/customers List, get, create, update, delete, billing details
Countries /api/countries Get all, get by ID
States /api/states Get all, get by country
Tax /api/tax Tax rules, tax groups CRUD
Tenants /api/tenants Create, list, get, update, delete
Settings /api/settings Get, create, update, delete, order settings
Imports /api/imports Upload CSV, analyze, preview, import, templates, history

Orders (detailed docs)

Base: /api/orders

Method Endpoint Description
POST /api/orders/initiate-payment Create order with payment
GET /api/orders/{id} Get order details
GET /api/orders/odata List orders with OData
GET /api/orders/aggregated Get aggregated metrics
PATCH /api/orders/{id}/status Update order status
POST /api/orders/bulk-cancel Bulk cancel orders
POST /api/orders/export Export orders
POST /api/orders/payment-workflow Process payment

Offers (detailed docs)

Base: /api/product-catalogue/offers

Method Endpoint Description
GET /api/product-catalogue/offers List all offers
GET /api/product-catalogue/offers/{id} Get offer by ID
GET /api/product-catalogue/offers/vendor/{vendorId} Get offers by vendor
GET /api/product-catalogue/offers/group/{offerGroupId} Get offers by group
POST /api/product-catalogue/offers Create offer
PUT /api/product-catalogue/offers/{id} Update offer
DELETE /api/product-catalogue/offers/{id} Delete offer
POST /api/product-catalogue/offers/import Import offers from CSV

Subscriptions (detailed docs)

Base: /api/subscriptions

Method Endpoint Description
GET /api/subscriptions List subscriptions with OData
GET /api/subscriptions/aggregated Get aggregated metrics
GET /api/subscriptions/{id} Get subscription by ID
POST /api/subscriptions Create subscription
PUT /api/subscriptions/{id} Update subscription
DELETE /api/subscriptions/{id} Delete subscription
POST /api/subscriptions/{id}/sync Sync subscription
POST /api/subscriptions/suspend Suspend subscription
POST /api/subscriptions/unsuspend Unsuspend subscription
POST /api/subscriptions/terminate Terminate subscription
POST /api/subscriptions/upgrade-quantity Upgrade quantity
POST /api/subscriptions/downgrade-quantity Downgrade quantity
POST /api/subscriptions/plan-change Change plan
POST /api/subscriptions/{id}/renew Renew subscription
POST /api/subscriptions/{id}/generate-renewal-invoice Generate renewal invoice
POST /api/subscriptions/bulk-renew Bulk renew subscriptions
POST /api/subscriptions/process-due-renewals Process due renewals
GET /api/subscriptions/{customerId}/domains Get subscription domains
POST /api/subscriptions/export Export to CSV/Excel

Invoices (detailed docs)

Base: /api/invoices

Method Endpoint Description
POST /api/invoices Create invoice
GET /api/invoices/{id} Get invoice by ID
GET /api/invoices/odata List invoices with OData
PUT /api/invoices/{id} Update invoice
PATCH /api/invoices/{id}/status Update invoice status
POST /api/invoices/bulk-cancel Bulk cancel invoices
POST /api/invoices/{id}/export-pdf Export invoice as PDF
DELETE /api/invoices/{id} Delete invoice

Cart (detailed docs)

Base: /api/cart

Method Endpoint Description
POST /api/cart Create cart
GET /api/cart/{cartId} Get cart
DELETE /api/cart/{cartId} Delete cart
GET /api/cart/customer/{customerId} Get cart by customer
POST /api/cart/merge Merge carts
POST /api/cart/{cartId}/items Add item to cart
PUT /api/cart/{cartId}/items/{itemId} Update cart item
DELETE /api/cart/{cartId}/items/{itemId} Remove item from cart
POST /api/cart/{cartId}/discounts Apply discount code
DELETE /api/cart/{cartId}/discounts/{code} Remove discount code

Receipts (detailed docs)

Base: /api/receipts

Method Endpoint Description
POST /api/receipts Create receipt
GET /api/receipts List receipts
GET /api/receipts/{id} Get receipt by ID
POST /api/receipts/{id}/export-pdf Export receipt as PDF
DELETE /api/receipts/{id} Delete receipt

Quotes (detailed docs)

Base: /api/quotes

Method Endpoint Description
POST /api/quotes Create quote
GET /api/quotes List quotes
GET /api/quotes/{id} Get quote by ID
PATCH /api/quotes/{id} Update quote
POST /api/quotes/{id}/actions Manage quote actions
POST /api/quotes/{id}/download-pdf Download quote PDF
GET /api/quotes/public/{publicToken} Get public quote
POST /api/quotes/public/{publicToken}/actions Perform public quote action

Ledger (detailed docs)

Base: /api/ledger

Method Endpoint Description
POST /api/ledger Create ledger entry
GET /api/ledger/{id} Get ledger entry by ID
GET /api/ledger List ledger entries
POST /api/ledger/export Export ledger data
GET /api/ledger/{customerId}/balance Get account balance
GET /api/ledger/document-types Get document types

Billed Usage (detailed docs)

Base: /api/billed-usage

Method Endpoint Description
POST /api/billed-usage Create billed usage record
GET /api/billed-usage/{id} Get billed usage record by ID
POST /api/billed-usage/bulk Bulk insert usage records
GET /api/billed-usage List billed usage records

Unbilled Usage (detailed docs)

Base: /api/unbilled-usage

Method Endpoint Description
POST /api/unbilled-usage Create unbilled usage record
GET /api/unbilled-usage/{id} Get unbilled usage record by ID
GET /api/unbilled-usage List unbilled usage records

CMS Pages (detailed docs)

Base: /api/cms-pages

Method Endpoint Description
POST /api/cms-pages Create page
GET /api/cms-pages/{id} Get page by ID
GET /api/cms-pages List pages
PUT /api/cms-pages/{id} Update page
DELETE /api/cms-pages/{id} Delete page
POST /api/cms-pages/{id}/publish Publish page
GET /api/cms-pages/public/content Get public page content
GET /api/cms-pages/by-url/{pageUrl} Get page by URL

CMS Headers (detailed docs)

Base: /api/cms-headers

Method Endpoint Description
POST /api/cms-headers Create header
GET /api/cms-headers/{id} Get header by ID
GET /api/cms-headers List headers
PUT /api/cms-headers/{id} Update header
DELETE /api/cms-headers/{id} Delete header
POST /api/cms-headers/{id}/activate Activate header

CMS Footers (detailed docs)

Base: /api/cms-footers

Method Endpoint Description
POST /api/cms-footers Create footer
GET /api/cms-footers/{id} Get footer by ID
GET /api/cms-footers List footers
PUT /api/cms-footers/{id} Update footer
DELETE /api/cms-footers/{id} Delete footer
POST /api/cms-footers/{id}/activate Activate footer

Reports (detailed docs)

Base: /api/reports

Method Endpoint Description
POST /api/reports Create report
GET /api/reports/{id} Get report by ID
GET /api/reports List reports
PUT /api/reports/{id} Update report
DELETE /api/reports/{id} Delete report
POST /api/reports/{id}/execute Execute report

Dashboards (detailed docs)

Base: /api/dashboards

Method Endpoint Description
POST /api/dashboards Create dashboard
GET /api/dashboards/{id} Get dashboard by ID
GET /api/dashboards List dashboards
PUT /api/dashboards/{id} Update dashboard
DELETE /api/dashboards/{id} Delete dashboard
GET /api/dashboards/by-user/{userId} Get user dashboards

Common Query Parameters

Parameter Type Description
$filter string OData filter expression
$orderby string Sort by columns with asc/desc
$skip integer Skip n records for pagination
$top integer Take n records for pagination
$select string Select specific columns
$expand string Expand related entities
$count boolean Include total count in response

Authentication Methods

Quick Navigation

Authentication Users Accounts Orders Offers Subscriptions Invoices Cart Receipts Quotes Ledger Billed Usage Unbilled Usage CMS Pages CMS Headers CMS Footers Reports Dashboards Back to Overview