NAV
MyIP IDC
bash php python

MyIP API 사용안내 (Introduction)

HTTP REST API를 사용해서, MyIP.co.kr 에서 제공하는 서버 및 서비스를 관리할 수 있습니다.

API 요청에 대한, 리턴 응답 Value 는 JSON 으로 제공됩니다.

API 메서드를 검색하려면 왼쪽 메뉴를 사용하시고, 코드 샘플을 확인하려면 오른쪽 메뉴를 사용하세요.

Our HTTP REST API allows you to manage vital details of your account and services in client portal. JSON is used for all API returns

Use left menu to browse trough available methods, use right menu to check required parameters, data to post and code samples in various languages.

Swagger Doc: You can download or display the JSON to generate documentation in Swagger.

API 인증 (Authentication)

1. JSON Web 토큰 인증 (Token Authentication)

curl 'https://idc.myip.co.kr/api/login' \
    -d username="username"\
    -d password="password"

# grab authentication token from the response and pass it in Authorization header
curl 'https://idc.myip.co.kr/api/details' \
    -H "Authorization: Bearer $token"
$resp = $client->post('/login', [
    'form_params' => [
        'username' => 'username',
        'password' => 'password'
    ]
]);

$token = $resp->json()['token'];

$resp = $client->get('/details', [
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

echo $resp->getBody();
payload = username
resp = requests.post('https://idc.myip.co.kr/api/login', data=payload)

headers = {
    'Authorization': 'Bearer ' + req.json().token
}
resp = requests.get('https://idc.myip.co.kr/api/details', headers=headers)
print(resp)

Make sure to replace username and password with your client area details.

웹토큰 방식 인증을 사용하려면, HTTP 헤더에 JSON Web Token(JWT) 형식으로 보내야 합니다.

API 인증 토큰을 얻으려면, 사용자 ID, Password 를 https://idc.myip.co.kr/api/login HTTP POST 방식으로 요청해야 합니다.

모든 API 호출은 Authorization: Bearer <token> 형식의 HTTP 헤더가 필요 합니다.

(예제) Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc...

To authenticate, you need to send a JSON Web Token (JWT) in the authorization header of the HTTP request.

To obtain the authorization token you need to submit a request with your username and password to POST https://idc.myip.co.kr/api/login API method

All API calls that require authentication expect HTTP header in the form of Authorization: Bearer <token>.

For example:
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc...

2. 기본 인증 방식(Basic Authentication)

# pass the correct header with each request (-u option)
curl 'https://idc.myip.co.kr/api/details' \
    -u "username:password"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'auth' => ['username', 'password']
]);

$resp = $client->get('/details');
# python requests module handles basic authentication if provided with auth parameter
payload = username
req = requests.get('https://idc.myip.co.kr/api/details', auth=('username', 'password'))
print(req.json())

Make sure to replace username and password with your client area details.

Basic Authentication 방식의 , 인증 방법은 모든 API 요청 시 사용자 이름(email address)과 비밀번호를 보내야 합니다.

인증이 필요한 API 호출은 Authorization: Basic <credentials> 형식의 헤더를 요구하며, 여기서 credentials은 콜론 : 으로 연결된 사용자 이름과 비밀번호의 Base64 인코딩 형식 입니다.

예제:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

This authentication method requires that you send your client area username (email address) and password with each request.

API calls that require authentication expect a header in the form of Authorization: Basic <credentials>, where credentials is the Base64 encoding of username and password joined by a single colon :.

For example:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

You can find more info on this authentication method here: Basic HTTP Authentication

Clientarea

Login

Generate new authorization token

POST_DATA="{
    \"username\": \"user@example.com\",
    \"password\": \"secret\"
}"

curl -X POST "https://idc.myip.co.kr/api/login" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);

$options = [
    'json' => [
        "username" => "user@example.com",
        "password" => "secret"
    ]
]
$resp = $client->post('/login', $options);
echo $resp->getBody();
payload = {
    'username': "user@example.com",
    'password': "secret"
}


req = requests.post('https://idc.myip.co.kr/api/login', json=payload)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRw(...)5lZ9T79ft9uwOkqRRmIBbtR51_w",
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMD(...)ChwIAb3zvxBu6kvULa2AwAt9U-I"
}

HTTP Request

POST /login

Query Parameters

Parameter Type Description
username string

Your acount email address

password string

Account password

Logout

Invalidate authorization token


curl -X POST "https://idc.myip.co.kr/api/logout" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->post('/logout');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/logout', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "status": true
}

HTTP Request

POST /logout

Refresh Token

Generate new authorization token using refresh token

POST_DATA="{
    \"refresh_token\": \"refresh_tokenValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);

$options = [
    'json' => [
        "refresh_token" => "refresh_tokenValue"
    ]
]
$resp = $client->post('/token', $options);
echo $resp->getBody();
payload = {
    'refresh_token': "refresh_tokenValue"
}


req = requests.post('https://idc.myip.co.kr/api/token', json=payload)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHR(...)vY2xlYiHGvauCWZD9B0VwXgHEzXDllqY",
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJBQ(...)Rmivc_u3YA_kgDqOPtUuGNXOzueXYtZw"
}

HTTP Request

POST /token

Query Parameters

Parameter Type Description
refresh_token string

Refresh token previously obtained from POST /login

Revoke Token

Invalidate authorization and refresh token. Pass refresh token or call this method with valid access token

POST_DATA="{
    \"refresh_token\": \"refresh_tokenValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/revoke" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);

$options = [
    'json' => [
        "refresh_token" => "refresh_tokenValue"
    ]
]
$resp = $client->post('/revoke', $options);
echo $resp->getBody();
payload = {
    'refresh_token': "refresh_tokenValue"
}


req = requests.post('https://idc.myip.co.kr/api/revoke', json=payload)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "status": true
}

HTTP Request

POST /revoke

Query Parameters

Parameter Type Description
refresh_token string

User Details

Return registration details for my account


curl -X GET "https://idc.myip.co.kr/api/details" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/details');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/details', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "client": {
        "id": "26",
        "email": "api@example.com",
        "lastlogin": "2016-12-30 12:24:28",
        "ip": "172.100.2.1",
        "host": "hostname",
        "firstname": "Joe",
        "lastname": "Doe",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3294",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123"
    }
}

HTTP Request

GET /details

Update User Details

Update registration details under my account

POST_DATA="{
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"phonenumber\": \"phonenumberValue\",
    \"email\": \"emailValue\",
    \"address1\": \"address1Value\",
    \"address2\": \"address2Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"country\": \"countryValue\",
    \"type\": \"typeValue\",
    \"companyname\": \"companynameValue\",
    \"companyno\": \"companynoValue\",
    \"companyphone\": \"companyphoneValue\"
}"

curl -X PUT "https://idc.myip.co.kr/api/details" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "phonenumber" => "phonenumberValue",
        "email" => "emailValue",
        "address1" => "address1Value",
        "address2" => "address2Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "country" => "countryValue",
        "type" => "typeValue",
        "companyname" => "companynameValue",
        "companyno" => "companynoValue",
        "companyphone" => "companyphoneValue"
    ]
]
$resp = $client->put('/details', $options);
echo $resp->getBody();
payload = {
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'phonenumber': "phonenumberValue",
    'email': "emailValue",
    'address1': "address1Value",
    'address2': "address2Value",
    'city': "cityValue",
    'state': "stateValue",
    'country': "countryValue",
    'type': "typeValue",
    'companyname': "companynameValue",
    'companyno': "companynoValue",
    'companyphone': "companyphoneValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.put('https://idc.myip.co.kr/api/details', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "client": {
        "id": "26",
        "email": "api@example.com",
        "lastlogin": "2016-12-30 12:34:20",
        "ip": "172.100.2.1",
        "host": "hostname",
        "firstname": "Joe",
        "lastname": "Doe",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3194",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123"
    },
    "info": [
        "client_info_updated"
    ]
}

HTTP Request

PUT /details

Query Parameters

Parameter Type Description
firstname string

First Name

lastname string

Last Name

phonenumber string

Phone

email string

Email Address

address1 string

Address 1

address2 string

Address 2

city string

City

state string

State

country string

Country

type string

Account Type

Available values: Private, Company.

companyname string

Organization - 회사이름

companyno string

사업자등록 번호

companyphone string

회사 전화번호

Get Affiliate summary


curl -X GET "https://idc.myip.co.kr/api/affiliates/summary" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/affiliates/summary');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/affiliates/summary', headers=headers)
print(req.json())

HTTP Request

GET /affiliates/summary

Get Affiliate campaigns


curl -X GET "https://idc.myip.co.kr/api/affiliates/campaigns" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/affiliates/campaigns');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/affiliates/campaigns', headers=headers)
print(req.json())

HTTP Request

GET /affiliates/campaigns

Get Affiliate commissions


curl -X GET "https://idc.myip.co.kr/api/affiliates/commissions" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/affiliates/commissions');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/affiliates/commissions', headers=headers)
print(req.json())

HTTP Request

GET /affiliates/commissions

Get Affiliate payouts


curl -X GET "https://idc.myip.co.kr/api/affiliates/payouts" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/affiliates/payouts');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/affiliates/payouts', headers=headers)
print(req.json())

HTTP Request

GET /affiliates/payouts

Get Affiliate vouchers


curl -X GET "https://idc.myip.co.kr/api/affiliates/vouchers" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/affiliates/vouchers');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/affiliates/vouchers', headers=headers)
print(req.json())

HTTP Request

GET /affiliates/vouchers

Get Affiliate commission plans


curl -X GET "https://idc.myip.co.kr/api/affiliates/commissionplans" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/affiliates/commissionplans');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/affiliates/commissionplans', headers=headers)
print(req.json())

HTTP Request

GET /affiliates/commissionplans

List contacts

Return a list of contacts on this account


curl -X GET "https://idc.myip.co.kr/api/contact" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/contact');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/contact', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "contacts": [
        {
            "email": "mary@example.com",
            "id": "49",
            "firstname": "Mary",
            "lastname": "Sue",
            "companyname": "",
            "company": "0",
            "lastlogin": "0000-00-00 00:00:00"
        }
    ]
}

HTTP Request

GET /contact

Add contact

Create new contact account, if password is provided you can use provided email addres to login as that contact.

POST_DATA="{
    \"password\": \"passwordValue\",
    \"privileges\": \"privilegesValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"phonenumber\": \"phonenumberValue\",
    \"email\": \"emailValue\",
    \"address1\": \"address1Value\",
    \"address2\": \"address2Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"country\": \"countryValue\",
    \"type\": \"typeValue\",
    \"companyname\": \"companynameValue\",
    \"companyno\": \"companynoValue\",
    \"companyphone\": \"companyphoneValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/contact" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "password" => "passwordValue",
        "privileges" => "privilegesValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "phonenumber" => "phonenumberValue",
        "email" => "emailValue",
        "address1" => "address1Value",
        "address2" => "address2Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "country" => "countryValue",
        "type" => "typeValue",
        "companyname" => "companynameValue",
        "companyno" => "companynoValue",
        "companyphone" => "companyphoneValue"
    ]
]
$resp = $client->post('/contact', $options);
echo $resp->getBody();
payload = {
    'password': "passwordValue",
    'privileges': "privilegesValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'phonenumber': "phonenumberValue",
    'email': "emailValue",
    'address1': "address1Value",
    'address2': "address2Value",
    'city': "cityValue",
    'state': "stateValue",
    'country': "countryValue",
    'type': "typeValue",
    'companyname': "companynameValue",
    'companyno': "companynoValue",
    'companyphone': "companyphoneValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/contact', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "contact_id": "1",        
    "info": [
        "profile_added"
    ]
}

HTTP Request

POST /contact

Query Parameters

Parameter Type Description
password string

Optional, allows you to login as contact

privileges array

Array with privileges that you want to enable. Formatted the same way as output from GET /contact/privileges

firstname string

First Name

lastname string

Last Name

phonenumber string

Phone

email string

Email Address

address1 string

Address 1

address2 string

Address 2

city string

City

state string

State

country string

Country

type string

Account Type

Available values: Private, Company.

companyname string

Organization - 회사이름

companyno string

사업자등록 번호

companyphone string

회사 전화번호

Contact privileges

List possible contact privileges. Each domain and service may list additional privileges, depending on available features.


curl -X GET "https://idc.myip.co.kr/api/contact/privileges" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/contact/privileges');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/contact/privileges', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "privileges": {
        "billing": [
            "emails", // Receive billing notifications
            "payinvoice", // Allow to view/pay invoices
            "orders", // Allow to place new orders
            "balance", // View account balance
            "addfunds", // Add account funds
            "creditcard" // Edit Credit Card details
        ],
        "support": [
            "newticket", // Open new tickets
            "tickets", // View all tickets
            "closeticket", // Close tickets
            "emails" // Receive email notifications from support
        ],
        "misc": [
            "editmain", // Modify main profile details
            "emails", // View emails history
            "editipaccess", // Edit allowed IP access
            "manageprofiles", // Add / Edit contacts
            "affiliates" // Access affiliates section
        ],
        "services": {
            "full": 1, // Full control over services
            "332": [
                "basic", // View basic details
                "billing", // View billing info
                "cancelation", // Request cancellation
                "upgrade", // Upgrade / Downgrade
                "notify", // Receive related email notifications  
                (...)
                "logindetails"
            ]
        },
        "domains": {
            "full": 1, // Full control over domains
            "523": [
                "basic", // View basic details
                "renew", // Renew domain
                "notify", // Receive related email notifications  
                "contactinfo", // Contact Information
                (...)
                "nameservers" // Manage Nameservers
            ]
        }
    }
}

HTTP Request

GET /contact/privileges

Get contacts details

Return array with contact details


curl -X GET "https://idc.myip.co.kr/api/contact/@id" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/contact/@id');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/contact/@id', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "contact": {
        "id": "49",
        "email": "mary@example.com",
        "firstname": "Mary",
        "lastname": "Sue",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3194",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123",
        "type": "Private",
        "privileges" : {
            "support" : ["tickets", "newticket"]
        }
    }
}

HTTP Request

GET /contact/@id

Query Parameters

Parameter Type Description
id int

Contact ID

Edit contact

Change contact details`

POST_DATA="{
    \"privileges\": \"privilegesValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"phonenumber\": \"phonenumberValue\",
    \"email\": \"emailValue\",
    \"address1\": \"address1Value\",
    \"address2\": \"address2Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"country\": \"countryValue\",
    \"type\": \"typeValue\",
    \"companyname\": \"companynameValue\",
    \"companyno\": \"companynoValue\",
    \"companyphone\": \"companyphoneValue\"
}"

curl -X PUT "https://idc.myip.co.kr/api/contact/@id" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "privileges" => "privilegesValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "phonenumber" => "phonenumberValue",
        "email" => "emailValue",
        "address1" => "address1Value",
        "address2" => "address2Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "country" => "countryValue",
        "type" => "typeValue",
        "companyname" => "companynameValue",
        "companyno" => "companynoValue",
        "companyphone" => "companyphoneValue"
    ]
]
$resp = $client->put('/contact/@id', $options);
echo $resp->getBody();
payload = {
    'privileges': "privilegesValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'phonenumber': "phonenumberValue",
    'email': "emailValue",
    'address1': "address1Value",
    'address2': "address2Value",
    'city': "cityValue",
    'state': "stateValue",
    'country': "countryValue",
    'type': "typeValue",
    'companyname': "companynameValue",
    'companyno': "companynoValue",
    'companyphone': "companyphoneValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.put('https://idc.myip.co.kr/api/contact/@id', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "info": [
        "profile_updated"
    ]
}

HTTP Request

PUT /contact/@id

Query Parameters

Parameter Type Description
id int
privileges array

Array with privileges that you want to enable. Formatted the same way as output from GET /contact/privileges

firstname string

First Name

lastname string

Last Name

phonenumber string

Phone

email string

Email Address

address1 string

Address 1

address2 string

Address 2

city string

City

state string

State

country string

Country

type string

Account Type

Available values: Private, Company.

companyname string

Organization - 회사이름

companyno string

사업자등록 번호

companyphone string

회사 전화번호

List all portal notifications

Return a list of all portal notifications.


curl -X GET "https://idc.myip.co.kr/api/notifications" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/notifications');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/notifications', headers=headers)
print(req.json())

HTTP Request

GET /notifications

Query Parameters

Parameter Type Description
rel_type string

Optional, return only by relation type

rel_id string

Optional, return only by relation id

List new portal notifications

Return only new portal notifications.


curl -X GET "https://idc.myip.co.kr/api/notifications/new" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/notifications/new');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/notifications/new', headers=headers)
print(req.json())

HTTP Request

GET /notifications/new

Query Parameters

Parameter Type Description
rel_type string

Optional, return only by relation type

rel_id string

Optional, return only by relation id

Acknowledge notification

Marks the notification as read


curl -X PUT "https://idc.myip.co.kr/api/notifications/@id/ack" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->put('/notifications/@id/ack');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.put('https://idc.myip.co.kr/api/notifications/@id/ack', headers=headers)
print(req.json())

HTTP Request

PUT /notifications/@id/ack

Query Parameters

Parameter Type Description
id int

Billing

Account balance

Get current account balance(unpaid invoices total), account credit


curl -X GET "https://idc.myip.co.kr/api/balance" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/balance');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/balance', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    {
        "success": true,
        "details": {
            "currency": "USD",
            "acc_balance": "123456.55",
            "acc_credit": "0.00"
        }
    }
}

HTTP Request

GET /balance

List Invoices

List all invoices under my account


curl -X GET "https://idc.myip.co.kr/api/invoice" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/invoice');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/invoice', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "invoices": [
        {
            "id": "308976",
            "date": "2016-12-30",
            "dateorig": "2016-12-30",
            "duedate": "2017-01-06",
            "paybefore": "2017-01-06",
            "total": "19.65",
            "datepaid": "2016-12-30 12:40:47",
            "status": "Paid",
            "merge_id": null,
            "number": "2016\/12\/1",
            "currency": "USD"
        }
    ]
}

HTTP Request

GET /invoice

Invoice Details

Get invoice details


curl -X GET "https://idc.myip.co.kr/api/invoice/@id" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/invoice/@id');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/invoice/@id', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "invoice": {
        "id": "308976",
        "status": "Paid",
        "date": "2016-12-30",
        "duedate": "2017-01-06",
        "paybefore": "2017-01-06",
        "datepaid": "2016-12-30 12:40:47",
        "subtotal": 16.24,
        "credit": 0,
        "tax": 3.41,
        "taxrate": 21,
        "tax2": 0,
        "taxrate2": 0,
        "taxexempt": "0",
        "total": 19.65,
        "rate": 1,
        "rate2": 0,
        "rate3": 1,
        "notes": "",
        "items": [
            {
                "id": "12305",
                "invoice_id": "308976",
                "type": "Other",
                "item_id": "0",
                "description": "Example Service",
                "amount": "15.00",
                "taxed": "1",
                "qty": "1.00",
                "linetotal": "15.00"
            },
            {
                "id": "12309",
                "invoice_id": "308976",
                "type": "Other",
                "item_id": "-2",
                "description": "PayPal Payment Fee",
                "amount": "1.24",
                "taxed": "1",
                "qty": "1.00",
                "linetotal": "1.24"
            }
        ],
        "client": {
            "id": "26",
            "email": "api@example.com",
            "firstname": "Joe",
            "lastname": "Doe",
            "companyname": "",
            "address1": "Pretty View Lane",
            "address2": "3194",
            "city": "Santa Rosa",
            "state": "California",
            "postcode": "95401",
            "country": "US",
            "phonenumber": "+1.24123123"
        },
        "number": "2016\/12\/1",
        "currency": "USD"
    }
}

HTTP Request

GET /invoice/@id

Query Parameters

Parameter Type Description
id int

Apply credit

Apply account credit to invoice

POST_DATA="{
    \"amount\": \"amountValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/invoice/@id/credit" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "amount" => "amountValue"
    ]
]
$resp = $client->post('/invoice/@id/credit', $options);
echo $resp->getBody();
payload = {
    'amount': "amountValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/invoice/@id/credit', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "success": true,
    "invoice_status": "Paid",
    "applied": 2.1
}

HTTP Request

POST /invoice/@id/credit

Query Parameters

Parameter Type Description
id int
amount decimal

Optional credit amount, when no value is specified maximum amount to fully pay the invoice will be used

Payment Methods

List available payment methods


curl -X GET "https://idc.myip.co.kr/api/payment" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/payment');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/payment', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "payments": {
        "10": "BankTransfer",
        "9": "PayPal"
    }
}

HTTP Request

GET /payment

Payment Methods Fees

List available payment methods with fees


curl -X GET "https://idc.myip.co.kr/api/payment/fees" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/payment/fees');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/payment/fees', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "payments": [
        {
            "id": 1,
            "name": "Bank Transfer",
            "fixed_fee": "0.0",
            "percent_fee": "0.0",
        },
        {
            "id": 2,
            "name": "Stripe",
            "fixed_fee": "0.5",
            "percent_fee": "2.9",
        },
        {
            "id": 4,
            "name": "Credit Card",
            "fixed_fee": "0.1",
            "percent_fee": "2.4"
        },
        {
            "id": 5,
            "name": "PayPal",
            "fixed_fee": "0.3",
            "percent_fee": "2.9"
        }
    ]
}

HTTP Request

GET /payment/fees

Support

List Tickets

List support tickets under my account


curl -X GET "https://idc.myip.co.kr/api/tickets" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/tickets');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/tickets', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "tickets": [
        {
            "client_read": "1",
            "ticket_number": "736633",
            "date": "2016-12-30 12:48:13",
            "deptname": "Billing",
            "subject": "Lore Ipsum",
            "status": "Open"
        }
    ]
}

HTTP Request

GET /tickets

Ticket details

Get ticket details, including all replies


curl -X GET "https://idc.myip.co.kr/api/tickets/@number" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/tickets/@number');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/tickets/@number', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "ticket": {
        "date": "2016-12-30 12:48:13",
        "ticket_number": "736633",
        "name": "Joe Doe",
        "email": "api@example.com",
        "subject": "Lore Ipsum",
        "body": "Donec sollicitudin molestie malesuada. \r\nSed porttitor lectus nibh. Vivamus magna justo, \r\nlacinia eget consectetur sed, convallis at tellus.",
        "status": "Answered",
        "client_read": "1",
        "deptname": "Billing"
    },
    "replies": [
        {
            "id": "929",
            "name": "Suppport Staff",
            "date": "2016-12-30 12:51:04",
            "body": "Vestibulum ac diam sit amet quam \r\nvehicula elementum sed sit amet dui. \r\nPraesent sapien massa\r\n\r\n-- Maecenas efficitur elit est --",
            "status": "Sent",
            "type": "Admin"
        }
    ]
}

HTTP Request

GET /tickets/@number

Query Parameters

Parameter Type Description
number int

Ticket number

Ticket attachment

Get ticket attachment


curl -X GET "https://idc.myip.co.kr/api/ticket/attachment/@file" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/ticket/attachment/@file');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/ticket/attachment/@file', headers=headers)
print(req.json())

HTTP Request

GET /ticket/attachment/@file

Query Parameters

Parameter Type Description
number int

Ticket number

file string

Attachment id

Create Ticket

Submit new ticket

POST_DATA="{
    \"dept_id\": 1,
    \"subject\": \"Subject\",
    \"body\": \"Message ...\"
}"

curl -X POST "https://idc.myip.co.kr/api/tickets" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "dept_id" => 1,
        "subject" => "Subject",
        "body" => "Message ..."
    ]
]
$resp = $client->post('/tickets', $options);
echo $resp->getBody();
payload = {
    'dept_id': 1,
    'subject': "Subject",
    'body': "Message ..."
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/tickets', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "ticket": 865650
}

HTTP Request

POST /tickets

Query Parameters

Parameter Type Description
dept_id int

Department id

subject string

Ticket subject

body string

Ticket message

Create Reply

Reply to ticket

POST_DATA="{
    \"body\": \"reply text ..\"
}"

curl -X POST "https://idc.myip.co.kr/api/tickets/@number" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "body" => "reply text .."
    ]
]
$resp = $client->post('/tickets/@number', $options);
echo $resp->getBody();
payload = {
    'body': "reply text .."
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/tickets/@number', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "info": [
        "reply_added"
    ]
}

HTTP Request

POST /tickets/@number

Query Parameters

Parameter Type Description
number int

Ticket number

body string

Reply message

Re-open ticket

Try to re-open closed ticket


curl -X PUT "https://idc.myip.co.kr/api/tickets/@number/open" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->put('/tickets/@number/open');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.put('https://idc.myip.co.kr/api/tickets/@number/open', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "status": true
}

HTTP Request

PUT /tickets/@number/open

Query Parameters

Parameter Type Description
number int

Ticket number

Close ticket

Send request to close a ticket


curl -X PUT "https://idc.myip.co.kr/api/tickets/@number/close" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->put('/tickets/@number/close');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.put('https://idc.myip.co.kr/api/tickets/@number/close', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "status": true
}

HTTP Request

PUT /tickets/@number/close

Query Parameters

Parameter Type Description
number int

Ticket number

List ticket departments

Get the list of ticket departments


curl -X GET "https://idc.myip.co.kr/api/ticket/departments" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/ticket/departments');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/ticket/departments', headers=headers)
print(req.json())

HTTP Request

GET /ticket/departments

Services

List services

List all services under your account


curl -X GET "https://idc.myip.co.kr/api/service" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "services": [
        {
            "id": "301",
            "domain": "examplename.com",
            "total": "9.99",
            "status": "Pending",
            "billingcycle": "Monthly",
            "next_due": "2017-12-30",
            "category": "Hosting",
            "category_url": "hosting",
            "name": "Starter Hosting"
        }
    ]
}

HTTP Request

GET /service

Service details

Return details for service @id


curl -X GET "https://idc.myip.co.kr/api/service/@id" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "service": {
        "id": "301",
        "date_created": "2016-12-30",
        "domain": "examplename.com",
        "firstpayment": "9.99",
        "total": "9.99",
        "billingcycle": "Monthly",
        "next_due": "2017-12-30",
        "next_invoice": "2017-01-27",
        "status": "Active",
        "label": "",
        "username": "examplen",
        "password": "pdtzc",
        "name": "Starter Hosting"
    }
}

HTTP Request

GET /service/@id

Query Parameters

Parameter Type Description
id int

Service id

List service methods

List methods available for service


curl -X GET "https://idc.myip.co.kr/api/service/@id/methods" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/methods');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/methods', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "methods": [
        {
            "name": "Upgrade Request",
            "method": "POST",
            "route": "\/service\/@id\/upgrade"
        },
        {
            "name": "Upgrade Options",
            "method": "GET",
            "route": "\/service\/@id\/upgrade"
        },
        {
            "name": "Change service label",
            "method": "POST",
            "route": "\/service\/@id\/label"
        },
        {
            "name": "Service label",
            "method": "GET",
            "route": "\/service\/@id\/label"
        },
        {
            "name": "Cancel Service",
            "method": "POST",
            "route": "\/service\/@id\/cancel"
        }
    ]
}

HTTP Request

GET /service/@id/methods

Query Parameters

Parameter Type Description
id int

Upgrade Options

List upgrade options


curl -X GET "https://idc.myip.co.kr/api/service/@id/upgrade" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/upgrade');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/upgrade', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "resources": [
        {
            "id": 1557,
            "name": "Bandwidth",
            "type": "select",
            "items": [
                {
                    "id": "9953",
                    "name": "100 GB",
                    "price": 1,
                    "setup_price": 0,
                    "selected": true
                },
                {
                    "id": "10103",
                    "name": "500 GB",
                    "price": 5,
                    "setup_price": 0,
                    "selected": false
                },
                {
                    "id": "10104",
                    "name": "1 TB",
                    "price": 10,
                    "setup_price": 0,
                    "selected": false
                }
            ]
        }
    ],
    "package": []
}

HTTP Request

GET /service/@id/upgrade

Query Parameters

Parameter Type Description
id int

Upgrade Request

Estimate or request upgrade

// Format of ''resources'' paremeter
{
    "resource_id" : "qty_value", // sliders & qty fields
    "resource_id" : "item_id", // dropdown & radio fields
    "resource_id" : {
        "item_id": "qty_value" // dropdown with qty field
    }
}
POST_DATA="{
    \"resources\": \"resourcesValue\",
    \"package\": \"packageValue\",
    \"cycle\": \"cycleValue\",
    \"send\": \"sendValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/upgrade" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "resources" => "resourcesValue",
        "package" => "packageValue",
        "cycle" => "cycleValue",
        "send" => "sendValue"
    ]
]
$resp = $client->post('/service/@id/upgrade', $options);
echo $resp->getBody();
payload = {
    'resources': "resourcesValue",
    'package': "packageValue",
    'cycle': "cycleValue",
    'send': "sendValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/upgrade', json=payload, headers=headers)
print(req.json())

HTTP Request

POST /service/@id/upgrade

Query Parameters

Parameter Type Description
id int

Service id

resources array

array with resource values

package int

New package id, optonal when upgrading resources

cycle string

New billing cycle, optonal when upgrading resources

send boolean

Set to true when you want to send your upgrade request

Cancel Service

Request service cancellation

POST_DATA="{
    \"immediate\": \"immediateValue\",
    \"reason\": \"reasonValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/cancel" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "immediate" => "immediateValue",
        "reason" => "reasonValue"
    ]
]
$resp = $client->post('/service/@id/cancel', $options);
echo $resp->getBody();
payload = {
    'immediate': "immediateValue",
    'reason': "reasonValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/cancel', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
  "info": [
    "cancell_sent"
  ]
}

HTTP Request

POST /service/@id/cancel

Query Parameters

Parameter Type Description
id int

Service id

immediate string

set to false to terminate service at the end of billing date, true - terminate immediately

reason string

Reason for this request

Service label

Show current service label


curl -X GET "https://idc.myip.co.kr/api/service/@id/label" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/label');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/label', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "label": "example"
}

HTTP Request

GET /service/@id/label

Query Parameters

Parameter Type Description
id int

Service id

Change service label

Set new custom label to identify this service

POST_DATA="{
    \"label\": \"labelValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/label" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "label" => "labelValue"
    ]
]
$resp = $client->post('/service/@id/label', $options);
echo $resp->getBody();
payload = {
    'label': "labelValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/label', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "success": true,
    "info": [
        "label_updated"
    ]
}

HTTP Request

POST /service/@id/label

Query Parameters

Parameter Type Description
id int

Service id

label string

New label

PDU ports

List PDU ports assigned to service


curl -X GET "https://idc.myip.co.kr/api/service/@id/pdu" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);


$resp = $client->get('/service/@id/pdu');
echo $resp->getBody();


req = requests.get('https://idc.myip.co.kr/api/service/@id/pdu')
print(req.json())

HTTP Request

GET /service/@id/pdu

Query Parameters

Parameter Type Description
id int

Service id

PDU Port state

Get PDU port/outlet state


curl -X GET "https://idc.myip.co.kr/api/service/@id/pdu/@port" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);


$resp = $client->get('/service/@id/pdu/@port');
echo $resp->getBody();


req = requests.get('https://idc.myip.co.kr/api/service/@id/pdu/@port')
print(req.json())

HTTP Request

GET /service/@id/pdu/@port

Query Parameters

Parameter Type Description
id int

Service id

port int

Port id

Set PDU port status

Set PDU port/outlet state

POST_DATA="{
    \"power\": \"powerValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/pdu/@port" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);

$options = [
    'json' => [
        "power" => "powerValue"
    ]
]
$resp = $client->post('/service/@id/pdu/@port', $options);
echo $resp->getBody();
payload = {
    'power': "powerValue"
}


req = requests.post('https://idc.myip.co.kr/api/service/@id/pdu/@port', json=payload)
print(req.json())

HTTP Request

POST /service/@id/pdu/@port

Query Parameters

Parameter Type Description
id int

Service id

port int

Port id

power bool

Desired power state - 'true' for ON or 'false' for OFF

IP Addresses

List Service IP Addresses


curl -X GET "https://idc.myip.co.kr/api/service/@id/ip" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/ip');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/ip', headers=headers)
print(req.json())

HTTP Request

GET /service/@id/ip

Query Parameters

Parameter Type Description
id int

Service ID

Reverse DNS

Get reverse DNS entries for service's IP addresses


curl -X GET "https://idc.myip.co.kr/api/service/@id/rdns" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/rdns');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/rdns', headers=headers)
print(req.json())

HTTP Request

GET /service/@id/rdns

Query Parameters

Parameter Type Description
id int

Service ID

Update rDNS

Update reverse DNS entries service's IP addresses

POST_DATA="{
    \"ipaddress\": \"ipaddressValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/rdns" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "ipaddress" => "ipaddressValue"
    ]
]
$resp = $client->post('/service/@id/rdns', $options);
echo $resp->getBody();
payload = {
    'ipaddress': "ipaddressValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/rdns', json=payload, headers=headers)
print(req.json())

HTTP Request

POST /service/@id/rdns

Query Parameters

Parameter Type Description
id int

Service ID

ipaddress array

Use Ip address as parameter key and hostname as value

Bandwidth Graph

Return base64 encoded images representing bandwidth usage for last day, week and month


curl -X GET "https://idc.myip.co.kr/api/service/@id/bandwidth-graphs" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);


$resp = $client->get('/service/@id/bandwidth-graphs');
echo $resp->getBody();


req = requests.get('https://idc.myip.co.kr/api/service/@id/bandwidth-graphs')
print(req.json())

HTTP Request

GET /service/@id/bandwidth-graphs

Query Parameters

Parameter Type Description
id int

Bandwidth Usage

Return bandwidth usage and billing details


curl -X GET "https://idc.myip.co.kr/api/service/@id/bandwidth" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);


$resp = $client->get('/service/@id/bandwidth');
echo $resp->getBody();


req = requests.get('https://idc.myip.co.kr/api/service/@id/bandwidth')
print(req.json())

HTTP Request

GET /service/@id/bandwidth

Query Parameters

Parameter Type Description
id int

List VMs

List virtual servers


curl -X GET "https://idc.myip.co.kr/api/service/@id/vms" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/vms');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/vms', headers=headers)
print(req.json())

HTTP Request

GET /service/@id/vms

Query Parameters

Parameter Type Description
id int

Get VM Details

Get the details of a particular virtual server


curl -X GET "https://idc.myip.co.kr/api/service/@id/vms/@vmid" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/vms/@vmid');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/vms/@vmid', headers=headers)
print(req.json())

HTTP Request

GET /service/@id/vms/@vmid

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Create VM

Add new virtual server

POST_DATA="{
    \"label\": \"labelValue\",
    \"template\": \"templateValue\",
    \"memory\": \"memoryValue\",
    \"cpu\": \"cpuValue\",
    \"disk\": \"diskValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/vms" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "label" => "labelValue",
        "template" => "templateValue",
        "memory" => "memoryValue",
        "cpu" => "cpuValue",
        "disk" => "diskValue"
    ]
]
$resp = $client->post('/service/@id/vms', $options);
echo $resp->getBody();
payload = {
    'label': "labelValue",
    'template': "templateValue",
    'memory': "memoryValue",
    'cpu': "cpuValue",
    'disk': "diskValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/vms', json=payload, headers=headers)
print(req.json())

HTTP Request

POST /service/@id/vms

Query Parameters

Parameter Type Description
id int
label string

VM label

template string

Template ID

memory string

Amount of RAM memory in MB

cpu string

Amount of CPU cores

disk string

Disk Space in GB

Destroy VM

Remove virtual server


curl -X DELETE "https://idc.myip.co.kr/api/service/@id/vms/@vmid" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->delete('/service/@id/vms/@vmid');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.delete('https://idc.myip.co.kr/api/service/@id/vms/@vmid', headers=headers)
print(req.json())

HTTP Request

DELETE /service/@id/vms/@vmid

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Resize VM

Edit a virtual server

POST_DATA="{
    \"memory\": \"memoryValue\",
    \"cpu\": \"cpuValue\"
}"

curl -X PUT "https://idc.myip.co.kr/api/service/@id/vms/@vmid" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "memory" => "memoryValue",
        "cpu" => "cpuValue"
    ]
]
$resp = $client->put('/service/@id/vms/@vmid', $options);
echo $resp->getBody();
payload = {
    'memory': "memoryValue",
    'cpu': "cpuValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.put('https://idc.myip.co.kr/api/service/@id/vms/@vmid', json=payload, headers=headers)
print(req.json())

HTTP Request

PUT /service/@id/vms/@vmid

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

memory string

Amount of RAM in MB

cpu string

Amount of CPU cores

Stop VM

Stop virtual server


curl -X POST "https://idc.myip.co.kr/api/service/@id/vms/@vmid/stop" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->post('/service/@id/vms/@vmid/stop');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/vms/@vmid/stop', headers=headers)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/stop

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Start VM

Start virtual servers


curl -X POST "https://idc.myip.co.kr/api/service/@id/vms/@vmid/start" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->post('/service/@id/vms/@vmid/start');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/vms/@vmid/start', headers=headers)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/start

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Shutdown VM

Perform graceful shutdown


curl -X POST "https://idc.myip.co.kr/api/service/@id/vms/@vmid/shutdown" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->post('/service/@id/vms/@vmid/shutdown');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/vms/@vmid/shutdown', headers=headers)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/shutdown

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Reboot VM

Reboot virtual servers


curl -X POST "https://idc.myip.co.kr/api/service/@id/vms/@vmid/reboot" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->post('/service/@id/vms/@vmid/reboot');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/vms/@vmid/reboot', headers=headers)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/reboot

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Reset VM

Reset virtual servers power


curl -X POST "https://idc.myip.co.kr/api/service/@id/vms/@vmid/reset" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->post('/service/@id/vms/@vmid/reset');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/vms/@vmid/reset', headers=headers)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/reset

Query Parameters

Parameter Type Description
id int
vmid string

Virtual server id

Rebuild VM

Rebuild server, you can get list of templates supported by this server using '''/service/$id/vms/$vmid/rebuild'''

POST_DATA="{
    \"template\": \"templateValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/vms/@vmid/rebuild" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "template" => "templateValue"
    ]
]
$resp = $client->post('/service/@id/vms/@vmid/rebuild', $options);
echo $resp->getBody();
payload = {
    'template': "templateValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@id/vms/@vmid/rebuild', json=payload, headers=headers)
print(req.json())

HTTP Request

POST /service/@id/vms/@vmid/rebuild

Query Parameters

Parameter Type Description
id int
vmid int
template string

Template ID

List OS templates

List templates that can be used to create virtual server


curl -X GET "https://idc.myip.co.kr/api/service/@id/templates" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/templates');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/templates', headers=headers)
print(req.json())

HTTP Request

GET /service/@id/templates

Query Parameters

Parameter Type Description
id int

Resources

Show available and used resources


curl -X GET "https://idc.myip.co.kr/api/service/@id/resources" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@id/resources');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@id/resources', headers=headers)
print(req.json())

HTTP Request

GET /service/@id/resources

Query Parameters

Parameter Type Description
id int

Cart

Most of API methods found here will require service @id, you can lookup your service ids with /service method

Get order quote

Calculate order cost and recuring prices for selected items. Use the same parameters as for POST /order

POST_DATA="{
    \"pay_method\": \"pay_methodValue\",
    \"items\": [
        {
            \"type\": \"product\",
            \"product_id\": 1080,
            \"domain\": \"hosting.com\",
            \"cycle\": \"a\"
        }
    ]
}"

curl -X POST "https://idc.myip.co.kr/api/quote" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "pay_method" => "pay_methodValue",
        "items" => [
            [
                "type" => "product",
                "product_id" => 1080,
                "domain" => "hosting.com",
                "cycle" => "a"
            ]
        ]
    ]
]
$resp = $client->post('/quote', $options);
echo $resp->getBody();
payload = {
    'pay_method': "pay_methodValue",
    'items': [
        {
            'type': "product",
            'product_id': 1080,
            'domain': "hosting.com",
            'cycle': "a"
        }
    ]
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/quote', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "summary": {
        "subtotal": 72.2,
        "total": 88.81,
        "credit": 0,
        "discount": 0,
        "cost": 72.2,
        "recurring": [
            {
                "title": "Annually",
                "price": 81.18,
                "value": "a"
            },
            {
                "title": "Monthly",
                "price": 1.48,
                "value": "m"
            }
        ],
        "tax": [
            {
                "name": "VAT",
                "tax": 16.61,
                "value": 23
            }
        ]
    },
    "items": [
        {
            "product": {
                "id": 1080,
                "category_name": "SSL",
                "category_id": 69,
                "name": "GeoTrust QuickSSL Premium",
                "domain": "test.api",
                (...)
            },
            "domains": {
                (...)
            },
            "coupon": {},
            "index": 0,
            "valid": true,
            "info": [],
            "error": []
        },
        {
            "product": {
                "id": 840,
                "category_name": "Proxmox",
                "category_id": 19,
                "name": "VPS",
                "domain": "user.test.api",
                (...)
            },
            "domains": {
                (...)
            },
            "coupon": {},
            "index": 1,
            "valid": true,
            "info": [],
            "error": []
        },
        {
            "product": null,
            "domains": {
                "hosting.com": {
                    "id": 6,
                    "index": 0,
                    "category_id": "6",
                    "category_name": "Domains",
                    "name": "hosting.com",
                    "tld": ".com",
                    "period": 1,
                    "price": "12.00",
                    (...) 
                }
            },
            "coupon": {},
            "index": 2,
            "valid": true,
            "info": [],
            "error": []
        }
    ]
}

HTTP Request

POST /quote

Query Parameters

Parameter Type Description
pay_method int

Payment method ID

items array

list with order items

List product categories

Return a list of product categories.


curl -X GET "https://idc.myip.co.kr/api/category" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/category');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/category', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "categories": [
        {
            "id": "10",
            "name": "Hosting",
            "description": "",
            "slug": "hosting"
        },
        {
            "id": "6",
            "name": "Domains",
            "description": "",
            "slug": "domains"
        },
        {
            "id": "16",
            "name": "Dedicated",
            "description": "",
            "slug": "dedicated"
        }
    ]
}

HTTP Request

GET /category

Order new service

Create and submit new order for selected product.

To get available cycle and configuration options lookup product details using GET /order/@product_id

POST_DATA="{
    \"domain\": \"domainValue\",
    \"cycle\": \"cycleValue\",
    \"pay_method\": \"pay_methodValue\",
    \"custom\": \"customValue\",
    \"promocode\": \"promocodeValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/order/@product_id" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "domain" => "domainValue",
        "cycle" => "cycleValue",
        "pay_method" => "pay_methodValue",
        "custom" => "customValue",
        "promocode" => "promocodeValue"
    ]
]
$resp = $client->post('/order/@product_id', $options);
echo $resp->getBody();
payload = {
    'domain': "domainValue",
    'cycle': "cycleValue",
    'pay_method': "pay_methodValue",
    'custom': "customValue",
    'promocode': "promocodeValue"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/order/@product_id', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "order_num": 873340995,
    "invoice_id": "308979",
    "total": "9.99",
    "items": {
        "id": "10",
        "type": "Hosting",
        "name": "test.com",
        "product_id": "3"
    }
}

HTTP Request

POST /order/@product_id

Query Parameters

Parameter Type Description
product_id int

Product ID

domain string

Domain name, ie. example.com, may be optional

cycle string

Billing period symbol

pay_method int

Payment method ID

custom array

Additional options data available for sop products

promocode string

Promotion code

DNS

List DNS

Returns a list of all DNS


curl -X GET "https://idc.myip.co.kr/api/dns" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/dns');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/dns', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "service_ids": [
        "10",
        "20"
    ],
    "zones": [
        {
            "domain_id": "60",
            "name": "booble.com",
            "service_id": "10"
        },
        {
            "domain_id": "61",
            "name": "bgg12ooble.com",
            "service_id": "20"
        }
    ]
}

HTTP Request

GET /dns

Add DNS Zone

Creates a new DNS zone

POST_DATA="{
    \"name\": \"testzone.com\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@service_id/dns" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "name" => "testzone.com"
    ]
]
$resp = $client->post('/service/@service_id/dns', $options);
echo $resp->getBody();
payload = {
    'name': "testzone.com"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@service_id/dns', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "info": [
        "Domain zone testzone.com was created successfully."
    ]
}

HTTP Request

POST /service/@service_id/dns

Query Parameters

Parameter Type Description
service_id int

Service ID

name string

Zone name

List DNS for service

Returns a list of DNS zones under the service


curl -X GET "https://idc.myip.co.kr/api/service/@service_id/dns" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@service_id/dns');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@service_id/dns', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "error": [
        "invalid method"
    ]
}

HTTP Request

GET /service/@service_id/dns

Query Parameters

Parameter Type Description
service_id int

Service ID

Get DNS details

Returns details of the DNS zone


curl -X GET "https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->get('/service/@service_id/dns/@zone_id');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.get('https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "service_id": 10,
    "name": "booble.com",
    "records": [
      {
        "id":"10",
        "name":"qwerty",
        "ttl":1800,
        "priority":0,
        "content":"127.0.0.1",
        "type":"A"
      },
      {
        "id":"11",
        "name":"qwerty",
        "ttl":1800,
        "priority":0,
        "content":"ns1.qwerty.com",
        "type":"NS"
      }
    ]
}

HTTP Request

GET /service/@service_id/dns/@zone_id

Query Parameters

Parameter Type Description
service_id int

Service ID

zone_id int

Zone ID

Remove DNS zone

Deletes the selected DNS zone


curl -X DELETE "https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->delete('/service/@service_id/dns/@zone_id');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.delete('https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id', headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
   "info": [
     "Domain zone testzone.com was deleted successfully."
   ]
}

HTTP Request

DELETE /service/@service_id/dns/@zone_id

Query Parameters

Parameter Type Description
service_id int

Service ID

zone_id int

Zone ID

Add DNS Record

Creates a new record in the DNS zone

POST_DATA="{
    \"name\": \"example.com\",
    \"ttl\": 3600,
    \"priority\": 10,
    \"type\": \"A\",
    \"content\": \"192.168.1.2\"
}"

# OR ...

POST_DATA="{
    \"name\": \"_sip._tcp.example.com\",
    \"ttl\": 3600,
    \"priority\": 10,
    \"type\": \"SRV\",
    \"content\": [
        10,
        5060,
        \"vc01.example.com\"
    ]
}"

curl -X POST "https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id/records" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "name" => "example.com",
        "ttl" => 3600,
        "priority" => 10,
        "type" => "A",
        "content" => "192.168.1.2"
    ]
]);

// OR ...

$options = [
    'json' => [
        "name" => "_sip._tcp.example.com",
        "ttl" => 3600,
        "priority" => 10,
        "type" => "SRV",
        "content" => [
            10,
            5060,
            "vc01.example.com"
        ]
    ]
]);

$resp = $client->post('/service/@service_id/dns/@zone_id/records', $options);
echo $resp->getBody();
payload = {
    'name': "example.com",
    'ttl': 3600,
    'priority': 10,
    'type': "A",
    'content': "192.168.1.2"
}

# OR ...

payload = {
    'name': "_sip._tcp.example.com",
    'ttl': 3600,
    'priority': 10,
    'type': "SRV",
    'content': [
        10,
        5060,
        "vc01.example.com"
    ]
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.post('https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id/records', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "record": {
      "name": "_sip._tcp.example.com",
      "type": "SRV",
      "ttl": "3600",
      "priority": "10",
      "content": [
        10,
        5060,
        "vc01.example.com"
      ]
    },
    "info": [
        "dnsnewrecordadded",
        "SRV"
    ]
}

HTTP Request

POST /service/@service_id/dns/@zone_id/records

Query Parameters

Parameter Type Description
service_id int

Service ID

zone_id int

Zone ID

name string

Record name

ttl int

Record ttl

priority int

Priority of the record

type string

Record type

content string

Contents of the record

Edit DNS Record

Edits the selected DNS zone record

POST_DATA="{
    \"name\": \"example.com\",
    \"ttl\": 3600,
    \"priority\": 10,
    \"type\": \"A\",
    \"content\": \"192.168.1.2\"
}"

curl -X PUT "https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id/records/@record_id" \
   -H "Authorization: Bearer $token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);

$options = [
    'json' => [
        "name" => "example.com",
        "ttl" => 3600,
        "priority" => 10,
        "type" => "A",
        "content" => "192.168.1.2"
    ]
]
$resp = $client->put('/service/@service_id/dns/@zone_id/records/@record_id', $options);
echo $resp->getBody();
payload = {
    'name': "example.com",
    'ttl': 3600,
    'priority': 10,
    'type': "A",
    'content': "192.168.1.2"
}

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.put('https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id/records/@record_id', json=payload, headers=headers)
print(req.json())
JSON 응답 형식 (Example Response):
{
    "record": {
        "id": "55",
        "type": "A",
        "ttl": "3600",
        "name": "test",
        "priority": 0,
        "content": "192.168.1.2"
    },
    "info": [
        "The record was updated successfully."
    ]
}

HTTP Request

PUT /service/@service_id/dns/@zone_id/records/@record_id

Query Parameters

Parameter Type Description
service_id int

Service ID

zone_id int

Zone ID

record_id int

Record ID

name string

Record name

ttl int

Record ttl

priority int

Priority of the record

type string

Record type

content string

Contents of the record

Remove DNS Record

Removes the selected DNS zone record


curl -X DELETE "https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id/records/@record_id" \
   -H "Authorization: Bearer $token" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
    'headers' => [
        'Authorization' => 'Bearer ' . $token
    ]
]);


$resp = $client->delete('/service/@service_id/dns/@zone_id/records/@record_id');
echo $resp->getBody();

headers = {
    'Authorization': 'Bearer ' + token
}

req = requests.delete('https://idc.myip.co.kr/api/service/@service_id/dns/@zone_id/records/@record_id', headers=headers)
print(req.json())

HTTP Request

DELETE /service/@service_id/dns/@zone_id/records/@record_id

Query Parameters

Parameter Type Description
service_id int

Service ID

zone_id int

Zone ID

record_id int

Record ID

Services

Server Power status

Return server status


curl -X GET "https://idc.myip.co.kr/api/service/@id/status" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);


$resp = $client->get('/service/@id/status');
echo $resp->getBody();


req = requests.get('https://idc.myip.co.kr/api/service/@id/status')
print(req.json())

HTTP Request

GET /service/@id/status

Query Parameters

Parameter Type Description
id int

Service id

Reset Server

Return server status

POST_DATA="{
    \"id\": \"idValue\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/reset" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);

$options = [
    'json' => [
        "id" => "idValue"
    ]
]
$resp = $client->post('/service/@id/reset', $options);
echo $resp->getBody();
payload = {
    'id': "idValue"
}


req = requests.post('https://idc.myip.co.kr/api/service/@id/reset', json=payload)
print(req.json())

HTTP Request

POST /service/@id/reset

Query Parameters

Parameter Type Description
id int

Service id

Server Bandwidth

Return server bandwidth details


curl -X GET "https://idc.myip.co.kr/api/service/@id/bandwidth" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);


$resp = $client->get('/service/@id/bandwidth');
echo $resp->getBody();


req = requests.get('https://idc.myip.co.kr/api/service/@id/bandwidth')
print(req.json())

HTTP Request

GET /service/@id/bandwidth

Query Parameters

Parameter Type Description
id int

Service id

Reinstal Details

Return installation options for server


curl -X GET "https://idc.myip.co.kr/api/service/@id/reinstall" 
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);


$resp = $client->get('/service/@id/reinstall');
echo $resp->getBody();


req = requests.get('https://idc.myip.co.kr/api/service/@id/reinstall')
print(req.json())

HTTP Request

GET /service/@id/reinstall

Query Parameters

Parameter Type Description
id int

Service id

Reinstall Server

POST_DATA="{
    \"id\": \"idValue\",
    \"profile\": \"profileValue\",
    \"rootpassword\": \"rootpasswordValue\",
    \"adminuser\": \"adminuserValue\",
    \"userpassword\": \"userpasswordValue\",
    \"packageselection\": \"packageselectionValue\",
    \"extra1\": \"extra1Value\"
}"

curl -X POST "https://idc.myip.co.kr/api/service/@id/reinstall" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"
use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://idc.myip.co.kr/api',
]);

$options = [
    'json' => [
        "id" => "idValue",
        "profile" => "profileValue",
        "rootpassword" => "rootpasswordValue",
        "adminuser" => "adminuserValue",
        "userpassword" => "userpasswordValue",
        "packageselection" => "packageselectionValue",
        "extra1" => "extra1Value"
    ]
]
$resp = $client->post('/service/@id/reinstall', $options);
echo $resp->getBody();
payload = {
    'id': "idValue",
    'profile': "profileValue",
    'rootpassword': "rootpasswordValue",
    'adminuser': "adminuserValue",
    'userpassword': "userpasswordValue",
    'packageselection': "packageselectionValue",
    'extra1': "extra1Value"
}


req = requests.post('https://idc.myip.co.kr/api/service/@id/reinstall', json=payload)
print(req.json())

HTTP Request

POST /service/@id/reinstall

Query Parameters

Parameter Type Description
id int

Service id

profile int

Vivamus porta consectetur sem sit amet pharetra

rootpassword string

Mauris feugiat in ipsum sit amet volutpat.

adminuser string

Donec in aliquet erat. Etiam vitae faucibus odio. In luctus

userpassword string

Sed in tortor consequat, ullamcorper ex in

packageselection string

Duis commodo egestas justo a cursus.

extra1 string

Morbi dictum faucibus lectus.

extra1 string

Lorem ipsum dolor sit amet, consectetur adipiscing elit. In at blandit nunc.