BrightSignNetwork (BSN) Main A...
Main REST HTTP API version 201...

Autoruns/Plugins Endpoints (2017/01)

5min
these endpoints allow users to manage autorun plugins on a network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/autoruns/plugins get / returns a list of autorun plugins on a network query string parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results sort string an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g " \[device] \[serial] asc ") marker string a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of plugin instances exceeds the pagesize pagesize int the maximum number of plugin instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of autorun plugin entity (2017/01) docid cm4edlntjgbfmvcihwqt instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages post / creates a new autorun plugin on a network request body the autorun plugin entity (2017/01) docid cm4edlntjgbfmvcihwqt response body returns a 201 status code and the autorun plugin entity (2017/01) docid cm4edlntjgbfmvcihwqt created and referenced by the uri (given by the location header field) in the response delete / removes autorun plugins, specified by a filter, from a network this allows multiple autorun plugins to be deleted at once query string parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body returns the number of affected autorun plugins as an integer value get /count/ returns the number of autorun plugins on the network query string parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response the autorun plugin count is returned as an integer value get /{id\ int}/ returns the specified autorun plugin on a network segment id int a unique identifier for a plugin instance response body the autorun plugin entity (2017/01) docid cm4edlntjgbfmvcihwqt put /{id\ int}/ update a specified autorun plugin on a network segment id int a unique identifier for a plugin instance request body the autorun plugin entity (2017/01) docid cm4edlntjgbfmvcihwqt response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/ remove a specified autorun plugin from a network segment id int a unique identifier for a plugin instance response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx