Ikoula API flex

List of the different action available for your flex product :


Get information about a given virtual server (FLEX)
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/info
REST Call URL:
wsflex/info
API return example:

											
Listing of the virtuals servers owned by the account
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT"]
WS Call URL:
wsflex/list
REST Call URL:
wsflex/list
API return example:

											
Start a given virtual server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/start
REST Call URL:
wsflex/start
API return example:

											
Stop a given virtual server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/stop
REST Call URL:
wsflex/stop
API return example:

											
Operating system shutdown a given virtual server (Windows only)
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/shutdown
REST Call URL:
wsflex/shutdown
API return example:

											
Pause a given virtual server (Hardware resources still allocated)
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/pause
REST Call URL:
wsflex/pause
API return example:

											
Suspend a given virtual server (RAM released)
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/suspend
REST Call URL:
wsflex/suspend
API return example:

											
Create a snapshot for a given virtual server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/snapshot-add
REST Call URL:
wsflex/snapshot-add
API return example:

											
Snapshots listing for a given virtual server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/snapshot-list
REST Call URL:
wsflex/snapshot-list
API return example:

											
Remove a given snapshot for a given virtual server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME","SNAPSHOT_NAME"]
WS Call URL:
wsflex/snapshot-remove
REST Call URL:
wsflex/snapshot-remove
API return example:

											
Apply a given snapshot to a given virtual server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME","SNAPSHOT_NAME"]
WS Call URL:
wsflex/snapshot-apply
REST Call URL:
wsflex/snapshot-apply
API return example:

											
Set a new password for a given AD user (KVM and flex web portal user)
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","AD_USER","AD_PASSWORD"]
WS Call URL:
wsflex/change-password
REST Call URL:
wsflex/change-password
API return example:

											
Raz a given virtual server (FLEX)
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SUBSCR_ID","VM_NAME"]
WS Call URL:
wsflex/raz
REST Call URL:
wsflex/raz
API return example:

											
Security scan listing for a given server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SCAN_ID"]
WS Call URL:
wsflex/scan-secu-result
REST Call URL:
wsflex/scan-secu-result
API return example:

											
Create a security scan request for a given server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SERVER_IP","SCAN_DATE"]
WS Call URL:
wsflex/scan-secu-create
REST Call URL:
wsflex/scan-secu-create
API return example:

											
Cancel a security scan request
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SCAN_ID"]
WS Call URL:
wsflex/scan-secu-abort
REST Call URL:
wsflex/scan-secu-abort
API return example:

											
Security scan listing for a given server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SERVER_IP"]
WS Call URL:
wsflex/scan-secu-list
REST Call URL:
wsflex/scan-secu-list
API return example:

											
Add an MX rescue to a given server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SERVER_IP","MX_NAME"]
WS Call URL:
wsflex/mx-rescue-add
REST Call URL:
wsflex/mx-rescue-add
API return example:

											
List MX rescue for a given server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SERVER_IP"]
WS Call URL:
wsflex/mx-rescue-list
REST Call URL:
wsflex/mx-rescue-list
API return example:

											
Update an MX rescue entry
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","MX_ID","MX_NAME"]
WS Call URL:
wsflex/mx-rescue-update
REST Call URL:
wsflex/mx-rescue-update
API return example:

											
Delete an MX rescue entry
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","MX_ID"]
WS Call URL:
wsflex/mx-rescue-delete
REST Call URL:
wsflex/mx-rescue-delete
API return example:

											
Add a secondary DNS entry to a given sever
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SERVER_IP","DNS_NAME"]
WS Call URL:
wsflex/dns-sec-add
REST Call URL:
wsflex/dns-sec-add
API return example:

											
Delete a secondary DNS entry
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","DNS_ID"]
WS Call URL:
wsflex/dns-sec-delete
REST Call URL:
wsflex/dns-sec-delete
API return example:

											
Secondary DNS listing for a given server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SERVER_IP"]
WS Call URL:
wsflex/dns-sec-list
REST Call URL:
wsflex/dns-sec-list
API return example:

											
Update a secondary DNS entry
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","DNS_ID","DNS_NAME"]
WS Call URL:
wsflex/dns-sec-update
REST Call URL:
wsflex/dns-sec-update
API return example:

											
DNS reverse listing for a given server
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","SERVER_IP"]
WS Call URL:
wsflex/reverse-dns-list
REST Call URL:
wsflex/reverse-dns-list
API return example:

											
Update a reverse DNS entry
List of the mandatory parameter:
["LOGIN","CRYPTED_PASSWORD","PASSWORD","FORMAT","REVERSE_DNS_IP","REVERSE_DNS_NAME","REVERSE_DNS_ID"]
WS Call URL:
wsflex/reverse-dns-update
REST Call URL:
wsflex/reverse-dns-update
API return example:

											
© 1998-2022 Ikoula tous droits reservés.