garage-admin-sdk-js/docs/NodesApi.md

garage.NodesApi

All URIs are relative to http://localhost:3903/v0

Method	HTTP request	Description
addNode	POST /connect	Connect target node to other Garage nodes
getNodes	GET /status	Status of this node and other nodes in the cluster

addNode

[AddNode200ResponseInner] addNode(requestBody)

Connect target node to other Garage nodes

Instructs this Garage node to connect to other Garage nodes at specified `<node_id>@<net_address>`. `node_id` is generated automatically on node start.

Example

import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new garage.NodesApi();
let requestBody = ["null"]; // [String] | 
apiInstance.addNode(requestBody).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
requestBody	**[String]**

Return type

**[AddNode200ResponseInner]**

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

getNodes

GetNodes200Response getNodes()

Status of this node and other nodes in the cluster

Returns the cluster's current status, including: - ID of the node being queried and its version of the Garage daemon - Live nodes - Currently configured cluster layout - Staged changes to the cluster layout

Example

import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new garage.NodesApi();
apiInstance.getNodes().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

GetNodes200Response

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json