Jump to content
Pulseway 9.14 🔥

REST API

REST API development

  1. Started by bbb,

    Hi, I'm using the Publish API to create a system, which shows up on the dashboard. I then send a notification using curl: https://api.pulseway.com/v1/publish -H Content-Type:application/json -u <user;key> -X POST -d '{"instance_id":"v7black","title":"Test error","message":"Running out of disk space","priority":"critical"}' which gets a valid response: {"response_code":200,"error_message":null} But I can't see any notification on the dashboard/mobile The name/description/group I used in publish seems to have been lost I put the publish again, and the group/description is back... however once the 'refresh interval' expires it greys out but there is no notific…

  2. Started by Erkin Borucu,

    Hi guys, We have IT support ticketing system in vb.net. I like to integrate critical notifications, health and disk usage information. I made the ticketing system myself but I don't have much knowledge of the Rest API integration in vb.net apps. I got my token and sample codes from pulsway web site but I could not make it work. Is there any other sample code for retrieving data and updating text objects in vb.net? thanks. Kind Regards, Erkin

  3. Started by guyvaio,

    Hello, The restApi needs the instance_id parameter. Where could I find this information ? Is it the tag in the system details URL, between /systems/ and /details? Best regards, Guy

    • 8 replies
    • 6.6k views
  4. Started by eric f,

    Hey everyone, I'm building a system for our shop and trying to make use of the REST API. I have things set up and working mostly. However, the problem I'm having is when I request asset information, the first time I'll get a full reply as follows with all the asset info, disk info, and IP addresses, but when I refresh the page, without changing anything, most of that info is missing. See the two examples below. Does anybody have any suggestions on what could be wrong? stdClass Object ( [data] => stdClass Object ( [identifier] => xxxxxxxx-202b-446d-8e87-xxxxxxxxxxxx [name] => DC4 [group] => Group Nam…

    • 5 replies
    • 5k views
  5. Started by CloudlySimon,

    Hello, When authenticating to the REST API, am I able to use the API Key/API Token found on the User Account Details page? I've been attempting to do so using Postman, by changing the Authorization type to API Key and then pasting the API Key into the Value field. Unsure that the Key field must contain, but having tried things like "apikey", "api_key" etc.. I always receive a 401 Unauthorized. I'm clearly getting something wrong - so appreciate any direction. Just a FYI, the documentation for the Notifications says a default priority is normal but I've found it to default to low when no priority field is populated.

  6. Hi I am looking for a way to pull and display live notifications into another application. Specifically, we have an internal dashboard using node-red and would like to add some info from Pulseway on to it.

    • 2 replies
    • 4.7k views
  7. Started by bbb,

    Hi, do you have a timetable for the REST API? As it stands I am interested in doing a 'proof-of-concept' but can imagine several things I'd like to see before it became useful as a central monitoring point. Off the top of my head... 1)Notifications that prompt for a reply eg 'Loss of power for 5 minutes and and UPS down to 20 minutes. Power off non-essential subsystems? (Y/N)') - that can be replied to over a mobile . The difference between this and 'send a command' would be application-specific rather than system-specific, for instance in the middle of a backup you might get a notification like 'Expected volume MONDAY but volume TUESDAY is loaded. 'C'ancel back…

    • 2 replies
    • 4.4k views
  8. Started by spinto,

    I'm using the API to get a list of IP addresses in order to whitelist those IP's in the Linux iptables firewall rules. This process works fine on an unrestricted server. The server I'm working with is very restricted, so it isn't able to communicate with the api. For example, our pulseway address is http://company.pulseway.com which translates to 12.34.56.78 I added the following into iptables.save: #Pulseway -A INPUT -i eth0 -s 12.34.56.78 -j ACCEPT -A OUTPUT -o eth0 -d 12.34.56.78 -j ACCEPT I test outbound communications by running the following: telnet 12.34.56.78 443 and it connects so I'm assuming it's the inbound communication. My a…

  9. Hello, Since February 29th 14:06 an application written en C# and using Rest API get blocked on a "Forbidden" error. It occurs in an application we've not modified. Our last successfull notification via Rest API occured on 12:11. Have you change something in the access to Rest API ? Thanks in advance for your help. Best regards, Guy

    • 2 replies
    • 4.3k views
  10. Our admins use Pulseway to monitor several of our systems. We also use 3rd party cloud based systems that will send us notifications via API. When we receive notifications from our 3rd party systems, our admins would like for me to forward them to Pulseway. I've read quite a bit of the documentation and perhaps it's because I'm unfamiliar with Pulseway nomenclature, but I'm unsure if this can be done. This thread had several questions in it that I have, but a lot of the content is still unclear for me. And at one point it was stated that what they were trying to accomplish wasn't possible, and that Pulseway was considering allowing to add notifications for other…

  11. Started by kramttocs,

    Playing around with the API in postman but the asset_info is always blank along with the disks. I am calling the assets endpoint with an ID but I see the same missing info if I don't provide an IP. The reason I am looking into the API is to see about making an integration with Home Assistant. Before I get too far I guess I should ask what the api limitations are. I don't see documentation on how many polls per minute/hour/day though I did see mention of 1/minute in another thread. Are there any other considerations that I need to be aware of to see if this api is a good candidate for inclusion in a home automation system? Thanks!

    • 4 replies
    • 3.9k views
  12. Started by leendertvdk,

    Hey, We use the REST API. In addition, we are writing a lot of the report of 'Can not perform database operation'. Array ( [data] => [meta] => Array ( [response_code] => 503 [error_message] => Cannot perform database operation ) ) Array ( [data] => [meta] => Array ( [response_code] => 503 [error_message] => Cannot perform database operation ) ) Array ( [data] => [meta] => Array ( [response_code] => 503 [error_message] => Cannot perform database operation ) ) Array ( [data] => [meta] => Array ( [response_code] => 503 [error_message] => Cannot perform database operation ) ) Array ( [data] => [meta] => Array ( […

  13. This may not be an Rest API thing, but in reading the documentation, it sounds like it MAY be. I have a distributed, multi-system, multi-service application, of which I want to monitor the status via running an RPC status binary I have which outputs XML containing a system, service, and status. Some assumptions I'd like confirmed System Publish can be used to publish custom status More than one system could publish into the same instance (assuming they don't run at the same time) Rest API is a good way to do this (there isn't a better way) If this is a bad choice or the wrong place to ask, please point me in the correct direction. At th…

  14. Our business operates with hundreds of products in our inventory and going through all of them and manually entering them into PSA was not exactly an option, and without an import function, I had to develop an import tool that uses the PSA API. I developed it originally with hard coded parameters, in a single class, but went back today and improved it for distribution to everyone here. To view the source code, check out the repository at https://bitbucket.org/garrettbromley/pulseway-product-import/ To download the executable files, download PulsewayProductImport-v2.zip at https://bitbucket.org/garrettbromley/pulseway-product-import/downloads/ Instruc…

    • 0 replies
    • 3.7k views
  15. Started by Cragdoo,

    Has anyone successfully made RESt calls using powershell Invoke-RestMethod or Invoke-WebRequest? Can't see, to get the header syntax Have tried $header = @{Authorization = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$($username):$($password)"))} Invoke-RestMethod -uri https://api.pulseway.com/v2/systems -Method POST -Header $header -ContentType "application/json" but keep getting '400 Bad request' any pointers?

    • 1 reply
    • 3.7k views
  16. Hi All, I realize there is no agent software for the ARM64 (other than the Pi), and we can't install it on Ubuntu running on the Nvidia Tegra based Jetson TX1 family. I am considering writing an agent based on the REST API and I was wondering if this was the best way to go about doing it. Basically I want to capture the remote system name, IP, and other info, and have it display on the Pulseway Dashboard. We might also consider outsourcing this project, so I might be looking for experienced Pulseway developers who could do this. Thanks for any advice. Jason

    • 1 reply
    • 3.7k views
  17. For those of you who would like to use WHMCS (Automated web hosting platform) but wish to use Pulseway PSA for your main ticketing software and for managing your consulting business if you are an MSP like us, I had to make a hook for WHMCS which takes the client details and automatically makes a client account for them within PSA and grants them access to the ticketing system, using the same password for WHMCS. This vastly simplifies things for the client, and conforms the tickets into one system. Once this file is created, it needs to be placed into the following directory with any name: \includes\hooks\AddClientToPSA.php YOU WILL NEED TO QUERY SOME VALUES YO…

    • 0 replies
    • 3.6k views
  18. I have what was a working PowerShell script to get a list of all my systems in Pulseway. It is no longer working. I am getting a 200 response, just no data. I even tried to replicate it in Node JS since there is official documentation for it, but I get the same response - 200 but no data. $username = 'administrator' $password = '*************' #Adding credentials to header $header = @{Authorization = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$($username):$($password)")) } #Call API to return first 100 systems - calls are limited to 100 results $first100 = Invoke-RestMethod -uri https://xxxxxxxxxxxx.pulseway.com/api/v2/systems -Metho…

    • 4 replies
    • 3.5k views
  19. Started by mitch,

    Hello, It is maybe a silly question but I can't figure it out. I want to publish an online webconsole in my dashboard. But I don't know how to publish a system. where do i put the code? pulseway manager? pulseway webapp? I have no idea.. could somebody tell me how this works this is the code: curl https://my.pulseway.com/api/v2/notifications \ -u username:password \ -X POST \ -H "Content-Type: application/json" \ -d '{"instance_id":"my_cloud_agent","title":"Runtime error","message":"Cannot connect to the database.","priority":"critical"}'

  20. Started by TheITJedi,

    It appears the V3 API is out now. I see in the permissions when creating a token 'Get Device Custom Fields' as a permission, but there is no endpoint listed in the documentation. Additionally, attempting to use the new /api/v3/devices endpoint fails, it will however take the /api/v3/systems endpoint. This appears to return same information as v2 API does. Error returned is as follows: '/api/v3/devices' MessageDetail: No type was found that matches the controller named 'v3' My questions are: 1. is the /devices endpoint a new endpoint that's not available yet? 2. what is the endpoint to get a device's custom field? 3. is there at time line f…

  21. Started by leendertvdk,

    Hey, The message counter of normal_notifications does not work. We had two normal notifications at a server but the counter is 0. Array ( [data] => Array ( [description] => Windows Server 2008 R2 Standard [uptime] => 0 days, 13 hours, 43 minutes [is_online] => 1 [computer_type] => windows [in_maintenance] => [external_ip_address] => ************ [critical_notifications] => 0 [elevated_notifications] => 0 [normal_notifications] => 0 [low_notifications] => 2 [client_version] => 5.3 [identifier] => *************************** [name] => ******** [group] => 3 Applicaties ) [meta] => Array ( [response_code] => …

  22. Started by bazzacad,

    When a system is offline... The "api/v2/assets" endpoint returns that the antivirus is "not_installed". It should return nothing or 0

  23. Started by pim,

    Hi, I am testing to send notifications but I keep receiving a 403 error? I tried several things username : API-Key / username MFA with - or without But 403 keeps comming back. Someone any idea?

  24. I have used the rest api Publish and Notify to make a system in Pulseway. When I run the api the system will be updated and there will be notifications of the devices I monitor. (if their are up or down) But if I run the script I get alle the notifications that I don't want because the state isn't change of the devices. Is there a php script that makes the Pulseway Notifiy api remember the state of the last send notification so there will only be send a notification if the state is change since the last send notification? Kind regards, Mitch

    • 1 reply
    • 3.2k views
  25. HI, I'm really struggling to authenticate to API - we have a dedicated hosted solution - therefore our web app base URL is https://[thename].pulseway.com. So, following the API documentation - am i correct in therefore assuming that the API base URL is https://[thename].pulseway.com/api/v2/ ? Every time i login, i get: "invalid username and\or password (199)" I've search forums, and tuned my code accordingly - some things i have tried: Using an account with or without MFA. Using Postman, with API Key as Authorisation - using Username (in plain text) as key, and API Key as Value Using Postman with Basic Auth as Authorisation - u…