Endpoint: multisites

Overview

The site hub is a special service for VIP customers. It allows you to create sites on your VIP cluster and is used for people that want to integrate communities within their entire organization. You can make hub api calls just like other api calls, but you make those calls against your site hub rather than an individual site. Most hub api calls will be against https://yourdomain.com/hub/api/v1.

Note: All endpoints for multisites require an access token with administrative privileges.

GET /multisites

GET /hub/api/v1/multisites.json?access_token=token HTTP/1.1
Host: https://yoursite.vanillaforums.com

Gets a list of sites in your hub.

Authentication: required

Parameters

Parameter Type Description
search string The site name to search for.

POST /multisites

POST /hub/api/v1/multisites.json?access_token=token HTTP/1.1
Host: https://yoursite.vanillaforums.com

Create a new site and queues it for building. When a site is created it will not be immediately available, but instead be in a Building status. Usually, sites take about a minute to build.

Authentication: required

Parameters

Parameter Type Description
Name string A human readable name for the site.
Slug string The site’s folder. Make sure to use just alphanumeric, lowercase characters for the slug.

GET /multisites/{id}

GET /hub/api/v1/multisites/1.json?access_token=token HTTP/1.1
Host: https://yoursite.vanillaforums.com

Get the details of an individual site by ID.

Authentication: required

Parameters

Parameter Type Description
id path The ID of the site.

POST /multisites/syncnode

POST /hub/api/v1/multisites/syncnode.json?access_token=token HTTP/1.1
Host: https://yoursite.vanillaforums.com

Synchronize the sites against the hub. Note that this method doesn’t have to be called as the nodes automatically synchronize every 20 minutes.

Authentication: required

Cloud Hosting

We believe that online communities should be intuitive, engaging and true to your brand.

Learn more