共通 - API環境情報

アクセスURL

XREA

https://api.xrea.com/

CORESERVER

https://api.coreserver.jp/

api_secret_keyについて

初回のみ、該当サーバーのコントロールパネルにログインし、 APIシークレットキー発行処理が必要となります。 詳しくは下記をご確認下さい。

XREA

https://www.xrea.com/support/manual/server/api/create/

CORESERVER

https://www.coreserver.jp/support/manual/api-create.php

共通 - API利用方法 【ご利用前に必ずお読み下さい】

APIご利用時の各種注意事項


■各種機能へのパラメータ送信時につきまして

当ドキュメントの各APIに、 ParamSampleとしてサンプルのコードを記載しておりますが、
JSON形式へ変換せず、全て「POSTのKey,Value形式」で送信して下さい。


■各種機能へのアクセスにつきまして

現在それぞれのエンドポイントへアクセスできるのは、

「1秒間に1アクセスまで」

となります。
同一機能に対して1秒間に1アクセスを超えるリクエストは全てエラーとなりますのでご注意下さい。


■各種変更・削除に関する機能につきまして

変更・削除につきましては、全て一致するナンバー(no)を元に処理されるので、 必ず各種リストを取得するコマンド(/v1/domain/listや/v1/mail/list等)listコマンドで情報を取得後、一致する「no」を確認した状態で、 変更・削除を行って下さい。

※削除を行うと、新たに連番が振られるので、noが変更いたします。
必ずlistコマンドでご確認下さい。

※追加につきましてはnoが不要なので、連続でご登録いただいても問題ございません。


■各APIのreset_flgにつきまして

reset_flgを1としてAPIを利用すると、 その際に送信した値のみ登録され、それ以外は全て削除されます。
全件一括登録等、全て上書き登録する際にご利用下さい。
1件、もしくは数件の変更を行う際は、必ずreset_flgを0にしてご利用下さい。

※デフォルトは0になっております。


共通 - APIステータスコード

apiステータスコード一覧

no 内容
200 成功
500 エラー

共通 - APIエラーコード

エラーコード一覧

no response_message 内容
100001 empty {$target}:リクエストされたパラメータが不正です。
100002 invalid {$target}:入力値が不正です。
100003 format {$target}:入力値の形式が不正です。
100004 ip_notself {$target}:IPアドレスを当サーバに向けて下さい。
100005 file_open 正常にデータを保存出来ませんでした。
100006 num_over {$target}:登録可能制限数を超えています。
100007 duplicate {$target}:重複しています。
100008 other_duplicate {$target}:すでに他のユーザが登録しています。
100009 already {$target}:すでに登録されています。
100010 no_data {$target}:データは存在しません。
100011 param_error {$target}:必要な情報が入力されていません。
100012 members_yes アカウントは無効です。
100013 error エラーが発生しました。お手数ですがサポートまでお問い合わせ下さい。
100014 permit {$target}:操作する権限がありません。
100015 length {$target}:文字数が不正です。
100016 data_error データ処理に失敗しました。お手数ですが再読込をお願いいたします。
100017 auth_error 認証情報が正しくありません。
100018 auth_error 認証情報が正しくありません。
100019 unpaid 有効期限がありません。
100020 ip_notself_free_ssl 無料SSLのIP設定が正しくありません。

共通 - APIサンプルコード・ご利用例

例)
ご登録アカウントが「xreasample」
ご利用サーバが「s1001.xrea.com」

ユーザ情報取得サンプル

アクセスURL:
https://api.xrea.com/v1/user/info

POSTで下記情報を送信
※「api_secret_key」は、共通 - API環境情報をご確認下さい。
※送信する値はJSON形式に変換せず、POSTのKey,Value形式で送信して下さい。

{ "account" : "xreasample", "server_name" : "s1001.xrea.com", "api_secret_key" : "your_secret_key", }


指定のサイト情報を変更したい場合

1.変更したいサイト情報の取得

アクセスURL:
https://api.xrea.com/v1/site/list

POSTで下記情報を送信

{ "account" : "xreasample", "server_name" : "s1001.xrea.com", "api_secret_key" : "your_secret_key", }

Response

{ "status_code" : 200 "message" : "" "result" : "1":{ "no" : 1, "domain" : "xreasample.com", "redirect_url" : "www.example.com", "nodir" : 1, "phpver" : "php53", "ip" : 150.95.9.221, "ssl_status" : 0, }, "2"{ "no" : 2, "domain" : "xreasample2.com", "redirect_url" : "www.example2.com", "nodir" : 1 "ip" : "150.95.9.221", "ssl_status" : 0, "phpver" : "php70", }, }

2.1.で確認したnoを元に、サイトの変更を行う

アクセスURL:
https://api.xrea.com/v1/site/edit

{ "account" : "xreasample", "server_name" : "s1001.xrea.com", "api_secret_key" : "your_secret_key", "param" : { { "no" : 2, "domain" : "xreaedit2.com", "redirect_url" : "www.xreaedit2.com", "ip" : "150.95.9.221", "force" : 0, "nodir" : 1, "phpver" : "php53" }, }, }

Response

{ "status_code" : 200 "message" : "" }

POST パスワードリセット

パスワードのリセットを行う。
実行すると登録されているメールアドレス宛てに、
再度新しいパスワードが送付される。

トライアル期間や無料期間は利用する事ができず、有料契約中のみ利用可能。

Request

URL

POST /v1/user/pass_reset

Param

key value type default 必須  
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" "result": { "new_pass" : "xxxxxxxxxxxx" } }

POST パスワードリマインダー

Request

URL

POST /v1/user/pass_remind

Param

key value type default 必須  
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 }

POST パスワードチェック

Request

URL

POST /v1/user/pass_check

Param

key value type default 必須  
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
pass xxxxxxxx string 無し アカウントパスワード

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "pass" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 }

POST アカウント情報取得

Request

URL

POST /v1/user/info

Param

key value type default 必須  
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

key value type 備考
result      
starttime_unix 1506783600 int 登録日時のUNIXTIME
starttime 2017/10/01 00:00:00 string 登録日時
name Taro Yamada string 名前
mail example@example.com string メールアドレス
use_default_mail 0,1 int 初期で設定されているメールアドレスを使用しているか
account xxxxxx string アカウント名
pass xxxxxxxxx string パスワード
mail_pop 1-4 int 下記に記載
mail_quota 100000000 int メールボックスのQUOTA
mail_trans example@digi-rock.com string メール転送先
is_paid 0,1 int 有償ユーザかどうか 1 or 0
expirationdate 2017-03-01 string 有効期限 YYYY-mm-dd
max_db_num 5 int DB設定上限数
max_ftp_account_num 3 int subftpアカウント上限
max_domainweb_num 10 int ドメインウェブ設定上限
max_disk_size 1000000 int 最大disk領域
max_mail_account 10 int メールアカウント上限
max_crontab_num 10 int クロンタブ設定上限
max_mail_list_num 10 int メーリングリスト設定上限
max_servercopy_num 10 int サーバコピー情報登録上限
ad_disp 0,1 int 広告表示の有無(1の場合表示)
share_ip xxx.xxx.xx.xx string # 共有IP(サーバIP)
original_ip [xxx.xxx.xx.xx,xxx.xx.xxx.xx] array # 独自IP
plan XREA_free string XREA_free
XREA_plus
XREA_mail
VS_business
VS_eco
VS_standard
VS_maru
CS_a
CS_b
CS_c
CS_m
CS_backup
CS_blog
trial_flg 0|1 int 登録開始から7日(COREは30日)以内で、左記体験期間から更に1ヶ月以上の有効期限を保持していない場合はtrialとする

Sample Param

OK

{ "status_code" : 200, "result" : { "starttime_unix" : 1506783600, "starttime" : "2017/10/01 00:00:00", "name" : "Taro Yamada" , "mail" : "example@example.com", "use_default_mail" : 0, "account" : "xxxxxxx", "pass" : "xxxxxxxxx", "mail_pop" : 1, "mail_quota" : 100000000, "mail_trans" : "example@example.com", "is_paid" : 1, "expirationdate" : "2017-03-01", "max_db_num" : 5, "max_ftp_account_num" : 3, "max_domainweb_num" : 10, "max_disk_size" : 1000000, "max_mail_account" : 10, "max_crontab_num" : 10, "max_mail_list_num" : 10, "ad_disp" : 1, "share_ip" : "xxx.xxx.xx.xx", "original_ip" : ["xxx.xxx.xx.xx"], "plan" : "XREA_free", "trial_flg" : 1, } }

mail_popの種類について

how comment
1 上記メール宛てに転送し、POP/WEBMAIL用にはメールを残さない。
2 上記メール宛てに転送し、POP/WEBMAIL用にもメールを残す。
3 上記メール宛てには転送せず、POP/WEBMAIL用にはメールを残す。
4 すべてのメールを破棄。

POST アカウント情報変更

Request

URL

POST /v1/user/info_edit

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
name Taro Yamada string 無し ユーザ名
mail_trans example@example.com string 無し 転送先メールアドレス(カンマ区切りで)
mail_pop 1〜4 int 無し メール受信時の動作
mail_quota text string 無し メールボックスのサイズ(バイト)

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "name" : "Taro Yamada", "mail_trans" : "example@digi-rock.com,example@digirock.co.jp", "mail_pop" : 1, "mail_quota" : "2000000" // バイト } }

mail_popの種類について

how comment
1 上記メール宛てに転送し、POP/WEBMAIL用にはメールを残さない。
2 上記メール宛てに転送し、POP/WEBMAIL用にもメールを残す。
3 上記メール宛てには転送せず、POP/WEBMAIL用にはメールを残す。
4 すべてのメールを破棄。

Response

ResponseSample

OK

{ "status_code" : 200, "message" : "" }

POST WP海外ログイン拒否設定情報取得

WordPressへ海外からのアクセスが許可/拒否されているか確認する

Request

URL

POST /v1/tool/wplogin_deny_list

Param

key value type default 必須  
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "deny_flg" : 1, // 0:許可 , 1:拒否 } }

POST WP海外ログイン拒否設定編集

設置したWordPressへ、海外からのアクセスの許可/拒否の設定を行う

Request

URL

POST /v1/tool/wplogin_deny_edit

Param

key value type default 必須  
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
deny_flg 0,1 int 無し 0:海外許可 1:海外拒否

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "deny_flg" : 1 }, }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST アクセスIP許可

Request

URL

POST /v1/tool/ssh_ip_allow

Param

SSH接続とFTP接続の許可を行うIPを登録する。
登録できるのは1IPのみ。

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
addr xxx.xxx.xxx.xxx string 無し 許可ipアドレス

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "addr" : "xxx.xxx.xxx.xxx" } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST htpasswd作成

※.htaccessへの設定用文字列を取得するもので、
自動的に.htaccessが設置されるツールではありません。

Request

URL

POST /v1/tool/htpasswd_create

Param

key value type default 必須  
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
username xxxxxxxxx string 無し htpasswdのユーザ名
pass xxxxxxxxx strint 無し htpasswdのパスワード

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "username" : xxxxxxx, "pass" : xxxxxx, }, }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "htaccess_text" : "username:crypt_pass", "sample_text" : " AuthUserFile /virtual/{$account}/.htpasswd AuthGroupFile /dev/null AuthName MembersOnly AuthType Basic <Limit GET POST> require valid-user </Limit>" } }

POST ファイル所有者修正

Request

URL

POST /v1/tool/chown_reset

Param

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST サイト一覧

Request

URL

POST /v1/site/list

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
grep xxxx string 無し 検索文字列
grep_type front|back|both|match string match 検索条件(front:前方一致 back:後方一致 both:部分一致 match:完全一致)

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "grep_type" : "all", "grep" : "example", }


Response

key value type default 備考
result        
no 1〜999 int 無し no
domain xxxx.com string 無し ドメイン名
redirect_url https://www.example.com string 無し リダイレクトURL
ip xxx.xxx.xxx.xxx string 無し ipアドレス
ssl_status 0|1|2 int 0 SSLステータス 1:無し 2:無料 3:独自
force 0|1 int 0 ドメインが当サーバに向いているか確認の有無
nodir 0|1 int 0 ディレクトリ作成の有無
phpver php53|php54|php55|php56|php70|php71 string php70 phpバージョン
sync_from example_org.com string 無し 同期元
force 0|1 int 0 ドメインが当サーバに向いているか確認の有無
ssl_info        
pkey_txt text string 無し プライベートキー(パスフレーズ有り)
pkey_pass text string 無し パスワード
key_txt text string 無し プライベートキー(パスフレーズ無し)
cert_txt text string 無し 発行された証明書
cact_txt text string 無し 発行された中間証明書

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "1":{ // no:1はメインサイトのため、設定できるのは下記4項目のみ "no" : 1, "domain" : "example2.com", "ip" : "157.7.184.101", "phpver" : "php70" }, "2":{ "no" : 2, "domain" : "example2.com", "redirect_url" : "https://www.example.com", // リダイレクト先 "nodir" : 1, "phpver" : "php53", "ip" : "157.7.184.101", "ssl_status" : 0, "sync_from" : "example_org.com", // 同期元設定 "ssl_info" : { // SSL "pkey_txt" : "pkey_txt", // プライベートキー(パスフレーズ有り) "key_txt" : "key_txt", // プライベートキー(パスフレーズ無し) "cert_txt" : "cert_txt", // certテキスト(証明書) "cact_txt" : "cact_txt", // cactテキスト(中間証明書) }, }, }, }

POST サイト追加/編集

no:1のサイトは、サーバ付属のメインサイトとなり、
変更可能箇所は
domain : ドメイン名
phpver : phpバージョン
の2項目のみとなります。
また、IPアドレスは、強制的に共有IPとなります。

Request

paramのnoが存在すれば編集、無ければ追加となる仕様 一括登録の場合は、domain_syncとSSLは登録不可

URL

POST /v1/site/edit

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
reset_flg 0|1 int 0 リセットフラグ
param          
no 1〜999 int 無し noがあれば編集、なければ追加
domain xxxx.com string 無し ドメイン名
redirect_url https://www.example.com string 無し リダイレクトURL
ip xxx.xxx.xxx.xxx string 無し ipアドレス
ssl_status 0|1|2 int 無し SSLステータス 0:設定無し 1:無料 2:独自
変更が無い場合は、ssl_statusを送らないで下さい。現在設定されているSSL情報が削除・もしくは上書きされます。
force 0|1 int 0 Aレコードのチェック (0:チェックする , 1:チェックしない)
nodir 0|1 int 0 ディレクトリ作成の有無
phpver php53|php54|php55|php56|php70|php71 string 無し phpバージョン
sync_info          
sync_from_custom example_org.com string 無し 同期元
ssl_info          
pkey_txt text string 無し プライベートキー(パスフレーズ有り)
pkey_pass text string 無し パスワード
key_txt text string 無し プライベートキー(パスフレーズ無し)
cert_txt text string 無し 発行された証明書
cact_txt text string 無し 発行された中間証明書

※ssl_infoについて
pkey_txtとkey_pass もしくは key_txt のどちらかは必須
sslを登録しない場合は「ssl_info」自体を送らない(送ると再設定処理が走る)

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx", "reset_flg" : 1, "param" : { { "no" : 1, "domain" : "example.com", "redirect_url" : "https://www.example.com", "ip" : "xxx.xxx.xxx.xx", "ssl_status" : 0, "force" : 0, "nodir" : 1, "phpver" : "php70", "sync_info" : { // 同期設定 "sync_from_custom" : "example1.com", }, "ssl_info" : { // SSL "pkey_txt" : "pkey_txt", // プライベートキー(パスフレーズ有り) "pkey_pass" : "pkey_pass", // パスフレーズ無し "key_txt" : "key_txt", // プライベートキー(パスフレーズ無し) "cert_txt" : "cert_txt", // certテキスト(証明書) "cact_txt" : "cact_txt", // cactテキスト(中間証明書) } }, { "no" : 2, "domain" : "example2.com", "redirect_url" : "www.example2.com", "ip" : "xxx.xxx.xxx.xx", "force" : 0, "nodir" : 1, "phpver" : "php70" }, }, }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST サイト削除

Request

URL

POST /v1/site/delete 一番目のサイト「no:1」はデフォルトで設定されているサイトなので、
削除する事はできません。

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
no 2〜999 array 無し no ※1は削除不可

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "no" [2], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST サーバ間コピー停止

当アカウントからサーバ間コピーの予約をしているものを、全て停止します。

Request

URL

POST /v1/server_copy/stop

Param

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST サーバ間コピー実行

コピー実行は1つずつしか行なえないので、paramのnoには、1配列しか設定できません。

Request

URL

POST /v1/server_copy/process

Param

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
no 1-999 array 無し no 値は1つのみ

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "no" [1], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST サーバ間コピーリスト

Request

URL

POST /v1/server_copy/list

Param

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

※resultにある「copy_process」が1の場合は、
すでにコピー実行プロセスの登録済、処理待ち状態となります。

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "1":{ "no" : 1, "remote_account" : "tests", "remote_pass" : "testpass", "remote_servername" : "testservername", "remote_dir" : "/testremoteddir", "local_dir" : "/testlocaldir", "transfer_mode" : "download", // download/upload "sync_type" : "testsyncmodel", "memo" : "memo", "copy_process" : 1, }, "2":{ "no" : 2, "remote_account" : "tests", "remote_pass" : "testpass", "remote_servername" : "testservername", "remote_dir" : "/testremoteddir", "local_dir" : "/testlocaldir", "transfer_mode" : "download", // download/upload "sync_type" : "testsyncmodel", "memo" : "memo", "copy_process" : 1, }, }, }

POST サーバ間コピー情報作成/編集

Request

URL

POST /v1/server_copy/edit

Param

key value type default 必須  
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
reset_flg 0|1 int 0 リセットフラグ
param          
no 1〜999 int 無し noがあれば編集、なければ追加
remote_account username string 無し  
remote_pass xxxxxxxx string 無し  
remote_servername example.com string 無し  
remote_dir /dirname string 無し  
local_dir /dirname string 無し  
transfer_mode download|upload string download 現在download(リモート→ローカル)のみ
sync_type xxxxx string 無し renew : 更新(削除なし)
mirror: ミラー(削除あり)
mirrornodel ;ミラー(削除なし)
missing : 差分(削除なし)
existing : 存在(削除なし)
memo xxxxx string 無し  

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param":{ { "no" : 1, "remote_account" : "tests", "remote_pass" : "testpass", "remote_servername" : "testservername", "remote_dir" : "/testremoteddir", "local_dir" : "/testlocaldir", "transfer_mode" : "download", // download/upload "sync_type" : "testsyncmodel", "memo" : "memo", }, { "no" : 2, "remote_account" : "tests", "remote_pass" : "testpass", "remote_servername" : "testservername", "remote_dir" : "/testremoteddir", "local_dir" : "/testlocaldir", "transfer_mode" : "download", // download/upload "sync_type" : "testsyncmodel", "memo" : "memo", }, } }


Response

ResponseSample

OK

{ "status_code" : 200 }

POST サーバ間コピー情報削除

Request

URL

POST /v1/server_copy/delete

Param

key value type default 必須 備考
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
no 1〜999 array 無し no

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "no" [1,2,3], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST サーバ使用量

Request

URL

POST /v1/server/use_info

Param info

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }

Response

resultが空配列で返ってきた場合は、現在集計ファイルの作成中となります。

ResponseSample

OK

{ "status_code" : 200 "message" : "" "result" : { "disk" : { "max" : "1000.00" "use" : "0.09" "mail_use" : "0.00" "db_use" : "0.00" "rest" : 999.9 }, "file" : { "max" : "50000" "use" : "31" "rest" : "969" } } }

POST サーバ統計

Request

URL

POST /v1/server/stat

Param

key value type default 必須 備考
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
type all|cpu|transfer|request|unique string all   all:全て cpu:CPU transfer:Transfer request:Request unique:ユニーク数
days 2〜32 int 2   取得日数(2の場合は過去2日分)

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "type" : "all" "days" : 2 }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "20161013" : { "cpu" : { "total" : 100 // pt }, "transfer" : { "total" : 0.14887 // MB "list" : { "example.s1001.xrea.com" : 0, "example.com" : 0, "example1.com" : 0.14887, } }, "req" : { "total" : 40, "list" : { "example.s1001.xrea.com" : 1, "example.com" : 30, "example1.com" : 9, } }, "unique" : { "total" : 10, "list" : { "example.s1001.xrea.com" : 1, "example.com" : 6, "example1.com" : 3, } } }, "20161012" : { "cpu" : { "total" : 100, // pt }, "transfer" : { "total" : 0.14887, // MB "list" : { "example.s1001.xrea.com" : 0, "example.com" : 0, "example1.com" : 0.14887, } }, "req" : { "total" : 40, "list" : { "example.s1001.xrea.com" : 1, "example.com" : 30, "example1.com" : 9, } }, "unique" : { "total" : 10, "list" : { "example.s1001.xrea.com" : 1, "example.com" : 6, "example1.com" : 3, } } }, } }

POST サーバスペック

Request

URL

POST /v1/server/spec

Param info

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" "result" : { "server_name" : "s1001.xrea.com", "ip" : "203.189.105.214", "cpu" : "Intel Xeon CPU E5620 @ 2.40GHz", "mem" : "6174MB", "apache_ver" : "2.2", "perl_ver" : "5.8.8", "php_ver" : "5.3.29", "ruby_ver" : "2.2.0p0", "mysql_ver" : "5.6.22", "postgreql_ver" : "9.3.5", "python_ver" : "2.7.11", "sqlite3_ver" : "3.8.0.2", "sqlite_ver" : "2.8.17", } }

POST サーバメール一覧

Request

URL

POST /v1/server/du_mail

Param info

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
sort_type name|size string name ソート項目
sort asc|desc string asc 並び順

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "sort_type" : "name", "sort" : "desc" }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" "result" : " "all" : " 20 KB (0 MB) ./exaple.jp/exapmle 20 KB (0 MB) ./exapmle.jp/exapmle 96 KB (0 MB) ./tsts.xvs.jp/aa4 20 KB (0 MB) ./tsts.xvs.jp/new17 ", "sum" : 60, "sumM" : 0, "lastupdate : 2017-01-26 10:00:00 } }

POST サーバファイル一覧

Request

URL

POST /v1/server/du_file

Param info

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
sort_type name|size string name ソート項目
sort asc|desc string asc 並び順

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "sort_type" : "name", "sort" : "desc" }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" "result" : " "all" : " 9071 KB (8 MB) . 105 KB (0 MB) ./log 883 KB (0 MB) ./public_html 991 KB (0 MB) ./public_html/log 984 KB (0 MB) ./public_html/log/phpmyadmin 766 KB (0 MB) ./public_html/log/phpmyadmin/js ", "sum" : 236113, "sumM" : 230, "lastupdate : 2017-01-26 10:00:00 } }

POST 【MailLogin】メールアドレスパスワードチェック

Request

URL

POST /v1/user/mail_pass_check

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
email example@example.com string 無し メールアカウント名
pop_pass xxxxxxxx string 無し popメールパスワード
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

Param

{ "account" : "xxxxxxxxxxxx", "email" : "xxxx@example.com", "pop_pass" : "your password", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST 【MailLogin】メール情報取得

Request

URL

POST /v1/mail/list

メールアドレスから、メールの情報を取得する

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
email example@example.com string 無し メールアカウント名
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
type mail_only string 無し メールアカウントによるログイン限定

ParamSample

{ "account" : "xxxxxxxxxxxx", "email" : "xxxx@example.com", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "type" : "mail_only", }


Response

key value type default 必須 備考
result          
address_name xxx string 無し メールアカウント名
address_domain xxx.com string 無し メールドメイン
pop_how 1-4 int 無し 受信方法(1:転送のみ 2:POP/WEB受信のみ 3:両方(転送+POP/WEB受信) 4:破棄)
address_trans www.example.com string 無し 転送先メールアドレス
pop_pass xxxxxxxx string 無し popメールパスワード
quota 1- int 無し 使用可能サイズ
quota_use_byte 1- int 無し 使用済サイズ(byte)
quota_use_per 1-100 int 無し 使用済パーセント
mail_num 1- int 無し メール数
autorespond 0|1 int 無し 自動返信設定
autorespond_body xxxxx string 無し 自動返信設定
clamd 0|1 int 無し ウイルスフィルター設定
spamd 0|1 int 無し スパムフィルター設定
customd 0|1 int 無し カスタムフィルター設定
customd_body array string 無し カスタムフィルター内容
※下記に別途項目記載

下記customd_body

key value type default 必須 備考
allow_stringcase 0|1 int 0 大文字小文字の区別をするか
save_mail 0|1 int 0 メールを残すか
action_type xxxxxx string 無し forward:メール転送
maildir:振り分け
change_subject:題名変更
change_from:from変更
add_header:header追加
delete:破棄
action_body xxxxxx string 無し example@example.com
conditions          
target xxxx string 無し all:全て
header_all:ヘッダ全体
from: From(差出人)
to: To(宛先)
cc: CC
tocc: ToまたはCC
subject: Subject(題名)
japanese:題名に日本語を含む
notjapanese:題名に日本語を含まない
all_japanese:全体に日本語を含む
all_notjapanese:全体に日本語を含まない
body xxxxxx string 無し targetに沿った内容(targetによっては必須)
condition xxxxxx string 無し match:を含む
notmatch:を含まない
byte_below:バイト以下
byte_above:バイト以上
none:指定無し(japaneseやnotjapanese等)

Response

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { { "1":{ "no" : 1, "address_name" : example, "address_domain" : example.com, "pop_how" : 1, "address_trans" : example@example.com, "pop_pass" : xxxxxxxxxx, "quota" : 100000 // バイト "quota_use_byte" : 50000 // 使用済サイズ "quota_use_per" : 50 // 使用済パーセント "mail_num" : 120 // メール数 "autorespond" : 1 // 自動返信 "autorespond_body" : "xxx" // 自動返信内容 "clamd" : 1 // ウイルスフィルター "spamd" : 1 // スパムフィルター "customd" : 1 // カスタムフィルター "customd_body" : { // カスタムフィルター内容 { "allow_stringcase" : 0, "save_mail" : 0, "conditions : { "1" : { "no" : 1, "target" : "all", "body" : "example_string", "condition" : "match" }, "2" : { "no" : 2, "target" : "subject", "body" : "sibject_ignore", "condition" : "notmatch" } }, "action_body" : "example@example.com", "action_type" : "forward", }, } } }, }, }

POST 【MailLogin】メールアドレス編集

Request

URL

POST /v1/mail/edit_mail_only

Param

pop_pass OR pop_pass_randどちらかは必須

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
email example@example.com string 無し メールアカウント名
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
type mail_only string 無し メールアカウントによるログイン限定
param          
force 0|1 int 0 ドメインが当サーバに向いているか確認の有無(A/MX)
pop_how 1-4 int 無し 受信方法(1:転送のみ 2:POP/WEB受信のみ 3:両方(転送+POP/WEB受信) 4:破棄)
address_trans www.example.com string 無し 転送先メールアドレス
pop_pass xxxxxxxx string 無し popメールパスワード
quota 1- int 無し 使用可能サイズ
autorespond 0|1 int 無し 自動返信設定
autorespond_body xxxxx string 無し 自動返信設定
clamd 0|1 int 無し ウイルスフィルター設定
spamd 0|1 int 無し スパムフィルター設定
customd 0|1 int 無し カスタムフィルター設定
customd_body array string 無し カスタムフィルター内容 ※下記に別途項目記載
pop_pass_rand 0|1 int 0 1にした場合パスワードをランダムで変更

下記customd_body

key value type default 必須 備考
allow_stringcase 0|1 int 0 大文字小文字の区別をするか
save_mail 0|1 int 0 メールを残すか
action_type xxxxxx string 無し forward:メール転送
maildir:振り分け
change_subject:題名変更
change_from:from変更
add_header:header追加
delete:破棄
action_body xxxxxx string 無し example@example.com
conditions          
target xxxx string 無し all:全て
header_all:ヘッダ全体
from: From(差出人)
to: To(宛先)
cc: CC
tocc: ToまたはCC
subject: Subject(題名)
japanese:題名に日本語を含む
notjapanese:題名に日本語を含まない
all_japanese:全体に日本語を含む
all_notjapanese:全体に日本語を含まない
body xxxxxx string 無し targetに沿った内容(targetによっては必須)
condition xxxxxx string 無し match:を含む
notmatch:を含まない
byte_below:バイト以下
byte_above:バイト以上

ParamSample

{ "account" : "xxxxxxxxxxxx", "email" : "example@example.com" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "type" : "mail_only", "param" :{ { "force" : 0, "pop_how" : 1, "address_trans" : "example@example.com", "pop_pass" : "xxxxxxxxxx", "quota" : 100000 // バイト "autorespond" : 1 // 自動返信 "autorespond_body" : "xxx" // 自動返信内容 "clamd" : 1 // ウイルスフィルター "spamd" : 1 // スパムフィルター "customd" : 1 // カスタムフィルター "customd_body" : { // カスタムフィルター内容 { "allow_stringcase" : 0, "save_mail" : 0, "conditions :{ { "target" : "all", "body" : "example_string", "condition" : "match" }, { "target" : "subject", "body" : "sibject_ignore", "condition" : "notmatch" } }, "action_body" : "example@example.com", "action_type" : "forward", }, }, "pop_pass_rand" : 1 // パスワードランダム設定 }, } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST メーリングリスト一覧

Request

URL

POST /v1/mail_list/list

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
grep xxxx string 無し 検索文字列
grep_type front|back|both|match string match 検索条件(front:前方一致 back:後方一致 both:部分一致)

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

key value type
account xxxxxxxxx string
result    
ml_name xxx string
ml_domain example.com string
ml_address xxx@example.com string
manage_address admin@example.com string
pass xxxxxxxxx string
clamd 0|1 int
spamd 0|1 int

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "1":{ "no" : 1, "ml_name" : test1, "ml_domain" : example.com, "ml_address" : test1@example.com, "manage_address" : admin@example.com, "pass" : xxxxxxxxxx, "clamd" : 1, // ウイルスフィルター "spamd" : 1, // スパムフィルター }, "2":{ "no" : 2, "ml_name" : test2, "ml_domain" : example.com, "ml_address" : test2@example.com, "manage_address" : admin@example.com, "pass" : xxxxxxxxxx, "clamd" : 0, "spamd" : 1, }, }, }

POST メーリングリスト作成/編集

メーリングリストの情報が変更できます。
※メーリングリスト名の変更はできません。

Request

URL

POST /v1/mail_list/edit

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
reset_flg 0|1 int 0 リセットフラグ
param          
ml_name xxx string 無し メーリングリストユーザ名
ml_domain example.com string 無し メーリングリストドメイン名
ml_address xxx@example.com string 無し メーリングリスト名
manage_address xxx.com string 無し 管理者メールアドレス
pass xxxxxxxxx string 無し パスワード
clamd 0|1 int 無し ウイルスフィルター設定
spamd 0|1 int 無し スパムフィルター設定

※メーリングリストの変更はできませんので、
変更時は「ml_name」「ml_domain」「ml_address」は不要です

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "reset_flg" : 1, "param" :{ { "ml_name" : "ml", "ml_domain" : "example.com", "ml_address" : "ml@example.com", "manage_address" : "admin@example.com", "pass" : "xxxxxxxxxx", "clamd" : 1, // ウイルスフィルター "spamd" : 1, // スパムフィルター }, { "no" : 2, "manage_address" : admin2@example.com, "pass" : xxxxxxxxxx, "clamd" : 0, // ウイルスフィルター "spamd" : 1 // スパムフィルター }, } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST メーリングリスト削除

Request

URL

POST /v1/mail_list/delete

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
no 1〜999 array 無し no

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "no" [1,2], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST メールアドレス一覧

Request

URL

POST /v1/mail/list

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
grep xxxx string 無し 検索文字列
grep_type front|back|both|match string match 検索条件(front:前方一致 back:後方一致 both:部分一致)
page 1-999 int 1 ページ数
limit 1-999 int 無し limit
offset 1-999 int 無し offset

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "grep" : "example" "page" : "1" "limit" : "30" "offset" : "0" }


Response

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
result          
address_name xxx string 無し メールアカウント名
address_domain xxx.com string 無し メールドメイン
pop_how 1-4 int 無し 受信方法(1:転送のみ 2:POP/WEB受信のみ 3:両方(転送+POP/WEB受信) 4:破棄)
address_trans www.example.com string 無し 転送先メールアドレス
pop_pass xxxxxxxx string 無し popメールパスワード
quota 1- int 無し 使用可能サイズ
quota_use_byte 1- int 無し 使用済サイズ(byte)
quota_use_per 1-100 int 無し 使用済パーセント
mail_num 1- int 無し メール数
autorespond 0|1 int 無し 自動返信設定
autorespond_body xxxxx string 無し 自動返信設定
clamd 0|1 int 無し ウイルスフィルター設定
spamd 0|1 int 無し スパムフィルター設定
customd 0|1 int 無し カスタムフィルター設定
customd_body array string 無し カスタムフィルター内容
※下記に別途項目記載

下記customd_body

key value type default 必須 備考
allow_stringcase 0|1 int 0 大文字小文字の区別をするか
save_mail 0|1 int 0 メールを残すか
action_type xxxxxx string 無し forward:メール転送
maildir:振り分け
change_subject:題名変更
change_from:from変更
add_header:header追加
delete:破棄
action_body xxxxxx string 無し example@example.com
conditions          
target xxxx string 無し all:全て
header_all:ヘッダ全体
from: From(差出人)
to: To(宛先)
cc: CC
tocc: ToまたはCC
subject: Subject(題名)
japanese:題名に日本語を含む
notjapanese:題名に日本語を含まない
all_japanese:全体に日本語を含む
all_notjapanese:全体に日本語を含まない
body xxxxxx string 無し targetに沿った内容(targetによっては必須)
condition xxxxxx string 無し match:を含む
notmatch:を含まない
byte_below:バイト以下
byte_above:バイト以上
none:指定無し(japaneseやnotjapanese等)

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "1":{ "no" : 1, "address_name" : example, "address_domain" : example.com, "pop_how" : 1, "address_trans" : exampletrans@example.com, "pop_pass" : xxxxxxxxxx, "quota" : 100000 // バイト "quota_use_byte" : 50000 // 使用済サイズ "quota_use_per" : 50 // 使用済パーセント "mail_num" : 120 // メール数 "autorespond" : 1 // 自動返信 "autorespond_body" : "xxx" // 自動返信内容 "clamd" : 1 // ウイルスフィルター "spamd" : 1 // スパムフィルター "customd" : 1 // カスタムフィルター "customd_body" : { // カスタムフィルター内容 { "allow_stringcase" : 0, "save_mail" : 0, "conditions : { "1" : { "no" : 1, "target" : "all", "body" : "example_string", "condition" : "match" }, "2" : { "no" : 2, "target" : "subject", "body" : "sibject_ignore", "condition" : "notmatch" } }, "action_body" : "example@example.com", "action_type" : "forward", }, } }, "2":{ "no" : 2, "address_name" : example, "address_domain" : example2.com, "pop_how" : 1, "address_trans" : exampletrans@example.com, "pop_pass" : xxxxxxxxxx, "quota" : 100000 // バイト "quota_use_byte" : 50000 // 使用済サイズ "quota_use_per" : 50 // 使用済パーセント "mail_num" : 120 // メール数 "autorespond" : 1 // 自動返信 "autorespond_body" : "xxx" // 自動返信内容 "clamd" : 1 // ウイルスフィルター "spamd" : 1 // スパムフィルター "customd" : 1 // カスタムフィルター "customd_body" : { // カスタムフィルター内容 { "allow_stringcase" : 0, "save_mail" : 0, "conditions : { "1" : { "no" : 1, "target" : "all", "body" : "example_string", "condition" : "match" }, "2" : { "no" : 2, "target" : "subject", "body" : "sibject_ignore", "condition" : "notmatch" } }, "action_body" : "example@example.com", "action_type" : "forward", }, } }, }, }

POST メールアドレス作成/編集

no:1のメールアカウントは、サーバ付属のメインメールとなりますので、
削除する事ができません。

Request

URL

POST /v1/mail/edit

Param

pop_pass OR pop_pass_randどちらかは必須

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
reset_flg 0|1 int 0 リセットフラグ
box_reset_flg 0|1 int 0 全メールボックスリセット
param          
address_name xxx string 無し メールアカウント名
address_domain xxx.com string 無し メールドメイン
address xxx@xxx.com string 無し メールアカウント
force 0|1 int 0 ドメインが当サーバに向いているか確認の有無(A/MX)
pop_how 1-4 int 無し 受信方法(1:転送のみ 2:POP/WEB受信のみ 3:両方(転送+POP/WEB受信) 4:破棄)
address_trans www.example.com string 無し 転送先メールアドレス
pop_pass xxxxxxxx string 無し popメールパスワード
quota 1- int 無し 使用可能サイズ
autorespond 0|1 int 無し 自動返信設定
autorespond_body xxxxx string 無し 自動返信設定
clamd 0|1 int 無し ウイルスフィルター設定
spamd 0|1 int 無し スパムフィルター設定
customd 0|1 int 無し カスタムフィルター設定
customd_body array string 無し カスタムフィルター内容 ※下記に別途項目記載
pop_pass_rand 0|1 int 0 1にした場合パスワードをランダムで変更

下記customd_body

key value type default 必須 備考
allow_stringcase 0|1 int 0 大文字小文字の区別をするか
save_mail 0|1 int 0 メールを残すか
action_type xxxxxx string 無し forward:メール転送
maildir:振り分け
change_subject:題名変更
change_from:from変更
add_header:header追加
delete:破棄
action_body xxxxxx string 無し ※ 例外として、削除する場合のみ非必須
conditions          
target xxxx string 無し all:全て
header_all:ヘッダ全体
from: From(差出人)
to: To(宛先)
cc: CC
tocc: ToまたはCC
subject: Subject(題名)
japanese:題名に日本語を含む
notjapanese:題名に日本語を含まない
all_japanese:全体に日本語を含む
all_notjapanese:全体に日本語を含まない
body xxxxxx string 無し targetに沿った内容(targetによっては必須)
condition xxxxxx string 無し match:を含む
notmatch:を含まない
byte_below:バイト以下
byte_above:バイト以上

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "reset_flg" : 1, "box_reset_flg" : 1, // メールボックス初期化 "param" : { { "address_name" : example, "address_domain" : example.com, "address" : example@example.com, "force" : 0, "pop_how" : 1, "address_trans" : exampletrans@example.com, "pop_pass" : xxxxxxxxxx, "quota" : 100000 // バイト "autorespond" : 1 // 自動返信 "autorespond_body" : "xxx" // 自動返信内容 "clamd" : 1 // ウイルスフィルター "spamd" : 1 // スパムフィルター "customd" : 1 // カスタムフィルター "customd_body" : { // カスタムフィルター内容 { "allow_stringcase" : 0, "save_mail" : 0, "conditions :{ { "target" : "all", "body" : "example_string", "condition" : "match" }, { "target" : "subject", "body" : "sibject_ignore", "condition" : "notmatch" } }, "action_body" : "example@example.com", "action_type" : "forward", }, }, "pop_pass_rand" : 1 // パスワードランダム設定 }, { "address_name" : example, "address_domain" : example2.com, "address" : example@example2.com, "pop_how" : 1, "address_trans" : exampletrans@example.com, "pop_pass" : xxxxxxxxxx, "quota" : 100000 // バイト "autorespond" : 1 // 自動返信 "autorespond_body" : "xxx" // 自動返信内容 "clamd" : 1 // ウイルスフィルター "spamd" : 1 // スパムフィルター "customd" : 0 // カスタムフィルター "pop_pass_rand" : 1 // パスワードランダム設定 } } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST メールアドレス削除

Request

URL

POST /v1/mail/delete

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
no 1〜999 array 無し no

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "no" [1,2], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST ログ保存設定確認

Request

URL

POST /v1/log/settings

Param

key value type default 必須 備考
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "rawlog" : 1, "analog" : 0 } }

POST ログ保存設定変更

Request

URL

POST /v1/log/settings_edit

Param

key value type default 必須 備考
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
rawlog 0|1 int 無し 解析済ログの保存設定
0:保存しない 1:保存する
analog 0|1 int 無し 生ログ(apacheアクセスログ)の保存設定
0:保存しない 1:保存する

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "rawlog" : 1, "analog" : 0 } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST 生ログ保存

本日分の生ログを保存する

Request

URL

POST /v1/log/rawlog_save

Param

key value type default 必須 備考
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
domain example.com string 無し ドメイン名

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx", "domain" : "example.com", }


Response

OK

{ "status_code" : 200, }

POST ログ出力

Request

URL

POST /v1/log/log_output

Param

key value type default 必須 備考
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
filename xxxx.com.1.log string 無し ファイル名
type rawlog|analog string 無し rawlog:生ログ,analog:解析ログ

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "filename" : "example.com.1.log", "type" : "rawlog", }


Response

OK

{ "status_code" : 200, "message" : "", "result" : "example.com - - [24/Jan/2017:10:20:55 +0900] "GET / HTTP/1.1" 304 - "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.95 Safari/537.36" example.com - - [24/Jan/2017:13:21:22 +0900] "GET / HTTP/1.1" 304 - "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.95 Safari/537.36" example.com - - [24/Jan/2017:14:49:45 +0900] "GET / HTTP/1.1" 304 - "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.95 Safari/537.36" " }

POST ログリスト

Request

URL

POST /v1/log/log_list

Param

key value type default 必須 備考
account xxxxxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
domain xxxx.com string 無し ドメイン名(無ければ全てのドメイン)
type rawlog|analog string 無し rawlog:生ログ,analog:解析ログ

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "type" : "rawlog", }


Response

OK

{ "status_code" : 200, "message" : "", "result" : { "example.com" : { { "filename" : "example.html" "filedate" : "2017-01-18", }, { "filename" : "example.1.html" "filedate" : "2017-01-17", } }, "example2.com" : { { "filename" : "example2.html" "filedate" : "2017-01-18", }, { "filename" : "example2.1.html" "filedate" : "2017-01-17", } }, }, }

POST FTP接続情報

Request

URL

POST /v1/ftp/info

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "", "result" : { "ftp_server" : "s1001.xrea.com", "ftp_account" : "example", "ftp_password" : "xxxxxxxxxxx", "ftp_dir" : "/public_html", "ftp_url" : "http://example.s1001.xrea.com/" } }

POST サブFTPアカウント一覧

Request

URL

POST /v1/ftp/account_list

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "1":{ "no" : 1, "full_ftp_account" : "testuser.example1", "ftp_account" : "example1", "ftp_pass" : "password", "ftp_dir" : www.example.com, }, "2":{ "no" : 2, "full_ftp_account" : "testuser.example2", "ftp_account" : "example2", "ftp_pass" : "password", "ftp_dir" : "www.example.com", }, }, }

POST サブFTPアカウント作成/編集

Request

paramのnoが存在すれば編集、無ければ追加となる仕様

URL

POST /v1/ftp/account_edit

key value type default 必須 備考  
account xxxxxx string 無し    
server_name s1001.xrea.com string 無し server_name  
api_secret_key xxxxxxxxx string 無し api_secret_key  
reset_flg 0|1 int 0 リセットフラグ  
param            
no 1〜999 int 無し no noがあれば編集、なければ追加
ftp_account xxxxx string 無し    
ftp_pass xxxxx string 無し 英数文字5〜15文字  
ftp_dir xxxxx string 無し    

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "reset_flg" : 1, "param" : { { "no" : 1, "ftp_account" : "xxxxxxxxxxxx", "ftp_pass" : "xxxxxxxxx", "ftp_dir" : "/public", }, { "ftp_account" : "xxxxxxxxxxxx", "ftp_pass" : "xxxxxxxxx", "ftp_dir" : "/public", } } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "", }

POST サブFTPアカウント削除

Request

URL

POST /v1/ftp/account_delete

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
no 1〜999 array 無し no

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "no" [1,2,3], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "", }

POST Mysql/Pgsql Restore

※現在paramのnoには、1配列しか設定できません。

Request

URL

POST /v1/db/restore

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
db_type xxxxxxxxx string 無し mysql/pgsql
param          
no 1〜999 int 無し no
filename mysql.example.1483196400.dump string 無し 無ければ最新をrestore

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "db_type" : "mysql" , "param" : { { "no" : 1, "filename" : "mysql.example.1483196400.dump", } } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Mysql/Pgsql一覧

Request

URL

POST /v1/db/list

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
db_type xxxxxxxxx string 無し mysql/pgsql

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "db_type" : "mysql" , }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "" "result" : { "1":{ "no" : 1, "db_name" : "db1", "db_pass" : "pass1", "code" : "unicode", "memo" : "バリュードメイン用" }, "2":{ "no" : 2, "db_name" : "db2", "db_pass" : "pass2", "code" : "unicode", "memo" : "お客様1用" }, } }

POST Mysql/Pgsql変更

変更可能箇所はDBパスワードとメモのみ

Request

URL

POST /v1/db/edit

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
db_type xxxxxxxxx string 無し mysql/pgsql
param          
no 1〜999 int 無し no
db_pass xxxxxxxxx string 無し DBパスワード
memo text string 空白 任意のメモ

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "db_type" : "mysql" , "param" : { { "no" : 2, "db_pass" : "pass2-2", "memo" : "memo1" }, { "no" : 3, "db_pass" : "pass3", }, } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Mysql/Pgsql Dump

Request

URL

POST /v1/db/dump

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
db_type xxxxxxxxx string 無し mysql/pgsql
param          
no 1〜999 int 無し no

ParamSample

{ "account" : "xxxxxxxxxxxx" , "api_secret_key" : "xxxxxxxxxxxx" , "db_type" : "mysql" , "param" : { "no" [1,2,3], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Mysql/Pgsql Dump一覧

Request

URL

POST /v1/db/dump_list

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
db_type xxxxxxxxx string 無し mysql/pgsql
param          
no 1- int 無し noはdb_listで取得するnoと同一
無ければ指定typeのもの全て

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "db_type" : "mysql" , "param" : { "no" [1,2], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" "result" : { "test" : { { "no" : 1, "filename" : "mysql.test.1484665200.dump", "filedate" : "2017-01-18 00:00:00", }, { "no" : 1, "filename" : "mysql.test.1484578800.dump", "filedate" : "2017-01-17 00:00:00", } }, "test_222" : { { "no" : 2, "filename" : "mysql.test_222.1484665200.dump", "filedate" : "2017-01-18 00:00:00", }, { "no" : 2, "filename" : "mysql.test_222.1484578800.dump", "filedate" : "2017-01-17 00:00:00", } }, }, }

POST Mysql/Pgsql Dump(全て)

お客様領域の /_db_dump/ 以下に、作成済Mysql,PostgreSql全てのデータベースがdumpされます。

Request

URL

POST /v1/db/dump_all

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Mysql/Pgsql削除

Request

URL

POST /v1/db/delete

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
db_type xxxxxxxxx string 無し mysql/pgsql
param          
no 1〜999 array 無し no

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "db_type" : "mysql" , "param" : { "no" [1,2], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Mysql/Pgsql作成

Request

DB名はアカウント名から始まる必要がある
アカウント名のみの場合はアカウント名のみの登録が可能
アカウント名とは別に追加する場合は「_」を付ける
例:accountがexampleの場合
example
example_1
example_2

URL

POST /v1/db/add

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
db_type xxxxxxxxx string 無し mysql/pgsql
param          
db_name xxxxxxxxx string 無し DB名
db_pass xxxxxxxxx string 無し DBパスワード
code euc|unicode|sjis string 無し 文字コード
memo text string 無し 任意のメモ

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "db_type" : "mysql" , "param" : { { "db_name" : "example", "db_pass" : "pass1", "code" : "sjis", "memo" : "バリュードメイン用" }, { "db_name" : "example_db2", "db_pass" : "pass2", "code" : "euc", "memo" : "お客様1用" }, } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Cronジョブ一覧

Request

URL

POST /v1/cron/list

key value type default 必須 備考
account xxxxxx string 無し  
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "", "result" : { "1":{ "no" : 1, "min" : "0", "hour" : "0", "day" : "1", "mon" : "1", "week" : "0", "sh" : "/bin/sh /virtual/exampleuser/job.sh" }, "2":{ "no" : 2, "min" : "0", "hour" : "*", "day" : "*", "mon" : "*", "week" : "*", "sh" : "/bin/sh /virtual/exampleuser/job2.sh" }, }, }

POST Cronジョブ作成/編集

Request

URL

POST /v1/cron/edit

Param

key value type default 必須    
account xxxxxxxxx string 無し account_id  
server_name s1001.xrea.com string 無し server_name  
api_secret_key xxxxxxxxx string 無し api_secret_key  
reset_flg 0|1 int 0 リセットフラグ  
param            
no 1〜999 int 無し no noがあれば変更、無ければ追加
min 0〜59 string 無し  
hour 0〜23|* string 無し  
day 1〜31|* string 無し  
mon 1〜12|* string 無し  
week 0〜6|* string 無し 曜日  
sh sample.sh string 無し 実行コマンド 「/bin/sh /virtual/アカウント名/」は入力不要  

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "reset_flg" : 1 "param" : { { "no" : "1", "min" : "0", "hour" : "0", "day" : "1", "mon" : "1", "week" : "0", "sh" : "job.sh" }, { "no" : "2", "min" : "0", "hour" : "*", "day" : "*", "mon" : "*", "week" : "*", "sh" : "job2.sh" }, } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Cronジョブ削除

Request

URL

POST /v1/cron/delete

Param

key value type default 必須  
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
param          
no 1〜999 array 無し no

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "param" : { "no" [1,2,3], } }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST Xoopsインストール

Request

URL

POST /v1/cms/xoops_install

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
install_path xoops string 無し /public_html以下の設置場所・パス

※install_pathを省略した場合、/public_html直下にファイルが展開されます。

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx", "install_path" : "xoops" // /public_html/xoops に設置される }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "" }

POST WordPressインストール

Request

URL

POST /v1/cms/wp_install

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
install_path wp string 無し /public_html以下の設置場所・パス

※install_pathを省略した場合、/public_html直下にファイルが展開されます。

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx", "install_path" : "wp" // /public_html/wp に設置される }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "" }

POST phpPgAdminインストール

Request

URL

POST /v1/cms/phppgadmin_install

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST phpMyAdminインストール

Request

URL

POST /v1/cms/phpmyadmin_install

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200 "message" : "" }

POST phpAdminインストール確認

phpMyAdminと、phpPgAdminがインストールされているか確認する。

Request

URL

POST /v1/cms/phpadmin_check

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key

ParamSample

{ "account" : "xxxxxxxxxxxx" , "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , }


Response

ResponseSample

OK

{ "status_code" : 200, "result" : { "pma" : 1, // phpMyAdmin "ppa" : 0 // phpPgAdmin } }

POST MovableTypeインストール

Request

URL

POST /v1/cms/mt_install

Param

key value type default 必須 備考
account xxxxxxxxx string 無し account_id
server_name s1001.xrea.com string 無し server_name
api_secret_key xxxxxxxxx string 無し api_secret_key
install_path mt string 無し /public_html以下の設置パス
install_img_path mt-static string 無し /public_html以下の設置パス(画像ファイル)

※install_pathを省略した場合、/public_html直下にファイルが展開されます。

ParamSample

{ "account" : "xxxxxxxxxxxx", "server_name" : "s1001.xrea.com", "api_secret_key" : "xxxxxxxxxxxx" , "install_path" : "mt", // /public_html/mt に設置 "install_img_path" : "mt-static" // /public_html/mt_static に設置 }


Response

ResponseSample

OK

{ "status_code" : 200, "message" : "" }