{"type":"doc","content":[{"type":"paragraph","content":[{"text":"By using the just:store API it is easier than ever before to integrate just:store into your workflow or application.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"You cannot use the “Try it out” button here.","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"For realtime testing please open your browser and enter following URL:","type":"text"},{"type":"hardBreak"},{"text":"http://[IP-of-your-juststore]:8080/api/v1/swagger-ui.html","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"__bodyContent":{"value":"{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"OpenAPI definition\",\"version\":\"v0\"},\"servers\":[{\"url\":\"http://10.39.1.92:8080/api/v1\",\"description\":\"Generated server url\"}],\"security\":[{\"bearer-jwt\":[\"read\",\"write\"]}],\"paths\":{\"/network/bond/{bondname}/settings\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify settings of given bond network, admin access required\",\"operationId\":\"modifyBondMode\",\"parameters\":[{\"name\":\"bondname\",\"in\":\"path\",\"description\":\"The unique name of the bond network\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"bondType: The bonding mode\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BondSettings\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new bond network
mode: The type of bond network, e.g. active backup
slaves: The set of slave connections managed by this bond
ipSettings: The ip settings of this bond
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Bond\"}}}}}}},\"/network/hostname\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Current hostname\",\"operationId\":\"getHostname\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"hostname: The current hostname\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Hostname\"}}}}}},\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify or set hostname\",\"operationId\":\"setNewHostname\",\"requestBody\":{\"description\":\"newHostName: The new hostname to set\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ModifyHostnameRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/network/teams\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get all team networks\",\"operationId\":\"getTeamMasters\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of all team networks
mode: The type of team network, e.g. round robin
slaves: The set of slave connections managed by this team
ipSettings: The ip settings of this team
\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Team\"}}}}}}}},\"/network/bonds\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get all bond networks\",\"operationId\":\"getBondMasters\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of all bond networks
mode: The type of bond network, e.g. active backup
slaves: The set of slave connections managed by this bond
ipSettings: The ip settings of this bond
\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Bond\"}}}}}}}},\"/network/shaping\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get interfaces and their current shaping rules\",\"operationId\":\"getAllShapedInterfaces\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of interfaces which can be shaped via shaping rules
name: The name of the interface
deviceType: The device type, e.g. ETHERNET
speed: The interface link speed in Mbits/sec
duplex: Indicates the interface latest or current duplex value
carrier: Indicates the current physical link state of the interface
incomingRules: List of incoming rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
outgoingRules: List of outgoing rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ShapedInterface\"}}}}}}}},\"/network/shaping/{interface-name}\":{\"post\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Add a new shaping rule for given interface name\",\"operationId\":\"addShapingRule\",\"parameters\":[{\"name\":\"interface-name\",\"in\":\"path\",\"description\":\"The interface name to apply the new rule to.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"ruleRequest: omitting sourceNetwork, destinationNetwork, destinationPort and sourcePort will apply the rule to all network packets on either outgoing or incoming depending on the flag outgoing: Should the rule be applied to outgoing connections? false == incoming, true == outgoing sourceNetwork: The source network address, can be empty (ignored). The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network address, can be empty (ignored). The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: The rate limit to apply in bits per second (minimum == 8)
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ModifyShapingRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"name: The name of the interface
deviceType: The device type, e.g. ETHERNET
speed: The interface link speed in Mbits/sec
duplex: Indicates the interface latest or current duplex value
carrier: Indicates the current physical link state of the interface
incomingRules: List of incoming rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
outgoingRules: List of outgoing rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShapedInterface\"}}}}}},\"delete\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Removes all shaping rules for given interface name\",\"operationId\":\"removeShaping\",\"parameters\":[{\"name\":\"interface-name\",\"in\":\"path\",\"description\":\"The name of the interface to remove shaping for\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"name: The name of the interface
deviceType: The device type, e.g. ETHERNET
speed: The interface link speed in Mbits/sec
duplex: Indicates the interface latest or current duplex value
carrier: Indicates the current physical link state of the interface
incomingRules: List of incoming rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
outgoingRules: List of outgoing rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
\"}}}},\"/network/shaping/{interface-name}/{shaping-rule-id}\":{\"delete\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Delete shaping rule from given interface\",\"operationId\":\"deleteShapingRule\",\"parameters\":[{\"name\":\"interface-name\",\"in\":\"path\",\"description\":\"The interface name to delete the given rule from.\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"shaping-rule-id\",\"in\":\"path\",\"description\":\"The ID of the rule to delete\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"name: The name of the interface
deviceType: The device type, e.g. ETHERNET
speed: The interface link speed in Mbits/sec
duplex: Indicates the interface latest or current duplex value
carrier: Indicates the current physical link state of the interface
incomingRules: List of incoming rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
outgoingRules: List of outgoing rules:
id: ID of shaping rule
sourceNetwork: The source network address. The source network is applied to the packet source, this differs from outgoing to incoming connections. For example, setting a source network on an incoming rule will limit packets from the given external address, conversely, setting a source network on an outgoing rule will limit packets sent from this host's interface.
sourceNetworkSubnet: The source network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationNetwork: The destination network is applied to the packet destination, this differs from outgoing to incoming connections. For example, setting a destination network on an incoming rule will limit packets to this host's interface , conversely, setting a destination network on an outgoing rule will limit packets to the given external address.
destinationNetworkSubnet: The destination network subnet, range = 0-32, when value is -1 no subnet masking will be applied. Example: subnet 24 on address 192.168.0.1 will apply rule to 192.168.0.1-192.168.0.254
destinationPort: The destination port, range (0-65535), 0 is no port restriction
sourcePort: The source port, range (0-65535), 0 is no port restriction
rate: current upload limit set, in various bit formats [bps, Kbps, Mbps, Gbps] (empty == no limit)
\"}}}},\"/network/{mastername}/slave\":{\"post\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Create a new network slave and assign it to a master, admin access required\",\"operationId\":\"createSlave\",\"parameters\":[{\"name\":\"mastername\",\"in\":\"path\",\"description\":\"The unique name of the master connection team or bond\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"slaveName: The unique name of the slave connection
interfaceName: The interface (device) to asign to this slave connection\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateSlaveRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new slave network
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
ipSettings: various standard ip settings
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Slave\"}}}}}}},\"/network/ip-connections\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get all IP connections\",\"operationId\":\"getAllIPConnections\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of all IP specific connections
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
ipSettings: The ip settings -
method: AUTO or MANUAL settings (DHCP)
dns: List of dns addresses
addresses: List of ip addresses for this connection
gateway: The gateway address to use
ipv6method: AUTO or MANUAL settings (dhcp)
ipv6dns: List of IPV6 dns addresses
ipv6addresses: List of IPV6 addresses for this connection
ipv6gateway: The IPV6 gateway to use \",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/IPConnectionDomain\"}}}}}}}},\"/network/{connectionname}/ipsettings\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify an existing connection's IP settings\",\"operationId\":\"modifyIPSettings\",\"parameters\":[{\"name\":\"connectionname\",\"in\":\"path\",\"description\":\"The unique name of the connection to modify\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"method: AUTO or MANUAL settings (DHCP)
dns: List of dns addresses
addresses: List of ip addresses for this connection
gateway: The gateway address to use
ipv6method: AUTO or MANUAL settings (dhcp)
ipv6dns: List of IPV6 dns addresses
ipv6addresses: List of IPV6 addresses for this connection
ipv6gateway: The IPV6 gateway to use \",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/IPSettings\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified connection
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
ipSettings: various standard ip settings
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/IPConnectionDomain\"}}}}}}},\"/network/team\":{\"post\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Create a new team network, admin access required\",\"operationId\":\"createTeamNetwork\",\"requestBody\":{\"description\":\"teamName: A unique connection name
mode: The teaming mode to use, e.g. round robin
ipSettings: The ip settings -
method: AUTO or MANUAL settings (DHCP)
dns: List of dns addresses
addresses: List of ip addresses for this connection
gateway: The gateway address to use
ipv6method: AUTO or MANUAL settings (dhcp)
ipv6dns: List of IPV6 dns addresses
ipv6addresses: List of IPV6 addresses for this connection
ipv6gateway: The IPV6 gateway to use \",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateTeamRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new team network
mode: The type of team network, e.g. round robin
slaves: The set of slave connections managed by this team
ipSettings: The ip settings of this team
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Team\"}}}}}}},\"/network/bond\":{\"post\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Create a new bond network, admin access required\",\"operationId\":\"createBondNetwork\",\"requestBody\":{\"description\":\"bondName: A unique connection name
mode: The bonding mode to use, e.g. active backup
ipSettings: The ip settings -
method: AUTO or MANUAL settings (DHCP)
dns: List of dns addresses
addresses: List of ip addresses for this connection
gateway: The gateway address to use
ipv6method: AUTO or MANUAL settings (dhcp)
ipv6dns: List of IPV6 dns addresses
ipv6addresses: List of IPV6 addresses for this connection
ipv6gateway: The IPV6 gateway to use \",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateBondRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new bond network
mode: The type of bond network, e.g. active backup
slaves: The set of slave connections managed by this bond
ipSettings: The ip settings of this bond
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Bond\"}}}}}}},\"/network/{connectionname}/autoconnect\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify the auto-connect flag for given connection\",\"operationId\":\"modifyConnectionAutoconnect\",\"parameters\":[{\"name\":\"connectionname\",\"in\":\"path\",\"description\":\"The unique name of the connection to modify\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"autoconnect: Should the connection autoconnect to the device when possible
autoConnectPriority: Integer priority for auto-connecting (0 is highest priority)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ModifyConnectionAutoconnect\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified connection
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ConnectionBase\"}}}}}}},\"/network/{connectionname}/ethernetsettings\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify the ethernet settings for given connection\",\"operationId\":\"modifyEthernetSettings\",\"parameters\":[{\"name\":\"connectionname\",\"in\":\"path\",\"description\":\"The unique name of the connection to modify\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"mtu: The maximum transmission unit (frame size)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/EthernetSettings\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified ethernet connection
mtu: The maximum transmission unit (frame size)
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/EthernetConnection\"}}}}}}},\"/network/ethernet-interfaces\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get all available ethernet network interfaces\",\"operationId\":\"getEthernetInterfaces\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of all interfaces
name: The name of the interface
deviceType: The device type, e.g. ETHERNET
speed: The interface link speed in Mbits/sec
duplex: Indicates the interface latest or current duplex value
carrier: Indicates the current physical link state of the interface portsSupport: What ports are supported, e.g. TP (twisted pair), MII (media independent interface) linkModesSupport: List of supported link modespauseFrameUseSupport: Are pause frames supported, PAUSE frames are generated when the receive packet buffer crosses a predefined thresholdautoNegotiationSupport: Does the device support transmission auto negotiationusedPortType: Current port type in use, e.g. Twisted PairautoNegotiationState: Is auto-negotiation enabled transceiverType: Type of transceiver used, e.g. Internal\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/EthernetInterface\"}}}}}}}},\"/network/team/{teamname}/settings\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify settings of given team network, admin access required\",\"operationId\":\"modifyTeamSettings\",\"parameters\":[{\"name\":\"teamname\",\"in\":\"path\",\"description\":\"The unique name of the team network\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"runner: The teaming mode\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TeamSettings\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new team network
mode: The type of team network, e.g. round robin
slaves: The set of slave connections managed by this team
ipSettings: The ip settings of this team
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Team\"}}}}}}},\"/network/{connectionname}/name\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify a connection name\",\"operationId\":\"modifyConnectionName\",\"parameters\":[{\"name\":\"connectionname\",\"in\":\"path\",\"description\":\"The unique name of the connection to modify\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"newConnectionName: The new connection name\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ModifyConnectionNameRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified connection
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ConnectionBase\"}}}}}}},\"/network/{connectionname}/active\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Set the UP/DOWN status of the given connection\",\"operationId\":\"modifyConnectionActive\",\"parameters\":[{\"name\":\"connectionname\",\"in\":\"path\",\"description\":\"The unique name of the connection\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"active: set connection state\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ModifyConnectionActiveRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified connection
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ConnectionBase\"}}}}}}},\"/network/{connectionname}/interface\":{\"put\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Modify the interface to which the given connection is assigned to\",\"operationId\":\"modifyInterfaceLink\",\"parameters\":[{\"name\":\"connectionname\",\"in\":\"path\",\"description\":\"The unique name of the connection to modify\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"newInterfaceName: The name of the new interface to connect to\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ModifyInterfaceLinkRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified connection
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ConnectionBase\"}}}}}}},\"/network/connections\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get all connections\",\"operationId\":\"getAllConnections\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of all connections
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ConnectionBase\"}}}}}}}},\"/network/ethernet-connections\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get all Ethernet connections\",\"operationId\":\"getAllEthernetConnections\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of all Ethernet connections
mtu: The maximum transmission unit (frame size)
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/EthernetConnection\"}}}}}}}},\"/network\":{\"post\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Create a new connection\",\"operationId\":\"createNetwork\",\"requestBody\":{\"description\":\"connectionName: Unique connection name
interfaceName: The interface name to assign this connection to, available interfaces from /interface endpoint
ipSettings: The ip settings -
method: AUTO or MANUAL settings (DHCP)
dns: List of dns addresses
addresses: List of ip addresses for this connection
gateway: The gateway address to use
ipv6method: AUTO or MANUAL settings (dhcp)
ipv6dns: List of IPV6 dns addresses
ipv6addresses: List of IPV6 addresses for this connection
ipv6gateway: The IPV6 gateway to use \",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateNetworkRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new connection
name: The unique name of the connection
active: Is the connection UP or DOWN
autoconnect: Should the connection auto-connect to the device when possible
autoConnectPriority: Integer priority for auto-connecting (0 is highest priority)
device: The device (interface) this connection is assigned to
connectionType: The connection type, e.g. ETHERNET or WIFI
ipSettings: various standard ip settings
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/IPConnectionDomain\"}}}}}}},\"/network/interfaces\":{\"get\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Get all available network interfaces\",\"operationId\":\"getInterfaces\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Set of all interfaces
name: The name of the interface
deviceType: The device type, e.g. ETHERNET
speed: The interface link speed in Mbits/sec
duplex: Indicates the interface latest or current duplex value
carrier: Indicates the current physical link state of the interface \",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Interface\"}}}}}}}},\"/network/{connectionname}\":{\"delete\":{\"tags\":[\"network-manager-rest-endpoint\"],\"description\":\"Delete given connection\",\"operationId\":\"delete\",\"parameters\":[{\"name\":\"connectionname\",\"in\":\"path\",\"description\":\"The unique name of the connection\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/sharepoints/afp/{name}/addUser\":{\"put\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Add given user to sharepoint\",\"operationId\":\"addUser\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The user to add to given sharepoint
userName: The unique name of the user
permission: The permissions for the given user:
read: read access to sharepoint
write: write access to sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddUserRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp/{name}/removeGroup\":{\"put\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Remove given group from sharepoint\",\"operationId\":\"removeGroup\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The group to remove from given sharepoint
groupName: The unique name of the group\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GroupName\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp\":{\"get\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Get all configured AFP sharepoints\",\"operationId\":\"getSharepoints\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The list of all configured AFP sharepoints\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"post\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Create a new AFP sharepoint\",\"operationId\":\"create\",\"requestBody\":{\"description\":\"The new sharepoint to add
name: Unique sharepoint name
location: The top level location, see the directory service for available configured locations\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SharepointRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp/{name}/removeUser\":{\"put\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Remove given user from sharepoint\",\"operationId\":\"removeUser\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The user to remove from given sharepoint
userName: The unique name of the user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserName\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp/{name}/setEnabled\":{\"put\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Enable/Disable the sharepoint. Disable will not delete the underlying data on the sharepoint\",\"operationId\":\"setEnabled\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"enabled: Flag to enabled/disable sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetEnabledRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp/{name}/addGroup\":{\"put\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Add given group to sharepoint\",\"operationId\":\"addGroup\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The group to add to given sharepoint
groupName: The unique name of the group
permission: The permissions for the given group:
read: read access to sharepoint
write: write access to sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddGroupRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp/{name}/setGuestOK\":{\"put\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Allow guest access on given sharepoint\",\"operationId\":\"setGuestOK\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"Allow guest access
guestOK: allow guest access flag\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetGuestOKRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp/{name}/setGuestPermission\":{\"put\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Set the guest permission for given sharepoint name\",\"operationId\":\"setGuestPermission\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The guest permissions
read: read access to sharepoint
write: write access to sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Permission\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified AFP sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AFPSharepoint\"}}}}}}},\"/sharepoints/afp/{name}\":{\"delete\":{\"tags\":[\"afp-rest-endpoint\"],\"description\":\"Delete AFP sharepoint\",\"operationId\":\"delete_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/monitoring/network-interface-stats\":{\"get\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"Network interface usage information\",\"operationId\":\"getNetworkInterfaceStats\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"various network interface information
rx values are read values, and tx are transfer values
networkInterface: network interface name
rxBytes: total network reads in bytes since start
rxPackets: total network packet reads since start
rxErrors: total network read errors (any error) since start
rxDropped: total dropped packets since start due to unintended VLAN tags or unsupported IPV6 frames
rxOverruns: total FIFO overruns (full buffer)
rxFrame: misaligned frame counts (not divisible by 8)
txCollisions: transmitted packets that experienced Ethernet collisions
speed: advertised speed in /sys/class/net//speed
txCarrier: packets that experienced loss of carriers. This usually happens when link is flapping
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NetworkInterfaceStatList\"}}}}}}},\"/monitoring/power-supply-stats\":{\"get\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"Power supply information\",\"operationId\":\"getPowerSupplyStats\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Power supply information provided by the ipmi interface (won't function if not available on installed system)
ident: unique power supply identification
status: status information on power supply
failure: is failed flag
connected: is connected flag\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PowerSupplyStatList\"}}}}}}},\"/monitoring/raid-stats\":{\"get\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"Raid Controller information\",\"operationId\":\"getRaidStats\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Raid information provided by adaptec Arcconf (won't function if not available on installed system)
identificationNumber: raid controller identification number
controllerStatus: controller status info
controllerMode: controller mode, Mixed, RAID, or HBA mode
channelDescription: e.g. SCSI
controllerModel: what type of controller model
controllerSerialNumber: advertised serial number of installed model
controllerWorldWideName: advertised world wide name
temperature: temperature information if available (celcius and fahrenheit)
automaticFailover: is automatic failover enabled
backUpUnitStatus: status of backup unit
unnassignedPhysicalDevices: list of unassigned physical devices with in-depth information
logicalDevices: list of assigned logical devices with in-depth information
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RaidStatList\"}}}}}}},\"/monitoring/raid-device-identify\":{\"put\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"Trigger light on raid device\",\"operationId\":\"identifyDevice\",\"requestBody\":{\"description\":\"controllerIdentification: top level controller identification
channel: the identifiable channel
blinkTimeInSeconds: how long to blink for in seconds\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RequestIdentifyDevice\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/monitoring/ipmi-info\":{\"get\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"IPMI config and info\",\"operationId\":\"getIpmiInfo\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"firmwareVersion: ipmi firmware version
IpmiConfig:
ipAddress: configured ip address
MAC: configured MAC address
gateway: configured gateway
subnetMask: configured subnet mask
dhcp: resolve over dhcp flag\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/IpmiInfo\"}}}}}}},\"/monitoring/ipmi-config\":{\"put\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"Modify the ipmi configuration\",\"operationId\":\"setIpmiConfig\",\"requestBody\":{\"description\":\"ipAddress: set the ip address
MAC: set the MAC address
gateway: set the gateway
subnetMask: set the subnet mask
dhcp: set the resolve over dhcp flag\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/IpmiConfig\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/monitoring/cpu-stats\":{\"get\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"Current CPU usage information\",\"operationId\":\"getCPUStats\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of information per CPU core
physicalCoreID: the unique id of the CPU core
idle: percentage (0.0-1.0) idle of CPU core
combined: the percent (0.0-1.0) usage of the CPU core
temp: the temperature in celsius of the CPU core\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CPUStatList\"}}}}}}},\"/monitoring/memory-stats\":{\"get\":{\"tags\":[\"monitoring-rest-endpoint\"],\"description\":\"Current memory usage information\",\"operationId\":\"getMemoryStats\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Various memory information, all appropriate values in base 2
total: the total amount of physical memory, in bytes
ram: the total physical memory in megabytes (base 2), value * 1024 * 1024 will equal total value
used: the total amount of physical memory in use, in bytes
free: the total amount of free physical memory, in bytes
actualUsed: the total amount of physical memory in use +/- the buffers/caches
actualFree: the total amount of free physical memory +/- the buffers/caches
usedPercent: the total used percentage of memory in range 0.0-100.0 path: mounted path
total: total amount of space on partition in KB
free: total free space on partition in KB
used: total used space on partition in KB
avail: total actual available space on partition in KB
files: total inodes (files) on partition
freeFiles: total free inodes on partition
diskReads: disk reads since start
diskWrites: disk writes since start
diskReadBytes: disk reads in bytes since start
diskWriteBytes: disk writes in bytes since start
usePercent: disk usage in percent (range 0.0-1.0)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FileSystemUsageStatList\"}}}}}}},\"/service/autostart\":{\"put\":{\"tags\":[\"service-manager-rest-endpoint\"],\"description\":\"Set the autostart of a service\",\"operationId\":\"setAutostart\",\"requestBody\":{\"description\":\"name: The name of the service taken from the list of available and monitored services
autostart: Should the service autostart on system boot\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetAutostartRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/service\":{\"get\":{\"tags\":[\"service-manager-rest-endpoint\"],\"description\":\"Gets the list of running and monitored juststore used services\",\"operationId\":\"getServices\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of services:
available: Is the service available (installed) on the system
serviceName: The actual name of the service
description: A description of the service
autostart: Should the service autostart on boot
running: Is the service running
status: extra status info on the service
status: can be any of - FAILED, INACTIVE, ACTIVE, ACTIVATING, UNKNOWN
latestMessage: The latest message the service sent
latestMessageTimestamp: The timestamp of the latest message (Unix epoch)\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SystemService\"}}}}}}}},\"/service/running\":{\"put\":{\"tags\":[\"service-manager-rest-endpoint\"],\"description\":\"Start or stop a service\",\"operationId\":\"setRunning\",\"requestBody\":{\"description\":\"name: The name of the service taken from the list of available and monitored services
running: Set the running state (on or off)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetRunningRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/timedate/time\":{\"get\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Get the current unix system time\",\"operationId\":\"getTime\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"localTime: time in milliseconds since unix epoch\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TimeResponse\"}}}}}},\"put\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Modify the system time\",\"operationId\":\"setTime\",\"requestBody\":{\"description\":\"time: in format: \\\"yyyy-MM-dd HH:mm:ss\\\"\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetTimeRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/timedate/available-timezone\":{\"get\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Get the timezones that are available\",\"operationId\":\"getAvailableTimezones\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of available timezone strings to set\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TimezoneAvailableResponse\"}}}}}}},\"/timedate/timezone\":{\"get\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Get the current system timezone\",\"operationId\":\"getTimezone\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Current configured timezone\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TimezoneResponse\"}}}}}},\"put\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Set the system timezone, use /available-timezone endpoint for options\",\"operationId\":\"setTimezone\",\"requestBody\":{\"description\":\"timezone: timezone to set\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TimezoneRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/timedate/ntpconfig\":{\"get\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Get the ntp config\",\"operationId\":\"getNTPConfig\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The current NTP config:
servers: list of configured ntp servers
peers: list of configured ntp peers
pools: list of configured ntp pools
refClocks: list of configured system reference clocks
combinelimit: number of configured sources to combine for when setting the current time
maxdistance: the maximum allowed root distance of the sources to not be rejected by the source selection algorithm
minsources: s the minimum number of sources that need to be considered as selectable in the source selection algorithm before the local clock is updated
allowAll: allow all connections to this NTP server
denyAll: deny all connections to this NTP server
allows: list of ip addresses to allow connection to this NTP server
denys: list of ip addresses to deny connection to this NTP server
bindaddress: the socket on which to bind NTP listener
bindacqaddress: the network interface to which client sockets will attempt to bind
acquisitionport: the port to which client sockets will attempt to bind
broadcast: addresses to which NTP packets should be sent
local: when set, enabled local reference mode, useful for running a closed NTP server without outside references
port: the port on which to listen for NTP requests, default is 123
rtconutc: is RTC on UTC or on local time?
rtcsync: allow the system time to be copied to the RTC clock\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NTPConfig\"}}}}}},\"put\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Modify the ntp config, admin restriction in place\",\"operationId\":\"setNTPConfig\",\"requestBody\":{\"description\":\"The modified NTP config:
servers: list of configured ntp servers
peers: list of configured ntp peers
pools: list of configured ntp pools
refClocks: list of configured system reference clocks
combinelimit: number of configured sources to combine for when setting the current time
maxdistance: the maximum allowed root distance of the sources to not be rejected by the source selection algorithm
minsources: s the minimum number of sources that need to be considered as selectable in the source selection algorithm before the local clock is updated
allowAll: allow all connections to this NTP server
denyAll: deny all connections to this NTP server
allows: list of ip addresses to allow connection to this NTP server
denys: list of ip addresses to deny connection to this NTP server
bindaddress: the socket on which to bind NTP listener
bindacqaddress: the network interface to which client sockets will attempt to bind
acquisitionport: the port to which client sockets will attempt to bind
broadcast: addresses to which NTP packets should be sent
local: when set, enabled local reference mode, useful for running a closed NTP server without outside references
port: the port on which to listen for NTP requests, default is 123
rtconutc: is RTC on UTC or on local time?
rtcsync: allow the system time to be copied to the RTC clock\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NTPConfig\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/timedate/state\":{\"get\":{\"tags\":[\"date-time-rest-endpoint\"],\"description\":\"Get the current NTP state\",\"operationId\":\"getState\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"Current NTP state info:
trackingInfo: various tracking information representing the ntp clock statesourceInfos: info on which sources are configured\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NTPStateInfo\"}}}}}}},\"/sharepoints/smb/{name}/addUser\":{\"put\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Add given user to sharepoint\",\"operationId\":\"addUser_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The user to add to given sharepoint
userName: The unique name of the user
permission: The permissions for the given user:
read: read access to sharepoint
write: write access to sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddUserRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb/{name}/removeGroup\":{\"put\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Remove given group from sharepoint\",\"operationId\":\"removeGroup_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The group to remove from given sharepoint
groupName: The unique name of the group\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GroupName\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb\":{\"get\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Get all configured SMB sharepoints\",\"operationId\":\"getSharepoints_1\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The list of all configured SMB sharepoints\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"post\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Create a new SMB sharepoint\",\"operationId\":\"create_1\",\"requestBody\":{\"description\":\"The new sharepoint to add
name: Unique sharepoint name
location: The top level location, see the directory service for available configured locations\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SharepointRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb/{name}/removeUser\":{\"put\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Remove given user from sharepoint\",\"operationId\":\"removeUser_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The user to remove from given sharepoint
userName: The unique name of the user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserName\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb/{name}/setEnabled\":{\"put\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Enable/Disable the sharepoint. Disable will not delete the underlying data on the sharepoint\",\"operationId\":\"setEnabled_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"enabled: Flag to enabled/disable sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetEnabledRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb/{name}/addGroup\":{\"put\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Add given group to sharepoint\",\"operationId\":\"addGroup_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The group to add to given sharepoint
groupName: The unique name of the group
permission: The permissions for the given group:
read: read access to sharepoint
write: write access to sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddGroupRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb/{name}/setGuestOK\":{\"put\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Allow guest access on given sharepoint\",\"operationId\":\"setGuestOK_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"Allow guest access
guestOK: allow guest access flag\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetGuestOKRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb/{name}/setGuestPermission\":{\"put\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Set the guest permission for given sharepoint name\",\"operationId\":\"setGuestPermission_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The guest permissions
read: read access to sharepoint
write: write access to sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Permission\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The modified SMB sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SMBSharepoint\"}}}}}}},\"/sharepoints/smb/{name}\":{\"delete\":{\"tags\":[\"smb-rest-endpoint\"],\"description\":\"Delete SMB sharepoint\",\"operationId\":\"delete_2\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/notification/email/password\":{\"put\":{\"tags\":[\"notification-rest-endpoint\"],\"description\":\"Set the email password\",\"operationId\":\"setEmailPassword\",\"requestBody\":{\"description\":\"password: The email Password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/EmailPasswordRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/notification/email/config\":{\"get\":{\"tags\":[\"notification-rest-endpoint\"],\"description\":\"Get the current email configuration\",\"operationId\":\"getEmailConfig\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The email config:
enabled: Is email notification enabled
addressesToNotify: A list of email addresses to notify when an alert occurs
emailHost: The email server
emailPort: The email server port
emailUser: The email user
sendFrom: The send from address that should appear in the email
auth: Is auth enabled
useTLS: Using Transport Layer Security
trustSSL: Using ssl trusting\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/EmailConfig\"}}}}}},\"put\":{\"tags\":[\"notification-rest-endpoint\"],\"description\":\"Set the email configuration\",\"operationId\":\"setEmailConfig\",\"requestBody\":{\"description\":\"The new email config:
enabled: Should email notifications be enabled
addressesToNotify: A list of email addresses to notify when an alert occurs
emailHost: The email server
emailPort: The email server port
emailUser: The email user
sendFrom: The send from address that should appear in the email
auth: Should use authentication
useTLS: Should use Transport Layer Security
trustSSL: Should check for ssl certs\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/EmailConfig\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/notification/alert/force-alerts\":{\"post\":{\"tags\":[\"notification-rest-endpoint\"],\"description\":\"Forces all alerts to fire, even if there is no problem\",\"operationId\":\"forceAlerts\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/notification/alert/config\":{\"get\":{\"tags\":[\"notification-rest-endpoint\"],\"description\":\"Get the currently configured alert config\",\"operationId\":\"getAlertConfig\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The alerts config:
enable: are all alerts enabled/disabled
timeoutMS: The timeout in milliseconds before another alert can be sent via email (this timeout is applied for each alert)
alertNodeConfigs: The various configured alert nodes in the system, each reporting on a different aspect of juststore
alertName: The unique name of the alert node
enabled: Is the alert node enabled
description: A description of the alerts function\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AlertConfigD\"}}}}}},\"put\":{\"tags\":[\"notification-rest-endpoint\"],\"description\":\"Set the alert config\",\"operationId\":\"setAlertConfig\",\"requestBody\":{\"description\":\"The alerts config to set:
enable: are all alerts enabled/disabled
timeoutMS: The timeout in milliseconds before another alert can be sent via email (this timeout is applied for each alert)
alertNodeConfigs: The alert nodes to change the config for
alertName: The unique name of the alert node (this must exist)
enabled: enable or disable the alert
description: this can be ignored while setting\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AlertConfigD\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/notification/email/test\":{\"post\":{\"tags\":[\"notification-rest-endpoint\"],\"description\":\"Sends a test email to check the email configuration\",\"operationId\":\"testEmail\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/users/{name}\":{\"get\":{\"tags\":[\"users-rest-endpoint\"],\"description\":\"Get a user by name\",\"operationId\":\"getUser\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the user\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The user
name: Unique name of the user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/User\"}}}}}},\"delete\":{\"tags\":[\"users-rest-endpoint\"],\"description\":\"Delete a given user\",\"operationId\":\"delete_3\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the user\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/users\":{\"get\":{\"tags\":[\"users-rest-endpoint\"],\"description\":\"Get a list of all users\",\"operationId\":\"getUsers\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of users
name: Unique name of the user\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/User\"}}}}}}},\"post\":{\"tags\":[\"users-rest-endpoint\"],\"description\":\"Create a new user, these users are used for sharepoint access\",\"operationId\":\"create_2\",\"requestBody\":{\"description\":\"The new user to create
name: Flag to enabled/disable sharepoint
password: The password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateUserRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The newly created user
name: Unique name of the user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/User\"}}}}}}},\"/users/{name}/modifyPassword\":{\"put\":{\"tags\":[\"users-rest-endpoint\"],\"description\":\"Modify the password of a given user\",\"operationId\":\"updatePassword\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the user\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"password: The new password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PasswordRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/sharepoints/nfs/{name}/setGlobalAccess\":{\"put\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Set global access for sharepoint\",\"operationId\":\"setGlobalAccess\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The global access options
rw: Allow Read/Write to sharepoint , false is read only
secure: This option requires that requests originate on an Internet port less than IPPORT_RESERVED (1024)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSAccessOptions\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new state of the NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs/{name}/removeGlobalAccess\":{\"put\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Remove any global access settings for sharepoint\",\"operationId\":\"removeGlobalAccess\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new state of the NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs\":{\"get\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Get all configured AFP sharepoints\",\"operationId\":\"getSharepoints_2\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The list of all configured NFS sharepoints\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"post\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Create a new NFS sharepoint\",\"operationId\":\"create_3\",\"requestBody\":{\"description\":\"The new sharepoint to add
name: Unique sharepoint name
location: The top level location, see the directory service for available configured locations\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NetworkAuthSharepointRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs/{name}/setEnabled\":{\"put\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Enable/Disable the sharepoint. Disable will not delete the underlying data on the sharepoint\",\"operationId\":\"setEnabled_2\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"enabled: Flag to enabled/disable sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetEnabledRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new state of the NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs/{name}/addHostname\":{\"put\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Add access of host to NFS sharepoint\",\"operationId\":\"addHostname\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"The new access options
hostname: the specific hostname to give access to
rw: Allow Read/Write to sharepoint , false is read only
secure: This option requires that requests originate on an Internet port less than IPPORT_RESERVED (1024)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddHostnameAccessRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new state of the NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs/{name}/removeHostname\":{\"put\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Remove hostname access from sharepoint\",\"operationId\":\"removeHostname\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"hostnameToRemove: the specific hostname to remove from the access options\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RemoveHostnameRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new state of the NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs/{name}/addAddress\":{\"put\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Add access of ip address to NFS sharepoint\",\"operationId\":\"addAddress\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"ip: the specific incoming ip to give access to
subnet: any subnet restrictions
rw: Allow Read/Write to sharepoint, false is read only
secure: This option requires that requests originate on an Internet port less than IPPORT_RESERVED (1024)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddAddressAccessRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new state of the NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs/{name}/removeAddress\":{\"put\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Remove IP access from sharepoint\",\"operationId\":\"removeAddress\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"ip: the ip to remove
subnet: the subnet to remove
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RemoveAddressAccessRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new state of the NFS sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NFSSharepoint\"}}}}}}},\"/sharepoints/nfs/{name}\":{\"delete\":{\"tags\":[\"nfs-rest-endpoint\"],\"description\":\"Delete sharepoint\",\"operationId\":\"delete_4\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The name of the sharepoint to delete\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/tuning\":{\"get\":{\"tags\":[\"tuning-profile-rest\"],\"description\":\"Get the available tuning profiles\",\"operationId\":\"getTuningProfiles\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of available tuning profiles
name: The unique name of the profile
description: The description of the profile\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TuningProfile\"}}}}}}},\"put\":{\"tags\":[\"tuning-profile-rest\"],\"description\":\"Set the performance tuning profile\",\"operationId\":\"setTuningProfile\",\"requestBody\":{\"description\":\"The profile to set:
name: The unique name of the profile
description: The description of the profile, not needed for setting\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetTuningProfileRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/tuning/active\":{\"get\":{\"tags\":[\"tuning-profile-rest\"],\"description\":\"Get the currently active tuning profile\",\"operationId\":\"getActiveTuningProfile\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The active profile
name: The unique name of the profile
description: The description of the profile\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TuningProfile\"}}}}}}},\"/directory/locations\":{\"get\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Get possible configured locations, one of which must be passed when creating a sharepoint
these can be configured on start using the argument \\\"--VALID_ROOTS\\\"\",\"operationId\":\"getPossibleLocations\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of possible locations:
path: absolute path on system
quotaSupport: supports quota settings (currently only supports xfs file systems)sysTypeName: the type of the file system e.g. XFS\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PossibleLocation\"}}}}}}}},\"/directory/quota\":{\"get\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Get the current state of Quota enforcing on the system\",\"operationId\":\"getQuotaState\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The quota state:
enforcement: quota enforcement enabled?
blocksGraceTime: time in seconds until a reached soft block limit will be treated as a hard limit
inodesGraceTime: time in seconds until a reached soft inodes(file) limit will be treated as a hard limit
realtimeBlocksGraceTime: time in seconds until a reached soft realtime blocks limit will be treated as a hard limit
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/QuotaState\"}}}}}}},\"/directory/permission\":{\"put\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Request a permission fix on a sharepoint, will recursively modify rights within a sharpoint to rwxrwxrwx\",\"operationId\":\"fixPermissions\",\"requestBody\":{\"description\":\"sharepointName: unique name of the sharepoint to modify\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RequestFixPermission\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/directory/quota/enforcing\":{\"put\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Set quota enforcing\",\"operationId\":\"setEnforcement\",\"requestBody\":{\"description\":\"enforce: set quota enforcing flag\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/EnableQuotaEnforcementRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/directory/quota/sharepoints\":{\"get\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Combined information on all sharepoints and their quota support capabilities\",\"operationId\":\"getQuotaSharepoints\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"list of sharepoints:
sharepointName: unique name of the sharepoint
localDestination: path to sharepoint on system
quotaSupport: has quota support
quotaEnabled: is quota enforcing enabled
quotaReport: various stats on quota usage
type: type of sharepoint
\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/QuotaSharepoint\"}}}}}}}},\"/directory/quota/timer\":{\"put\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Set quota soft limit enforcement timer\",\"operationId\":\"setQuotaTimer\",\"requestBody\":{\"description\":\"blocksGraceTime: time in seconds until a reached block size soft limit will be treated as a hard limit
inodesGraceTime: time in seconds until a reached inodes(file) soft limit will be treated as a hard limit
realtimeBlocksGraceTime: time in seconds until a reached realtime block soft limit will be treated as a hard limit
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/QuotaTime\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/directory/quota/limits\":{\"put\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Set quota limits for given sharepoint. (Must have quota support)\",\"operationId\":\"setQuotaLimits\",\"requestBody\":{\"description\":\"Settings for the quota limits
sharepointName: unique identifying name for sharepoint
limits: soft and hard limits for block size, inode and realtime block size settings\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SetQuotaLimitRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}},\"delete\":{\"tags\":[\"directory-rest-enpoint\"],\"description\":\"Remove quota limits for given sharepoint\",\"operationId\":\"removeQuotaLimits\",\"requestBody\":{\"description\":\"sharepointName: unique identifying name for sharepoint\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RemoveQuotaLimitsRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/groups\":{\"get\":{\"tags\":[\"groups-rest-endpoint\"],\"description\":\"List all existing groups\",\"operationId\":\"getGroups\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of groups configured on the system
name: unique name of the group
users: list of users in the group\",\"content\":{\"application/json\":{\"schema\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Group\"}}}}}}},\"post\":{\"tags\":[\"groups-rest-endpoint\"],\"description\":\"Create a new group\",\"operationId\":\"create_4\",\"requestBody\":{\"description\":\"name: the new and unique name of the group to create\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GroupRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The created group\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Group\"}}}}}}},\"/groups/{name}/removeUser\":{\"put\":{\"tags\":[\"groups-rest-endpoint\"],\"description\":\"Remove a user from the given group\",\"operationId\":\"removeUser_2\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of a group\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"userName: the unique name of the user to remove\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserName\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/groups/{name}\":{\"get\":{\"tags\":[\"groups-rest-endpoint\"],\"description\":\"Get a specific group by name\",\"operationId\":\"getGroup\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the group to return\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The group by name
name: unique name of the group
users: list of users in the group\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Group\"}}}}}},\"delete\":{\"tags\":[\"groups-rest-endpoint\"],\"description\":\"Delete an existing group\",\"operationId\":\"delete_5\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the group to delete\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/groups/{name}/modifyName\":{\"put\":{\"tags\":[\"groups-rest-endpoint\"],\"description\":\"Modify the name of the given group\",\"operationId\":\"updateName\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of the existing group\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"newName: the new group name\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NameRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Group\"}}}}}}},\"/groups/{name}/addUser\":{\"put\":{\"tags\":[\"groups-rest-endpoint\"],\"description\":\"Add a user to the given group\",\"operationId\":\"updatePassword_1\",\"parameters\":[{\"name\":\"name\",\"in\":\"path\",\"description\":\"The unique name of a group\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"userName: the unique name of the user to add\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserName\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/os-logging/available-identifiers\":{\"get\":{\"tags\":[\"logging-rest-controller\"],\"description\":\"Get a list of available subscribe paths that can be used to subscribe to a log output\",\"operationId\":\"getAvailableSubscribePaths\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The list of available subscribe paths\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SubscribePaths\"}}}}}}},\"/os-logging/last-logs/{identifier}/{entries}\":{\"get\":{\"tags\":[\"logging-rest-controller\"],\"description\":\"Get last log entries of given service identifier retrieved from the available identifiers endpoint\",\"operationId\":\"getLastLogs\",\"parameters\":[{\"name\":\"identifier\",\"in\":\"path\",\"description\":\"The unique identifier retrieved from the available subscribe paths\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"entries\",\"in\":\"path\",\"description\":\"The last N entries to retrieve\",\"required\":true,\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The requested list of log messages limited by the number of entries
serviceName: The name of the service this message belongs to
timestamp: The timestamp of the message, in unix epoch (milliseconds)
logMessage: The actual message
syslogIdentifier: The SYSLOG_IDENTIFIER tag\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Logs\"}}}}}}},\"/os-logging/download-full-log\":{\"get\":{\"tags\":[\"logging-rest-controller\"],\"description\":\"Start a download of all available logs\",\"operationId\":\"downloadFullLog\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"An octet stream containing a zip with all the logs\",\"content\":{\"application/octet-stream\":{\"schema\":{\"$ref\":\"#/components/schemas/StreamingResponseBody\"}}}}}}},\"/os-logging/register-listener/{identifier}\":{\"get\":{\"tags\":[\"logging-rest-controller\"],\"description\":\"Add a listener to the log output\",\"operationId\":\"register\",\"parameters\":[{\"name\":\"identifier\",\"in\":\"path\",\"description\":\"The unique identifier retrieved from the available subscribe paths\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"A server sent event emitter (SSEEmitter) containing a text event stream with incoming logs\",\"content\":{\"text/event-stream\":{\"schema\":{\"$ref\":\"#/components/schemas/SseEmitter\"}}}}}}},\"/os/restart\":{\"put\":{\"tags\":[\"os-rest-controller\"],\"description\":\"Restart the machine (hardware)\",\"operationId\":\"restart\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/os/shutdown\":{\"put\":{\"tags\":[\"os-rest-controller\"],\"description\":\"Shutdown the machine (hardware)\",\"operationId\":\"shutdown\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/cron/jobs\":{\"get\":{\"tags\":[\"cron-tab-rest-controller\"],\"description\":\"Get registered cron jobs\",\"operationId\":\"getJobs\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of registered cron jobs
fileName: The unique job name
cronExpression: The cron expression defining the execution timer
script: The script content
last100LogEntries: The last 100 log entries of this cron job\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CronJob\"}}}}}}},\"put\":{\"tags\":[\"cron-tab-rest-controller\"],\"description\":\"Modify existing cron jobs, requires admin privileges\",\"operationId\":\"updateJobs\",\"requestBody\":{\"description\":\"List of new cron jobs to add
fileName: The unique existing cron job name
cronExpression: The cron expression defining the execution timer e.g. \\\"*/5 * * * *\\\"
script: The script content to execute\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/UpdateJobRequest\"}}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}},\"post\":{\"tags\":[\"cron-tab-rest-controller\"],\"description\":\"Post new cron jobs, requires admin privileges\",\"operationId\":\"addJobs\",\"requestBody\":{\"description\":\"List of new cron jobs to add
fileName: Cron job name
cronExpression: The cron expression defining the execution timer e.g. \\\"*/5 * * * *\\\"
script: The script content to execute\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AddJobRequest\"}}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}},\"delete\":{\"tags\":[\"cron-tab-rest-controller\"],\"description\":\"Delete existing cron jobs, requires admin privileges\",\"operationId\":\"deleteJobs\",\"requestBody\":{\"description\":\"List of cron jobs to delete
fileName: The unique existing cron job name\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DeleteJobRequest\"}}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/auth/login\":{\"post\":{\"tags\":[\"authentication-rest\"],\"description\":\"Login endpoint for authentication (jwt)\",\"operationId\":\"authenticateUser\",\"requestBody\":{\"description\":\"The login credentials
username: The username (from the security users)
password: The password of the given user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoginRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The token information
token: The token to put into the Authorization header upon requests
refreshToken: The refresh token to use on the refresh endpoint when the current token expires
type: Type of the token
username: The currently authorized user
role: The role of the user
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/JwtResponse\"}}}}}}},\"/auth/refresh\":{\"post\":{\"tags\":[\"authentication-rest\"],\"description\":\"Refresh endpoint when token expires\",\"operationId\":\"refreshUser\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RefreshRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new token information
token: The token to put into the Authorization header upon requests
refreshToken: The refresh token to use on the refresh endpoint when the current token expires
type: Type of the token
username: The currently authorized user
role: The role of the user
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/JwtResponse\"}}}}}}},\"/security/license\":{\"get\":{\"tags\":[\"license-rest\"],\"description\":\"Get current juststore license status\",\"operationId\":\"licenseStatus\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The new token information
machineID: The machine id
licenseKey: The key that is currently registered to this machine
valid: Indicates if the license is valid
endlessLicense: Is the license an endless license
expireDateMillis: Date of when the license expires (Unix epoch in milliseconds)
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LicenseStatus\"}}}}}},\"put\":{\"tags\":[\"license-rest\"],\"description\":\"Set the license, requires admin privileges\",\"operationId\":\"setLicense\",\"requestBody\":{\"description\":\"The license to set
licenseKey: The license key to set\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/License\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"204\":{\"description\":\"No Content\"}}}},\"/security/change-password\":{\"post\":{\"tags\":[\"security-user-rest\"],\"description\":\"Change password for given user, requires admin privileges or must be authorization bearer of target user\",\"operationId\":\"changePassword\",\"requestBody\":{\"description\":\"username: The unique name of the user
newPassword: The new password to apply to given user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ChangeSecurityUserPasswordRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/security/user\":{\"get\":{\"tags\":[\"security-user-rest\"],\"description\":\"Get current registered security users\",\"operationId\":\"getUsers_1\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"List of registered api access users
username: The unique name of the user
role: The role of the user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SecurityUsersResponse\"}}}}}},\"post\":{\"tags\":[\"security-user-rest\"],\"description\":\"Create a new security user for api access, requires admin privileges\",\"operationId\":\"createUser\",\"requestBody\":{\"description\":\"The create user request
username: The username
role: Which role should be applied to the new user, one of ADMIN or CUSTOMER
password: The password for the user\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateSecurityUserRequest\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/security/user/{username}\":{\"delete\":{\"tags\":[\"security-user-rest\"],\"description\":\"Delete given user, requires admin privileges or must be authorization bearer of target user\",\"operationId\":\"deleteUser\",\"parameters\":[{\"name\":\"username\",\"in\":\"path\",\"description\":\"Unique name of user\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}},\"/iconik/settings\":{\"get\":{\"tags\":[\"iconik-rest-controller\"],\"description\":\"Get the current iconik settings\",\"operationId\":\"getSettings\",\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"The current iconik settings
appID: The iconik app-id property
storageID: The iconik storage-id property
authToken: The iconik auth-token property
sleepTime: The iconik sleep-time property
maxTranscodingJobs: The iconik max-transcoding-jobs property
fileUploadParallelNum: The iconik file-upload-parallel-uploads-num property
fileDownloadParallelNum: The iconik file-download-parallel-uploads-num property
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/IconikSettings\"}}}}}},\"put\":{\"tags\":[\"iconik-rest-controller\"],\"description\":\"Set new Iconik settings, requires admin privileges, furthermore iconik must be installed.\",\"operationId\":\"setSettings\",\"requestBody\":{\"description\":\"The new iconik settings
appID: The iconik app-id property
storageID: The iconik storage-id property
authToken: The iconik auth-token property
sleepTime: The iconik sleep-time property
maxTranscodingJobs: The iconik max-transcoding-jobs property
fileUploadParallelNum: The iconik file-upload-parallel-uploads-num property
fileDownloadParallelNum: The iconik file-download-parallel-uploads-num property
\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/IconikSettings\"}}},\"required\":true},\"responses\":{\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"503\":{\"description\":\"Service Unavailable\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}}},\"200\":{\"description\":\"OK\"}}}}},\"components\":{\"schemas\":{\"ErrorResponse\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"code\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"BondSettings\":{\"type\":\"object\",\"properties\":{\"bondType\":{\"type\":\"string\",\"enum\":[\"BALANCERRR\",\"BROADCAST\",\"ACTIVEBACKUP\",\"BALANCEXOR\",\"EIGHTZEROTWO\",\"BALANCETLB\",\"BALANCEALB\"]}}},\"Bond\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"active\":{\"type\":\"boolean\"},\"autoconnect\":{\"type\":\"boolean\"},\"autoConnectPriority\":{\"type\":\"integer\",\"format\":\"int32\"},\"device\":{\"$ref\":\"#/components/schemas/Interface\"},\"connectionType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"802-3-ethernet\",\"802-11-wireless\",\"wimax\",\"gsm\",\"cdma\",\"infiniband\",\"adsl\",\"bluetooth\",\"vpn\",\"802-11-olpc-mesh\",\"vlan\",\"bond\",\"team\",\"bridge\"]},\"ipSettings\":{\"$ref\":\"#/components/schemas/IPSettings\"},\"slaves\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Slave\"}},\"bondingMode\":{\"type\":\"string\",\"enum\":[\"BALANCERRR\",\"BROADCAST\",\"ACTIVEBACKUP\",\"BALANCEXOR\",\"EIGHTZEROTWO\",\"BALANCETLB\",\"BALANCEALB\"]}}},\"IPAddress\":{\"type\":\"object\",\"properties\":{\"ip\":{\"type\":\"string\"},\"prefix\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"IPSettings\":{\"type\":\"object\",\"properties\":{\"method\":{\"type\":\"string\",\"enum\":[\"AUTO\",\"MANUAL\"]},\"dns\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"addresses\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/IPAddress\"}},\"gateway\":{\"type\":\"string\"},\"ipv6method\":{\"type\":\"string\",\"enum\":[\"AUTO\",\"MANUAL\"]},\"ipv6dns\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ipv6addresses\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ipv6gateway\":{\"type\":\"string\"}}},\"Interface\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"deviceType\":{\"type\":\"string\",\"enum\":[\"ETHERNET\",\"BOND\",\"BRIDGE\",\"TEAM\",\"WIFI\",\"LOOPBACK\",\"UNDEFINED\",\"NOT_FOUND\"]},\"speed\":{\"type\":\"number\",\"format\":\"double\"},\"duplex\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"FULL\",\"HALF\"]},\"carrier\":{\"type\":\"boolean\"}}},\"Slave\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"active\":{\"type\":\"boolean\"},\"autoconnect\":{\"type\":\"boolean\"},\"autoConnectPriority\":{\"type\":\"integer\",\"format\":\"int32\"},\"device\":{\"$ref\":\"#/components/schemas/Interface\"},\"connectionType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"802-3-ethernet\",\"802-11-wireless\",\"wimax\",\"gsm\",\"cdma\",\"infiniband\",\"adsl\",\"bluetooth\",\"vpn\",\"802-11-olpc-mesh\",\"vlan\",\"bond\",\"team\",\"bridge\"]}}},\"ModifyHostnameRequest\":{\"type\":\"object\",\"properties\":{\"newHostName\":{\"type\":\"string\"}}},\"Team\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"active\":{\"type\":\"boolean\"},\"autoconnect\":{\"type\":\"boolean\"},\"autoConnectPriority\":{\"type\":\"integer\",\"format\":\"int32\"},\"device\":{\"$ref\":\"#/components/schemas/Interface\"},\"connectionType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"802-3-ethernet\",\"802-11-wireless\",\"wimax\",\"gsm\",\"cdma\",\"infiniband\",\"adsl\",\"bluetooth\",\"vpn\",\"802-11-olpc-mesh\",\"vlan\",\"bond\",\"team\",\"bridge\"]},\"ipSettings\":{\"$ref\":\"#/components/schemas/IPSettings\"},\"slaves\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Slave\"}},\"mode\":{\"type\":\"string\",\"enum\":[\"ROUNDROBIN\",\"BROADCAST\",\"ACTIVEBACKUP\",\"LOADBALANCE\",\"LACP\",\"RANDOM\"]}}},\"InterfaceShapingRule\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"sourceNetwork\":{\"type\":\"string\"},\"sourceNetworkSubnet\":{\"type\":\"integer\",\"format\":\"int32\"},\"destinationNetwork\":{\"type\":\"string\"},\"destinationNetworkSubnet\":{\"type\":\"integer\",\"format\":\"int32\"},\"destinationPort\":{\"type\":\"integer\",\"format\":\"int32\"},\"sourcePort\":{\"type\":\"integer\",\"format\":\"int32\"},\"rate\":{\"type\":\"string\"}}},\"ShapedInterface\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"deviceType\":{\"type\":\"string\",\"enum\":[\"ETHERNET\",\"BOND\",\"BRIDGE\",\"TEAM\",\"WIFI\",\"LOOPBACK\",\"UNDEFINED\",\"NOT_FOUND\"]},\"speed\":{\"type\":\"number\",\"format\":\"double\"},\"duplex\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"FULL\",\"HALF\"]},\"carrier\":{\"type\":\"boolean\"},\"incomingRules\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/InterfaceShapingRule\"}},\"outgoingRules\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/InterfaceShapingRule\"}}}},\"InterfaceShapingRuleRequest\":{\"type\":\"object\",\"properties\":{\"outgoing\":{\"type\":\"boolean\"},\"sourceNetwork\":{\"type\":\"string\"},\"sourceNetworkSubnet\":{\"type\":\"integer\",\"format\":\"int32\"},\"destinationNetwork\":{\"type\":\"string\"},\"destinationNetworkSubnet\":{\"type\":\"integer\",\"format\":\"int32\"},\"destinationPort\":{\"type\":\"integer\",\"format\":\"int32\"},\"sourcePort\":{\"type\":\"integer\",\"format\":\"int32\"},\"rateBitsPerSecond\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"ModifyShapingRequest\":{\"type\":\"object\",\"properties\":{\"ruleRequest\":{\"$ref\":\"#/components/schemas/InterfaceShapingRuleRequest\"}}},\"CreateSlaveRequest\":{\"type\":\"object\",\"properties\":{\"slaveName\":{\"type\":\"string\"},\"interfaceName\":{\"type\":\"string\"}}},\"IPConnectionDomain\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"active\":{\"type\":\"boolean\"},\"autoconnect\":{\"type\":\"boolean\"},\"autoConnectPriority\":{\"type\":\"integer\",\"format\":\"int32\"},\"device\":{\"$ref\":\"#/components/schemas/Interface\"},\"connectionType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"802-3-ethernet\",\"802-11-wireless\",\"wimax\",\"gsm\",\"cdma\",\"infiniband\",\"adsl\",\"bluetooth\",\"vpn\",\"802-11-olpc-mesh\",\"vlan\",\"bond\",\"team\",\"bridge\"]},\"ipSettings\":{\"$ref\":\"#/components/schemas/IPSettings\"}}},\"CreateTeamRequest\":{\"type\":\"object\",\"properties\":{\"teamName\":{\"type\":\"string\"},\"mode\":{\"type\":\"string\",\"enum\":[\"ROUNDROBIN\",\"BROADCAST\",\"ACTIVEBACKUP\",\"LOADBALANCE\",\"LACP\",\"RANDOM\"]},\"ipSettings\":{\"$ref\":\"#/components/schemas/IPSettings\"}}},\"CreateBondRequest\":{\"type\":\"object\",\"properties\":{\"bondName\":{\"type\":\"string\"},\"mode\":{\"type\":\"string\",\"enum\":[\"BALANCERRR\",\"BROADCAST\",\"ACTIVEBACKUP\",\"BALANCEXOR\",\"EIGHTZEROTWO\",\"BALANCETLB\",\"BALANCEALB\"]},\"ipSettings\":{\"$ref\":\"#/components/schemas/IPSettings\"}}},\"ModifyConnectionAutoconnect\":{\"type\":\"object\",\"properties\":{\"autoconnect\":{\"type\":\"boolean\"},\"autoConnectPriority\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ConnectionBase\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"active\":{\"type\":\"boolean\"},\"autoconnect\":{\"type\":\"boolean\"},\"autoConnectPriority\":{\"type\":\"integer\",\"format\":\"int32\"},\"device\":{\"$ref\":\"#/components/schemas/Interface\"},\"connectionType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"802-3-ethernet\",\"802-11-wireless\",\"wimax\",\"gsm\",\"cdma\",\"infiniband\",\"adsl\",\"bluetooth\",\"vpn\",\"802-11-olpc-mesh\",\"vlan\",\"bond\",\"team\",\"bridge\"]}}},\"EthernetSettings\":{\"type\":\"object\",\"properties\":{\"mtu\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"EthernetConnection\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"active\":{\"type\":\"boolean\"},\"autoconnect\":{\"type\":\"boolean\"},\"autoConnectPriority\":{\"type\":\"integer\",\"format\":\"int32\"},\"device\":{\"$ref\":\"#/components/schemas/Interface\"},\"connectionType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"802-3-ethernet\",\"802-11-wireless\",\"wimax\",\"gsm\",\"cdma\",\"infiniband\",\"adsl\",\"bluetooth\",\"vpn\",\"802-11-olpc-mesh\",\"vlan\",\"bond\",\"team\",\"bridge\"]},\"mtu\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"EthernetInterface\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"deviceType\":{\"type\":\"string\",\"enum\":[\"ETHERNET\",\"BOND\",\"BRIDGE\",\"TEAM\",\"WIFI\",\"LOOPBACK\",\"UNDEFINED\",\"NOT_FOUND\"]},\"speed\":{\"type\":\"number\",\"format\":\"double\"},\"duplex\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"FULL\",\"HALF\"]},\"carrier\":{\"type\":\"boolean\"},\"portsSupport\":{\"type\":\"string\"},\"linkModesSupport\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"pauseFrameUseSupport\":{\"type\":\"boolean\"},\"autoNegotiationSupport\":{\"type\":\"boolean\"},\"usedPortType\":{\"type\":\"string\"},\"autoNegotiationState\":{\"type\":\"boolean\"},\"transceiverType\":{\"type\":\"string\"}}},\"TeamSettings\":{\"type\":\"object\",\"properties\":{\"runner\":{\"type\":\"string\",\"enum\":[\"ROUNDROBIN\",\"BROADCAST\",\"ACTIVEBACKUP\",\"LOADBALANCE\",\"LACP\",\"RANDOM\"]}}},\"ModifyConnectionNameRequest\":{\"type\":\"object\",\"properties\":{\"newConnectionName\":{\"type\":\"string\"}}},\"ModifyConnectionActiveRequest\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"}}},\"ModifyInterfaceLinkRequest\":{\"type\":\"object\",\"properties\":{\"newInterfaceName\":{\"type\":\"string\"}}},\"CreateNetworkRequest\":{\"type\":\"object\",\"properties\":{\"connectionName\":{\"type\":\"string\"},\"interfaceName\":{\"type\":\"string\"},\"ipSettings\":{\"$ref\":\"#/components/schemas/IPSettings\"}}},\"Hostname\":{\"type\":\"object\",\"properties\":{\"hostname\":{\"type\":\"string\"}}},\"AddUserRequest\":{\"type\":\"object\",\"properties\":{\"userName\":{\"type\":\"string\"},\"permission\":{\"$ref\":\"#/components/schemas/Permission\"}}},\"Permission\":{\"type\":\"object\",\"properties\":{\"read\":{\"type\":\"boolean\"},\"write\":{\"type\":\"boolean\"}}},\"AFPSharepoint\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"groups\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/Permission\"}},\"users\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/Permission\"}},\"localDestination\":{\"type\":\"object\",\"properties\":{\"absolute\":{\"type\":\"boolean\"},\"fileSystem\":{\"type\":\"object\",\"properties\":{\"rootDirectories\":{\"type\":\"object\"},\"fileStores\":{\"type\":\"object\"},\"userPrincipalLookupService\":{\"type\":\"object\"},\"separator\":{\"type\":\"string\"},\"readOnly\":{\"type\":\"boolean\"},\"open\":{\"type\":\"boolean\"}}},\"nameCount\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"directoryStats\":{\"$ref\":\"#/components/schemas/DirectoryStat\"},\"enabled\":{\"type\":\"boolean\"},\"guestAccessAvailable\":{\"type\":\"boolean\"}}},\"DirectoryStat\":{\"type\":\"object\",\"properties\":{\"total\":{\"type\":\"integer\",\"format\":\"int64\"},\"files\":{\"type\":\"integer\",\"format\":\"int64\"},\"subdirs\":{\"type\":\"integer\",\"format\":\"int64\"},\"symlinks\":{\"type\":\"integer\",\"format\":\"int64\"},\"chrdevs\":{\"type\":\"integer\",\"format\":\"int64\"},\"blkdevs\":{\"type\":\"integer\",\"format\":\"int64\"},\"sockets\":{\"type\":\"integer\",\"format\":\"int64\"},\"diskUsage\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"GroupName\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"}}},\"UserName\":{\"type\":\"object\",\"properties\":{\"userName\":{\"type\":\"string\"}}},\"SetEnabledRequest\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\"}}},\"AddGroupRequest\":{\"type\":\"object\",\"properties\":{\"groupName\":{\"type\":\"string\"},\"permission\":{\"$ref\":\"#/components/schemas/Permission\"}}},\"SetGuestOKRequest\":{\"type\":\"object\",\"properties\":{\"guestOK\":{\"type\":\"boolean\"}}},\"SharepointRequest\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"location\":{\"type\":\"string\"}}},\"NetworkInterfaceStat\":{\"type\":\"object\",\"properties\":{\"networkInterface\":{\"type\":\"string\"},\"rxBytes\":{\"type\":\"integer\",\"format\":\"int64\"},\"rxPackets\":{\"type\":\"integer\",\"format\":\"int64\"},\"rxErrors\":{\"type\":\"integer\",\"format\":\"int64\"},\"rxDropped\":{\"type\":\"integer\",\"format\":\"int64\"},\"rxOverruns\":{\"type\":\"integer\",\"format\":\"int64\"},\"rxFrame\":{\"type\":\"integer\",\"format\":\"int64\"},\"txBytes\":{\"type\":\"integer\",\"format\":\"int64\"},\"txPackets\":{\"type\":\"integer\",\"format\":\"int64\"},\"txErrors\":{\"type\":\"integer\",\"format\":\"int64\"},\"txDropped\":{\"type\":\"integer\",\"format\":\"int64\"},\"txOverruns\":{\"type\":\"integer\",\"format\":\"int64\"},\"txCollisions\":{\"type\":\"integer\",\"format\":\"int64\"},\"txCarrier\":{\"type\":\"integer\",\"format\":\"int64\"},\"speed\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"NetworkInterfaceStatList\":{\"type\":\"object\",\"properties\":{\"networkInterfaceStats\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NetworkInterfaceStat\"}}}},\"PowerSupplyStat\":{\"type\":\"object\",\"properties\":{\"ident\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"},\"failure\":{\"type\":\"boolean\"},\"connected\":{\"type\":\"boolean\"}}},\"PowerSupplyStatList\":{\"type\":\"object\",\"properties\":{\"powerSupplyStats\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PowerSupplyStat\"}}}},\"LogicalDeviceStat\":{\"type\":\"object\",\"properties\":{\"identificationNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"logicalDeviceName\":{\"type\":\"string\"},\"raidLevel\":{\"type\":\"integer\",\"format\":\"int32\"},\"uniqueIdentifier\":{\"type\":\"string\"},\"statusOfLogicalDevice\":{\"type\":\"string\"},\"size\":{\"type\":\"string\"},\"interfaceType\":{\"type\":\"string\"},\"deviceType\":{\"type\":\"string\"},\"readCacheStatus\":{\"type\":\"boolean\"},\"writeCacheStatus\":{\"type\":\"boolean\"},\"partitioned\":{\"type\":\"boolean\"},\"bootable\":{\"type\":\"boolean\"},\"failedStripes\":{\"type\":\"boolean\"},\"segments\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SegmentStats\"}},\"physicalDevices\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PhysicalDeviceStat\"}}}},\"PhysicalDeviceStat\":{\"type\":\"object\",\"properties\":{\"identificationNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"hardwareType\":{\"type\":\"string\"},\"state\":{\"type\":\"string\"},\"supported\":{\"type\":\"boolean\"},\"programmedMaxSpeed\":{\"type\":\"string\"},\"transferSpeed\":{\"type\":\"string\"},\"reportedLocation\":{\"$ref\":\"#/components/schemas/ReportedLocationStat\"},\"reportedChannel\":{\"$ref\":\"#/components/schemas/ReportedChannelStat\"},\"vendor\":{\"type\":\"string\"},\"model\":{\"type\":\"string\"},\"firmware\":{\"type\":\"string\"},\"serialNumber\":{\"type\":\"string\"},\"worldWideName\":{\"type\":\"string\"},\"smartErrors\":{\"type\":\"boolean\"},\"smartWarnings\":{\"type\":\"integer\",\"format\":\"int32\"},\"powerState\":{\"type\":\"string\"},\"ssd\":{\"type\":\"boolean\"},\"temperature\":{\"$ref\":\"#/components/schemas/TemperatureStat\"},\"hardwareErrorCount\":{\"type\":\"integer\",\"format\":\"int32\"},\"mediumErrorCount\":{\"type\":\"integer\",\"format\":\"int32\"},\"parityErrorCount\":{\"type\":\"integer\",\"format\":\"int32\"},\"linkFailureCount\":{\"type\":\"integer\",\"format\":\"int32\"},\"abortedCommandCount\":{\"type\":\"integer\",\"format\":\"int32\"},\"smartWarningCount\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"RaidStat\":{\"type\":\"object\",\"properties\":{\"identificationNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"controllerStatus\":{\"type\":\"string\"},\"controllerMode\":{\"type\":\"string\"},\"channelDescription\":{\"type\":\"string\"},\"controllerModel\":{\"type\":\"string\"},\"controllerSerialNumber\":{\"type\":\"string\"},\"controllerWorldWideName\":{\"type\":\"string\"},\"temperature\":{\"$ref\":\"#/components/schemas/TemperatureStat\"},\"automaticFailover\":{\"type\":\"boolean\"},\"bios\":{\"type\":\"string\"},\"firmware\":{\"type\":\"string\"},\"driver\":{\"type\":\"string\"},\"backUpUnitStatus\":{\"type\":\"string\"},\"unnassignedPhysicalDevices\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PhysicalDeviceStat\"}},\"logicalDevices\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/LogicalDeviceStat\"}}}},\"RaidStatList\":{\"type\":\"object\",\"properties\":{\"raidStats\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RaidStat\"}}}},\"ReportedChannelStat\":{\"type\":\"object\",\"properties\":{\"channel\":{\"type\":\"integer\",\"format\":\"int32\"},\"device\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ReportedLocationStat\":{\"type\":\"object\",\"properties\":{\"enclosure\":{\"type\":\"integer\",\"format\":\"int32\"},\"slot\":{\"type\":\"integer\",\"format\":\"int32\"},\"connector\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"SegmentStats\":{\"type\":\"object\",\"properties\":{\"segmentNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"status\":{\"type\":\"string\"},\"enclosure\":{\"type\":\"integer\",\"format\":\"int32\"},\"slot\":{\"type\":\"integer\",\"format\":\"int32\"},\"serialNumber\":{\"type\":\"string\"}}},\"TemperatureStat\":{\"type\":\"object\",\"properties\":{\"supported\":{\"type\":\"boolean\"},\"celcius\":{\"type\":\"integer\",\"format\":\"int32\"},\"fahrenheit\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"RequestIdentifyDevice\":{\"type\":\"object\",\"properties\":{\"controllerIdentification\":{\"type\":\"integer\",\"format\":\"int32\"},\"channel\":{\"$ref\":\"#/components/schemas/ReportedChannelStat\"},\"blinkTimeInSeconds\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"IpmiConfig\":{\"type\":\"object\",\"properties\":{\"ipAddress\":{\"type\":\"string\"},\"gateway\":{\"type\":\"string\"},\"subnetMask\":{\"type\":\"string\"},\"dhcp\":{\"type\":\"boolean\"},\"mac\":{\"type\":\"string\"}}},\"IpmiInfo\":{\"type\":\"object\",\"properties\":{\"firmwareVersion\":{\"type\":\"string\"},\"config\":{\"$ref\":\"#/components/schemas/IpmiConfig\"}}},\"CPUStat\":{\"type\":\"object\",\"properties\":{\"physicalCoreID\":{\"type\":\"integer\",\"format\":\"int32\"},\"idle\":{\"type\":\"number\",\"format\":\"double\"},\"combined\":{\"type\":\"number\",\"format\":\"double\"},\"temp\":{\"type\":\"number\",\"format\":\"double\"}}},\"CPUStatList\":{\"type\":\"object\",\"properties\":{\"cpuStats\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CPUStat\"}}}},\"MemoryStat\":{\"type\":\"object\",\"properties\":{\"total\":{\"type\":\"integer\",\"format\":\"int64\"},\"ram\":{\"type\":\"integer\",\"format\":\"int64\"},\"used\":{\"type\":\"integer\",\"format\":\"int64\"},\"free\":{\"type\":\"integer\",\"format\":\"int64\"},\"actualUsed\":{\"type\":\"integer\",\"format\":\"int64\"},\"actualFree\":{\"type\":\"integer\",\"format\":\"int64\"},\"usedPercent\":{\"type\":\"number\",\"format\":\"double\"},\"freePercent\":{\"type\":\"number\",\"format\":\"double\"}}},\"FileSystemUsageStatList\":{\"type\":\"object\",\"properties\":{\"filesystemUsageStats\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/FilesystemUsageStat\"}}}},\"FilesystemUsageStat\":{\"type\":\"object\",\"properties\":{\"path\":{\"type\":\"string\"},\"total\":{\"type\":\"integer\",\"format\":\"int64\"},\"free\":{\"type\":\"integer\",\"format\":\"int64\"},\"used\":{\"type\":\"integer\",\"format\":\"int64\"},\"avail\":{\"type\":\"integer\",\"format\":\"int64\"},\"files\":{\"type\":\"integer\",\"format\":\"int64\"},\"freeFiles\":{\"type\":\"integer\",\"format\":\"int64\"},\"diskReads\":{\"type\":\"integer\",\"format\":\"int64\"},\"diskWrites\":{\"type\":\"integer\",\"format\":\"int64\"},\"diskReadBytes\":{\"type\":\"integer\",\"format\":\"int64\"},\"diskWriteBytes\":{\"type\":\"integer\",\"format\":\"int64\"},\"usePercent\":{\"type\":\"number\",\"format\":\"double\"}}},\"SetAutostartRequest\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"autostart\":{\"type\":\"boolean\"}}},\"ServiceStatus\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"enum\":[\"FAILED\",\"INACTIVE\",\"ACTIVE\",\"ACTIVATING\",\"UNKNOWN\"]},\"latestMessage\":{\"type\":\"string\"},\"latestMessageTimestamp\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"SystemService\":{\"type\":\"object\",\"properties\":{\"available\":{\"type\":\"boolean\"},\"serviceName\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"autostart\":{\"type\":\"boolean\"},\"running\":{\"type\":\"boolean\"},\"status\":{\"$ref\":\"#/components/schemas/ServiceStatus\"}}},\"SetRunningRequest\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"running\":{\"type\":\"boolean\"}}},\"SetTimeRequest\":{\"type\":\"object\",\"properties\":{\"time\":{\"type\":\"string\"}}},\"TimeResponse\":{\"type\":\"object\",\"properties\":{\"localTime\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"TimezoneAvailableResponse\":{\"type\":\"object\",\"properties\":{\"availableTimezones\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"TimezoneResponse\":{\"type\":\"object\",\"properties\":{\"timezone\":{\"type\":\"string\"}}},\"TimezoneRequest\":{\"type\":\"object\",\"properties\":{\"timezone\":{\"type\":\"string\"}}},\"NTPBroadcast\":{\"type\":\"object\",\"properties\":{\"interval\":{\"type\":\"integer\",\"format\":\"int32\"},\"address\":{\"type\":\"string\"},\"port\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"NTPConfig\":{\"type\":\"object\",\"properties\":{\"servers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NTPServer\"}},\"peers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NTPPeer\"}},\"pools\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NTPPool\"}},\"refClocks\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NTPRefClock\"}},\"combinelimit\":{\"type\":\"integer\",\"format\":\"int32\"},\"maxdistance\":{\"type\":\"integer\",\"format\":\"int32\"},\"minsources\":{\"type\":\"integer\",\"format\":\"int32\"},\"allowAll\":{\"type\":\"boolean\"},\"denyAll\":{\"type\":\"boolean\"},\"allows\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/IPAddress\"}},\"denys\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/IPAddress\"}},\"bindaddress\":{\"type\":\"string\"},\"bindacqaddress\":{\"type\":\"string\"},\"acquisitionport\":{\"type\":\"integer\",\"format\":\"int32\"},\"broadcast\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NTPBroadcast\"}},\"local\":{\"$ref\":\"#/components/schemas/NTPLocal\"},\"port\":{\"type\":\"integer\",\"format\":\"int32\"},\"rtconutc\":{\"type\":\"boolean\"},\"rtcsync\":{\"type\":\"boolean\"}}},\"NTPLocal\":{\"type\":\"object\",\"properties\":{\"stratum\":{\"type\":\"integer\",\"format\":\"int32\"},\"distance\":{\"type\":\"integer\",\"format\":\"int32\"},\"orphan\":{\"type\":\"boolean\"}}},\"NTPPeer\":{\"type\":\"object\",\"properties\":{\"hostname\":{\"type\":\"string\"},\"minpoll\":{\"type\":\"integer\",\"format\":\"int32\"},\"maxpoll\":{\"type\":\"integer\",\"format\":\"int32\"},\"iburst\":{\"type\":\"boolean\"},\"burst\":{\"type\":\"boolean\"},\"maxdelay\":{\"type\":\"number\",\"format\":\"double\"},\"offset\":{\"type\":\"number\",\"format\":\"double\"},\"prefer\":{\"type\":\"boolean\"},\"noselect\":{\"type\":\"boolean\"},\"trust\":{\"type\":\"boolean\"},\"require\":{\"type\":\"boolean\"},\"polltarget\":{\"type\":\"integer\",\"format\":\"int32\"},\"port\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"NTPPool\":{\"type\":\"object\",\"properties\":{\"hostname\":{\"type\":\"string\"},\"minpoll\":{\"type\":\"integer\",\"format\":\"int32\"},\"maxpoll\":{\"type\":\"integer\",\"format\":\"int32\"},\"iburst\":{\"type\":\"boolean\"},\"burst\":{\"type\":\"boolean\"},\"maxdelay\":{\"type\":\"number\",\"format\":\"double\"},\"offset\":{\"type\":\"number\",\"format\":\"double\"},\"prefer\":{\"type\":\"boolean\"},\"noselect\":{\"type\":\"boolean\"},\"trust\":{\"type\":\"boolean\"},\"require\":{\"type\":\"boolean\"},\"polltarget\":{\"type\":\"integer\",\"format\":\"int32\"},\"port\":{\"type\":\"integer\",\"format\":\"int32\"},\"maxsources\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"NTPRefClock\":{\"type\":\"object\",\"properties\":{\"refClockType\":{\"type\":\"string\",\"enum\":[\"PPS\",\"SHM\",\"SOCK\",\"PHC\"]},\"parameter\":{\"type\":\"string\"},\"poll\":{\"type\":\"integer\",\"format\":\"int32\"},\"dpoll\":{\"type\":\"integer\",\"format\":\"int32\"},\"rate\":{\"type\":\"integer\",\"format\":\"int32\"},\"maxlockage\":{\"type\":\"integer\",\"format\":\"int32\"},\"pps\":{\"type\":\"boolean\"},\"offset\":{\"type\":\"number\",\"format\":\"double\"},\"stratum\":{\"type\":\"integer\",\"format\":\"int32\"},\"filter\":{\"type\":\"integer\",\"format\":\"int32\"},\"prefer\":{\"type\":\"boolean\"},\"noselect\":{\"type\":\"boolean\"},\"trust\":{\"type\":\"boolean\"},\"require\":{\"type\":\"boolean\"},\"tai\":{\"type\":\"boolean\"}}},\"NTPServer\":{\"type\":\"object\",\"properties\":{\"hostname\":{\"type\":\"string\"},\"minpoll\":{\"type\":\"integer\",\"format\":\"int32\"},\"maxpoll\":{\"type\":\"integer\",\"format\":\"int32\"},\"iburst\":{\"type\":\"boolean\"},\"burst\":{\"type\":\"boolean\"},\"maxdelay\":{\"type\":\"number\",\"format\":\"double\"},\"offset\":{\"type\":\"number\",\"format\":\"double\"},\"prefer\":{\"type\":\"boolean\"},\"noselect\":{\"type\":\"boolean\"},\"trust\":{\"type\":\"boolean\"},\"require\":{\"type\":\"boolean\"},\"polltarget\":{\"type\":\"integer\",\"format\":\"int32\"},\"port\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"NTPSourceInfo\":{\"type\":\"object\",\"properties\":{\"mode\":{\"type\":\"string\",\"enum\":[\"SERVER\",\"PEER\",\"REF_CLOCK\"]},\"state\":{\"type\":\"string\",\"enum\":[\"SYNCHRONISED\",\"COMBINED\",\"EXCLUDED\",\"CONNECTION_LOST_BAD_PACKETS\",\"FALSE_TICKER\",\"TOO_VARIABLE\"]},\"address\":{\"type\":\"string\"},\"stratum\":{\"type\":\"integer\",\"format\":\"int32\"},\"poll\":{\"type\":\"integer\",\"format\":\"int32\"},\"reach\":{\"type\":\"integer\",\"format\":\"int32\"},\"lastRX\":{\"type\":\"integer\",\"format\":\"int64\"},\"adjustedOffsetToLocalClock\":{\"type\":\"number\",\"format\":\"double\"},\"actualOffsetToLocalClock\":{\"type\":\"number\",\"format\":\"double\"},\"marginOfError\":{\"type\":\"number\",\"format\":\"double\"}}},\"NTPStateInfo\":{\"type\":\"object\",\"properties\":{\"trackingInfo\":{\"$ref\":\"#/components/schemas/NTPTrackingInfo\"},\"sourceInfos\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NTPSourceInfo\"}}}},\"NTPTrackingInfo\":{\"type\":\"object\",\"properties\":{\"referenceID\":{\"type\":\"string\"},\"address\":{\"type\":\"string\"},\"stratum\":{\"type\":\"integer\",\"format\":\"int32\"},\"refTimeUTC\":{\"type\":\"number\",\"format\":\"double\"},\"localTimeOffset\":{\"type\":\"number\",\"format\":\"double\"},\"lastOffsetAdjust\":{\"type\":\"number\",\"format\":\"double\"},\"lastRMSOffsetAdjust\":{\"type\":\"number\",\"format\":\"double\"},\"frequency\":{\"type\":\"number\",\"format\":\"double\"},\"residualFrequency\":{\"type\":\"number\",\"format\":\"double\"},\"skew\":{\"type\":\"number\",\"format\":\"double\"},\"rootDelay\":{\"type\":\"number\",\"format\":\"double\"},\"rootDispersion\":{\"type\":\"number\",\"format\":\"double\"},\"updateInterval\":{\"type\":\"number\",\"format\":\"double\"},\"leapStatus\":{\"type\":\"string\"}}},\"SMBSharepoint\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"groups\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/Permission\"}},\"users\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/Permission\"}},\"localDestination\":{\"type\":\"object\",\"properties\":{\"absolute\":{\"type\":\"boolean\"},\"fileSystem\":{\"type\":\"object\",\"properties\":{\"rootDirectories\":{\"type\":\"object\"},\"fileStores\":{\"type\":\"object\"},\"userPrincipalLookupService\":{\"type\":\"object\"},\"separator\":{\"type\":\"string\"},\"readOnly\":{\"type\":\"boolean\"},\"open\":{\"type\":\"boolean\"}}},\"nameCount\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"directoryStats\":{\"$ref\":\"#/components/schemas/DirectoryStat\"},\"enabled\":{\"type\":\"boolean\"},\"guestAccessAvailable\":{\"type\":\"boolean\"}}},\"EmailPasswordRequest\":{\"type\":\"object\",\"properties\":{\"password\":{\"type\":\"string\"}}},\"EmailConfig\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"addressesToNotify\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"emailHost\":{\"type\":\"string\"},\"emailPort\":{\"type\":\"integer\",\"format\":\"int32\"},\"emailUser\":{\"type\":\"string\"},\"sendFrom\":{\"type\":\"string\"},\"auth\":{\"type\":\"boolean\"},\"useTLS\":{\"type\":\"boolean\"},\"trustSSL\":{\"type\":\"boolean\"}}},\"AlertConfigD\":{\"type\":\"object\",\"properties\":{\"enable\":{\"type\":\"boolean\"},\"timeoutMS\":{\"type\":\"integer\",\"format\":\"int64\"},\"alertNodeConfigs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AlertNodeConfigD\"}}}},\"AlertNodeConfigD\":{\"type\":\"object\",\"properties\":{\"alertName\":{\"type\":\"string\"},\"enabled\":{\"type\":\"boolean\"},\"description\":{\"type\":\"string\"}}},\"User\":{\"type\":\"object\",\"properties\":{\"password\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}}},\"PasswordRequest\":{\"type\":\"object\",\"properties\":{\"password\":{\"type\":\"string\"}}},\"CreateUserRequest\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"}}},\"NFSAccessOptions\":{\"type\":\"object\",\"properties\":{\"rw\":{\"type\":\"boolean\"},\"secure\":{\"type\":\"boolean\"}}},\"NFSAccessAllowedNetwork\":{\"type\":\"object\",\"properties\":{\"rw\":{\"type\":\"boolean\"},\"secure\":{\"type\":\"boolean\"}}},\"NFSSharepoint\":{\"type\":\"object\",\"properties\":{\"networks\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NFSAccessAllowedNetwork\"}},\"name\":{\"type\":\"string\"},\"localDestination\":{\"type\":\"object\",\"properties\":{\"absolute\":{\"type\":\"boolean\"},\"fileSystem\":{\"type\":\"object\",\"properties\":{\"rootDirectories\":{\"type\":\"object\"},\"fileStores\":{\"type\":\"object\"},\"userPrincipalLookupService\":{\"type\":\"object\"},\"separator\":{\"type\":\"string\"},\"readOnly\":{\"type\":\"boolean\"},\"open\":{\"type\":\"boolean\"}}},\"nameCount\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"directoryStats\":{\"$ref\":\"#/components/schemas/DirectoryStat\"},\"enabled\":{\"type\":\"boolean\"}}},\"AddHostnameAccessRequest\":{\"type\":\"object\",\"properties\":{\"hostname\":{\"type\":\"string\"},\"options\":{\"$ref\":\"#/components/schemas/NFSAccessOptions\"}}},\"RemoveHostnameRequest\":{\"type\":\"object\",\"properties\":{\"hostnameToRemove\":{\"type\":\"string\"}}},\"AddAddressAccessRequest\":{\"type\":\"object\",\"properties\":{\"ip\":{\"type\":\"string\"},\"subnet\":{\"type\":\"integer\",\"format\":\"int32\"},\"options\":{\"$ref\":\"#/components/schemas/NFSAccessOptions\"}}},\"RemoveAddressAccessRequest\":{\"type\":\"object\",\"properties\":{\"ip\":{\"type\":\"string\"},\"subnet\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"NetworkAuthSharepointRequest\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"location\":{\"type\":\"string\"}}},\"SetTuningProfileRequest\":{\"type\":\"object\",\"properties\":{\"tuningProfile\":{\"$ref\":\"#/components/schemas/TuningProfile\"}}},\"TuningProfile\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"}}},\"PossibleLocation\":{\"type\":\"object\",\"properties\":{\"path\":{\"type\":\"string\"},\"quotaSupport\":{\"type\":\"boolean\"},\"sysTypeName\":{\"type\":\"string\"}}},\"QuotaState\":{\"type\":\"object\",\"properties\":{\"enforcement\":{\"type\":\"boolean\"},\"blocksGraceTime\":{\"type\":\"integer\",\"format\":\"int64\"},\"inodesGraceTime\":{\"type\":\"integer\",\"format\":\"int64\"},\"realtimeBlocksGraceTime\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"RequestFixPermission\":{\"type\":\"object\",\"properties\":{\"sharepointName\":{\"type\":\"string\"}}},\"EnableQuotaEnforcementRequest\":{\"type\":\"object\",\"properties\":{\"enforce\":{\"type\":\"boolean\"}}},\"QuotaSharepoint\":{\"type\":\"object\",\"properties\":{\"sharepointName\":{\"type\":\"string\"},\"localDestination\":{\"type\":\"object\",\"properties\":{\"absolute\":{\"type\":\"boolean\"},\"fileSystem\":{\"type\":\"object\",\"properties\":{\"rootDirectories\":{\"type\":\"object\"},\"fileStores\":{\"type\":\"object\"},\"userPrincipalLookupService\":{\"type\":\"object\"},\"separator\":{\"type\":\"string\"},\"readOnly\":{\"type\":\"boolean\"},\"open\":{\"type\":\"boolean\"}}},\"nameCount\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"quotaSupport\":{\"type\":\"boolean\"},\"quotaEnabled\":{\"type\":\"boolean\"},\"quotaReport\":{\"$ref\":\"#/components/schemas/Report\"},\"type\":{\"type\":\"string\",\"enum\":[\"SMB\",\"AFP\",\"NFS\"]}}},\"Report\":{\"type\":\"object\",\"properties\":{\"blockUsedKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"blockSoftKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"blockHardKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"realTimeBlockUsedKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"realTimeBlockHardKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"realTimeBlockSoftKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"inodeSoft\":{\"type\":\"integer\",\"format\":\"int64\"},\"inodeHard\":{\"type\":\"integer\",\"format\":\"int64\"},\"inodeUsed\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"QuotaTime\":{\"type\":\"object\",\"properties\":{\"blocksGraceTime\":{\"type\":\"integer\",\"format\":\"int64\"},\"inodesGraceTime\":{\"type\":\"integer\",\"format\":\"int64\"},\"realtimeBlocksGraceTime\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"QuotaLimits\":{\"type\":\"object\",\"properties\":{\"blockSoftKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"blockHardKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"realTimeBlockSoftKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"realTimeBlockHardKB\":{\"type\":\"integer\",\"format\":\"int64\"},\"inodeSoft\":{\"type\":\"integer\",\"format\":\"int64\"},\"inodeHard\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"SetQuotaLimitRequest\":{\"type\":\"object\",\"properties\":{\"sharepointName\":{\"type\":\"string\"},\"limits\":{\"$ref\":\"#/components/schemas/QuotaLimits\"}}},\"RemoveQuotaLimitsRequest\":{\"type\":\"object\",\"properties\":{\"sharepointName\":{\"type\":\"string\"}}},\"Group\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"users\":{\"uniqueItems\":true,\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/User\"}}}},\"NameRequest\":{\"type\":\"object\",\"properties\":{\"newName\":{\"type\":\"string\"}}},\"GroupRequest\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"}}},\"SubscribePaths\":{\"type\":\"object\",\"properties\":{\"availablePaths\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"LogMessage\":{\"type\":\"object\",\"properties\":{\"serviceName\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"integer\",\"format\":\"int64\"},\"logMessage\":{\"type\":\"string\"},\"syslogIdentifier\":{\"type\":\"string\"}}},\"Logs\":{\"type\":\"object\",\"properties\":{\"messages\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/LogMessage\"}}}},\"StreamingResponseBody\":{\"type\":\"object\"},\"SseEmitter\":{\"type\":\"object\",\"properties\":{\"timeout\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"AddJobRequest\":{\"type\":\"object\",\"properties\":{\"fileName\":{\"type\":\"string\"},\"cronExpression\":{\"type\":\"string\"},\"script\":{\"type\":\"string\"}}},\"CronJob\":{\"type\":\"object\",\"properties\":{\"fileName\":{\"type\":\"string\"},\"cronExpression\":{\"type\":\"string\"},\"script\":{\"type\":\"string\"},\"last100LogEntries\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"UpdateJobRequest\":{\"type\":\"object\",\"properties\":{\"fileName\":{\"type\":\"string\"},\"cronExpression\":{\"type\":\"string\"},\"script\":{\"type\":\"string\"}}},\"DeleteJobRequest\":{\"type\":\"object\",\"properties\":{\"fileName\":{\"type\":\"string\"}}},\"LoginRequest\":{\"type\":\"object\",\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"}}},\"JwtResponse\":{\"type\":\"object\",\"properties\":{\"token\":{\"type\":\"string\"},\"refreshToken\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"username\":{\"type\":\"string\"},\"role\":{\"type\":\"string\",\"enum\":[\"ADMIN\",\"CUSTOMER\"]}}},\"RefreshRequest\":{\"type\":\"object\",\"properties\":{\"refreshToken\":{\"type\":\"string\"}}},\"License\":{\"type\":\"object\",\"properties\":{\"licenseKey\":{\"type\":\"string\"}}},\"LicenseStatus\":{\"type\":\"object\",\"properties\":{\"machineID\":{\"type\":\"string\"},\"licenseKey\":{\"type\":\"string\"},\"valid\":{\"type\":\"boolean\"},\"endlessLicense\":{\"type\":\"boolean\"},\"expireDateMillis\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"ChangeSecurityUserPasswordRequest\":{\"type\":\"object\",\"properties\":{\"username\":{\"type\":\"string\"},\"newPassword\":{\"type\":\"string\"}}},\"SecurityUserResponse\":{\"type\":\"object\",\"properties\":{\"username\":{\"type\":\"string\"},\"role\":{\"type\":\"string\",\"enum\":[\"ADMIN\",\"CUSTOMER\"]}}},\"SecurityUsersResponse\":{\"type\":\"object\",\"properties\":{\"users\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SecurityUserResponse\"}}}},\"CreateSecurityUserRequest\":{\"type\":\"object\",\"properties\":{\"username\":{\"type\":\"string\"},\"role\":{\"type\":\"string\",\"enum\":[\"ADMIN\",\"CUSTOMER\"]},\"password\":{\"type\":\"string\"}}},\"IconikSettings\":{\"type\":\"object\",\"properties\":{\"appID\":{\"type\":\"string\"},\"storageID\":{\"type\":\"string\"},\"authToken\":{\"type\":\"string\"},\"sleepTime\":{\"type\":\"integer\",\"format\":\"int64\"},\"maxTranscodingJobs\":{\"type\":\"integer\",\"format\":\"int32\"},\"fileUploadParallelNum\":{\"type\":\"integer\",\"format\":\"int32\"},\"fileDownloadParallelNum\":{\"type\":\"integer\",\"format\":\"int32\"}}}},\"securitySchemes\":{\"bearer-jwt\":{\"type\":\"http\",\"name\":\"Authorization\",\"in\":\"header\",\"scheme\":\"bearer\",\"bearerFormat\":\"JWT\"}}}}"}},"macroMetadata":{"macroId":{"value":"77a458ed-fc83-466f-b1d1-c3419c992209"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.herokuapp.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) visualization"}}}},{"type":"paragraph"}],"version":1}

just:store v4.0 REST API documentation

Related content

→ Use the sidebar to navigate.