Community Discussions
Unable to Retrieve Port/Service Data via Armis APIs
Hi Armis Community,
I am working on integrating with the Armis API and I am trying to fetch active ports and port-related data for specific devices/assets. I would love some guidance on the correct approach.
What I am trying to achieve:
For a given device_id or asset_id, I want to retrieve:
- All active/open ports
- Protocol information (TCP/UDP)
- Service names running on those ports
- Any traffic or connection data related to those ports
What I have tried so far:
-
v3
/api/v3/assets/_search(POST) — I can successfully fetch devices with fields likenetwork_interfaces,ipv4_addresses, etc. However, I do not see any port or service data insidenetwork_interfaces. -
v1
/api/v1/devices/{id}/— I tried fetching individual device data from the v1 endpoint but I am not sure which field contains the port/service data or if it is available at all via this endpoint.
My questions:
- Which API endpoint should I use to get active ports for a specific
device_idorasset_id? - What is the correct field name in the response that contains port/service data?
- Is port data available in v3 or only in v1? If v3, which field should I request in the
fieldsarray? - Is there a separate endpoint specifically for port/traffic/connection data?
Environment:
- Using the
<mytenant>.armis.combase URL - API v3 with JWT Bearer token authentication
- Scopes:
PERMISSION.DEVICE.READ,PERMISSION.PII.DEVICE,FULL_VISIBILITY
Any guidance or example response structures would be greatly appreciated!
Thank you!
