Jump to content

REST API v3 Questions


TheITJedi

Recommended Posts

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

 

Link to comment
Share on other sites

  • Administrators

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 

Link to comment
Share on other sites

 

@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: 
image.png.e7317184dcb4bc29a6dbad45f6fdfd69.png

But there is nothing in the documentation about it. 

image.png.ee6cb3ea31d9a19dc3e0a89b03f9c2d9.png

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

image.png.5ec2ac8e0074de3e2b279b9711ac0408.png


Attempting to call that endpoint results in this error:
image.png.a3444d700460372a42ab64a531094a6f.png

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,

Link to comment
Share on other sites

  • Administrators

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
Link to comment
Share on other sites

  • 2 months later...
  • 1 month later...

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
×
×
  • Create New...