Create a hub

Creates an Asset Hub hub with a name, an access type, and an optional description.

Prerequisites

Authentication and setup: A valid access token.

Endpoint

POST /api/assethub/v2/hub

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.

Request

Parameter	Type	Required	Description
`hub_name`	string	Required	Name of the hub. Maximum 50 characters. Cannot contain `/`, `\`, or `.`.
`access_type`	string	Required	Hub access setting. `HUB_ACCESS_PUBLIC` or `HUB_ACCESS_RESTRICTED`.
`description`	string	Optional	Description of the hub. Maximum 1,000 characters, excluding HTML tags.
`user_id`	string	Required	ID of the user performing the operation. Must have the `HUB_MANAGEMENT` permission.

Request example

{
  "hub_name": "Team Hub",
  "access_type": "HUB_ACCESS_RESTRICTED",
  "description": "This is a private hub for my team",
  "user_id": "123456789abcd101"
}

Response

Field	Type	Description
`hub_id`	string	Unique ID of the created hub.
`hub_name`	string	Name of the created hub.
`access_type`	string	Access setting of the hub.
`description`	string	Description of the hub.
`request_id`	string	Unique ID for the request.

Response example

{
  "hub_id": "123456789012345102",
  "hub_name": "Team Hub",
  "access_type": "HUB_ACCESS_RESTRICTED",
  "description": "This is a private hub for my team",
  "request_id": "req_101"
}

Notes

Usage: This endpoint supports large-scale setups, such as onboarding multiple hubs for different business units or geographies.
Access types: HUB_ACCESS_PUBLIC is a public hub that everyone can access. HUB_ACCESS_RESTRICTED is a restricted hub that only selected users can access.
Limits: Hub name 50 characters. Hub description 1,000 characters.
Validation: The request fails if the name contains /, \, or ., or if a hub with the same name already exists.
Permissions: The user in user_id must have the HUB_MANAGEMENT permission.