HomeGuidesAPI Reference
API Reference

Get GMS registration settings for appliance connectivity (deprecated)

DEPRECATED: Use /gms/gmsRegistration2 instead. Retrieves Orchestrator registration settings that appliances use to connect. Without nePk: returns full configuration with defaultIPOrDns populated from customDefaultIP or internalManagementIP. With nePk: returns the specific IP/domain for that appliance based on its WAN label configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

Responses

401

Unauthorized - User lacks READ or READ_WRITE permission

500

Internal server error - Failed to retrieve registration information

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