Knowledgebase: Client Area > API
How to use the Host1Plus API
Posted by Jonas B., Last modified by Jonas B. on 03 May 2018 05:36 AM

Introduction

The Host1Plus API allows you to manage our services and resources using most popular programming languages (PHP, Java, Python, Ruby, C, C#, Javascript, etc.). The vast majority of the functionality that you are familiar within the Host1Plus Client Area panel is also available through the API, allowing you to script complex actions that your situation requires.


Host1Plus API Documentation

Using Host1Plus API you can manage our services and resources (i. e. Enterprise Cloud, Virtuozzo, PTR records, etc.). The root directory for the API calls is https://manage.host1plus.com/api/v2/. If API call request is successful, a response body will typically be sent back in the form of a JSON object. More in-depth information on Host1Plus Application Programming Interface utilization for different services and resources can be found in our official documentation.


Private API Key

Access to Host1Plus Application Programming Interface requires valid private API key (access token). This key is automatically generated upon registering in the Host1Plus Client Area. You can view current API key or generate the new one in Client Area -> API section:

API key

Keep in mind that you also have ability to test your current private API key directly via documentation using "SEND REQUEST" button. If you provide valid API key (X-Auth-Token), you will get "200 OK" response and will see JSON object with status success:

Private API key test


Examples of API Calls

Host1Plus official API documentation explains definitions of the API calls and JSON objects responses. It is important to know that documentation also provides "Try it out" section which explains to you how to define API call in different programming languages:

API Try it out

If you want to check how to Host1Plus API response looks like from the remote server, please choose one of the examples from "Try it out" section. For example, if you fill X-Auth-Token field and select "Use API response", you will see valid API call example for selected programming language:

Private API key test

Above listed example is for Shell and based on cURL. If you copy and paste above provided code to server Terminal, you will get standard API answer in JSON object format:

Private API key test

(1 vote(s))
Helpful
Not helpful