Interesting thing is when this task is run manually through the Web App it complete fine in 2 seconds. Has anyone else used this successfully? I'm thinking something is broken.

For those who really want to see some PowerShell code:

$TaskResp = Invoke-WebRequest -Uri $RunTaskUrl -UseBasicParsing `

-Headers $Headers `

-Method POST `

-ContentType 'application/json' `

-Body "$RunTaskBody"

where

$RunTaskBody = {"DeviceIdentifiers":["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]} # edited for privacy

$RunTaskUrl = https://my_domain.pulseway.com/api/v3/automation/tasks/148/run # editied for privacy

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
    {
        private const string ENDPOINT = "https://api.pulseway.com/v3";
        private const string TOKEN_ID = "api_token_id_generated_in_pulseway";
        private const string TOKEN_SECRET = "api_token_secret_generated_in_pulseway";

        static void Main(string[] args)
        {
            // Create RestClientOptions and set the Authenticator
            var clientOptions = new RestClientOptions(ENDPOINT)
            {
                Authenticator = new HttpBasicAuthenticator(TOKEN_ID, TOKEN_SECRET)
            };

            // Initialize the RestClient with the options
            var client = new RestClient(clientOptions);

            // Create the request
            var request = new RestRequest("devices", Method.Get);

            // Add parameters to the request
            request.AddParameter("$top", "50");
            request.AddParameter("$skip", "0");

            // Execute the request
            var response = client.Execute(request) as RestResponse;

            // Get the content of the response
            var content = response.Content;

            // Deserialize the content
            dynamic result = JsonConvert.DeserializeObject(content);

            // Output the result (for demonstration purposes)
            Console.WriteLine(result);
        }
    }

}

ConsoleApp.cs

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

https://{endpoint}/v3/devices/:id/appliedpolicies 

Error: 

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
} | ConvertTo-Json

$jsonPayload

# Set the authorization header
$headers = @{
    Authorization = "Basic {0}" -f [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$($tokenID):$($tokenSecret)"))
    'Content-Type' = 'application/json'
}

# Send the API request
try {
    $response = Invoke-RestMethod -Uri $apiEndpoint -Method Post -Headers $headers -Body $jsonPayload

    if ($response.status -eq "success") {
        Write-Host "Notification sent successfully."
    } else {
        Write-Host "Failed to send notification. Response: $($response | ConvertTo-Json -Depth 5)"
    }
}
catch {
    Write-Host "Error occurred: $_"
}
 

Hope someone can help us.

Greeting,

Martijn

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 = await client.GetAsync("devices");
			response.EnsureSuccessStatusCode();

		}

I get the same error with postman.

Have I made a mistake?
Thanks for your help!
Cyril

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
Thursday, 14 March 2024 11:08 pm

Most of the result are in dd MMMM yyyy HH:mm format.

Except once pc all others are windows. I checked the datetime format in windows for two PC's that had different boot up time format in REST API result but both windows time formats were same.

How to get a unified time format as the API result ? 

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 for getting the documentation updated?

Thanks

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!

i copied the curl example replacing username and password
i tried with the php example.
i tried with my custom library, etc.

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 to delete them from pulseway.

Thank you,

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.

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

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 ?

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!

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!

WHERE IS https://api.psa.pulseway.com/swagger/index.html ?

Hello. I want create new ticket with api but i don't see Source: *  api method

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!

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!

Using this HTTP Request:

GET https://server_name/api/servicedesk/tickets

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(Date.From(DateTime.LocalNow())),
        Month   = Date.Month(Date.From(DateTime.LocalNow())),
        Year    = Date.Year(Date.From(DateTime.LocalNow())),

        Date    = DateTime.ToText(#datetime(Year, Month, Day, 00, 00, 00), "yyyy-MM-ddThh:mm:ss"),

        Filter1 = "?$filter=endswith(TicketNumber, '2022')",
        Filter2 = "?$filter=StatusSLAEventId gt 1",
        Filter3 = "?$filter=ResolutionActualTime gte " & Date,
        Filter4 = "?$filter=ResolutionActualTime gte 2022-01-03T00:00:00.000Z",

            Source = Json.Document(Web.Contents(BaseURL & Path & Filter4, [Headers = [Authorization="Bearer " & Token]]))
in
    Source

Does anyone know where I'm going wrong?

Thank you in advance!

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. 

I tried several things

• username : API-Key  /   username
• MFA with - or without

But 403 keeps comming back. Someone any idea?