GET/api/networks/{networkId}/resources

List resources in a network

Lists the resources associated with a specific network. Use networkId to select the network whose resources you want to inspect. Each resource includes its identifier, type, groups, name, address, and enabled state.

1 parameter
networkIdstringrequired
The unique identifier of the network whose resources to list.

5 status codes
200Returns an array of network resource objects containing each resource's identifier, type, groups, name, address, and enabled state.
groupsarray<object>required
Groups that the resource belongs to
idstringrequired
Network Resource ID
typestringrequired
Network resource type based of the address
Allowed:hostsubnetdomain
addressstringrequired
Network resource address (either a direct host like 1.1.1.1 or 1.1.1.1/32, or a subnet like 192.168.178.0/24, or domains like example.com and *.example.com)
descriptionstringoptional
Network resource description
enabledbooleanrequired
Network resource status
namestringrequired
Network resource name
400Returned when the request is malformed.
401Returned when authentication is required but missing or invalid.
403Returned when the operation is forbidden.
500Returned when an internal server error occurs.

Error handling

A 400 is returned for a malformed request, a 401 when authentication is required but missing or invalid, a 403 when the operation is forbidden, and a 500 for an internal server error. The networkId path parameter must identify the network whose resources you want to list.