Atman Documentation https://ex-docs.atman.pl Our customers deserve the best services Tue, 26 Sep 2023 09:32:28 +0000 en-US hourly 1 97722638 Baas – Przewodnik użytkownika https://ex-docs.atman.pl/en/bez-kategorii/baas-przewodnik-uzytkownika-html/ Tue, 26 Sep 2023 08:58:03 +0000 https://docs.atman.pl/?p=3888 BaaS – Przewodnik użytkownika

]]> 3888 User Manual https://ex-docs.atman.pl/en/atman-baas-faq/user-manual/ Wed, 19 Dec 2018 13:04:57 +0000 https://docs.atman.pl/?p=597 Atman BaaS (Backup as a Service) User Manual is available below:

Atman-Backup-User-Guide-EN

]]> 597 API: Managing products https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-products/ https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-products/#respond Tue, 25 Aug 2015 11:08:08 +0000 https://docs.atman.pl/?p=73

products.list

Description

Returns list of sellable products.

Command specific parameters
Name Description
categoryId Product category ID: 4 – Startup, 5 – Business, 6 – Enterprise, 7 – Cloud
language Language: pl, en, ru
Command specific response

Products array.

Name Description
products/product Products array entry
products/product[id] Product ID
products/product/name Product name
products/product/order-link Link for product ordering
products/product/description Product description
Sample response
...
<products>
  <product id="xx">
    <name>...</name>
    <order-link>...</order-link>
    <price>...</price>
    <description>...</description>
  </product>
</products>
...
]]> https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-products/feed/ 0 73 API: Managing operating system https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-operating-system/ https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-operating-system/#respond Wed, 19 Aug 2015 15:09:09 +0000 https://docs.atman.pl/?p=65

os.list

Description

Returns available operating systems list.

Command specific parameters

None.

Command specific response

Array of servers.

Name Description
operatingsystems/os Operating systems list entry. Entry value represents OS name.
operatingsystems/os[id] Operating system ID
Sample response
...
<operatingsystems>
  <os id="yy">zz</os>
  ...
</operatingsystems>
...

server.os.install

Description

Installs specified operating system on server.

Command specific parameters
Name Description
serverId Server ID
osId Operating system ID
Command specific response

None.

]]> https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-operating-system/feed/ 0 65 API: Trouble tickets https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-trouble-tickets/ https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-trouble-tickets/#respond Wed, 19 Aug 2015 11:20:59 +0000 https://docs.atman.pl/?p=56

tt.departments.list

Description

Returns support departments list for trouble ticket processing.

Command specific parameters

None.

Command specific response

Departments array.

Name Description
departments/department Department list entry. Entry value represents department name.
departments/department[id] Department ID
Sample response
...
<departments>
  <department id="yy">xx</department>
  ...
</departments>
...

tt.priorities.list

Description

Returns ticket priority levels.

Command specific parameters

None.

Command specific response

Prorities array.

Name Description
priorities/priority Priorities list entry. Entry value represents priority level name.
priorities/priority[id] Priority level ID
Sample response
...
<priorities>
  <priority id="yy">xx</priority>
  ...
</priorities>
...

tt.add

Description

Creates new trouble ticket.

Command specific parameters
Name Description
serverID ID of server
title Ticket title
content Message
departmentId Support department ID
priorityId Priority level ID
Command specific response

None.

]]> https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-trouble-tickets/feed/ 0 56 API: IP and network management https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-ip-and-network-management/ https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-ip-and-network-management/#respond Wed, 19 Aug 2015 00:36:36 +0000 https://docs.atman.pl/?p=48 ip.list
Description

Fetches IP address list.

Command specific parameters

None.

Command specific response

IP addresses array.

Name Description
net/address IP address array item
net/address[addressId] IP address ID
net/address[role=main\|additional] IP address type
net/address/addr IP address
net/address/gw Gateway
net/address/mask Network mask
Sample response
...
<net>
  <address addressId="XX" role="additional">
    <addr>XXX</addr>
  </address>
  <address addressId="XX" role="main">
    <addr>XX</addr>
    <gw>XX</gw>
    <mask>XX</mask>
  </address>
</net>
...

ip.movements.list

Description

Fetches configured IP redirection links.

Command specific parameters

None.

Command specific response

IP addresses redirection links array.

Name Description
movements/movement IP address redirection links array item. Element value contains IP redirection link.
movements/movement[addr] IP address redirection links being configured
movements/movement[to] Main IP of destination server
net/address[role=main\|additional] IP address type
net/address/addr IP address
net/address/gw Gateway
net/address/mask Network mask 
...
<movements>
  <movement addr="xx" to="yy">link</movement>
  ...
</movements>
...

ip.movements.create

Description

Creates new IP redirection link.

Command specific parameters
Name Description
movements/movement IP address redirection links array item. Element value contains IP redirection link.
addressId IP address ID
serverId Destination server ID
Command specific response

None.

ip.move

Description

Moves additional IP address from one server to another.

Command specific parameters
Name Description
addressId IP address ID
serverId Destination server ID
Command specific response

None.

ip.rev-dns

Description

Updates reverse DNS entry for specified IP address.

Command specific parameters
Name Description
addressId IP address ID
value New reverse DNS entry – should be valid hostname
Command specific response

None.

]]> https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-ip-and-network-management/feed/ 0 48 API: Connecting https://ex-docs.atman.pl/en/dedicated-servers/api-en/connecting-to-api/ https://ex-docs.atman.pl/en/dedicated-servers/api-en/connecting-to-api/#respond Tue, 18 Aug 2015 14:32:30 +0000 https://docs.atman.pl/?p=28 Introduction

ATMAN API allows to manage whole ATMAN infrastructure using a standardized programmatic interface. Using ATMAN API, you can do just about anything you can do on control panel. The ATMAN API is based on XML requests and responses. As an alternative, you can use SOAP.

Best practices

Use separate API user

We suggest to use separate user to access API and set its access rights to minimum required.

Caching requests

We suggest to cache information which does not change frequently i.e. trouble ticket department list or priorities.

Using API

API URL

To send a command, you need to send POST request to API URL – URL is shown in control panel, usually it is https://panel.atman.pl/api/xml.

Authentication

You can use control panel credentials to access API. It is advised to use separate user dedicated for API access.

XML API

Request

<?xml version="1.0"?>
<request>
  <user>
    <mail>[api_user]</mail>
    <password>[api_password]</password>
  </user>
  <command>
    <name>[command name]</name>
    [command parameters]
  </command>
</request>

Response

<?xml version="1.0"?>
<response>
  <status>ok</status>
  <message>Command OK</message>
  [command specific response]
</response>

Sample command

Request
<?xml version="1.0"?>
<request>
  <user>
    <mail>sample_user</mail>
    <password>sample_password</password>
  </user>
  <command>
    <name>server.ipmi.start</name>
    <serverId>xxx</serverId>
    <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
  </command>
</request>
Response
<?xml version="1.0"?>
<response>
  <status>ok</status>
  <message>Command OK</message>
  <ipmi>
    <status>active</status>
    <address>xxx.xxx.xxx.xxx</address>
    <login>yyy</login>
    <password>zzz</password>
    <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
    <endTime>ccc</endTime>
  </ipmi>
</response>
]]> https://ex-docs.atman.pl/en/dedicated-servers/api-en/connecting-to-api/feed/ 0 28 API: Managing IPMI https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-ipmi/ https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-ipmi/#respond Tue, 18 Aug 2015 13:35:50 +0000 https://docs.atman.pl/?p=24 server.ipmi.reset
Description

IPMI management interface reset.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.ipmi.start

Description

Enable IPMI access.

Command specific parameters
Name Description
serverId Server ID
sourceAddress IP address or network which is allowed to access IPMI interface, format aaa.aaa.aaa.aaa/bb.
Command specific response
Name Description
ipmi/status IPMI access status
ipmi/address IPMI interface IP address
ipmi/login IPMI login
ipmi/password IPMI password
ipmi/sourceAddress IP address or network allowed to access IPMI interface
ipmi/endTime IPMI session expiry time
Sample response
...
<ipmi>
  <status>active</status>
  <address>xxx.xxx.xxx.xxx</address>
  <login>yyy</login>
  <password>zzz</password>
  <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
  <endTime>ccc</endTime>
</ipmi>
...

server.ipmi.stop

Description

Disables IPMI access.

Command specific parameters
Name Description
serverId Server ID
sourceAddress IP address or network which is allowed to access IPMI interface
Command specific response

None.

server.ipmi.info

Description

Gets information about IPMI access.

Command specific parameters
Name Description
serverId Server ID
Command specific response
Name Description
ipmi/status IPMI access status
ipmi/address IPMI interface IP address
ipmi/login IPMI login
ipmi/password IPMI password
ipmi/sourceAddress IP address or network allowed to access IPMI interface
ipmi/endTime IPMI session expiry time
Sample response
...
<ipmi>
  <status>active</status>
  <address>xxx.xxx.xxx.xxx</address>
  <login>yyy</login>
  <password>zzz</password>
  <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
  <endTime>ccc</endTime>
</ipmi>
...

server.ipmi.change_password

Description

Gets information about IPMI access.

Command specific parameters
Name Description
serverId Server ID
Command specific response
Name Description
ipmi/status IPMI access status
ipmi/address IPMI interface IP address
ipmi/login IPMI login
ipmi/password New IPMI password
ipmi/sourceAddress IP address or network allowed to access IPMI interface
ipmi/endTime IPMI session expiry time
Sample response
...
<ipmi>
  <status>active</status>
  <address>xxx.xxx.xxx.xxx</address>
  <login>yyy</login>
  <password>zzz</password>
  <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
  <endTime>ccc</endTime>
</ipmi>
...
]]> https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-managing-ipmi/feed/ 0 24 API: Controlling server status https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-controlling-server-status/ https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-controlling-server-status/#respond Tue, 18 Aug 2015 13:11:48 +0000 https://docs.atman.pl/?p=11

servers.list

Description

Fetch servers list for certain user.

Command specific parameters

None.

Command specific response

Array of servers.

Name Description
servers/server/serverId Server ID
servers/server/name Server name
servers/server/status Server status
Sample response
...
<servers>
  <server>
    <serverId>xxx</serverId>
    <name>yyy</name>
    <status>online</status>
  </server>
  ...
</servers>
...

server.info

Description

Gets information about specific server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

Array of servers.

Name Description
server/serverId Server ID
server/os Operating system
net/speed Interface speed
net/address Server IPv4 address information block
net/address[addressId] IPv4 address ID
net/address[role=main\|additional] IPv4 address type
net/address/addr IPv4 address
net/address/gw Gateway address
net/address/mask IP address mask
hw/component Component description
Sample response
<server>
  <serverId>xxx</serverId>
  <os osID="XX">YY</os>
  <net>
    <speed>AA</speed>
    <address addressId="XX" role="additional">
      <addr>XXX</addr>
    </address>
    <address addressId="XX" role="main">
      <addr>XX</addr>
      <gw>XX</gw>
      <mask>XX</mask>
    </address>
  </net>
  <hw>
    <component>AA</component>
    <component>BB</component>
  </hw>
  <storage>
    <storage id="XX">
      <user>XX</user>
      <pass>XX</pass>
      <used>XX</used>
    </storage>
  </storage>
  <traffic>
    <cycle from="AA" to="BB">XX</cycle>
  </traffic>
</server>

server.stop

Description

Stops dedicated server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.start

Description

Starts dedicated server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.restart

Description

Reboots dedicated server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.change-name

Description

Changes dedicated server name.

Command specific parameters
Name Description
serverId Server ID
ownName New server name
Command specific response

None.

server.crash

This method is obsolete. Please use tt.add method instead.

Description

Reports problem with dedicated server to customer support.

Command specific parameters
Name Description
serverId Server ID
message Message content
Command specific response

None.

server.status.refresh

Description

Forces to refresh server status.

Usage of this method is limited: no more than 0.2 rq/min per server.

Command specific parameters
Name Description
serverId Server ID
Command specific response
Name Description
server/serverId Server ID
server/status Server status
Sample response
...
<server>
  <serverId>xxx</serverId>
  <status>online</status>
</server>
...
]]> https://ex-docs.atman.pl/en/dedicated-servers/api-en/api-controlling-server-status/feed/ 0 11