API Reference - Installer Groups

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108135

← Back to API Reference | Getting Started

Installer Groups

Installer Groups are named bundles of installer steps that can be applied to a directory site to configure it with a specific set of features, content, or settings. Each group has a version, access controls, and optional plugin requirements. Installer groups are used by the platform's setup wizard and configuration system to organize site-building steps into logical collections.

Model name in URL: installer_groups — DB table: installer_groups

The Installer Group Object

FieldTypeDescription
install_group_idintegerUnique installer group ID (primary key, read-only)
installer_nicknamestringHuman-readable display name for this installer group (EG Real Estate Starter Kit); max 255 characters required on create
installer_namestringMachine-readable slug identifier for this group (EG real_estate_starter); max 255 characters required on create
installer_tokenstringUnique token used internally to reference this installer group; max 255 characters
installer_versionnumberVersion number for this installer group (EG 1.0, 2.5)
installer_descriptiontextLong-form description of what this installer group sets up
installer_tagstextComma-separated or JSON tags for categorizing and filtering installer groups
installer_iconstringFilename or path to the icon image displayed for this installer group; max 255 characters
regular_installer_accessstringAccess control value determining which plan types can use this installer via normal installation; max 255 characters
auto_installer_accessstringAccess control value for automated (non-manual) installation of this group; max 255 characters
plugin_requirementstringPlugin variable name that must be active for this installer group to be available; max 255 characters
plugin_versionstringMinimum plugin version required to use this installer group; max 255 characters
express_installer_accessstringAccess control value for express (one-click) installation of this group; max 255 characters
installer_software_versionstringMinimum platform software version required for this installer group to function correctly; max 50 characters

List Installer Groups

GET /api/v2/installer_groups/get

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/installer_groups/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "install_group_id": "1",
      "installer_nickname": "Real Estate Starter Kit",
      "installer_name": "real_estate_starter",
      "installer_token": "re_starter_v1",
      "installer_version": "1",
      "installer_description": "Sets up a real estate directory with listings, agents, and search.",
      "installer_tags": "real-estate,starter",
      "installer_icon": "real_estate.png",
      "regular_installer_access": "1",
      "auto_installer_access": "1",
      "plugin_requirement": "",
      "plugin_version": "",
      "express_installer_access": "1",
      "installer_software_version": "5.0"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Retrieve an Installer Group

GET /api/v2/installer_groups/get/{install_group_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/installer_groups/get/1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "install_group_id": "1",
      "installer_nickname": "Real Estate Starter Kit",
      "installer_name": "real_estate_starter",
      "installer_token": "re_starter_v1",
      "installer_version": "1",
      "installer_description": "Sets up a real estate directory with listings, agents, and search.",
      "installer_tags": "real-estate,starter",
      "installer_icon": "real_estate.png",
      "regular_installer_access": "1",
      "auto_installer_access": "1",
      "plugin_requirement": "",
      "plugin_version": "",
      "express_installer_access": "1",
      "installer_software_version": "5.0"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create an Installer Group

POST /api/v2/installer_groups/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/installer_groups/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "installer_nickname=Restaurant+Directory+Kit" \
  -d "installer_name=restaurant_directory" \
  -d "installer_token=rest_dir_v1" \
  -d "installer_version=1.0" \
  -d "installer_description=Sets+up+a+restaurant+directory+with+menus+and+reviews" \
  -d "installer_icon=restaurant.png" \
  -d "regular_installer_access=1" \
  -d "auto_installer_access=1" \
  -d "express_installer_access=1" \
  -d "installer_software_version=5.0"

Example Response

Copy
{
  "status": "success",
  "message": {
    "install_group_id": "2",
    "installer_nickname": "Restaurant Directory Kit",
    "installer_name": "restaurant_directory",
    "installer_token": "rest_dir_v1",
    "installer_version": "1.0",
    "installer_description": "Sets up a restaurant directory with menus and reviews",
    "installer_tags": null,
    "installer_icon": "restaurant.png",
    "regular_installer_access": "1",
    "auto_installer_access": "1",
    "plugin_requirement": null,
    "plugin_version": null,
    "express_installer_access": "1",
    "installer_software_version": "5.0"
  }
}

Update an Installer Group

PUT /api/v2/installer_groups/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/installer_groups/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "install_group_id=2" \
  -d "installer_nickname=Restaurant+Directory+Kit+v2" \
  -d "installer_version=2.0"

Example Response

Copy
{
  "status": "success",
  "message": {
    "install_group_id": "2",
    "installer_nickname": "Restaurant Directory Kit v2",
    "installer_name": "restaurant_directory",
    "installer_token": "rest_dir_v1",
    "installer_version": "2.0",
    "installer_description": "Sets up a restaurant directory with menus and reviews",
    "installer_tags": "",
    "installer_icon": "restaurant.png",
    "regular_installer_access": "1",
    "auto_installer_access": "1",
    "plugin_requirement": "",
    "plugin_version": "",
    "express_installer_access": "1",
    "installer_software_version": "5.0"
  }
}

Delete an Installer Group

DELETE /api/v2/installer_groups/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/installer_groups/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "install_group_id=2"

Example Response

Copy
{
  "status": "success",
  "message": "installer_groups record was deleted"
}