FireDaemon Fusion's RESTful API provides a way for users and developers to communicate between FireDaemon Fusion and any 'client' program. It enables users to manage their FireDaemon and Windows services programmatically from anywhere, from a browser to a mobile device, or from any custom program or script.
\nWhen the FireDaemon Fusion API is accessed from a browser, CORS must be enabled in Fusion's settings, and the browser needs to support the \"SameSite=None\" cookie modifier.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"582683","collectionId":"fbffa5c9-f3b6-4eeb-97ca-a03be556f53e","publishedId":"2s946eBECf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-07-14T08:05:06.000Z"},"item":[{"name":"Login","event":[{"listen":"test","script":{"id":"3c3446e0-fd5b-4c3b-93da-035e4ff4f2f1","type":"text/javascript","exec":["pm.test(\"Status code is success\", function () {"," pm.response.to.be.success;","});","","pm.test(\"Content-Type is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Your test name\", function () {"," pm.response.to.have.jsonBody('landing');","});",""]}}],"id":"51f855cc-b7fa-4227-8aa9-e5752e526d68","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"userName\": \"admin\",\n\t\"password\": \"admin\"\n}\n"},"url":"https://localhost:20604/auth/login","description":"Login to Fusion.
\nReturns several cookies for various service points.
\nReturns json with some information about the user, FireDaemon Pro and a possible landing page (which is especially useful after logging in to remote nodes).
If you want to redirect to a specific landing page navigation-wise, { landing: \"\" } in the returned JSON data tells where to go next.
Fetch FireDaemon services.
\nReturns json suitable for the datatables plugin.
Fetch system services.
\nReturns json suitable for the datatables plugin.
Optional. Using this parameter shows only Windows system services.
\n","type":"text/plain"},"key":"system-only","value":null}],"variable":[]}},"response":[],"_postman_id":"52c6c545-9534-4b34-9228-ceedebd2174f"},{"name":"Fetch service \"UI0Detect\"","id":"3e170b30-7d48-4dda-a259-03744cfb4131","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:20604/api/v1/services/UI0Detect","description":"Returns information about a specified service.
\nReturns xml.
Note that there's no API yet to save the xml back to the server, only the legacy API /inbuilt/descr.
Returns the status and runtime information of a service.
\nReturns json.
Return the status and runtime information of a service.
\nReturns json.
Returns information about the status and controllability of a service.
\nReturns json.
Control a service via POST request. Two parameters are required.
\nsvcname - The shortname of the service. Separate multiple services by /.action - The action to take on the service(s) specified in svcname. These actions are supported: start,stop,restart,resume,pauseReturns the following:
\nFetch settings of the currently running Fusion instance in json.
This action returns a JqueryFileTree of directories and files relative to a given directory as an HTML fragment. This fragment is suitable for jQueryFileTree.
\n","urlObject":{"protocol":"https","port":"20604","path":["api","v1","browsefolder.jqueryfiletree"],"host":["localhost"],"query":[{"key":"dir","value":"C:\\"}],"variable":[]}},"response":[],"_postman_id":"e837937b-7668-47f5-bfe6-2f5d0b564566"},{"name":"Validate a folder or file path","id":"0c15c64a-6f75-4eca-84db-4d8b73180ad0","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://localhost:20604/api/v1/validatepath?path=C:\\&isFolder=true","description":"Validates the existence of a provided file or folder. Returns a success or error message in json.
The path parameter is required.
The isFolder parameter's value must be one of true or false. This parameter is required when validating a file. It is optional when validating a folder.
Fetch information on all local and remote nodes.
\n","urlObject":{"protocol":"https","port":"20604","path":["api","v1","nodes"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"035663d1-2c17-42a9-a667-aa2c407871c5"},{"name":"Fetch system information","id":"fbbc7f53-d6e9-47ba-a2a8-f6475f1c2a22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:20604/api/v1/system-information?filter=fd","description":"Fetches information for the system in json.
The filter parameter allows for filtering for a specific set of information. Multiple values, separated by commas, are supported.
The following values for filter are supported: quickstats, fd, os, processor, storage, memory, session, network
Filter for specific system information. Supported values: quickstats, fd, os, processor, storage, memory, session, network
\n","type":"text/plain"},"key":"filter","value":"fd"}],"variable":[]}},"response":[],"_postman_id":"fbbc7f53-d6e9-47ba-a2a8-f6475f1c2a22"},{"name":"Fetch service dependency information","id":"32d44456-97f5-41a4-82e2-030350bf202f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:20604/api/v1/service-dependency-information","description":"Retrieves service dependency list from the OS.
\n","urlObject":{"protocol":"https","port":"20604","path":["api","v1","service-dependency-information"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"32d44456-97f5-41a4-82e2-030350bf202f"},{"name":"Fetch pre-shutdown list from OS","id":"8e52cc42-9490-4516-a872-4b3288d06cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:20604/api/v1/preshutdown-list","description":"This API call returns the pre-shutdown list from the OS in JSON format.
\n","urlObject":{"protocol":"https","port":"20604","path":["api","v1","preshutdown-list"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e52cc42-9490-4516-a872-4b3288d06cbe"},{"name":"Create a new FireDaemon Service","id":"a6ffac9b-91b3-4afc-8928-c96329e21d18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Requested-With","value":"XMLHttpRequest","description":"Makes Fusion return 204 upon success.\nIf unspecified Fusion returns 302 to /fd/list
Creates a new FireDaemon service via the legacy API /fd/new.
Returns the following:
\nDeletes a FireDaemon service.
\nReturns the following:
\nRetrieves the scheduling settings for the given service in xml format.
Uploads the scheduling settings for the given service.\nThe data must be submitted in the body of the request in xml format.
Information on the scheduling XML tags can be found in the FireDaemon Pro manual.
\n","urlObject":{"protocol":"https","port":"20604","path":["api","v1","services","Notepad","scheduling"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"093f7179-3a24-44fa-92fc-b420dac4e5b5"},{"name":"Fetch a specific template","id":"7bd488a4-da69-42f0-b5f7-089ffd8e706b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:20604/api/v1/service-templates/Default%20Template","description":"Fetches a selected template from which one can build new services via XML.
\n","urlObject":{"protocol":"https","port":"20604","path":["api","v1","service-templates","Default%20Template"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7bd488a4-da69-42f0-b5f7-089ffd8e706b"},{"name":"Fetch list of services assigned to a given user","id":"06f872f6-0c82-4cbd-9970-83d30ce7bd40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:20604/api/v1/services.assignment?username=admin&fd-only","description":"Retrieves a list of services assigned to a given user in json format.
The user parameter specifies which user's assigned services to retrive.
The fd-only or system-only parameters may also be used to filter the list of services by FireDaemon services or system services.
This action returns JSON with FireDaemon Fusion user data.
\nNote that all these parameters are optional and will revert to the default value if not set.
\npage - Tells which page to display. The default value is 1.rows - Tells how many rows to display per page. The default value is 15.sord - Tells which order to sort the result in. Options are asc (ascending) and desc (descending). The default value is asc.sidx - Tells which field to sort by. Options are username, firstname, lastname, servicesassigned, roles, actions. The default value is username.The term 'legacy' suggests that it will change in a future release, the reason for this being that the currently returned information is tied to what Fusion itself displays to the user.
\n","urlObject":{"protocol":"https","port":"20604","path":["api","v1","users.legacy"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee595e1d-770a-40d8-878a-1671b1dbd265"},{"name":"Shutdown or Restart a node","id":"b126fca1-b7b9-4c5e-9156-b570c277943b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\"shutting down\"","options":{"raw":{"language":"json"}}},"url":"https://localhost:20604/api/v1/nodes/state?nodealias=localhost","description":"Shuts down or restarts the local or a remote node.
\nGET parameters:
\nnodelias optional alias of the target remote node.POST data in json format:
shutting down, restartingoptional, alias of remote node
\n","type":"text/plain"},"key":"nodealias","value":"localhost"}],"variable":[]}},"response":[],"_postman_id":"b126fca1-b7b9-4c5e-9156-b570c277943b"},{"name":"Logout","id":"aeb22a1d-6719-470e-8b4f-2d1745adfecd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://localhost:20604/auth/logout","description":"Logout of Fusion.
\nResets several cookies for various service points.
\n","urlObject":{"protocol":"https","port":"20604","path":["auth","logout"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"aeb22a1d-6719-470e-8b4f-2d1745adfecd"}],"event":[{"listen":"prerequest","script":{"id":"0822230c-a50b-458c-9fbe-4fc17ce43b00","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"25241ced-140f-473d-883c-ec6a96576313","type":"text/javascript","exec":[""]}}]}