Jump to content
Pulseway 9.14 🔥

REST API

REST API development

  1. Hi, I need assistance with getting this c# code to authenticate and list all devices. I tried it with the username/password combo AND the token id/secret combo (token permissions are fully open) I get the same error on both as seen here { "Data": null, "Meta": { "TotalCount": 0, "ResponseCode": 403, "ErrorMessage": "A delegate registered to create instances of 'MM.Monitor.Application.ApiTokens.Services.Interfaces.IApiTokensDataService' returned null." } } Here's the Class in C# using Newtonsoft.Json; using RestSharp.Authenticators; using RestSharp; using System; namespace Pulseway_Helper { internal class GetDevices { …

  2. Started by Nelson,

    Hello, Trying to test the API using Postman, but I'm always getting the "ResponseCode": 403 with "ErrorMessage": "This token is invalid. Contact your administrator.". Any clue what might be the issue? I'm 100% sure the authentication, urls and parameters are ok. Thanks, NL

  3. Calling: https://{endpoint}/v3/devices/:id/appliedpolicies Error: GetSystemAppliedPolicies cannot be executed due to lack of permissions Why am I getting this error I do not see any permission settings on the token setup?

  4. Hello, We want to send a post notification via the API, but we always get the message "Unknown system identifier". What are we doing wrong? Below is the script that is used. # Set your Pulseway API credentials $tokenID = "*********" $tokenSecret = "*************" # Pulseway API Endpoint $apiEndpoint = "https://************.pulseway.com/api/v3/notifications" # Notification details $instanceId = "Test" $title = "Testing" $message = "Test succeed" $priority = "Critical" # Create the JSON payload $jsonPayload = @{ InstanceId = $instanceId Title = $title Message = $message Priority = $priority } | Con…

    • 1 reply
    • 1.1k views
  5. Started by Cyrion,

    Hi! I try to authenticate and send my first request, but I get the 403 error. Here is my code, whose ENDPOINT is: "https://api.pulseway.com/v3/" var ENDPOINT = _configuration["PulsewayService:ENDPOINT"]; var TOKEN_ID = _configuration["PulsewayService:TOKEN_ID"]; var TOKEN_SECRET = _configuration["PulsewayService:TOKEN_SECRET"]; using (var client = new HttpClient()) { client.BaseAddress = new Uri(ENDPOINT); var auth = TOKEN_ID + ":" + TOKEN_SECRET; var authBytes = Encoding.ASCII.GetBytes(auth); client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(authBytes)); var response = aw…

  6. Started by JpBIT,

    I am creating a C# program to fetch the "Last Boot Uptime" for all devices under a particular group with /v3/assets But the time format is inconsistent for some devices. Some are in 24hr format others in 12hr format, some has the weekday on it etc.. Eg: 15 February 2024 21:58 22 February 2024 08:57 12 March 2024 08:24 18 March 2024 01:33 17 February 2024 02:11 15 February 2024 21:50 11 March 2024 15:08 17 February 2024 02:44 29 February 2024 00:36 16 March 2024 00:33 16 March 2024 01:29 06 February 2024 15:24 13 March 2024 08:46 Saturday, 2 March 2024 10:12 a.m. Thursday, 14 March 2024 1:36 AM Saturday, February 24, 2024 20:02…

  7. 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…

  8. Started by Trilliant-JP,

    Hi folks, We were notified earlier this year that V3 of the Pulseway API was in active development. What's the status of that API release, and where can I go check on that announcement or updates? Thanks!

    • 1 reply
    • 1.1k views
  9. Impossible to authenticate on the rest api i copied the curl example replacing username and password i tried with the php example. i tried with my custom library, etc.

  10. Hi, I am looking for a way to remove devices via the API, for example: Search for a device name with a wildcard, eg: "COMPUTER3" - full name: COMPUTER3 - London - 1101 And delete that device from systems (no longer billed) The reason we need this, is because we constantly have duplicate machines in the portal and are being harassed by account managers to buy more licenses. The duplicates exist because we re-image the machine and the portal cannot pick up on the fact it's a same machine (probably because the pulseway ID is generated at the time of installation) We have an in house asset check in application, we can add additional code …

    • 0 replies
    • 979 views
  11. 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.

  12. Started by carvic,

    Hi, I'm looking for a way to retrive the Ids for the PSA currencies using the API. I want to use the currencyId when posting a new account to set it's currency. But i can't find any documentation on how to get the ids. I found the documentation on how to get countries. I guess there must be a simliar thing for currencies: GET https://server_name/api/system/countries

    • 2 replies
    • 1.6k views
  13. Started by Trodelphin,

    Chasing up what the following are calls to Specifically ; Pulseway_instance_id Pulseway_Instance_Name Pulseway_Instance Group Pulseway_instance_Decription Figured out ; Pulseway_instance_id Not sure of Pulseway_Instance_Name would be ie (https://companyname.pulseway.com/) ? Pulseway_Instance Group Would be the Group its in obviously (any Syntax required ? or straight label copy paste ?) and with Username and password 2FA not required or seperate Pulseway account needed with 2FA disabled ?

    • 4 replies
    • 2.7k views
  14. Started by vnguy,

    hi there, i'm using postman to try to connect to the API. I'm following this documentation but i'm unable to authenticate. Some details: I don't have MFA on i've tried using key name grantType=password and grant_type=password, but I still get the same error in the screenshot (Grant Type is Required) I'm using base url: https://api.psa.pulseway.com/ i'm at a lost. please advise. thank you!

  15. 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
  16. Started by darkavenger,

    Hello. I want create new ticket with api but i don't see Source: * AND Type: * api method WHERE IS https://api.psa.pulseway.com/swagger/index.html ?

  17. Started by darkavenger,

    https://api.psa.pulseway.com/swagger/index.html Hello. I want create new ticket with api but i don't see Source: * api method

  18. Started by Nelson,

    Hello all! I keep getting 401 Unauthorized when trying to get all systems using either basic auth or API key. I have 2FA disabled... Any hint? Thank you!

    • 2 replies
    • 2.5k views
  19. Hey all! Testing out Pulseway's REST API endpoints. I can query for systems, etc but executing a task just gets a happy little 403... Posting to: https://api.pulseway.com/v2/automation/tasks/[redacted]/executions returns this: { "meta": { "response_code": 403, "error_message": "Operation refused as the account has 2FA enabled." }, "data": { "id": 0 } } What recourse do I have here? Is the REST API simply unavailable for task execution in cloud accounts while 2FA is enabled? Suppose I could disable it and just live with a super-long password, but... perhaps there is a way Thanks!

  20. Started by darkavenger,

    Hello. I need help. Can I add https://psa.pulseway.com/MSP/TicketsListing.aspx here to Tickets ? Using https://api.pulseway.com/ ?

  21. Started by BShevchuck,

    We recently rolled out both Pulseway and the PSA replacing out Spiceworks help desk. Since the client portal is not as simple for user to create tickets within our mobile application, I am looking to use the PSA API but stuck. I am testing with the basic GET request to retrieve tickets and stuck on what server_name should be. Also for the authorization Bearer access_token, am I using the same token from the Pulseway webapp? Using this HTTP Request: GET https://server_name/api/servicedesk/tickets

  22. Started by Jason Willis,

    Hoping someone can help with this as I can't find a clear answer... I have a simple query to call from the servicedesk/tickets endpoint, but I'm unable to get the filter working with a DateTime column. In the code block below, Filter 1 (on the TickerNumber) & Filter 2 (on the SLA Status) both work fine and give the expected results, but Filter 3 (on Actual Resolution) returns a (400): Bad Request error. It does this whether I create the datetime programmatically as in Filter3, or hard-code it as in Filter4. let Token = "TOKEN GOES HERE", BaseURL = "https://psa.pulseway.com/api/", Path = "servicedesk/tickets", Day = Date.Day…

  23. Started by Mark G38,

    I've been working in the Pulseway REST API, and first off, I wish there were more endpoints here to work with, however, that said, I'm currently looking at the Automation section of the API, and there is the Get Task Execution section. This clearly states my url /api/v2/automation/executions/:id. My question is, where do I find the execution ID? Putting in the actual task ID returns that a task execution not found. Am I just missing a step or something? I don't see anyway through the API or Web UI to actually get any ID numbers for each task execution.

    • 1 reply
    • 2.1k views
  24. 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?

  25. 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