curl --request GET \
--url https://app.oryzacloud.app/api/client \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.oryzacloud.app/api/client"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.oryzacloud.app/api/client', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.oryzacloud.app/api/client",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.oryzacloud.app/api/client"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.oryzacloud.app/api/client")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.oryzacloud.app/api/client")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"object": "server",
"attributes": {
"server_owner": false,
"identifier": "dmjkuwbo",
"__deprecated_uuid_short": "dmjkuwbo",
"server_identifier": "serv_1a2b3c4d",
"internal_id": 8117,
"uuid": "b4775bce-7333-4ebc-aa89-115fb04a9d51",
"name": "Leo",
"node": "FactoryNode_bbRqrPBYOG",
"is_node_under_maintenance": false,
"sftp_details": {
"ip": "246.107.107.140",
"port": 2022
},
"description": "Survival world",
"limits": {
"memory": 512,
"swap": 0,
"disk": 512,
"io": 500,
"cpu": 0,
"threads": "1,2",
"oom_disabled": false
},
"invocation": "/bin/bash echo \"hello world\"",
"docker_image": "foo/bar:latest",
"egg_features": [
"eula"
],
"feature_limits": {
"databases": 5,
"allocations": 5,
"backups": 5
},
"status": null,
"is_suspended": false,
"is_installing": false,
"is_transferring": false,
"relationships": {
"allocations": {
"object": "list",
"data": [
{
"object": "allocation",
"attributes": {
"id": 9834,
"ip": "54.95.112.197",
"ip_alias": "<string>",
"port": 8189,
"notes": "Primary game port",
"is_default": false
}
}
]
},
"variables": {
"object": "list",
"data": [
{
"object": "egg_variable",
"attributes": {
"name": "Leo",
"description": "Et modi ipsum nostrum omnis autem et consequatur.",
"env_variable": "AUT_DOLORES",
"default_value": "OldLace",
"server_value": "<string>",
"is_editable": true,
"rules": "required|string"
},
"meta": {
"startup_command": "java -Xms128M -Xmx1024M -jar paper.jar",
"raw_startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"
}
}
],
"meta": {
"startup_command": "java -Xms128M -Xmx1024M -jar paper.jar",
"docker_images": {
"Java 23": "ghcr.io/Oryza/yolks:java_23"
},
"raw_startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"
}
}
}
},
"meta": {
"is_server_owner": true,
"user_permissions": [
"websocket.connect"
]
}
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 50,
"current_page": 1,
"total_pages": 1,
"links": {}
}
}
}{
"errors": [
{
"code": "<string>",
"status": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"status": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"status": "<string>",
"detail": "<string>",
"source": {
"field": "<string>"
}
}
]
}Listar Servidores
Lista todos os servidores aos quais o usuário tem acesso no Oryza.
curl --request GET \
--url https://app.oryzacloud.app/api/client \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.oryzacloud.app/api/client"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.oryzacloud.app/api/client', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.oryzacloud.app/api/client",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.oryzacloud.app/api/client"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.oryzacloud.app/api/client")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.oryzacloud.app/api/client")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"object": "server",
"attributes": {
"server_owner": false,
"identifier": "dmjkuwbo",
"__deprecated_uuid_short": "dmjkuwbo",
"server_identifier": "serv_1a2b3c4d",
"internal_id": 8117,
"uuid": "b4775bce-7333-4ebc-aa89-115fb04a9d51",
"name": "Leo",
"node": "FactoryNode_bbRqrPBYOG",
"is_node_under_maintenance": false,
"sftp_details": {
"ip": "246.107.107.140",
"port": 2022
},
"description": "Survival world",
"limits": {
"memory": 512,
"swap": 0,
"disk": 512,
"io": 500,
"cpu": 0,
"threads": "1,2",
"oom_disabled": false
},
"invocation": "/bin/bash echo \"hello world\"",
"docker_image": "foo/bar:latest",
"egg_features": [
"eula"
],
"feature_limits": {
"databases": 5,
"allocations": 5,
"backups": 5
},
"status": null,
"is_suspended": false,
"is_installing": false,
"is_transferring": false,
"relationships": {
"allocations": {
"object": "list",
"data": [
{
"object": "allocation",
"attributes": {
"id": 9834,
"ip": "54.95.112.197",
"ip_alias": "<string>",
"port": 8189,
"notes": "Primary game port",
"is_default": false
}
}
]
},
"variables": {
"object": "list",
"data": [
{
"object": "egg_variable",
"attributes": {
"name": "Leo",
"description": "Et modi ipsum nostrum omnis autem et consequatur.",
"env_variable": "AUT_DOLORES",
"default_value": "OldLace",
"server_value": "<string>",
"is_editable": true,
"rules": "required|string"
},
"meta": {
"startup_command": "java -Xms128M -Xmx1024M -jar paper.jar",
"raw_startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"
}
}
],
"meta": {
"startup_command": "java -Xms128M -Xmx1024M -jar paper.jar",
"docker_images": {
"Java 23": "ghcr.io/Oryza/yolks:java_23"
},
"raw_startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"
}
}
}
},
"meta": {
"is_server_owner": true,
"user_permissions": [
"websocket.connect"
]
}
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 50,
"current_page": 1,
"total_pages": 1,
"links": {}
}
}
}{
"errors": [
{
"code": "<string>",
"status": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"status": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"status": "<string>",
"detail": "<string>",
"source": {
"field": "<string>"
}
}
]
}Resposta
server, stats, list, api_key).Exemplo de Uso
curl -X GET "https://app.oryzacloud.app/api/client" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer SUA_CHAVE_CLIENT_API"
const response = await fetch("https://app.oryzacloud.app/api/client", {
method: "GET",
headers: {
"Accept": "application/json",
"Content-Type": "application/json",
"Authorization": "Bearer SUA_CHAVE_CLIENT_API"
}
});
const data = await response.json();
console.log(data);
Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parâmetros de consulta
Page number to return.
1
Number of servers to return per page. The maximum is 100.
50
Scope of servers to return. "owner" returns owned servers, "admin" returns admin-accessible servers excluding owned or subuser servers, and "admin-all" returns all servers for root administrators.
owner, admin, admin-all "owner"
Filter servers by UUID.
"4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26"
Filter servers by name.
"Minecraft Server"
Filter servers by description.
"Production"
Filter servers by external identifier.
"billing-server-42"
Search across server name, UUID, short UUID, external identifier, or allocation address and port.
"192.0.2.10:25565"