apis » npm.discovered_servers » 1.0
NPM Auto Discovered Servers APIs v1.0
Created Nov 12, 2024 at 09:55 PM

Resource: config

Server Names Auto Discovery configuration.

http://{device}/api/npm.discovered_servers/1.0/config
  • JSON
    • {
  "enabled": boolean
}
    Property Name Type Description Notes
    config <object> Server Names Auto Discovery configuration. Required properties: [enabled];
    config.enabled <boolean> Enable/disable Server Names Auto Discovery.

    config: get

    Returns the Server Names Auto Discovery configuration.

    GET http://{device}/api/npm.discovered_servers/1.0/config
    Response Body

    Returns a config data object.

    config: set

    Updates the Server Names Auto Discovery configuration.

    PUT http://{device}/api/npm.discovered_servers/1.0/config
    Request Body

    Provide a config data object.

    Response Body

    Returns a config data object.

    Resource: ignored_server

    Ignored Discovered Server.

    http://{device}/api/npm.discovered_servers/1.0/ignored/items/{id}
  • JSON
    • {
  "id": string
}
    Property Name Type Description Notes
    ignored_server <object> Ignored Discovered Server.
    ignored_server.id <string> A unique id for the ignored discovered server. Optional;

    ignored_server: delete

    Un-ignores a Discovered Server.

    DELETE http://{device}/api/npm.discovered_servers/1.0/ignored/items/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    Resource: ignored_servers

    Ignored Discovered Servers.

    http://{device}/api/npm.discovered_servers/1.0/ignored
  • JSON
    • {
  "items": [ ignored_server ],
  "limit": ignored_limit,
  <prop>: any
}
    Property Name Type Description Notes
    ignored_servers <object> Ignored Discovered Servers.
    ignored_servers.items <array of <ignored_server>> Optional;
    ignored_servers.items[items] <ignored_server> Ignored Discovered Server.
    ignored_servers.limit <ignored_limit>
    ignored_servers.<prop> <any> Optional;

    ignored_servers: bulk_create

    Ignores a list of Discovered Servers.

    POST http://{device}/api/npm.discovered_servers/1.0/ignored/bulk_create
    Request Body

    Provide an ignored_servers data object.

    Response Body

    Returns an ignored_servers data object.

    ignored_servers: bulk_delete

    Un-ignores a list of Discovered Servers.

    POST http://{device}/api/npm.discovered_servers/1.0/ignored/bulk_delete
    Request Body

    Provide an iservers_bulk_deleter data object.

    Response Body

    Returns an iservers_bulk_deleter data object.

    ignored_servers: create

    Ignores a Discovered Server.

    POST http://{device}/api/npm.discovered_servers/1.0/ignored
    Request Body

    Provide an ignored_server data object.

    Response Body

    Returns an ignored_server data object.

    ignored_servers: limit

    Returns the ignored discovered servers entries limit.

    GET http://{device}/api/npm.discovered_servers/1.0/ignored/limit
    Response Body

    Returns an ignored_limit data object.

    Resource: server

    Discovered Server.

    http://{device}/api/npm.discovered_servers/1.0/servers/items/{id}
  • JSON
    • {
  "first_seen": string,
  "host": string,
  "id": string,
  "ignored": boolean,
  "last_seen": string,
  "origin": string,
  "protocol": string,
  "url_app_id": integer
}
    Property Name Type Description Notes
    server <object> Discovered Server.
    server.first_seen <string> Time at which this discovered server was first seen. Optional;
    server.host <string> Server host or domain name. Optional;
    server.id <string> A unique id for the discovered server. Optional;
    server.ignored <boolean> Indicates wether the discovered server is ignored. Optional;
    server.last_seen <string> Time at which this discovered server was last seen. Optional;
    server.origin <string> Source of the server name (SNI, X509 Certificate or Connect Host). Optional;
    server.protocol <string> The protocol from which the server name was extracted. Optional; Values: HTTP, TLS;
    server.url_app_id <integer> The URL Application id associated with the discovered server. Optional;

    server: delete

    Deletes a Discovered Server.

    DELETE http://{device}/api/npm.discovered_servers/1.0/servers/items/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    server: get

    Returns a Discovered Server.

    GET http://{device}/api/npm.discovered_servers/1.0/servers/items/{id}
    Response Body

    Returns a server data object.

    Resource: servers

    Discovered Servers.

    http://{device}/api/npm.discovered_servers/1.0/servers
  • JSON
    • {
  "items": [ server ],
  "total": integer,
  <prop>: any
}
    Property Name Type Description Notes
    servers <object> Discovered Servers.
    servers.items <array of <server>> Optional;
    servers.items[items] <server> Discovered Server.
    servers.total <integer> The number of total requested discovered servers. Optional;
    servers.<prop> <any> Optional;

    servers: bulk_delete

    Deletes a list of Discovered Servers.

    POST http://{device}/api/npm.discovered_servers/1.0/servers/bulk_delete
    Request Body

    Provide a dservers_bulk_deleter data object.

    Response Body

    Returns a dservers_bulk_deleter data object.

    servers: get

    Returns the list of Discovered Servers.

    GET http://{device}/api/npm.discovered_servers/1.0/servers{?has_url_app,ignored,topby,topn,filter}
    Response Body

    Returns a servers data object.

    Type: dservers_bulk_deleter

  • JSON
    • {
  "delete_all": boolean,
  "delete_all_ignored": boolean,
  "delete_ids": [
    string
  ],
  <prop>: any
}
    Property Name Type Description Notes
    dservers_bulk_deleter <object>
    dservers_bulk_deleter.delete_all <boolean> Delete all objects in the given config. Optional;
    dservers_bulk_deleter.delete_all_ignored <boolean> Delete all ignored server names in the given config. Optional;
    dservers_bulk_deleter.delete_ids <array of <string>> List of discovered servers ids to delete. Optional;
    dservers_bulk_deleter.delete_ids[items] <string>
    dservers_bulk_deleter.<prop> <any> Optional;

    Type: ignored_limit

  • JSON
    • {
  "current": integer,
  "max": integer,
  <prop>: any
}
    Property Name Type Description Notes
    ignored_limit <object>
    ignored_limit.current <integer> The current number of discovered_servers ignored. Optional;
    ignored_limit.max <integer> The max number of discovered_servers that can be ignored. Optional;
    ignored_limit.<prop> <any> Optional;

    Type: iservers_bulk_deleter

  • JSON
    • {
  "delete_all": boolean,
  "delete_ids": [
    string
  ],
  <prop>: any
}
    Property Name Type Description Notes
    iservers_bulk_deleter <object>
    iservers_bulk_deleter.delete_all <boolean> Delete all objects in the given config. Optional;
    iservers_bulk_deleter.delete_ids <array of <string>> List of ignored discovered servers ids to delete. Optional;
    iservers_bulk_deleter.delete_ids[items] <string>
    iservers_bulk_deleter.<prop> <any> Optional;