HomeGuidesAPI Reference
API Reference

Update GMS registration settings for appliance connectivity

Updates the Orchestrator IP/domain that appliances use to connect.

Behavior:

  • If customDefaultIP is empty, appliances use Orchestrator's internal management IP
  • Label entries allow different IPs for appliances based on WAN interface labels
  • Lower priority numbers are checked first (priority 1 before priority 2)
  • The internalManagementIP field is ignored in requests (auto-populated by Orchestrator)

Validation Rules:

  • customDefaultIP and label ipOrDns must not contain slashes (not full URLs)
  • Priority values must be non-negative integers (>= 0)
  • Label field must be a non-null object (use empty object {} if no labels needed)
  • In container mode, customDefaultIP cannot be empty

Side Effects:

  • Action is logged to system action log with user and data details
  • Changes affect appliance connectivity on next configuration sync
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Registration configuration. The customDefaultIP specifies the default IP/domain (empty string uses internal IP). The label field maps priority numbers to label-specific IP configurations.

Request body for POST /gms/gmsRegistration2. Updates the Orchestrator IP/domain for appliance connectivity.

string
required
^[^/]*$

Default domain or IP for appliances. Set to empty string to use Orchestrator's internal management IP. Cannot be empty in container mode. Must not contain slashes.

label
object
required

Required map of priority-to-label IP configurations. Use empty object {} if no label-specific IPs needed. Priority keys must be non-negative integers (>= 0).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - requires READ_WRITE role. Authenticate with valid X-Auth-Token header.

500

Internal server error - failed to save registration settings to database.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json