apis » npm.banner » 1.1
npm svc banner v1.1
Created Aug 12, 2025 at 07:10 PM

Resource: settings

Login banner settings

http://{device}/api/npm.banner/1.1/settings
  • JSON
    • {
  "banner": string,
  "require_acknowledgement": boolean
}
    Property Name Type Description Notes
    settings <object> Login banner settings Required properties: [banner];
    settings.banner <string> Text to show prior to authenticating
    settings.require_acknowledgement <boolean> Users must acknowledge the banner before any login. This is enforced by the user interfaces. Optional; Default is False;

    settings: get

    GET http://{device}/api/npm.banner/1.1/settings
    Response Body

    Returns a settings data object.

    settings: set

    PUT http://{device}/api/npm.banner/1.1/settings
    Request Body

    Provide a settings data object.

    Response Body

    Returns a settings data object.

    Resource: settings_view

    Read-only occess to banner settings

    http://{device}/api/npm.banner/1.1/settings_view
  • JSON
    • {
  "banner": string,
  "require_acknowledgement": boolean
}
    Property Name Type Description Notes
    settings_view <object> Read-only occess to banner settings Required properties: [banner, require_acknowledgement];
    settings_view.banner <string> Text to show prior to authenticating
    settings_view.require_acknowledgement <boolean> Users must acknowledge the banner before any login. This is enforced by the user interfaces.

    settings_view: get

    GET http://{device}/api/npm.banner/1.1/settings_view
    Response Body

    Returns a settings_view data object.