This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
manuals:vps:api [2017/02/12 15:28] – Use shortcutVpsFree::Client.new Aither | manuals:vps:api [2024/01/02 20:44] – Update auth methods aither | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== API ====== | ====== API ====== | ||
- | Our API is running at https:// | + | Our API is running at https:// |
- | actions, just like you can do from the web interface. | + | any action that you can do in the web interface. In fact, the web interface |
- | are the management of user profiles (address, email, etc.) and data transfers. | + | running at https:// |
- | + | action. | |
- | In reality, the web interface running at https:// | + | |
- | the API and calls it for every action. | + | |
===== API Documentation ===== | ===== API Documentation ===== | ||
The API documentation, | The API documentation, | ||
- | parameters can be found at https:// | + | parameters can be found at https:// |
Even without logging in, you can see a list of all objects, i.e. even those that only | Even without logging in, you can see a list of all objects, i.e. even those that only | ||
Line 25: | Line 23: | ||
* Ruby - https:// | * Ruby - https:// | ||
- | * PHP - https:// | + | * PHP - https:// |
- | * JavaScript - https:// | + | * JavaScript - https:// |
- | * The HaveAPI web interface - https:// | + | * Go - https:// |
- | * A file system based on FUSE - https:// | + | * The HaveAPI web interface - https:// |
+ | * A file system based on FUSE - https:// | ||
Usage examples can always be found in the '' | Usage examples can always be found in the '' | ||
Line 39: | Line 38: | ||
===== Authentication===== | ===== Authentication===== | ||
- | There are two authentication methods | + | There are two authentication methods: |
- | basic. The name and password must be sent along with every API request. This is a good | + | |
- | choice for one-off actions. However, if you need to call the API several times or | + | * [[# |
- | automatically, | + | * [[# |
+ | |||
+ | Example usage in different programming languages can be found in [[https:// | ||
+ | |||
+ | ==== HTTP Basic ==== | ||
+ | The name and password must be sent along with every API request | ||
+ | This is a good choice for one-off actions. However, if you need to call the API repeatedly | ||
+ | automatically, | ||
+ | HTTP Basic cannot be used if two-factor authentication is enabled on your account. | ||
- | Another method is authentication using tokens. | + | ==== Tokens ==== |
- | requests a token to be created, one for which the client needs the name and password. As soon as the client receives | + | The client first requests a token using your credentials |
- | the token, the name and password | + | As soon as the client receives the token, the credentials |
+ | is used for authentication. | ||
There can be several types of tokens with different lifetimes: | There can be several types of tokens with different lifetimes: | ||
- | * fixed - token validity is fixed | + | * //fixed// - token validity is fixed |
- | * renewable_manual - token validity can be manually extended | + | * //renewable_manual// - token validity can be manually extended |
- | * renewable_auto - token validity is extended after every request | + | * //renewable_auto// - token validity is extended after every request |
- | * permament - the token is valid permanently, | + | * //permament// - the token is valid permanently, |
- | The type of token and time period by which its validity is extended is chosen by the client. | + | The type of token and time period by which its validity is extended is chosen |
+ | by the client. | ||
===== CLI ===== | ===== CLI ===== | ||
Line 165: | Line 174: | ||
Commands: | Commands: | ||
- | vps remote_console VPS_ID | + | action_state wait <STATE ID> |
+ | vps remote_console VPS_ID | ||
+ | vps migrate_many VPS_ID... | ||
+ | snapshot download [SNAPSHOT_ID] | ||
+ | snapshot send SNAPSHOT_ID | ||
+ | backup dataset [DATASET_ID] FILESYSTEM Backup dataset locally | ||
+ | backup vps [VPS_ID] FILESYSTEM | ||
+ | ip_traffic top Live IP traffic monitor | ||
Available resources: | Available resources: | ||
- | auth_token | ||
cluster | cluster | ||
cluster_resource | cluster_resource | ||
+ | cluster_resource_package | ||
+ | cluster_resource_package.item | ||
dataset | dataset | ||
dataset.snapshot | dataset.snapshot | ||
dataset.plan | dataset.plan | ||
+ | dataset.property_history | ||
dataset_plan | dataset_plan | ||
dns_resolver | dns_resolver | ||
Line 179: | Line 197: | ||
environment.config_chain | environment.config_chain | ||
environment.dataset_plan | environment.dataset_plan | ||
+ | host_ip_address | ||
integrity_check | integrity_check | ||
integrity_fact | integrity_fact | ||
integrity_object | integrity_object | ||
ip_address | ip_address | ||
+ | ip_traffic | ||
+ | ip_traffic_monitor | ||
+ | language | ||
location | location | ||
mail_log | mail_log | ||
Line 188: | Line 210: | ||
mail_template | mail_template | ||
mail_template.recipient | mail_template.recipient | ||
+ | mail_template.translation | ||
+ | migration_plan | ||
+ | migration_plan.vps_migration | ||
+ | network | ||
+ | network_interface | ||
node | node | ||
+ | node.status | ||
+ | object_history | ||
os_template | os_template | ||
pool | pool | ||
+ | session_token | ||
snapshot_download | snapshot_download | ||
+ | system_config | ||
+ | transaction | ||
transaction_chain | transaction_chain | ||
- | transaction_chain.transaction | ||
user | user | ||
user.environment_config | user.environment_config | ||
user.cluster_resource | user.cluster_resource | ||
+ | user.public_key | ||
+ | user.mail_role_recipient | ||
+ | user.mail_template_recipient | ||
user.state_log | user.state_log | ||
+ | user_cluster_resource_package | ||
+ | user_cluster_resource_package.item | ||
+ | user_namespace | ||
+ | user_namespace_map | ||
+ | user_namespace_map.entry | ||
user_session | user_session | ||
vps | vps | ||
Line 203: | Line 242: | ||
vps.config | vps.config | ||
vps.feature | vps.feature | ||
- | vps.ip_address | ||
vps.mount | vps.mount | ||
+ | vps.outage_window | ||
vps.console_token | vps.console_token | ||
+ | vps.status | ||
vps_config | vps_config | ||
+ | monitored_event | ||
+ | monitored_event.log | ||
+ | outage | ||
+ | outage.entity | ||
+ | outage.handler | ||
+ | outage_update | ||
+ | user_outage | ||
+ | vps_outage | ||
+ | vps_outage_mount | ||
+ | help_box | ||
+ | news_log | ||
+ | incoming_payment | ||
+ | payment_stats | ||
+ | user_account | ||
+ | user_payment | ||
+ | user_request | ||
+ | user_request.registration | ||
+ | user_request.change | ||
+ | action_state | ||
</ | </ | ||
Line 234: | Line 293: | ||
-a, --auth METHOD | -a, --auth METHOD | ||
-s, --save | -s, --save | ||
- | --username | + | --user USER User name |
--password PASSWORD | --password PASSWORD | ||
--token TOKEN Token | --token TOKEN Token |