HomeGuidesAPI Reference
API Reference

Update GMS registration settings (deprecated)

DEPRECATED: Use POST /gms/gmsRegistration2 instead.

Updates the Orchestrator IP/domain that appliances use to connect. The defaultIPOrDns field value is automatically copied to customDefaultIP before saving. Use the label field to configure different IPs for appliances based on their WAN interface labels.

Validation Rules:

  • Domain/IP values must not contain slashes (not full URLs)
  • Both defaultIPOrDns and label ipOrDns values are validated
  • Label ipOrDns values are trimmed of whitespace before validation

Side Effects:

  • Updates are logged to the system action log
  • Changes propagate to connected appliances on next configuration sync
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Registration configuration object. The defaultIPOrDns field is required and specifies the default IP/domain. Optional label field maps priority numbers to label-specific IP configurations.

Request body for POST /gms/gmsRegistration (deprecated). The defaultIPOrDns value is copied to customDefaultIP before saving.

string
required
^[^/]+$

The IP address or domain name for appliance connectivity. This value is copied to customDefaultIP internally. Must not contain slashes or be a full URL.

label
object

Optional priority-ordered map of label-specific IP/domain configurations. Each label ipOrDns must not contain slashes.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - User lacks READ_WRITE permission. Only users with READ_WRITE role can update registration settings.

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