Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 137 additions & 4 deletions docs/api/application/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -1120,6 +1120,12 @@ GET /api/application/nodes/{node}/configuration

This endpoint returns the complete Wings configuration that should be placed in the Wings configuration file.

### Path Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `node` | integer | Node ID |

### Example Request


Expand Down Expand Up @@ -1147,9 +1153,136 @@ const response = await axios.get(`https://your-panel.com/api/application/nodes/$

console.log(response.data);
```
</TabItem>

<TabItem value="python" label="Python">
```python
import requests

node_id = 1
headers = {
'Authorization': 'Bearer ptla_YOUR_API_KEY',
'Accept': 'Application/vnd.pterodactyl.v1+json'
}

response = requests.get(f'https://your-panel.com/api/application/nodes/{node_id}/configuration',
headers=headers)
print(response.json())
```
</TabItem>

<TabItem value="php" label="PHP">
```php
<?php
$client = new GuzzleHttp\Client();
$nodeId = 1;

$response = $client->get("https://your-panel.com/api/application/nodes/{$nodeId}/configuration", [
'headers' => [
'Authorization' => 'Bearer ptla_YOUR_API_KEY',
'Accept' => 'Application/vnd.pterodactyl.v1+json'
]
]);

$data = json_decode($response->getBody(), true);
print_r($data);
?>
```
</TabItem>

<TabItem value="go" label="Go">
```go
package main

import (
"encoding/json"
"fmt"
"net/http"
)

func main() {
nodeId := 1
url := fmt.Sprintf("https://your-panel.com/api/application/nodes/%d/configuration", nodeId)

client := &http.Client{}
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer ptla_YOUR_API_KEY")
req.Header.Add("Accept", "Application/vnd.pterodactyl.v1+json")

resp, _ := client.Do(req)
defer resp.Body.Close()

var result map[string]interface{}
json.NewDecoder(resp.Body).Decode(&result)
fmt.Println(result)
}
```
</TabItem>

<TabItem value="java" label="Java">
```java
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

int nodeId = 1;
String url = String.format("https://your-panel.com/api/application/nodes/%d/configuration", nodeId);

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.header("Authorization", "Bearer ptla_YOUR_API_KEY")
.header("Accept", "Application/vnd.pterodactyl.v1+json")
.GET()
.build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```
</TabItem>

<TabItem value="csharp" label="C#">
```csharp
using System.Net.Http;
using System.Threading.Tasks;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer ptla_YOUR_API_KEY");
client.DefaultRequestHeaders.Add("Accept", "Application/vnd.pterodactyl.v1+json");

int nodeId = 1;
var response = await client.GetAsync($"https://your-panel.com/api/application/nodes/{nodeId}/configuration");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
```
</TabItem>

<TabItem value="ruby" label="Ruby">
```ruby
require 'net/http'
require 'json'

node_id = 1
uri = URI("https://your-panel.com/api/application/nodes/#{node_id}/configuration")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer ptla_YOUR_API_KEY'
request['Accept'] = 'Application/vnd.pterodactyl.v1+json'

response = http.request(request)
puts JSON.parse(response.body)
```
</TabItem>

</Tabs>

### Response

Returns HTTP 200 OK with the Wings configuration.

### Example Response

Expand Down Expand Up @@ -1384,16 +1517,16 @@ DELETE /api/application/nodes/{node}

### Example Request



<Tabs>
<TabItem value="curl" label="cURL">
```bash
curl -X DELETE "https://your-panel.com/api/application/nodes/2" \
-H "Authorization: Bearer ptla_YOUR_API_KEY" \
-H "Accept: Application/vnd.pterodactyl.v1+json"
```
</TabItem>



<TabItem value="javascript" label="JavaScript">
```javascript
const axios = require('axios');

Expand Down
3 changes: 2 additions & 1 deletion docs/api/client/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,8 @@ curl "https://your-panel.com/api/client/account/two-factor" \
```json
{
"data": {
"image_url_data": "otpauth://totp/Pterodactyl:user%40example.com?secret=LGYOWJEGVRPPGPWATP5ZHOYC7DHAYQ6S&issuer=Pterodactyl"
"image_url_data": "otpauth://totp/Pterodactyl:admin%40example.com?secret=XHL4JKY746CH46YJCHA25JWAUDBAM24I&issuer=Pterodactyl",
"secret": "XHL4JKY746CH46YJCHA25JWAUDBAM24I"
}
}
```
Expand Down
24 changes: 4 additions & 20 deletions docs/api/client/databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,16 +105,8 @@ func main() {
},
"name": "s4_gamedata",
"username": "u4_gKGSzC8x9M",
"remote": "%",
"max_connections": 0,
"relationships": {
"password": {
"object": "database_password",
"attributes": {
"password": "aP$9gH#x2Kw8"
}
}
}
"connections_from": "%",
"max_connections": 0
}
},
{
Expand All @@ -127,16 +119,8 @@ func main() {
},
"name": "s4_website",
"username": "u4_hN7jL4mP6Q",
"remote": "127.0.0.1",
"max_connections": 10,
"relationships": {
"password": {
"object": "database_password",
"attributes": {
"password": "xR$7nM#k9Lp3"
}
}
}
"connections_from": "127.0.0.1",
"max_connections": 10
}
}
]
Expand Down
6 changes: 3 additions & 3 deletions docs/api/client/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ print_r($data['data']);
"attributes": {
"name": "server.jar",
"mode": "-rw-r--r--",
"mode_bits": "0644",
"mode_bits": "644",
"size": 47698923,
"is_file": true,
"is_symlink": false,
Expand All @@ -113,7 +113,7 @@ print_r($data['data']);
"attributes": {
"name": "logs",
"mode": "drwxr-xr-x",
"mode_bits": "0755",
"mode_bits": "755",
"size": 4096,
"is_file": false,
"is_symlink": false,
Expand All @@ -127,7 +127,7 @@ print_r($data['data']);
"attributes": {
"name": "world",
"mode": "drwxr-xr-x",
"mode_bits": "0755",
"mode_bits": "755",
"size": 4096,
"is_file": false,
"is_symlink": false,
Expand Down
48 changes: 30 additions & 18 deletions docs/api/client/servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,16 +355,22 @@ func main() {
"internal_id": 4,
"uuid": "d3aac109-e5e0-4331-b03e-3454f7e136dc",
"name": "Survival Server",
"description": "A vanilla Minecraft survival server",
"status": "running",
"is_suspended": false,
"is_installing": false,
"is_transferring": false,
"node": "Node 1",
"is_node_under_maintenance": false,
"sftp_details": {
"ip": "node.example.com",
"port": 2022
},
"description": "A vanilla Minecraft survival server",
"limits": {
"memory": 1024,
"swap": 0,
"disk": 5120,
"io": 500,
"cpu": 200,
"threads": null,
"oom_disabled": true
},
"invocation": "java -Xms128M -Xmx1024M -jar server.jar",
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
"egg_features": [
Expand All @@ -377,20 +383,26 @@ func main() {
"allocations": 1,
"backups": 10
},
"user_permissions": [
"control.console",
"control.start",
"control.stop",
"control.restart"
],
"limits": {
"memory": 1024,
"swap": 0,
"disk": 5120,
"io": 500,
"cpu": 200,
"threads": null
"status": "running",
"is_suspended": false,
"is_installing": false,
"is_transferring": false,
"relationships": {
"allocations": {
"object": "list",
"data": []
},
"variables": {
"object": "list",
"data": []
}
}
},
"meta": {
"is_server_owner": true,
"user_permissions": [
"*"
]
}
}
```
Expand Down