NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Configs/Configuration Definitions → Read a Specific Configuration Definition

AI-generated

Summary

Read configuration definitions matching given criteria.

Inputs

  • refreshOptions — Bypass cached dropdown values and fetch fresh options.
  • GetConfigDefinitionsBy__path__config-name (required) — Name or path of the configuration definition to read; use '*' to read all configurations.
  • GetConfigDefinitionsBy__query__tags — Comma-separated list of tags to filter configurations; leave empty to match all.
  • GetConfigDefinitionsBy__query__sort — Sort order; defaults to "code_version desc,config_name asc".
  • GetConfigDefinitionsBy__pagination__returnAll — If true, fetch all results by paging; if false, respect start and limit.
  • GetConfigDefinitionsBy__pagination__start — Zero-based index of the first item to return (only when returnAll is false).
  • GetConfigDefinitionsBy__pagination__limit — Maximum number of items to return per page (only when returnAll is false).

Output shape

a list of configuration definition objects

Pagination can be controlled with start and limit; returnAll toggles fetching all pages; the response may be an empty array if no definitions match.

Examples

Example 1: Read all configuration definitions

Set config-name to '*' and optionally enable returnAll; pagination fields can be left at defaults.

Example 2: Read a single configuration definition by name

Enter the desired definition name in config-name; leave tags empty; pagination defaults return the first page (up to 100 items).

Links

Discussion