API RU VDS


Getting started
 
Users
 
Servers
Functions for users management are no longer available
Access to customer accounts via API is turned off by default. It is available only for legal entities provided they signed a partner Contract. For more detailed information, please contact the support team.
API functions
URL: https://ruvds.com/api/user/get/
Query Parameters:
sessionToken – token received after authentication
id – required users IDs, separated by commas, or me value
Request Example:
https://ruvds.com/api/user/get/?sessionToken=YOURTOKEN&id=me
Response Example:
{
"rejectReason": 0,
"result":
[
{
"id": 00000000-1111-2222-3333-444444444444,
"firstName": "Ivan",
"lastName": "Ivanov",
"patronymic": "Ivanovich",
"engName": "Ivan Ivanovich",
"gender": 1,
"birthDate": "29061975",
"country": {"name":"Russia","phoneCode":7 },
"city":
{
"name": "Moscow",
"country": {"name":"Russia","phoneCode":7 },
"lat": 55.751667,
"lng": 37.617778,
},
"postcode": null,
"address": "Street, building and apartment/office",
"phone": "9031112233",
"phoneVerified": true,
"email": "user@mail.com",
"emailVerified": true,
"balance": 0,
"currency": 1,
"org": null,
}
]
}
Response Fields:
rejectReason – numeric value (error code)
errMessage – error description, if occured
result – user list array
id – Files.API.FldUsrInfId
firstName – first name
lastName – last name
patronymic – patronymic
engName – full name (in English)
gender – sex: 1 - male; 2 - female
birthDate – date of birth, ddMMyyyy format
country – country
city – city/country
postcode – postal code
address – address/location
phone – phone number (no 8 prefix or country code)
phoneVerified – phone number verified, yes/no
email – email
emailVerified – email verified, yes/no
balance – user balance
currency – user balance currency: 1 - RUB; 2 - UAH; 3 - USD; 4 - EUR
org – user legal entity info
Error Codes:
0 – request successfully completed
3 – invalid authentication token or no access to user administration
6 – invalid query
1000 – internal system error

URL: https://ruvds.com/api/user/create/ and https://ruvds.com/api/user/update/, respectively
Query Parameters:
sessionToken – token received after authentication
id – RuVDS system user ID
email – email (unique and used as login)
password – user password (only if new is created)
phone – phone number (no 8 prefix or country code)
firstName – first name
lastName – last name
patronymic – patronymic
gender – sex: 1 - male; 2 - female
birthDate – date of birth, dd.MM.yyyy format
country – country (Russia by default, if field is left empty)
city – city/country
postcode – postal code
address – address/location
Request Example:
https://ruvds.com/api/user/create/?sessionToken=YOURTOKEN&id=
&email=test@mail.com&password=P@ssword&phone=9031112233&firstName=Ivan
&lastName=Ivanov&patronymic=Ivanovich&gender=1&birthDate=29.06.1975
&country=Russia&city=Moscow&postcode=123456
&address=Street, building and apartment/office
Response Example:
{
"rejectReason": 0,
"result":null
}
Response Fields:
rejectReason – numeric value (error code)
errMessage – error description, if occured
result – user object (not NULL if successful)
Error Codes:
0 – request successfully completed
3 – invalid authentication token or no access to user administration
4 – password field empty (when creating)
5 – password too easy or too short
6 – invalid query
7 – user not found or you do not have editing rights
21 – email field empty
22 – incorrect email format
23 – email already registered for another account
32 – Incorrect phone number format/phone number incomplete
1000 – internal system error

URL: https://ruvds.com/api/user/change_password/
Query Parameters:
sessionToken – token received after authentication
id – RuVDS system user ID
password – new user password
Request Example:
https://ruvds.com/api/user/change_password/?sessionToken=YOURTOKEN
&id=00000000-1111-2222-3333-444444444444&password=NewP@assword
Response Example:
{
"rejectReason": 0,
"result":null
}
Response Fields:
rejectReason – numeric value (error code)
errMessage – error description, if occured
result – user object (not NULL if successful)
Error Codes:
0 – request successfully completed
3 – invalid authentication token or no access to user administration
4 – password field empty
5 – password too easy or too short
6 – invalid query
7 – user not found or you do not have editing rights
1000 – internal system error

URL: https://ruvds.com/api/user/remove/
Query Parameters:
sessionToken – token received after authentication
id – RuVDS system user ID
Request Example:
https://ruvds.com/api/user/remove/?sessionToken=YOURTOKEN
&id=00000000-1111-2222-3333-444444444444
Response Example:
{
"rejectReason": 0,
"result":null
}
Response Fields:
rejectReason – numeric value (error code)
errMessage – error description, if occured
result – user object (not NULL if successful)
Error Codes:
0 – request successfully completed
3 – invalid authentication token or no access to user administration
6 – invalid query
7 – user not found or you do not have editing rights
40 – user has servers on his/her account
1000 – internal system error

 
We use cookies (our own) to make our websites easier for you to use. By continuing to use our website, you consent to the use of cookies. Please see our Privacy Policy for more information on cookies and information on how you can change your browser's cookie settings.