NAV
فناوران شبکه سینداد
bash php python

Introduction

Our HTTP REST API allows you to manage vital details of your account and services in client portal. JSON is used for all API returns

Use left menu to browse trough available methods, use right menu to check required parameters, data to post and code samples in various languages.

Swagger Doc: You can download or display the JSON to generate documentation in Swagger.

Authentication

Basic Authentication

# pass the correct header with each request (-u option)
curl 'https://my.royaserver.com/api/details' \
    -u "username:password"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);

$resp = $client->get('/details');
# python requests module handles basic authentication if provided with auth parameter
payload = username
req = requests.get('https://my.royaserver.com/api/details', auth=('username', 'password'))
print(req.json())

Make sure to replace username and password with your client area details.

This authentication method requires that you send your client area username (email address) and password with each request.

API calls that require authentication expect a header in the form of Authorization: Basic <credentials>, where credentials is the Base64 encoding of username and password joined by a single colon :.

For example:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

You can find more info on this authentication method here: Basic HTTP Authentication

Clientarea

Login

Generate new authorization token

curl -X POST "https://my.royaserver.com/api/login" \
   -H "Content-Type: application/json" \
   -d "{
    \"username\": \"user@example.com\",
    \"password\": \"secret\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
]);


$resp = $client->post('/login', [
    'json' => [
        "username" => "user@example.com",
        "password" => "secret"
    ]
]);

echo $resp->getBody();
payload = {
    'username': "user@example.com",
    'password': "secret"
}

req = requests.post('https://my.royaserver.com/api/login', json=payload)
print(req.json())
Example Response:
{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRw(...)5lZ9T79ft9uwOkqRRmIBbtR51_w",
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMD(...)ChwIAb3zvxBu6kvULa2AwAt9U-I"
}

HTTP Request

POST /login

Query Parameters

Parameter Type Description
username string

Your acount email address

password string

Account password

Logout

Invalidate authorization token

curl -X POST "https://my.royaserver.com/api/logout" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/logout');

echo $resp->getBody();
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/logout', auth=auth)
print(req.json())
Example Response:
{
    "status": true
}

HTTP Request

POST /logout

Refresh Token

Generate new authorization token using refresh token

curl -X POST "https://my.royaserver.com/api/token" \
   -H "Content-Type: application/json" \
   -d "{
    \"refresh_token\": \"refresh_tokenValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
]);


$resp = $client->post('/token', [
    'json' => [
        "refresh_token" => "refresh_tokenValue"
    ]
]);

echo $resp->getBody();
payload = {
    'refresh_token': "refresh_tokenValue"
}

req = requests.post('https://my.royaserver.com/api/token', json=payload)
print(req.json())
Example Response:
{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHR(...)vY2xlYiHGvauCWZD9B0VwXgHEzXDllqY",
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJBQ(...)Rmivc_u3YA_kgDqOPtUuGNXOzueXYtZw"
}

HTTP Request

POST /token

Query Parameters

Parameter Type Description
refresh_token string

Refresh token previously obtained from POST /login

Revoke Token

Invalidate authorization and refresh token. Pass refresh token or call this method with valid access token

curl -X POST "https://my.royaserver.com/api/revoke" \
   -H "Content-Type: application/json" \
   -d "{
    \"refresh_token\": \"refresh_tokenValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
]);


$resp = $client->post('/revoke', [
    'json' => [
        "refresh_token" => "refresh_tokenValue"
    ]
]);

echo $resp->getBody();
payload = {
    'refresh_token': "refresh_tokenValue"
}

req = requests.post('https://my.royaserver.com/api/revoke', json=payload)
print(req.json())
Example Response:
{
    "status": true
}

HTTP Request

POST /revoke

Query Parameters

Parameter Type Description
refresh_token string

User Details

Return registration details for my account

curl -X GET "https://my.royaserver.com/api/details" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/details');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/details', auth=auth)
print(req.json())
Example Response:
{
    "client": {
        "id": "26",
        "email": "api@example.com",
        "lastlogin": "2016-12-30 12:24:28",
        "ip": "172.100.2.1",
        "host": "hostname",
        "firstname": "Joe",
        "lastname": "Doe",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3294",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123"
    }
}

HTTP Request

GET /details

Update User Details

Update registration details under my account

curl -X PUT "https://my.royaserver.com/api/details" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"email\": \"emailValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"companyname\": \"companynameValue\",
    \"address1\": \"address1Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"postcode\": \"postcodeValue\",
    \"country\": \"countryValue\",
    \"phonenumber\": \"phonenumberValue\",
    \"type\": \"typeValue\",
    \"mellicardimage\": \"mellicardimageValue\",
    \"telegramnotifications\": \"telegramnotificationsValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->put('/details', [
    'json' => [
        "email" => "emailValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "companyname" => "companynameValue",
        "address1" => "address1Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "postcode" => "postcodeValue",
        "country" => "countryValue",
        "phonenumber" => "phonenumberValue",
        "type" => "typeValue",
        "mellicardimage" => "mellicardimageValue",
        "telegramnotifications" => "telegramnotificationsValue"
    ]
]);

echo $resp->getBody();
payload = {
    'email': "emailValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'companyname': "companynameValue",
    'address1': "address1Value",
    'city': "cityValue",
    'state': "stateValue",
    'postcode': "postcodeValue",
    'country': "countryValue",
    'phonenumber': "phonenumberValue",
    'type': "typeValue",
    'mellicardimage': "mellicardimageValue",
    'telegramnotifications': "telegramnotificationsValue"
}
auth=('username', 'password')

req = requests.put('https://my.royaserver.com/api/details', json=payload, auth=auth)
print(req.json())
Example Response:
{
    "client": {
        "id": "26",
        "email": "api@example.com",
        "lastlogin": "2016-12-30 12:34:20",
        "ip": "172.100.2.1",
        "host": "hostname",
        "firstname": "Joe",
        "lastname": "Doe",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3194",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123"
    },
    "info": [
        "client_info_updated"
    ]
}

HTTP Request

PUT /details

Query Parameters

Parameter Type Description
email string

Email Address

firstname string

First Name

lastname string

Last Name

companyname string

Organization

address1 string

Address 1

city string

City

state string

State

postcode string

Post code

country string

Country

phonenumber string

Phone

type string

Account Type

Available values: Private, Company.

mellicardimage string

تصویر کارت ملی

Value pattern: .jpg;.gif;.png;.pdf

telegramnotifications string[]

دریافت نوتیفیکیشن از تلگرام - می‌توانید نوتیفیکیشن‌های مربوط به تیکت‌ها، صورتحساب‌ها و ... را با فعال کردن این گزینه از طریق تلگرام دریافت کنید.

Available values: بله.

List contacts

Return a list of contacts on this account

curl -X GET "https://my.royaserver.com/api/contact" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/contact');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/contact', auth=auth)
print(req.json())
Example Response:
{
    "contacts": [
        {
            "email": "mary@example.com",
            "id": "49",
            "firstname": "Mary",
            "lastname": "Sue",
            "companyname": "",
            "company": "0",
            "lastlogin": "0000-00-00 00:00:00"
        }
    ]
}

HTTP Request

GET /contact

Add contact

Create new contact account, if password is provided you can use provided email addres to login as that contact.

curl -X POST "https://my.royaserver.com/api/contact" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"password\": \"passwordValue\",
    \"privileges\": \"privilegesValue\",
    \"email\": \"emailValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"companyname\": \"companynameValue\",
    \"address1\": \"address1Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"postcode\": \"postcodeValue\",
    \"country\": \"countryValue\",
    \"phonenumber\": \"phonenumberValue\",
    \"type\": \"typeValue\",
    \"mellicardimage\": \"mellicardimageValue\",
    \"telegramnotifications\": \"telegramnotificationsValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/contact', [
    'json' => [
        "password" => "passwordValue",
        "privileges" => "privilegesValue",
        "email" => "emailValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "companyname" => "companynameValue",
        "address1" => "address1Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "postcode" => "postcodeValue",
        "country" => "countryValue",
        "phonenumber" => "phonenumberValue",
        "type" => "typeValue",
        "mellicardimage" => "mellicardimageValue",
        "telegramnotifications" => "telegramnotificationsValue"
    ]
]);

echo $resp->getBody();
payload = {
    'password': "passwordValue",
    'privileges': "privilegesValue",
    'email': "emailValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'companyname': "companynameValue",
    'address1': "address1Value",
    'city': "cityValue",
    'state': "stateValue",
    'postcode': "postcodeValue",
    'country': "countryValue",
    'phonenumber': "phonenumberValue",
    'type': "typeValue",
    'mellicardimage': "mellicardimageValue",
    'telegramnotifications': "telegramnotificationsValue"
}
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/contact', json=payload, auth=auth)
print(req.json())
Example Response:
{
    "contact_id": "1",        
    "info": [
        "profile_added"
    ]
}

HTTP Request

POST /contact

Query Parameters

Parameter Type Description
password string

Optional, allows you to login as contact

privileges array

Array with privileges that you want to enable. Formatted the same way as output from GET /contact/privileges

email string

Email Address

firstname string

First Name

lastname string

Last Name

companyname string

Organization

address1 string

Address 1

city string

City

state string

State

postcode string

Post code

country string

Country

phonenumber string

Phone

type string

Account Type

Available values: Private, Company.

mellicardimage string

تصویر کارت ملی

Value pattern: .jpg;.gif;.png;.pdf

telegramnotifications string[]

دریافت نوتیفیکیشن از تلگرام - می‌توانید نوتیفیکیشن‌های مربوط به تیکت‌ها، صورتحساب‌ها و ... را با فعال کردن این گزینه از طریق تلگرام دریافت کنید.

Available values: بله.

Contact privileges

List possible contact privileges. Each domain and service may list additional privileges, depending on available features.

curl -X GET "https://my.royaserver.com/api/contact/privileges" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/contact/privileges');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/contact/privileges', auth=auth)
print(req.json())
Example Response:
{
    "privileges": {
        "billing": [
            "emails", // Receive billing notifications
            "payinvoice", // Allow to view/pay invoices
            "orders", // Allow to place new orders
            "balance", // View account balance
            "addfunds", // Add account funds
            "creditcard" // Edit Credit Card details
        ],
        "support": [
            "newticket", // Open new tickets
            "tickets", // View all tickets
            "closeticket", // Close tickets
            "emails" // Receive email notifications from support
        ],
        "misc": [
            "editmain", // Modify main profile details
            "emails", // View emails history
            "editipaccess", // Edit allowed IP access
            "manageprofiles", // Add / Edit contacts
            "affiliates" // Access affiliates section
        ],
        "services": {
            "full": 1, // Full control over services
            "332": [
                "basic", // View basic details
                "billing", // View billing info
                "cancelation", // Request cancellation
                "upgrade", // Upgrade / Downgrade
                "notify", // Receive related email notifications	
                (...)
                "logindetails"
            ]
        },
        "domains": {
            "full": 1, // Full control over domains
            "523": [
                "basic", // View basic details
                "renew", // Renew domain
                "notify", // Receive related email notifications	
                "contactinfo", // Contact Information
                (...)
                "nameservers" // Manage Nameservers
            ]
        }
    }
}

HTTP Request

GET /contact/privileges

Get contacts details

Return array with contact details

curl -X GET "https://my.royaserver.com/api/contact/@id" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/contact/@id');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/contact/@id', auth=auth)
print(req.json())
Example Response:
{
    "contact": {
        "id": "49",
        "email": "mary@example.com",
        "firstname": "Mary",
        "lastname": "Sue",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3194",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123",
        "type": "Private",
        "privileges" : {
            "support" : ["tickets", "newticket"]
        }
    }
}

HTTP Request

GET /contact/@id

Query Parameters

Parameter Type Description
id int

Contact ID

Edit contact

Change contact details`

curl -X PUT "https://my.royaserver.com/api/contact/@id" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"privileges\": \"privilegesValue\",
    \"email\": \"emailValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"companyname\": \"companynameValue\",
    \"address1\": \"address1Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"postcode\": \"postcodeValue\",
    \"country\": \"countryValue\",
    \"phonenumber\": \"phonenumberValue\",
    \"type\": \"typeValue\",
    \"mellicardimage\": \"mellicardimageValue\",
    \"telegramnotifications\": \"telegramnotificationsValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->put('/contact/@id', [
    'json' => [
        "privileges" => "privilegesValue",
        "email" => "emailValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "companyname" => "companynameValue",
        "address1" => "address1Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "postcode" => "postcodeValue",
        "country" => "countryValue",
        "phonenumber" => "phonenumberValue",
        "type" => "typeValue",
        "mellicardimage" => "mellicardimageValue",
        "telegramnotifications" => "telegramnotificationsValue"
    ]
]);

echo $resp->getBody();
payload = {
    'privileges': "privilegesValue",
    'email': "emailValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'companyname': "companynameValue",
    'address1': "address1Value",
    'city': "cityValue",
    'state': "stateValue",
    'postcode': "postcodeValue",
    'country': "countryValue",
    'phonenumber': "phonenumberValue",
    'type': "typeValue",
    'mellicardimage': "mellicardimageValue",
    'telegramnotifications': "telegramnotificationsValue"
}
auth=('username', 'password')

req = requests.put('https://my.royaserver.com/api/contact/@id', json=payload, auth=auth)
print(req.json())
Example Response:
{
    "info": [
        "profile_updated"
    ]
}

HTTP Request

PUT /contact/@id

Query Parameters

Parameter Type Description
id int
privileges array

Array with privileges that you want to enable. Formatted the same way as output from GET /contact/privileges

email string

Email Address

firstname string

First Name

lastname string

Last Name

companyname string

Organization

address1 string

Address 1

city string

City

state string

State

postcode string

Post code

country string

Country

phonenumber string

Phone

type string

Account Type

Available values: Private, Company.

mellicardimage string

تصویر کارت ملی

Value pattern: .jpg;.gif;.png;.pdf

telegramnotifications string[]

دریافت نوتیفیکیشن از تلگرام - می‌توانید نوتیفیکیشن‌های مربوط به تیکت‌ها، صورتحساب‌ها و ... را با فعال کردن این گزینه از طریق تلگرام دریافت کنید.

Available values: بله.

List all portal notifications

Return a list of all portal notifications.

curl -X GET "https://my.royaserver.com/api/notifications" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/notifications');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/notifications', auth=auth)
print(req.json())

HTTP Request

GET /notifications

Query Parameters

Parameter Type Description
rel_type string

Optional, return only by relation type

rel_id string

Optional, return only by relation id

List new portal notifications

Return only new portal notifications.

curl -X GET "https://my.royaserver.com/api/notifications/new" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/notifications/new');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/notifications/new', auth=auth)
print(req.json())

HTTP Request

GET /notifications/new

Query Parameters

Parameter Type Description
rel_type string

Optional, return only by relation type

rel_id string

Optional, return only by relation id

Acknowledge notification

Marks the notification as read

curl -X PUT "https://my.royaserver.com/api/notifications/@id/ack" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->put('/notifications/@id/ack');

echo $resp->getBody();
auth=('username', 'password')

req = requests.put('https://my.royaserver.com/api/notifications/@id/ack', auth=auth)
print(req.json())

HTTP Request

PUT /notifications/@id/ack

Query Parameters

Parameter Type Description
id int

Billing

Account balance

Get current account balance(unpaid invoices total), account credit

curl -X GET "https://my.royaserver.com/api/balance" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/balance');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/balance', auth=auth)
print(req.json())
Example Response:
{
    {
        "success": true,
        "details": {
            "currency": "USD",
            "acc_balance": "123456.55",
            "acc_credit": "0.00"
        }
    }
}

HTTP Request

GET /balance

List Invoices

List all invoices under my account

curl -X GET "https://my.royaserver.com/api/invoice" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/invoice');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/invoice', auth=auth)
print(req.json())
Example Response:
{
    "invoices": [
        {
            "id": "308976",
            "date": "2016-12-30",
            "dateorig": "2016-12-30",
            "duedate": "2017-01-06",
            "paybefore": "2017-01-06",
            "total": "19.65",
            "datepaid": "2016-12-30 12:40:47",
            "status": "Paid",
            "merge_id": null,
            "number": "2016\/12\/1",
            "currency": "USD"
        }
    ]
}

HTTP Request

GET /invoice

Invoice Details

Get invoice details

curl -X GET "https://my.royaserver.com/api/invoice/@id" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/invoice/@id');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/invoice/@id', auth=auth)
print(req.json())
Example Response:
{
    "invoice": {
        "id": "308976",
        "status": "Paid",
        "date": "2016-12-30",
        "duedate": "2017-01-06",
        "paybefore": "2017-01-06",
        "datepaid": "2016-12-30 12:40:47",
        "subtotal": 16.24,
        "credit": 0,
        "tax": 3.41,
        "taxrate": 21,
        "tax2": 0,
        "taxrate2": 0,
        "taxexempt": "0",
        "total": 19.65,
        "rate": 1,
        "rate2": 0,
        "rate3": 1,
        "notes": "",
        "items": [
            {
                "id": "12305",
                "invoice_id": "308976",
                "type": "Other",
                "item_id": "0",
                "description": "Example Service",
                "amount": "15.00",
                "taxed": "1",
                "qty": "1.00",
                "linetotal": "15.00"
            },
            {
                "id": "12309",
                "invoice_id": "308976",
                "type": "Other",
                "item_id": "-2",
                "description": "PayPal Payment Fee",
                "amount": "1.24",
                "taxed": "1",
                "qty": "1.00",
                "linetotal": "1.24"
            }
        ],
        "client": {
            "id": "26",
            "email": "api@example.com",
            "firstname": "Joe",
            "lastname": "Doe",
            "companyname": "",
            "address1": "Pretty View Lane",
            "address2": "3194",
            "city": "Santa Rosa",
            "state": "California",
            "postcode": "95401",
            "country": "US",
            "phonenumber": "+1.24123123"
        },
        "number": "2016\/12\/1",
        "currency": "USD"
    }
}

HTTP Request

GET /invoice/@id

Query Parameters

Parameter Type Description
id int

Payment Methods

List available payment methods

curl -X GET "https://my.royaserver.com/api/payment" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/payment');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/payment', auth=auth)
print(req.json())
Example Response:
{
    "payments": {
        "10": "BankTransfer",
        "9": "PayPal"
    }
}

HTTP Request

GET /payment

Payment Methods Fees

List available payment methods with fees

curl -X GET "https://my.royaserver.com/api/payment/fees" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/payment/fees');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/payment/fees', auth=auth)
print(req.json())
Example Response:
{
    "payments": [
        {
            "id": 1,
            "name": "Bank Transfer",
            "fixed_fee": "0.0",
            "percent_fee": "0.0",
        },
        {
            "id": 2,
            "name": "Stripe",
            "fixed_fee": "0.5",
            "percent_fee": "2.9",
        },
        {
            "id": 4,
            "name": "Credit Card",
            "fixed_fee": "0.1",
            "percent_fee": "2.4"
        },
        {
            "id": 5,
            "name": "PayPal",
            "fixed_fee": "0.3",
            "percent_fee": "2.9"
        }
    ]
}

HTTP Request

GET /payment/fees

Support

List Tickets

List support tickets under my account

curl -X GET "https://my.royaserver.com/api/tickets" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/tickets');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/tickets', auth=auth)
print(req.json())
Example Response:
{
    "tickets": [
        {
            "client_read": "1",
            "ticket_number": "736633",
            "date": "2016-12-30 12:48:13",
            "deptname": "Billing",
            "subject": "Lore Ipsum",
            "status": "Open"
        }
    ]
}

HTTP Request

GET /tickets

Ticket details

Get ticket details, including all replies

curl -X GET "https://my.royaserver.com/api/tickets/@number" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/tickets/@number');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/tickets/@number', auth=auth)
print(req.json())
Example Response:
{
    "ticket": {
        "date": "2016-12-30 12:48:13",
        "ticket_number": "736633",
        "name": "Joe Doe",
        "email": "api@example.com",
        "subject": "Lore Ipsum",
        "body": "Donec sollicitudin molestie malesuada. \r\nSed porttitor lectus nibh. Vivamus magna justo, \r\nlacinia eget consectetur sed, convallis at tellus.",
        "status": "Answered",
        "client_read": "1",
        "deptname": "Billing"
    },
    "replies": [
        {
            "id": "929",
            "name": "Suppport Staff",
            "date": "2016-12-30 12:51:04",
            "body": "Vestibulum ac diam sit amet quam \r\nvehicula elementum sed sit amet dui. \r\nPraesent sapien massa\r\n\r\n-- Maecenas efficitur elit est --",
            "status": "Sent",
            "type": "Admin"
        }
    ]
}

HTTP Request

GET /tickets/@number

Query Parameters

Parameter Type Description
number int

Ticket number

Ticket attachment

Get ticket attachment

curl -X GET "https://my.royaserver.com/api/ticket/attachment/@file" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/ticket/attachment/@file');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/ticket/attachment/@file', auth=auth)
print(req.json())

HTTP Request

GET /ticket/attachment/@file

Query Parameters

Parameter Type Description
number int

Ticket number

file string

Attachment id

Create Ticket

Submit new ticket

curl -X POST "https://my.royaserver.com/api/tickets" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"dept_id\": 1,
    \"subject\": \"Subject\",
    \"body\": \"Message ...\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/tickets', [
    'json' => [
        "dept_id" => 1,
        "subject" => "Subject",
        "body" => "Message ..."
    ]
]);

echo $resp->getBody();
payload = {
    'dept_id': 1,
    'subject': "Subject",
    'body': "Message ..."
}
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/tickets', json=payload, auth=auth)
print(req.json())
Example Response:
{
    "ticket": 865650
}

HTTP Request

POST /tickets

Query Parameters

Parameter Type Description
dept_id int

Department id

subject string

Ticket subject

body string

Ticket message

Create Reply

Reply to ticket

curl -X POST "https://my.royaserver.com/api/tickets/@number" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"body\": \"reply text ..\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/tickets/@number', [
    'json' => [
        "body" => "reply text .."
    ]
]);

echo $resp->getBody();
payload = {
    'body': "reply text .."
}
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/tickets/@number', json=payload, auth=auth)
print(req.json())
Example Response:
{
    "info": [
        "reply_added"
    ]
}

HTTP Request

POST /tickets/@number

Query Parameters

Parameter Type Description
number int

Ticket number

body string

Reply message

Re-open ticket

Try to re-open closed ticket

curl -X PUT "https://my.royaserver.com/api/tickets/@number/open" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->put('/tickets/@number/open');

echo $resp->getBody();
auth=('username', 'password')

req = requests.put('https://my.royaserver.com/api/tickets/@number/open', auth=auth)
print(req.json())
Example Response:
{
    "status": true
}

HTTP Request

PUT /tickets/@number/open

Query Parameters

Parameter Type Description
number int

Ticket number

Close ticket

Send request to close a ticket

curl -X PUT "https://my.royaserver.com/api/tickets/@number/close" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->put('/tickets/@number/close');

echo $resp->getBody();
auth=('username', 'password')

req = requests.put('https://my.royaserver.com/api/tickets/@number/close', auth=auth)
print(req.json())
Example Response:
{
    "status": true
}

HTTP Request

PUT /tickets/@number/close

Query Parameters

Parameter Type Description
number int

Ticket number

List ticket departments

Get the list of ticket departments

curl -X GET "https://my.royaserver.com/api/ticket/departments" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/ticket/departments');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/ticket/departments', auth=auth)
print(req.json())

HTTP Request

GET /ticket/departments

Services

List services

List all services under your account

curl -X GET "https://my.royaserver.com/api/service" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service', auth=auth)
print(req.json())
Example Response:
{
    "services": [
        {
            "id": "301",
            "domain": "examplename.com",
            "total": "9.99",
            "status": "Pending",
            "billingcycle": "Monthly",
            "next_due": "2017-12-30",
            "category": "Hosting",
            "category_url": "hosting",
            "name": "Starter Hosting"
        }
    ]
}

HTTP Request

GET /service

Service details

Return details for service @id

curl -X GET "https://my.royaserver.com/api/service/@id" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id', auth=auth)
print(req.json())
Example Response:
{
    "service": {
        "id": "301",
        "date_created": "2016-12-30",
        "domain": "examplename.com",
        "firstpayment": "9.99",
        "total": "9.99",
        "billingcycle": "Monthly",
        "next_due": "2017-12-30",
        "next_invoice": "2017-01-27",
        "status": "Active",
        "label": "",
        "username": "examplen",
        "password": "pdtzc",
        "name": "Starter Hosting"
    }
}

HTTP Request

GET /service/@id

Query Parameters

Parameter Type Description
id int

Service id

List service methods

List methods available for service

curl -X GET "https://my.royaserver.com/api/service/@id/methods" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id/methods');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id/methods', auth=auth)
print(req.json())
Example Response:
{
    "methods": [
        {
            "name": "Upgrade Request",
            "method": "POST",
            "route": "\/service\/@id\/upgrade"
        },
        {
            "name": "Upgrade Options",
            "method": "GET",
            "route": "\/service\/@id\/upgrade"
        },
        {
            "name": "Change service label",
            "method": "POST",
            "route": "\/service\/@id\/label"
        },
        {
            "name": "Service label",
            "method": "GET",
            "route": "\/service\/@id\/label"
        },
        {
            "name": "Cancel Service",
            "method": "POST",
            "route": "\/service\/@id\/cancel"
        }
    ]
}

HTTP Request

GET /service/@id/methods

Query Parameters

Parameter Type Description
id int

Upgrade Options

List upgrade options

curl -X GET "https://my.royaserver.com/api/service/@id/upgrade" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id/upgrade');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id/upgrade', auth=auth)
print(req.json())
Example Response:
{
    "resources": [
        {
            "id": 1557,
            "name": "Bandwidth",
            "type": "select",
            "items": [
                {
                    "id": "9953",
                    "name": "100 GB",
                    "price": 1,
                    "setup_price": 0,
                    "selected": true
                },
                {
                    "id": "10103",
                    "name": "500 GB",
                    "price": 5,
                    "setup_price": 0,
                    "selected": false
                },
                {
                    "id": "10104",
                    "name": "1 TB",
                    "price": 10,
                    "setup_price": 0,
                    "selected": false
                }
            ]
        }
    ],
    "package": []
}

HTTP Request

GET /service/@id/upgrade

Query Parameters

Parameter Type Description
id int

Upgrade Request

Estimate or request upgrade

// Format of ''resources'' paremeter
{
    "resource_id" : "qty_value", // sliders & qty fields
    "resource_id" : "item_id", // dropdown & radio fields
    "resource_id" : {
        "item_id": "qty_value" // dropdown with qty field
    }
}
curl -X POST "https://my.royaserver.com/api/service/@id/upgrade" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"resources\": \"resourcesValue\",
    \"package\": \"packageValue\",
    \"cycle\": \"cycleValue\",
    \"send\": \"sendValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/upgrade', [
    'json' => [
        "resources" => "resourcesValue",
        "package" => "packageValue",
        "cycle" => "cycleValue",
        "send" => "sendValue"
    ]
]);

echo $resp->getBody();
payload = {
    'resources': "resourcesValue",
    'package': "packageValue",
    'cycle': "cycleValue",
    'send': "sendValue"
}
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/upgrade', json=payload, auth=auth)
print(req.json())

HTTP Request

POST /service/@id/upgrade

Query Parameters

Parameter Type Description
id int

Service id

resources array

array with resource values

package int

New package id, optonal when upgrading resources

cycle string

New billing cycle, optonal when upgrading resources

send boolean

Set to true when you want to send your upgrade request

Cancel Service

Request service cancellation

curl -X POST "https://my.royaserver.com/api/service/@id/cancel" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"immediate\": \"immediateValue\",
    \"reason\": \"reasonValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/cancel', [
    'json' => [
        "immediate" => "immediateValue",
        "reason" => "reasonValue"
    ]
]);

echo $resp->getBody();
payload = {
    'immediate': "immediateValue",
    'reason': "reasonValue"
}
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/cancel', json=payload, auth=auth)
print(req.json())
Example Response:
{
  "info": [
    "cancell_sent"
  ]
}

HTTP Request

POST /service/@id/cancel

Query Parameters

Parameter Type Description
id int

Service id

immediate string

set to false to terminate service at the end of billing date, true - terminate immediately

reason string

Reason for this request

Service label

Show current service label

curl -X GET "https://my.royaserver.com/api/service/@id/label" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id/label');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id/label', auth=auth)
print(req.json())
Example Response:
{
    "label": "example"
}

HTTP Request

GET /service/@id/label

Query Parameters

Parameter Type Description
id int

Service id

Change service label

Set new custom label to identify this service

curl -X POST "https://my.royaserver.com/api/service/@id/label" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"label\": \"labelValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/label', [
    'json' => [
        "label" => "labelValue"
    ]
]);

echo $resp->getBody();
payload = {
    'label': "labelValue"
}
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/label', json=payload, auth=auth)
print(req.json())
Example Response:
{
    "success": true,
    "info": [
        "label_updated"
    ]
}

HTTP Request

POST /service/@id/label

Query Parameters

Parameter Type Description
id int

Service id

label string

New label

Get list statuses

Get a list of all statuses.

curl -X GET "https://my.royaserver.com/api/statuses" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
]);


$resp = $client->get('/statuses');

echo $resp->getBody();

req = requests.get('https://my.royaserver.com/api/statuses')
print(req.json())

HTTP Request

GET /statuses

Get specific statuses

Get a list of all statuses with specific status.

curl -X GET "https://my.royaserver.com/api/statuses/specific/@status" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
]);


$resp = $client->get('/statuses/specific/@status');

echo $resp->getBody();

req = requests.get('https://my.royaserver.com/api/statuses/specific/@status')
print(req.json())

HTTP Request

GET /statuses/specific/@status

Query Parameters

Parameter Type Description
status string

Status. Possible values: Scheduled, InProgress, Cancelled, ResolvedFaultIssue, CompletedMaintenance, Finished

Get status

Get status details.

curl -X GET "https://my.royaserver.com/api/statuses/@id" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
]);


$resp = $client->get('/statuses/@id');

echo $resp->getBody();

req = requests.get('https://my.royaserver.com/api/statuses/@id')
print(req.json())

HTTP Request

GET /statuses/@id

Query Parameters

Parameter Type Description
id int

Status id

List VMs

List virtual servers

curl -X GET "https://my.royaserver.com/api/service/@id/vms" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id/vms');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id/vms', auth=auth)
print(req.json())

HTTP Request

GET /service/@id/vms

Query Parameters

Parameter Type Description
id int

Get VM Details

Get the details of a particular virtual server

curl -X GET "https://my.royaserver.com/api/service/@id/vms/@vmid" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id/vms/@vmid');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id/vms/@vmid', auth=auth)
print(req.json())

HTTP Request

GET /service/@id/vms/@vmid

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Stop VM

Stop virtual server

curl -X POST "https://my.royaserver.com/api/service/@id/vms/@vmid/stop" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/vms/@vmid/stop');

echo $resp->getBody();
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/vms/@vmid/stop', auth=auth)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/stop

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Start VM

Start virtual servers

curl -X POST "https://my.royaserver.com/api/service/@id/vms/@vmid/start" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/vms/@vmid/start');

echo $resp->getBody();
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/vms/@vmid/start', auth=auth)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/start

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Reboot VM

Reboot virtual servers

curl -X POST "https://my.royaserver.com/api/service/@id/vms/@vmid/reboot" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/vms/@vmid/reboot');

echo $resp->getBody();
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/vms/@vmid/reboot', auth=auth)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/reboot

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Rescue VM

Reboot virtual servers into rescue mode.

curl -X POST "https://my.royaserver.com/api/service/@id/vms/@vmid/rescue" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/vms/@vmid/rescue');

echo $resp->getBody();
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/vms/@vmid/rescue', auth=auth)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/rescue

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Unrescue VM

Disable rescue mode for server.

curl -X POST "https://my.royaserver.com/api/service/@id/vms/@vmid/unrescue" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/vms/@vmid/unrescue');

echo $resp->getBody();
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/vms/@vmid/unrescue', auth=auth)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/unrescue

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Rebuild VM

Rebuild server, you can get list of templates supported by this server using '''/service/$id/vms/$vmid/rebuild'''

curl -X POST "https://my.royaserver.com/api/service/@id/vms/@vmid/rebuild" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "{
    \"template\": \"templateValue\"
}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->post('/service/@id/vms/@vmid/rebuild', [
    'json' => [
        "template" => "templateValue"
    ]
]);

echo $resp->getBody();
payload = {
    'template': "templateValue"
}
auth=('username', 'password')

req = requests.post('https://my.royaserver.com/api/service/@id/vms/@vmid/rebuild', json=payload, auth=auth)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/rebuild

Query Parameters

Parameter Type Description
id int
vmid int
template string

Template ID

List OS templates

List templates that can be used to create virtual server

curl -X GET "https://my.royaserver.com/api/service/@id/templates" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id/templates');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id/templates', auth=auth)
print(req.json())

HTTP Request

GET /service/@id/templates

Query Parameters

Parameter Type Description
id int

Resources

Show available and used resources

curl -X GET "https://my.royaserver.com/api/service/@id/resources" \
   -u user:pass 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://my.royaserver.com/api',
    'auth' => ['username', 'password']
]);


$resp = $client->get('/service/@id/resources');

echo $resp->getBody();
auth=('username', 'password')

req = requests.get('https://my.royaserver.com/api/service/@id/resources', auth=auth)
print(req.json())

HTTP Request

GET /service/@id/resources

Query Parameters

Parameter Type Description
id int