---
url: /apidocs/adminserver_network.md
---
## Admin Network API

| Endpoint | Method | Description |
|-----|-----|-----|
| [/files/parseNetworkParticipantSpreadsheet](#parse-network-participant-spreadsheet) | webRequest | Parse network participant spreadsheet |
| [/files/generateNetworkPluginSettings/{networkId}.json](#generate-network-plugin-json) | webRequest | Generate network plugin json |
| [/jsonRpc/network.getNetworkModel](#get-network-model) | jsonRpc | Get network model |
| [/jsonRpc/network.getNetworkInfo](#get-network-info) | jsonRpc | Get network info |
| [/jsonRpc/network.getPrivateNetworkModel](#get-private-network-model) | jsonRpc | Get private network model |
| [/jsonRpc/network.getClusters](#get-clusters) | jsonRpc | Get clusters |
| [/jsonRpc/network.createNetwork](#create-network) | jsonRpc | Create network |
| [/jsonRpc/network.searchNetworkModels](#search-network-models) | jsonRpc | Search network models |
| [/jsonRpc/network.listNetworkModels](#list-network-models) | jsonRpc | List network models |
| [/jsonRpc/network.listActiveNetworkModels](#list-active-network-models) | jsonRpc | List active network models |
| [/jsonRpc/network.listUserNetworks](#list-user-networks) | jsonRpc | List user networks |
| [/jsonRpc/network.activateNetwork](#activate-network) | jsonRpc | Activate network |
| [/jsonRpc/network.disableNetwork](#disable-network) | jsonRpc | Disable network |
| [/jsonRpc/network.setNetworkThumbnail](#set-network-thumbnail) | jsonRpc | Set network thumbnail |
| [/jsonRpc/network.setNetworkSettings](#set-network-settings) | jsonRpc | Set network settings |
| [/jsonRpc/network.setNetworkPluginSettings](#set-network-plugin-settings) | jsonRpc | Set network plugin settings |
| [/jsonRpc/network.generateNetworkPluginSettings](#generate-network-plugin-settings) | jsonRpc | Generate network plugin settings |
| [/jsonRpc/network.isUserSubscribedToNetwork](#is-user-subscribed-to-network) | jsonRpc | Is user subscribed to network |
| [/jsonRpc/network.subscribeUserToNetwork](#subscribe-user-to-network) | jsonRpc | Subscribe user to network |
| [/jsonRpc/network.addNetworkParticipant](#add-network-participant) | jsonRpc | Add network participant |

### Parse network participant spreadsheet

**HTTP Method:** POST

**Path:** /files/parseNetworkParticipantSpreadsheet

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Generate network plugin json

**HTTP Method:** GET

**Path:** /files/generateNetworkPluginSettings/{networkId}.json

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Get network model

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.getNetworkModel

**Permissions:**

user subscribed to network

network.manage

network.listHidden

**Request:**

**Response:**

### Get network info

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.getNetworkInfo

**Permissions:**

user subscribed to network

network.manage

network.listHidden

**Request:**

**Response:**

### Get private network model

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.getPrivateNetworkModel

**Permissions:**

network.listHidden

**Request:**

**Response:**

### Get clusters

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.getClusters

**Permissions:**

all

**Request:**

**Response:**

### Create network

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.createNetwork

**Permissions:**

all

**Request:**

**Response:**

### Search network models

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.searchNetworkModels

**Permissions:**

network.listHidden

**Request:**

**Response:**

### List network models

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.listNetworkModels

**Permissions:**

network.listHidden

**Request:**

**Response:**

### List active network models

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.listActiveNetworkModels

**Permissions:**

network.listHidden

**Request:**

**Response:**

### List user networks

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.listUserNetworks

**Request:**

**Response:**

### Activate network

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.activateNetwork

**Permissions:**

all

**Request:**

**Response:**

### Disable network

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.disableNetwork

**Permissions:**

all

**Request:**

**Response:**

### Set network thumbnail

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.setNetworkThumbnail

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Set network settings

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.setNetworkSettings

**Permissions:**

all

**Request:**

**Response:**

### Set network plugin settings

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.setNetworkPluginSettings

**Permissions:**

all

**Request:**

**Response:**

### Generate network plugin settings

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.generateNetworkPluginSettings

**Permissions:**

all

**Request:**

**Response:**

### Is user subscribed to network

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.isUserSubscribedToNetwork

**Description:** API checks if user is subscribed to network.

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Subscribe user to network

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.subscribeUserToNetwork

**Description:** API subscribes user to network.

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Add network participant

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/network.addNetworkParticipant

**Description:** API creates new user (or takes existing one), subscribes him to network and sets company info.

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

## Models

#### Network

#### Network Private