Nodesty

https://nodesty.com/docs
Admin
Nodesty provides an API for managing various hosting services, including dedicated servers, virtual...
Tokens:2,606
Snippets:17
Trust Score:6.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET /api/services/{id}/dedicated/os-templates

Source: https://nodesty.com/docs/index

Get available OS templates for a dedicated server.

```APIDOC
## GET /api/services/{id}/dedicated/os-templates

### Description
Get available OS templates for a dedicated server.

### Method
GET

### Endpoint
/api/services/{id}/dedicated/os-templates

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (Example: PAT <your_personal_access_token>)

### Response
#### Success Response (200)
List of available OS templates
```json
[
  {
    "id": 1,
    "name": "Debian 9.5"
  }
]
```

#### Error Response (404)
Dedicated server not found
```

--------------------------------

### Curl Command Example

Source: https://nodesty.com/docs/index

This snippet shows how to make a request using curl. It includes headers and body.

```curl
curl
```

--------------------------------

### GET /api/services/{id}/dedicated/hardware

Source: https://nodesty.com/docs/index

Retrieve hardware components of a dedicated server.

```APIDOC
## GET /api/services/{id}/dedicated/hardware

### Description
Retrieve hardware components of a dedicated server.

### Method
GET

### Endpoint
/api/services/{id}/dedicated/hardware

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (Example: PAT <your_personal_access_token>)

### Response
#### Success Response (200)
List of hardware components for the dedicated server
```json
[
  {
    "component": "CPU Model",
    "model": "AMD Ryzen 9 9950X",
    "value": 5000,
    "valueSuffix": " MHz"
  }
]
```

#### Error Response (404)
Dedicated server not found
```

--------------------------------

### GET /api/services/{id}/dedicated/info

Source: https://nodesty.com/docs/index

Get information about a dedicated server.

```APIDOC
## GET /api/services/{id}/dedicated/info

### Description
Get information about a dedicated server.

### Method
GET

### Endpoint
/api/services/{id}/dedicated/info

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (Example: PAT <your_personal_access_token>)

### Response
#### Success Response (200)
Information about the dedicated server
```json
{
  "dedicatedId": "1",
  "status": true,
  "availableActions": [
    "setPowerOn"
  ],
  "mainboard": "ASUS ROG Strix X570-E Gaming",
  "ram": 128,
  "disk": 1000,
  "cpu": {
    "model": "AMD Ryzen 9 5950X",
    "speed": 3500,
    "turboSpeed": 4900,
    "cores": 16,
    "threads": 32
  }
}
```

#### Error Response (404)
Dedicated server not found
```

--------------------------------

### Get Reinstall Status

Source: https://nodesty.com/docs/index

Retrieves the dedicated server reinstall status for a given service ID.

```APIDOC
## GET /api/services/{id}/dedicated/reinstall-status

### Description
Get dedicated server reinstall status.

### Method
GET

### Endpoint
/api/services/{id}/dedicated/reinstall-status

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (PAT <your_personal_access_token>)

### Request Example
```bash
curl https://nodesty.com/api/services/1/dedicated/reinstall-status \
  --header 'Authorization: PAT <your_personal_access_token>'
```

### Response
#### Success Response (200)
- **completed** (boolean) - Indicates if the reinstallation is completed.
- **step** (integer) - The current step of the reinstallation process.

#### Response Example
```json
{
  "completed": true,
  "step": 1
}
```
```

--------------------------------

### Get OS Templates for Dedicated Server (Shell)

Source: https://nodesty.com/docs/index

Retrieves a list of available operating system templates for a dedicated server. Authentication with a Personal Access Token is necessary. The response is a JSON array containing template IDs and names.

```Shell
curl https://nodesty.com/api/services/1/dedicated/os-templates \
  --header 'Authorization: PAT <your_personal_access_token>'
```

--------------------------------

### Get Tasks

Source: https://nodesty.com/docs/index

Retrieves a list of tasks performed on a dedicated server.

```APIDOC
## GET /api/services/{id}/dedicated/tasks

### Description
Get dedicated server tasks.

### Method
GET

### Endpoint
/api/services/{id}/dedicated/tasks

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (PAT <your_personal_access_token>)

### Request Example
```bash
curl https://nodesty.com/api/services/1/dedicated/tasks \
  --header 'Authorization: PAT <your_personal_access_token>'
```

### Response
#### Success Response (200)
List of dedicated server tasks.

#### Response Example
```json
[
  {
    "action": "Server reboot initiated",
    "startedAt": 1625251200000,
    "updatedAt": 1625254800000
  }
]
```
```

--------------------------------

### Get Hardware Components of Dedicated Server (Shell)

Source: https://nodesty.com/docs/index

Retrieves a list of hardware components for a specific dedicated server. Authentication is required using a Personal Access Token. The response includes details like component name, model, and value.

```Shell
curl https://nodesty.com/api/services/1/dedicated/hardware \
  --header 'Authorization: PAT <your_personal_access_token>'
```

--------------------------------

### Get Information about Dedicated Server (Shell)

Source: https://nodesty.com/docs/index

Fetches general information about a dedicated server, including its ID, status, available actions, mainboard, RAM, disk, and CPU details. Requires a Personal Access Token for authentication.

```Shell
curl https://nodesty.com/api/services/1/dedicated/info \
  --header 'Authorization: PAT <your_personal_access_token>'
```

--------------------------------

### Get Dedicated Server Reinstall Status (cURL)

Source: https://nodesty.com/docs/index

Retrieves the reinstall status of a dedicated server. Requires the server ID and an Authorization header with a Personal Access Token. Returns a JSON object with completion status and current step.

```shell
curl https://nodesty.com/api/services/1/dedicated/reinstall-status \
  --header 'Authorization: PAT <your_personal_access_token>'
```

--------------------------------

### Get Dedicated Server Tasks (cURL)

Source: https://nodesty.com/docs/index

Fetches a list of tasks performed on a dedicated server. Requires the server ID and an Authorization header. Returns a JSON array of task objects, each detailing the action and timestamps.

```shell
curl https://nodesty.com/api/services/1/dedicated/tasks \
  --header 'Authorization: PAT <your_personal_access_token>'
```

--------------------------------

### Reinstall Dedicated Server

Source: https://nodesty.com/docs/index

Reinstalls a dedicated server with a new operating system and sets the root password.

```APIDOC
## POST /api/services/{id}/dedicated/reinstall

### Description
Reinstall a dedicated server with a new OS.

### Method
POST

### Endpoint
/api/services/{id}/dedicated/reinstall

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (PAT <your_personal_access_token>)
- **Content-Type** (string) - Required - application/json

#### Request Body
- **osId** (integer) - Required - ID of the new OS to install.
- **password** (string) - Required - New root password for the dedicated server.

### Request Example
```bash
curl https://nodesty.com/api/services/1/dedicated/reinstall \
  --request POST \
  --header 'Authorization: PAT <your_personal_access_token>' \
  --header 'Content-Type: application/json' \
  --data '{ 
  "password": "StrongPassword123!", 
  "osId": 1 
}'
```

### Response
#### Success Response (204)
VPS reinstallation initiated successfully.

#### Error Response (404)
VPS not found.
```

--------------------------------

### POST /api/services/{id}/dedicated/action

Source: https://nodesty.com/docs/index

Perform an action on a dedicated server, such as powering it on or off.

```APIDOC
## POST /api/services/{id}/dedicated/action

### Description
Perform an action on a dedicated server.

### Method
POST

### Endpoint
/api/services/{id}/dedicated/action

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (Example: PAT <your_personal_access_token>)

#### Request Body
- **action** (string) - Required - Action to perform on the dedicated server. Enum: setPowerOff, setPowerOn, setPowerReset

### Request Example
```json
{
  "action": "setPowerOn"
}
```

### Response
#### Success Response (204)
Action executed successfully

#### Error Response (404)
Dedicated server not found
```

--------------------------------

### Reinstall Dedicated Server (cURL)

Source: https://nodesty.com/docs/index

Initiates the reinstallation of a dedicated server with a new operating system and sets the root password. Requires the server ID, Authorization header, and a JSON body containing the OS ID and new password. Returns a 204 status code on success.

```shell
curl https://nodesty.com/api/services/1/dedicated/reinstall \
  --request POST \
  --header 'Authorization: PAT <your_personal_access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "password": "StrongPassword123!",
  "osId": 1
}'
```

--------------------------------

### Perform Dedicated Server Action

Source: https://nodesty.com/docs/index

Performs a specific action on a dedicated server.

```APIDOC
## POST /api/services/{id}/dedicated/action

### Description
Perform a specific action on a dedicated server.

### Method
POST

### Endpoint
/api/services/{id}/dedicated/action

### Parameters
#### Path Parameters
- **id** (string) - Required - Service ID

#### Headers
- **Authorization** (string) - Required - Personal Access Token (PAT <your_personal_access_token>)
- **Content-Type** (string) - Required - application/json

#### Request Body
- **action** (string) - Required - The action to perform (e.g., "setPowerOn").

### Request Example
```json
{
  "action": "setPowerOn"
}
```
```

--------------------------------

### Perform Action on Dedicated Server (Shell)

Source: https://nodesty.com/docs/index

Executes a specified action (e.g., power on/off) on a dedicated server. Requires the server ID and a Personal Access Token for authorization. The action is specified in the JSON request body.

```Shell
curl https://nodesty.com/api/services/1/dedicated/action \
  --request POST \
  --header 'Authorization: PAT <your_personal_access_token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "setPowerOn" }'
```

--------------------------------

### Perform Dedicated Server Action (cURL)

Source: https://nodesty.com/docs/index

Sends a POST request to perform a specific action on a dedicated server. Requires the server ID, Authorization header, and a JSON body specifying the action, such as 'setPowerOn'.

```shell
curl https://nodesty.com/api/services/{id}/dedicated/action \
  --request POST \
  --header 'Authorization: PAT <your_personal_access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "setPowerOn"
}'
```
Tokens:
Raw