NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Configs/Configurations → Read a Specific Configuration

AI-generated

Summary

Read a specific configuration by its path name, optionally filtering by reseller, domain, user, core server, user scope, or admin UI account type.

Inputs

  • refreshOptions — Whether to bypass cached dropdown values and fetch fresh options
  • reseller — Choose from the list, or enter an ID manually
  • ReadSpecificConfiguration__path__config-name (required) —
  • ReadSpecificConfiguration__query__domain — This is the domain this configuration applies to. Defaults to search for "*"
  • ReadSpecificConfiguration__query__user — This is the user this configuration applies to. Defaults to search for "*"
  • ReadSpecificConfiguration__query__core-server — This is the hostname this configuration applies to. Defaults to search for "*"
  • ReadSpecificConfiguration__query__user-scope — This is the user scope this configuration applies to. Defaults to search for "*"
  • ReadSpecificConfiguration__query__admin-ui-account-type — This is the admin UI account this configuration applies to. Defaults to search for "*"

Output shape

a single configuration record

The response contains the matching configuration details; fields not matched are omitted. Errors return an error envelope.

Examples

Example 1: Fetch a specific configuration by its path name

Set Path config-name to "example" and optionally provide domain or user filters

Example 2: Read configuration for a particular reseller

Select a reseller from the dropdown or enter its ID, then specify the config name

Links

Discussion