Customer management

Use Hive’s secure REST API to create, list, look up, and remove customers from a partner-facing portal or management tool.

Partner-facing only. This API supports partners administering their customer inventory. It is not designed for direct end-customer interactions.

From onboarding to removal

1 Create Add the customer and metadata

2 List Build an inventory view

3 Look up Retrieve one customer

4 Support Use metadata in partner tools

5 Remove Delete from partner inventory

Authenticate every partner request

All Customer API operations accept the partner token through the X-Hive-Partner-Token header or partner_token query parameter. A partner may operate on its own customer inventory. Requests targeting a different partner require administrator privileges and otherwise return 403 Forbidden.

STANDARD PARTNER Own customers

Create, list, retrieve, and remove customers associated with the authenticated partner.

ADMIN PARTNER Cross-partner access

List all partners and perform operations outside the authenticated partner’s own ID.

Security: prefer the header form and call the API from a trusted backend. Never expose or log partner tokens in browser code, client-side telemetry, or partner-list output.

Customer and partner operations

PRODUCTION https://api.hivestreaming.com/v1

TEST https://api-test.hivestreaming.com/v1

Method	Path	Purpose	Success
POST	/partner/{partnerId}	Create a customer	200/201*
GET	/partner/{partnerId}	List a partner’s customers	200
GET	/partner/{partnerId}/{customerId}	Look up one customer	200
DELETE	/partner/{partnerId}/{customerId}	Remove a customer	200
GET	/partner/partners	List every partner; administrators only	200

*The overview documents 201 Created; the current Swagger documents 200. Accept either until the contract is clarified.

Call the Partner endpoint

The same endpoint shape supports the complete customer lifecycle. The examples below show each operation using server-side curl.

Create

curl -X POST https://api.hivestreaming.com/v1/partner/9001 \
  -H "X-Hive-Partner-Token: <partner-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "partnerId": 9001,
    "customerId": "customer-777",
    "name": "Example Customer",
    "metaInfo": {
      "customer_key": "<customer-key>",
      "installer_eula_url": "https://install.hivestreaming.com/license.php",
      "region": "se"
    }
  }'

List

curl https://api.hivestreaming.com/v1/partner/9001 \
  -H "X-Hive-Partner-Token: <partner-token>"

Lookup

curl https://api.hivestreaming.com/v1/partner/9001/customer-777 \
  -H "X-Hive-Partner-Token: <partner-token>"

Remove

curl -X DELETE \
  https://api.hivestreaming.com/v1/partner/9001/customer-777 \
  -H "X-Hive-Partner-Token: <partner-token>"

List partners

# Administrator partners only
curl https://api.hivestreaming.com/v1/partner/partners \
  -H "X-Hive-Partner-Token: <admin-partner-token>"

Customer and metadata fields

Customer

customerIdstring

Partner-defined customer identifier.

partnerIdinteger

Owning partner ID.

namestring

Customer display name.

metaInfoobject

Hive installer settings and arbitrary partner metadata.

Documented MetaInfo

installer_eula_urlstring

Installer license URL.

installer_target_envsstring[]

Target environments such as test and production.

installer_targetsstring[]

Installer artifacts such as MSI and PKG.

installer_download_base_pathstring

Customer-specific download path.

pluginUrlstring

Media-player plugin URL.

customer_keystring

Customer key used by Hive tooling.

Custom metadata: the overview explicitly allows partners to add any other values needed to associate operational information with the customer. Treat keys as a stable integration contract.

Use returned customer records

Customer object

{
  "customerId": "customer-777",
  "partnerId": 9001,
  "name": "Example Customer",
  "metaInfo": {
    "customer_key": "<customer-key>",
    "installer_eula_url": "https://install.hivestreaming.com/license.php",
    "region": "se"
  }
}

Customer list

[
  {
    "customerId": "customer-777",
    "partnerId": 9001,
    "name": "Example Customer",
    "metaInfo": {
      "installer_target_envs": ["test", "production"]
    }
  }
]

Partner list

[
  {
    "id": ["9001"],
    "name": "Example Partner",
    "token": "<sensitive-partner-token>",
    "accessLevel": 0
  }
]

Administrator response: the Swagger Partner schema includes a token field. Treat it as sensitive secret material, restrict this operation to administrators, and avoid rendering or persisting tokens unless strictly required.

Resolve contract differences safely

STATUS CODE Create customer

The overview expects 201 Created; Swagger declares 200. Clients should handle both success codes until Hive confirms one contract.

ACCESS DESCRIPTION List customers

The overview says a partner requests all of its own customers. Swagger’s description calls this admin-only. Enforce ownership and 403 handling; confirm whether non-admin partner access is supported.

UNUSED SCHEMA TicketRequest

The Swagger components include a self-referential TicketRequest schema, but no Customer API operation references it. It is not part of the customer-management flow documented here.

Updated 9/19/2026