List
List information about all networks available to either the current authenticated user or the team, if the user belongs to a team. The list method takes an optional first argument to limit the returned network objects.
Examples
HTTP
Node.js
1
# HTTP request:
2
https://api.paperspace.io
3
GET /networks/getNetworks
4
x-api-key: 1ba4f98e7c0...
5
# Returns 200 on success
Copied!
1
paperspace.networks.list(function(err, res) {
2
// handle error or result
3
});
Copied!
1
Copied!
Parameters
Name
Type
Attributes
Description
id
string
<optional>
Optional network id to match on
name
string
<optional>
Optional name to match on
region
string
<optional>
Optional region to match on
dtCreated
string
<optional>
Optional datetime created value to match on
network
string
<optional>
Optional network to match on
netmask
string
<optional>
Optional netmask to match on
teamId
string
<optional>
Optional teamId to match on
Returns
[ network, ... ] - JSON array of network objects
Type array
1
//Example return value:
2
[
3
{
4
"id": "n123abc",
5
"name": "Example Network",
6
"region": "East Coast (NY2)",
7
"dtCreated": "2016-12-22T16:36:42.613Z",
8
"network": "10.64.21.0",
9
"netmask": "255.255.255.0",
10
"teamId": "te456def"
11
}
12
]
Copied!
Last modified 9mo ago
Copy link