REST API v3 Questions

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

 

Thanks

 

[Anne]

Hi @TheITJedi

Thanks for reaching out, the following link should take you to all the documentation you will need regarding API V3 

Just uses this link: https://<yourserverURL>/api 

and be sure to input your URL

If you need anything else please let me know!

Thanks, 
Stefan 

[TheITJedi]

 

@StefanMcl_Pulseway, 

I have reviewed that documentation, it does not list anything for getting custom field values. Its listed in the API Token permissions here: 

But there is nothing in the documentation about it. 

The documentation shows that the endpoint for devices should be /devices,

Attempting to call that endpoint results in this error:

However, if I call the /systems endpoint (like for the V2 API but on V3), I get the same content I see from V2 API. 

 

What I need is the endpoint to get the custom fields for devices. 

 

Thanks,

[Anne]

Hi @TheITJedi

So the new update release for the API Authentication talks about API Access based on the Token. You can find it in the release notes here

 

Fetching value on the Custom field is not yet available, what shows on the api documentation page is what we have open and that been said as we progress we will start adding support for the additional value.

 

I hope this helps and if you have any more question please let me know

[TheITJedi]

@StefanMcl_Pulseway,

Is there a rough idea on when we can expect the ability to read custom field values via API? (hopefully set as well)

[Anne]

Hi @TheITJedi

 

Sorry I haven't replied I completely missed the notification on this thread. There is no set in stone date but we do aim to have this for the first quarter of next year. 

[tristan]

What are the limits to the Asset API, it seems very easy to get over usage. The $top limit of 100 also makes this challenging. V2 allowed more.

[Anne]

Hey @tristan

Thanks for reaching out, Apologies for the late reply I was consulting with our API expert - The current rate limit is set at 60 requests per minute but the plan is to increase it within coming releases. 

Thanks, 
Stefan 

[TheITJedi]

Any update on when we will get the ability to schedule workflows and tasks via API?

Edited January 18, 2024 by TheITJedi