SoAPI vs APIv6

SoAPI vs APIv6

 

OVH is planning to shutdown SoAPI beginning of 2016 and for that we recommend all our customers using SoAPI to migrate towards APIv6.
You will find hereinafter the table of correspondence SoAPI vs APIv6.

Here are somme links that should help you during your migration:

Do not hesitate to post your comments on the forum post.

Account

Group
SoAPI Methods list
SoAPI method Description
API equivalent
account
 
Retrieve your loyalty/reseller account summary
 
account
 
Retrieve your loyalty/reseller account history
 
Account
 
Set the loyalty/reseller account alert threshold
 

Billing

Group
SoAPI Methods list SoAPI method Description

API equivalent

Billing
 
Return the references (domain, hosting, dedicated) that will expired soon
 
Billing
 
Return invoice list
 
Billing
 
Return domains where user is billing or admin contact
 
GET /{typeOfProduct}
Billing
 
Return an invoice detailled infos
 

Dedicated

Group SoAPI Methods list SoAPI method Description

API equivalent

Dedicated

dedicatedMrtgInfo

 

Return bandwidth/packet/error values and graph URL

 

GET /dedicated/server/{serviceName}/mrtg

Dedicated

dedicatedRtmGetStatus

 

Get the RTM status for an hostname

 

GET /dedicated/server/{serviceName}/statistics *

Dedicated

dedicatedFailoverRipeList

 

List dedicated failover ripe

 

GET /ip

GET /ip/{ip}

GET /ip/{ip}/ripe 

Dedicated

dedicatedInfo

Returns server informations

GET /dedicated/server/{serviceName}

GET /dedicated/server/{serviceName}/specifications/network

GET /dedicated/server/{serviceName}/features/backupFTP

GET /dedicated/server/{serviceName}/specifications/hardware

Dedicated

dedicatedFailoverList

 

Retrieve dedicated failover ip list

 

GET /ip

Dedicated

dedicatedMonitoringList

 

Fetch the dedicated monitoring list

 

GET /dedicated/server/{serviceName}/serviceMonitoring *

Dedicated

dedicatedVirtualMacIpUsedGetList

 

Retrieve Ip and mac used by dedicated server

 

GET /dedicated/server/{serviceName}/virtualMac

Dedicated

dedicatedList

 

Get your dedicated servers list

 

GET /dedicated/server

Dedicated

dedicatedNetbootGetAll

 

Get all dedicated netboot

 

GET /dedicated/server/{serviceName}/boot *

Dedicated

dedicatedNetbootInfo

 

Get dedicated netboot info

 

GET /dedicated/server/{serviceName}/boot *

Dedicated

dedicatedFailoverUpdate

Update a dedicated ip failover

POST /ip/{ip}/move

POST /ip/{ip}/park

POST /dedicated/server/{serviceName}/ipMove

Dedicated

dedicatedReverseList

List the dedicated server reverse(s) (ipv4/ipv6)

GET /ip

GET /ip/{ip}/reverse

Dedicated

dedicatedBackupFtpInfo

 

Dedicated backup ftp info

 

GET /dedicated/server/{serviceName}/features/backupFTP *

Dedicated

dedicatedHardRebootStatus

Get dedicated hard reboot status

GET /dedicated/server/{serviceName}/task

GET /dedicated/server/{serviceName}/task/{taskId}

Dedicated

dedicatedBackupList

 

Get all the backup infos

 

DEPRECATED

Dedicated

dedicatedCapabilitiesGet

Returns server capabilities

GET /dedicated/server/{serviceName}/orderable/ip

GET /dedicated/server/{serviceName}/specifications/ip

Dedicated

dedicatedSecondaryDNSGetAll

 

Get all the secondary DNS

 

GET /dedicated/server/{serviceName}/secondaryDnsDomains *

Dedicated

dedicatedBackupFtpPassword

 

Change backup ftp password

 

POST /dedicated/server/{serviceName}/features/backupFTP/password

Dedicated

dedicatedNetbootGetAvailable

Get available dedicated netboot

GET /dedicated/server/{serviceName}/boot

GET /dedicated/server/{serviceName}/boot/{bootId}

Dedicated

dedicatedReverseAdd

 

Add a dedicated reverse (ipv6)

 

POST /ip/{ip}/reverse

Dedicated

dedicatedSecondaryDNSAdd

 

Add a secondary DNS zone

 

POST /dedicated/server/{serviceName}/secondaryDnsDomains

Dedicated

dedicatedMonitoringAdd

 

Add a dedicated monitoring

 

POST /dedicated/server/{serviceName}/serviceMonitoring

Dedicated

dedicatedAddServiceMonitoringAlertEmail

 

add a new SMS alert on a service monitoring

 

POST /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/email

Dedicated

dedicatedAddServiceMonitoringAlertSMS

 

add a new SMS alert on a service monitoring

 

POST /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms

Dedicated

dedicatedAvailableNotificationNicsGet

of nic available to create alert notification

DEPRECATED

Dedicated

dedicatedBackupExcludeAdd

Add a directory to include

DEPRECATED

Dedicated

dedicatedBackupExcludeDel

Delete an excluded directory

DEPRECATED

Dedicated

dedicatedBackupFtpAdd

 

Add a dedicated backup

 

POST /dedicated/server/{serviceName}/features/backupFTP

Dedicated

dedicatedBackupGetCalendar

get the possibilities to set a backup

DEPRECATED

Dedicated

dedicatedBackupGetDate

get all the backup infos

DEPRECATED

Dedicated

dedicatedBackupGetFreePlanning

get the possibilities to set a backup

DEPRECATED

Dedicated

dedicatedBackupGetHisto

get the backup history

DEPRECATED

Dedicated

dedicatedBackupIncludeAdd

Add a directory to include

DEPRECATED

Dedicated

dedicatedBackupIncludeDel

Delete an included directory

DEPRECATED

Dedicated

dedicatedBackupInfo

get all the backup infos

DEPRECATED

Dedicated

dedicatedBackupReinstallConfiguration

Schedule the reinstallation of the backup configuration

DEPRECATED

Dedicated

dedicatedBackupReinstallData

Schedule the reinstallation of the data from the backup

DEPRECATED

Dedicated

dedicatedBackupSet

setup a backup configuration

DEPRECATED

Dedicated

dedicatedBackupUpdate

update a backup configuration

DEPRECATED

Dedicated

dedicatedBackupUpdateDate

Update backup dates ( be careful, this will erase any previous date configuration )

DEPRECATED

Dedicated

dedicatedBandwidthManagementGet

return info about Bandwidth management

DEPRECATED

Dedicated

dedicatedBandwidthSwitching

Change Bp management type

DEPRECATED

Dedicated

dedicatedCapabilitiesGetAll

Returns all server capabilities for a nichandle

DEPRECATED

Dedicated

dedicatedDelServiceMonitoringAlert

 

delete a service monitoring

 

DELETE /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedEditServiceMonitoringItem

 

edit the monitoring made on a service

 

PUT /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedFailoverAdd

 

Add a dedicated ip failover

 

POST /ip/{ip}/move

Dedicated

dedicatedFailoverRipeAdd

 

Add dedicated failover ripe

 

POST /order/dedicated/server/{serviceName}/ip/{duration}

Dedicated

dedicatedFailoverRipeGetIp

 

method to get a ripe ip block

 

GET /ip

Dedicated

dedicatedMonitoringModify

 

Modify a dedicated monitoring

 

PUT /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedMonitoringNotificationCreate

 

Add a service monitoring by Notification

 

POST /dedicated/server/{serviceName}/serviceMonitoring

Dedicated

dedicatedMonitoringNotificationDel

 

Delete a dedicated monitoring by notification

 

DELETE /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedMonitoringSMSCreate

 

Add a service monitoring by SMS

 

POST /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms

Dedicated

dedicatedMonitoringSMSDel

 

Delete a dedicated monitoring by SMS

 

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms

DELETE /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms/{alertId}

Dedicated

dedicatedMonitoringSMSModify

Modify a dedicated monitoring

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms

PUT /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms/{alertId}

Dedicated

dedicatedMonitoringServiceAdd

 

Create a service monitoring

 

POST /dedicated/server/{serviceName}/serviceMonitoring

Dedicated

dedicatedMonitoringServiceAddNotification

 

Create a service monitoring and warn wit Notification

 

POST /dedicated/server/{serviceName}/serviceMonitoring

Dedicated

dedicatedMonitoringServiceAddSMS

 

Create a service monitoring and warn wit SMS

 

POST /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms

Dedicated

dedicatedMonitoringServiceDel

 

Delete a service monitoring

 

DELETE /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedMonitoringServiceList

Get a list of services monitored

GET /dedicated/server/{serviceName}/serviceMonitoring

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/email

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/email/{alertId}

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}/alert/sms/{alertId}

Dedicated

dedicatedMonitoringStatusGet

Enable or disable ICMP monitoring

GET /dedicated/server/{serviceName}/serviceMonitoring

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedMonitoringStatusUpdate

 

Enable or disable ICMP monitoring

 

PUT /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedNetbootGetRescueEmail

 

Get dedicated netboot rescue email

 

GET /dedicated/server/{serviceName}

Dedicated

dedicatedNetbootModify

 

Modify the netboot

 

PUT /dedicated/server/{serviceName}

Dedicated

dedicatedNetbootModifyById

 

Modify the netboot using the netboot id

 

PUT /dedicated/server/{serviceName}

Dedicated

dedicatedOperationList

Get the dedicated operation summary

GET /dedicated/server/{serviceName}/intervention

GET /dedicated/server/{serviceName}

GET /dedicated/server/{serviceName}/intervention/{interventionId}

Dedicated

dedicatedReverseDel

 

Delete a dedicated reverse (ipv6)

 

DELETE /ip/{ip}/reverse/{ipReverse}

Dedicated

dedicatedReverseInfo

Get a dedicated reverse informations

GET /ip/{ip}/reverse

GET /ip/{ip}/reverse/{ipReverse}

Dedicated

dedicatedReverseModify

Modify a dedicated reverse (ipv4/ipv6)

DELETE /ip/{ip}/reverse/{ipReverse}

POST /ip/{ip}/reverse

Dedicated

dedicatedRipeCreateOrganisation

 

create an organisation object

 

POST /me/ipOrganisation

Dedicated

dedicatedRipeDeleteOrganisation

 

update an inetnum object

 

DELETE /me/ipOrganisation/{organisationId}

Dedicated

dedicatedRipeGetRipeIds

 

List the object created

 

GET /me/ipOrganisation

Dedicated

dedicatedRipeQuery

query the whois database

DEPRECATED

Dedicated

dedicatedRipeUpdateInetnum

update an inetnum object

PUT /ip/{ip}/ripe

Dedicated

dedicatedRipeUpdateOrganisation

update an organisation object

PUT /me/ipOrganisation/{organisationId}  

Dedicated

dedicatedRtmBackdoorUpdateAlert

Get the backdoor info for an hostname

TO DO

Dedicated

dedicatedRtmListBackdoor

Get the backdoor info for an hostname

TO DO

Dedicated

dedicatedSecondaryDNSDel

Delete a secondary DNS zone

DELETE /dedicated/server/{serviceName}/secondaryDnsDomains/{domain}

Dedicated

dedicatedSecondaryDNSInfo

Get the secondary DNS info for an IP

GET /dedicated/server/{serviceName}/secondaryDnsDomains

Dedicated

dedicatedVirtualMacIpAdd

Link an Ip with a virtual mac

POST /dedicated/server/{serviceName}/virtualMac  

Dedicated

dedicatedVirtualMacIpAvailableGetList

Retrieve the ip and mac they could be used

GET /dedicated/server/{serviceName}/virtualMac

Dedicated

dedicatedVirtualMacIpDelete

Dele the virtual mac link for an ip

DELETE /dedicated/server/{serviceName}/virtualMac/{macAddress}/virtualAddress/{ipAddress}  

Dedicated

dedicatedFailoverRipeModify

Add dedicated failover ripe

DEPRECATED

Dedicated

dedicatedFailoverRipeSplit

method to split a ripe block

DEPRECATED

Dedicated

dedicatedFilterIrcClientRuleAdd

Add a dedicated filter IRC client rule

DEPRECATED

Dedicated

dedicatedFilterIrcClientRuleDel

Delete a dedicated filter IRC client rule

DEPRECATED

Dedicated

dedicatedFilterIrcClientRuleList

List dedicated filter IRC client rules

DEPRECATED

Dedicated

dedicatedFilterIrcServerRuleAdd

Add a dedicated filter IRC server rule

DEPRECATED

Dedicated

dedicatedFilterIrcServerRuleDel

Delete a dedicated filter IRC server rule

DEPRECATED

Dedicated

dedicatedFilterIrcServerRuleList

List dedicated filter IRC server rules

DEPRECATED

Dedicated

dedicatedGetAvailableIpFromNetwork

Get available ips for a network

DEPRECATED

Dedicated

dedicatedGetAvailableNetworkFromCountry

Get available networks for a country

DEPRECATED

Dedicated

dedicatedGetRandomAvailableIpFromCountry

Get a random available IP for a country

DEPRECATED

Dedicated

dedicatedGetServiceMonitoringItem

get the details of a monitoring service item

GET /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Dedicated

dedicatedHardRebootDo

Hard reboot a server

POST /dedicated/server/{serviceName}/reboot

Dedicated

dedicatedIPForUDPGet

List all ip for UDP

DEPRECATED

Dedicated

dedicatedIPForUDPMove

Move Ip For UDP from hostname to hostnameTo

DEPRECATED

Dedicated

dedicatedIPForUDPMoveGetStatus

Move Ip For UDP from hostname to hostnameTo

DEPRECATED

Dedicated

dedicatedIPForUDPServerList

List all Server of a nic with Ip for UDP list

DEPRECATED

Dedicated

dedicatedInstallAllowedDistributionGet

Retrieve available distribution for this hostname

GET /dedicated/server/{serviceName}/install/compatibleTemplates  

Dedicated

dedicatedInstallBasic

Reinstall server

POST /dedicated/server/{serviceName}/install/start

Dedicated

dedicatedInstallBasicProgress

The installation Progress

GET /dedicated/server/{serviceName}/install/status

Dedicated

dedicatedInstallReset

Reset an OS installation on a given hostname

DEPRECATED

Dedicated

dedicatedInstallationTemplateList

Retrieve available installation template for session nic

GET /me/installationTemplate

Dedicated

dedicatedInstallationTemplateUse

Launch instllation of template given on hostname

POST /dedicated/server/{serviceName}/install/start

Dedicated

dedicatedIpLoadBalancingAdd

Add an load balancing infrastructure (up to 8 servers with a minimum of 2)

DEPRECIATED

Dedicated

dedicatedIpLoadBalancingDel

Delete an IP load balancing infrastructure (the server slots must be removed first)

DEPRECIATED

Dedicated

dedicatedIpLoadBalancingList

List IP load balancing infrastructures

GET /ip/loadBalancing

Dedicated

dedicatedIpLoadBalancingNameModify

Modify the name of an IP load balancing infrastructure

DEPRECIATED

Dedicated

dedicatedIpLoadBalancingServerAdd

Add a server to an IP load balancing infrastructure

POST /ip/loadBalancing/{serviceName}/backend

Dedicated

dedicatedIpLoadBalancingServerDel

Delete a server from an IP load balancing infrastructure (the server state must be set to inactive)

DELETE /ip/loadBalancing/{serviceName}/backend/{backend}

Dedicated

dedicatedIpLoadBalancingServerStateModify

Modify the state of a server of an IP load balancing infrastructure

POST /ip/loadBalancing/{serviceName}/backend/{backend}/backupState

Dedicated

dedicatedMailinglistGetAllowed

get the list of allowed mailing list

GET /me/mailingList/availableLists

Dedicated

dedicatedMailinglistSubscribe

get the list of allowed mailing list

POST /me/mailingList/subscribe

Dedicated

dedicatedMonitoringDel

Delete a dedicated monitoring

DELETE /dedicated/server/{serviceName}/serviceMonitoring/{monitoringId}

Domains

Group SoAPI Methods list SoAPI method Description

API equivalent

Domains domainCheck Check domain availability

GET /order/cart/{cartId}/domain  

Domains domainInfo domainInfo get all informations about a domain name

GET /domain/{serviceName}

Domains zoneEntryModify Modify a dns zone entry

PUT /domain/zone/{zoneName}/record/{id}

Domains zoneEntryList retrieve dns zone entries list

GET /domain/zone/{zoneName}/record

Domains domainOperationList Retrieve domain operations list

GET /domain/{serviceName}/task

Domains domainList Get your domain list

GET /domain

Domains zoneEntryAdd Add a dns zone entry

POST /domain/zone/{zoneName}/record

Domains domainLockStatus Retrieve the lock status of a domain name

GET /domain/{serviceName}

Domains domainWhoisObfuscatorInfo Get domain Whois obfuscator infos

GET /domain/{serviceName}/owo

Domains domainDnsUpdate Set DNS for a domain

POST /domain/{serviceName}/nameServer

DELETE /domain/{serviceName}/nameServer/{id}

Domains zoneEntryDel Delete a dns zone entry

DELETE /domain/zone/{zoneName}/record/{id}

Domains domainUnlock Unlock the domain

PUT /domain/{serviceName}

Domains domainHostAdd Add a domain host

POST /domain/{serviceName}/glueRecord

Domains domainDnsList Retrieve the list of nameservers for a domain

GET /domain/{serviceName}/nameServer

Domains dnsInstall install dns zone

POST /domain/{serviceName}/activateZone

Domains ortDomainList retieve the domain ORT list

GET /domain/zone/{zoneName}/redirection

Domains domainHostInfo Retrieve infos of a host

GET /domain/{serviceName}/glueRecord/{host}  

Domains domainCapabilities Return domain capabilities

GET /domain/{serviceName}

Domains zoneExport Export zone

GET /domain/zone/{zoneName}/export

Domains ortDomainAdd Add an domain ORT

POST /domain/zone/{zoneName}/redirection

Domains domainDnsGetOvhDefault Get Ovh default DNS

GET /domain/zone/{zoneName}

Domains domainHostList List domain hosts

GET /domain/{serviceName}/glueRecord

Domains domainLock Lock the domain

PUT /domain/{serviceName}

Domains domainWhoisObfuscatorSet Set specified domain whois obfuscator

POST /domain/{serviceName}/owo

Domains zoneEntryAddCustom Add a dns customized zone entry

DEPRECATED

Domains dnsUninstall uninstall dns zone

TO DO

Domains domainOperationInfo Get an operation details

GET /domain/{serviceName}/task/{id}

Domains domainWhoisObfuscatorUnset Unset domain whois obfuscator

DELETE /domain/{serviceName}/owo/{field}

Domains zoneImport Import zone

POST /domain/zone/{zoneName}/import

Domains dnsDefaultInstallCustom reset customized default dns zone

POST /domain/zone/{zoneName}/reset

Domains dnsGeolocalizeHosting

Geolocalize hosting

GET /hosting/web/{serviceName}

Domains dnsInstallCustom install customized default dns zone

POST /domain/{serviceName}/activateZone

Domains dnsReset reset dns zone

POST /domain/zone/{zoneName}/reset

Domains dnsSoaModify Modify SOA value

PUT /domain/zone/{zoneName}/soa

Domains domainHostDel Delete a domain host

DELETE /domain/{serviceName}/glueRecord/{host}

Domains domainHostUpdate Modify a host

DEPRECATED

Domains domainOperationCancel Cancel an operation

POST /domain/zone/{zoneName}/task/{id}/cancel

POST /domain/{serviceName}/task/{id}/cancel

Domains domainOperationRelaunch Relauch an operation

POST /domain/{serviceName}/task/{id}/relaunch

Domains domainResellerDel Remove domain reseller

DEPRECATED

Domains domainResellerSet Set domain reseller DEPRECATED
Domains domainWhoisObfuscatorList List domains whois obfuscator

GET /domain/{serviceName}/owo

Domains domainWhoisObfuscatorSetAll Set all domains whois obfuscator

POST /domain/{serviceName}/owo

Domains domainWhoisObfuscatorUnsetAll Unset all domains whois obfuscator

DELETE /domain/{serviceName}/owo/{field}

Domains ortDomainDel Delete an domain ORT

DELETE /domain/zone/{zoneName}/redirection/{id}

Emails

Group SoAPI Methods list SoAPI method Description

API equivalent

Email popGetQuota Get a pop account quota GET /email/domain/{domain}/account/{accountName}/usage
Email mailingListSubscriberAdd Add a subscriber to a mailing list POST /email/domain/{domain}/mailingList/{name}/subscriber
Email mailingListSubscriberDel Delete a subscriber from a mailing list DELETE /email/domain/{domain}/mailingList/{name}/subscriber/{email}
Email popList Return the domain pop list GET /email/domain/{domain}/account
Email redirectedEmailDel Delete an email redirection DELETE /email/domain/{domain}/redirection/{id} 
Email emailGetCapabilities Get email capabilities GET /email/domain/{domain}/quota
Email emailDomainSummary Get domain email sumarry

GET /email/domain/{domain}/summary

Email mailingListSubscriberList Retrieve the mailing list subscribers GET /email/domain/{domain}/mailingList/{name}/subscriber
Email redirectedEmailAdd Create an email redirection POST /email/domain/{domain}/redirection 
Email redirectedEmailList Retrieve the list of email redirection GET /email/domain/{domain}/redirection
Email mailingListList Retrieve the domain mailing lists GET /email/domain/{domain}/mailingList
Email responderEmailList Retrieve the email responders list GET /email/domain/{domain}/responder
Email popListByMasterNic Return the domain pop list by master nic DEPRECATED
Email emailDomainListByMasterNic Return a mail domain list by master nic GET /email/domain/{domain}/acl
Email emailGetDomainMxFiltering Get domain MX filtering

GET /email/domain/{domain}/dnsMXFilter

Email mailingListFullInfo Retrieve the mailing list full infos GET /email/domain/{domain}/mailingList/{name}
Email popAdd Add a pop account POST /email/domain/{domain}/account
Email popModifyPassword Modify a pop account password POST /email/domain/{domain}/account/{accountName}/changePassword
Email mailingListModeratorAdd Add a moderator to a mailing list POST /email/domain/{domain}/mailingList/{name}/moderator
Email popDel Del a pop account DELETE /email/domain/{domain}/account/{accountName}
Email emailAccessByNic Return the domain list where you can manage email GET /email/domain
Email emailFilterList List email filters GET /email/domain/{domain}/account/{accountName}/filter
Email emailSetDomainMxFiltering Set domain MX filtering : none, simple (antispam) or full (antispam+antivirus)

POST /email/domain/{domain}/changeDnsMXFilter

Email popUpgradeQuota Update a pop account quota PUT /email/domain/{domain}/account/{accountName} 
Email redirectedEmailModify Modify an email redirection

POST /email/domain/{domain}/redirection/{id}/changeRedirection

Email responderEmailAdd Add an email responder POST /email/domain/{domain}/responder
Email emailDomainMxList List domain MX

GET /email/domain/{domain}/dnsMXRecords

Email mailingListAdd Create a mailing list POST /email/domain/{domain}/mailingList
Email emailGetDomainCatchAll Get domain email catch-all DEPRECATED
Email mailingListModeratorList Retrieve the mailing list moderators GET /email/domain/{domain}/mailingList/{name}/moderator
Email responderEmailDel Delete an email responder DELETE /email/domain/{domain}/responder/{account}
Email emailFilterAdd Add a new email filter and its first rule POST /email/domain/{domain}/account/{accountName}/filter
Email emailFilterDel Delete an email filter DELETE /email/domain/{domain}/account/{accountName}/filter/{name}
Email emailSetMasterNic Set email master nic POST /email/domain/{domain}/acl
Email popDetachMasterNic Detach a master nic to a pop account DEPRECATED
Email popInfo Return the pop info GET /email/domain/{domain}/account/{accountName} 
Email popModifyDescription Modify a pop account description DELETE /email/domain/{domain}/account/{accountName}
Email responderEmailInfo Retrieve an email responder infos POST /email/domain/{domain}/responder/{account}
Email responderEmailModify Modify an email responder DELETE /email/domain/{domain}/responder/{account} 
Email emailDelMasterNic Del email master nic POST /email/domain/{domain}/acl/{accountId}
Email emailFilterActive Active/Inactive an email filter POST /email/domain/{domain}/account/{accountName}/filter/{name}/changeActivity
Email emailFilterPriority Set an email filter priority POST /email/domain/{domain}/account/{accountName}/filter/{name}/changePriority
Email emailFilterRuleAdd Add a new filter rule POST /email/domain/{domain}/account/{accountName}/filter/{name}/rule
Email emailFilterRuleDel Delete an email filter rule DELETE /email/domain/{domain}/account/{accountName}/filter/{name}/rule/{id}
Email emailSetDomainCatchAll Set domain email catch-all DEPRECATED
Email mailingListDel Delete a mailing list DELETE /email/domain/{domain}/mailingList/{name}
Email mailingListInfo Retrieve the mailing list infos GET /email/domain/{domain}/mailingList/{name}
Email mailingListModeratorDel Delete a moderator from a mailing list DELETE /email/domain/{domain}/mailingList/{name}/moderator/{email}
Email mailingListModify Modify a mailing list PUT /email/domain/{domain}/mailingList/{name}
Email mailingListSubscriberListByEmail Retrieve the mailing list subscribers by email POST /email/domain/{domain}/mailingList/{name}/sendListByEmail 
Email popAttachMasterNic Attach a master nic to a pop account DEPRECATED

Hosting

Group SoAPI Methods list SoAPI method Description

API equivalent

Hosting hostingSummary Retrieve hosting summary GET /hosting/web/{serviceName}
Hosting hostingList Retrieve hosting list GET /hosting/web
Hosting automatedMailGetState Get automated emails state GET /hosting/web/{serviceName}/email
Hosting automatedMailGetErrors Get automated emails errors reports GET /hosting/web/{serviceName}/email/bounces
Hosting databaseList Retrieve the hosting database list GET /hosting/web/{serviceName}/database
Hosting hostingGetCapabilities Retrieve hosting capabilities GET /hosting/web/offerCapabilities
Hosting ftpInfo Retrieve the domain FTP informations GET /hosting/web/{serviceName}
Hosting multiFtpList Retrieve your domain multi-ftp list GET /hosting/web/{serviceName}/user
Hosting cmsList Get a list of installed modules GET /hosting/web/moduleList
Hosting cmsAvailableList Get a list of available modules GET /hosting/web/moduleList
Hosting multiDomainAdd Add a multidomain GET /hosting/web/{serviceName}/attachedDomain
Hosting anonymousFtpInfo Retrieve anonymous FTP informations DEPRECATED
Hosting cmsInstall Install a module POST /hosting/web/{serviceName}/module
Hosting databaseCreate Create a database POST /hosting/web/{serviceName}/database
Hosting subDomainAdd Add a subdomain GET /hosting/web/{serviceName}/attachedDomain
Hosting subDomainList Retrieve your domain subdomain list GET /hosting/web/{serviceName}/attachedDomain
Hosting ftpChangePassword Change the FTP password POST /hosting/web/{serviceName}/user/{login}/changePassword
Hosting logsAccessList List logs access POST /hosting/web/{serviceName}/userLogs
Hosting multiFtpAdd Add a multiFtp GET /hosting/web/{serviceName}/user
Hosting overquotaInfo Get overquota information GET /hosting/web/{serviceName}
Hosting anonymousFtpActivate Activate anonymous FTP DEPRECATED
Hosting anonymousFtpChangePassword Desactivate anonymous FTP DEPRECATED
Hosting automatedMailFlush Flush automated emails currently locked POST /hosting/web/{serviceName}/email/request 
Hosting automatedMailGetTodo Get automated emails flushing todo DEPRECATED
Hosting automatedMailGetVolumeHistory Get automated emails volumes sent GET /hosting/web/{serviceName}/email/volumes
Hosting automatedMailLock Lock automated emails POST /hosting/web/{serviceName}/email/request
Hosting automatedMailReturnSet Change email for returning error reports POST /hosting/web/{serviceName}/email
Hosting automatedMailUnlock Unlock automated emails POST /hosting/web/{serviceName}/email/request
Hosting cmsRemove Delete a module DELETE /hosting/web/{serviceName}/module/{id}
Hosting cmsRenewAdminPassword Change administrator password for module POST /hosting/web/{serviceName}/module/{id}/changePassword
Hosting crontabAdd Add a crontab job PUT /hosting/web/{serviceName}/cron
Hosting crontabDel Delete crontab job PUT /hosting/web/{serviceName}/cron/{id}
Hosting crontabInfo Cron job info PUT /hosting/web/{serviceName}/cron/{id}
Hosting crontabList List crontab jobs PUT /hosting/web/{serviceName}/cron
Hosting crontabModify Modify a crontab job PUT /hosting/web/{serviceName}/cron/{id}
Hosting databaseChangePassword Change a database password POST /hosting/web/{serviceName}/database/{name}/changePassword
Hosting databaseDelete Delete a database POST /hosting/web/{serviceName}/database/{name}
Hosting databaseDump Request a database dump, you will receive the link and login/password by email POST /hosting/web/{serviceName}/database/{name}/dump
Hosting databaseRecreate Recreate a database DEPRECATED
Hosting subDomainDel Delete a subdomain PUT /hosting/web/{serviceName}/attachedDomain/{domain}
Hosting subDomainModify Modify a subdomain PUT /hosting/web/{serviceName}/attachedDomain/{domain}
Hosting hostingAccessByNic Retrieve the domain list where you can manage hosting GET /hosting/web
Hosting hostingChangeMainDomain Change hosting main domain DEPRECATED
Hosting logsAccessAdd Add logs access (overwriting old data if exists) DELETE /hosting/web/{serviceName}/userLogs
Hosting logsAccessDel Delete logs access DELETE /hosting/web/{serviceName}/userLogs/{login}
Hosting multiDomainDel Delete a multidomain PUT /hosting/web/{serviceName}/attachedDomain/{domain} 
Hosting multiDomainInfo Get a domain multidomain infos PUT /hosting/web/{serviceName}/attachedDomain/{domain} 
Hosting multiDomainList Retrieve your domain multidomain list PUT /hosting/web/{serviceName}/attachedDomain 
Hosting multiDomainModify Modify a multidomain PUT /hosting/web/{serviceName}/attachedDomain/{domain} 
Hosting multiFtpChangeDirectory Change a multiFtp directory PUT /hosting/web/{serviceName}/user/{login}
Hosting multiFtpChangePassword Change a multiFtp password POST /hosting/web/{serviceName}/user/{login}/changePassword
Hosting multiFtpDel Delete a multiFtp DELETE /hosting/web/{serviceName}/user/{login}

Infrastructure

Group SoAPI Methods list SoAPI method Description

API equivalent

Infrastructure ripeCreateOrganisation create an organisation object

POST /me/ipOrganisation

Infrastructure ripeDeleteOrganisation update an inetnum object

DELETE /me/ipOrganisation/{organisationId}

Infrastructure ripeGetRipeIds List the object created

GET /me/ipOrganisation

Infrastructure ripeQuery query the whois database

DEPRECATED

Infrastructure ripeUpdateInetnum update an inetnum object

PUT /ip/{ip}/ripe

Infrastructure ripeUpdateOrganisation update an organisation object

PUT /me/ipOrganisation/{organisationId}  

Infrastructure infrastructureIpListGet List infrastructure failover ripe

DEPRECATED

Infrastructure infrastructureReverseModify Create a reverse For a ip failover Ip

DEPRECATED

ManagedServices

Group SoAPI Methods list SoAPI method Description

API equivalent

Managed Services managedServicesHostMasterIpGet Get host IP from storage name DEPRECATED
Managed Services managedServicesIpAccessChange Update ACL for an offer DEPRECATED
Managed Services managedServicesNameUpdate Update the name of an offer DEPRECATED
Managed Services managedServicesPartitionCreate Create a new partition DEPRECATED
Managed Services managedServicesPartitionDelete Delete a partition DEPRECATED
Managed Services managedServicesPartitionGet Get the list of the partitions available for a given offer DEPRECATED
Managed Services managedServicesPartitionQuotaUsed Get the quota used for a partition DEPRECATED
Managed Services managedServicesPartitionStatusCheck Get the status of a partition DEPRECATED
Managed Services managedServicesPartitionUpdate Update the size of a partition DEPRECATED
Managed Services managedServicesSnapshotUpdate Update the snapshot list for an offer DEPRECATED

Misc

Group SoAPI Methods list SoAPI method Description

API equivalent

Misc globalAccessByNic Get global access list DEPRECATED

Notepad

Group SoAPI Methods list SoAPI method Description

API equivalent

Notepad notepadAdd Appends or prepends data to the notepad content DEPRECATED
Notepad notepadFlush Flush the notepad content DEPRECATED
Notepad notepadGet Get the notepad content DEPRECATED
Notepad notepadSet Set the notepad content DEPRECATED

Prepaid

Group SoAPI Methods list SoAPI method Description

API equivalent

Prepaid prepaidDomainCreate Create a domain DEPRECATED
Prepaid prepaidDomainRenew Renew a domain DEPRECATED
Prepaid prepaidDomainTransfer Transfer a domain DEPRECATED
Prepaid prepaidGetBalance Get the account balance DEPRECATED
Prepaid prepaidGetHistory Retrieve the prepaid accound history DEPRECATED
Prepaid prepaidGetSummary Retrieve the prepaid accound summary DEPRECATED
Prepaid prepaidGetThreshold Get the account threshold DEPRECATED
Prepaid prepaidSetThreshold Set the account threshold DEPRECATED

RPS

Group SoAPI Methods list SoAPI method Description

API equivalent

RPS rpsGetIoStats return I/O stats values and graph URL DEPRECATED
RPS rpsMigrationGetProgressStatus get RPS migration status for all steps DEPRECATED
RPS rpsMigrationStatus get RPS migration status DEPRECATED
RPS rpsMigrationTodo request RPS migration DEPRECATED

Reseller

Group SoAPI Methods list SoAPI method Description

API equivalent

Reseller resellerDomainCreate Create a domain using your loyalty/reseller account

POST /order/cart/{cartId}/domain

Reseller resellerDomainCreateASIA Create a .ASIA domain using your loyalty/reseller account

POST /order/cart/{cartId}/domain

Reseller resellerDomainCreateCAT Create a .CAT domain using your loyalty/reseller account

POST /order/cart/{cartId}/domain

Reseller resellerDomainCreateIT Create a .IT domain using your loyalty/reseller account

POST /order/cart/{cartId}/domain

Reseller resellerDomainRenew Renew a domain using your loyalty/reseller account GET /service/{serviceId}/renew
Reseller resellerDomainRestore Restore a domain using your loyalty/reseller account TO DO
Reseller resellerDomainTransfer Transfer a domain using your loyalty/reseller account

POST /order/cart/{cartId}/domainTransfer

Reseller resellerDomainTransferASIA Transfer a .ASIA domain using your loyalty/reseller account DEPRECATED - Use generic POST /order/cart/{cartId}/domainTransfer
Reseller resellerDomainTransferIT Transfer a .IT domain using your loyalty/reseller account DEPRECATED - Use generic POST /order/cart/{cartId}/domainTransfer

SQLPrive

Group SoAPI Methods list SoAPI method Description

API equivalent

Sql Prive sqlpriveMysqlProcessList MySQL process list DEPRECATED
Sql Prive sqlpriveMysqlRamUsed Get MySQL used ram

GET /hosting/privateDatabase/{serviceName}

Sql Prive sqlpriveMysqlProcessKill kill MySQL process DEPRECATED
Sql Prive sqlpriveMysqlRestart Restart MySQL POST /hosting/privateDatabase/{serviceName}/restart
Sql Prive sqlpriveMysqlLogs Get MySQL logs DEPRECATED
Sql Prive sqlpriveList List sqlprive GET /hosting/privateDatabase 
Sql Prive sqlpriveAlertInfo List sqlprive alerts DEPRECATED
Sql Prive sqlpriveMysqlOvhMyAdmin Manage databases, users and grants (OVH management must be enabled) POST /hosting/privateDatabase/{serviceName}/database 
Sql Prive sqlpriveMysqlRootPassword Modify MySQL root password POST /hosting/privateDatabase/{serviceName}/changeRootPassword 
Sql Prive sqlpriveMysqlUserList List users GET /hosting/privateDatabase/{serviceName}/user
Sql Prive sqlpriveMysqlVersion Modify MySQL version POST /hosting/privateDatabase/{serviceName}/changeVersion
Sql Prive sqlpriveAlertSet Sets sqlprive alerts DEPRECATED
Sql Prive sqlpriveCronDel Sets sqlprive cron DELETE /hosting/privateDatabase/{serviceName}/cron/{id}
Sql Prive sqlpriveCronGet Gets sqlprive cron POST /hosting/privateDatabase/{serviceName}/cron
Sql Prive sqlpriveCronSet Sets sqlprive cron POST /hosting/privateDatabase/{serviceName}/cron
Sql Prive sqlpriveFtpPassword Modify FTP password POST /hosting/privateDatabase/{serviceName}/changeFtpPassword
Sql Prive sqlpriveMysqlActivateOvhManagement Enable MySQL OVH user DEPRECATED
Sql Prive sqlpriveMysqlDatabaseImportFromFile Import database from dump file POST /hosting/privateDatabase/{serviceName}/database/{databaseName}/dumps/{id}/restore 
Sql Prive sqlpriveMysqlDatabaseImportFromHost Import database from foreign host DEPRECATED
Sql Prive sqlpriveMysqlDatabaseList List database GET /hosting/privateDatabase/{serviceName}/database
Sql Prive sqlpriveMysqlDatabasePrivilegeList Get sqlprive privilege list GET /hosting/privateDatabase/{serviceName}/user/{userName}/grant
Sql Prive sqlpriveMysqlDatabaseSave Save a database (dump file will be store in your /dump FTP directory) POST /hosting/privateDatabase/{serviceName}/database/{databaseName}/dump
Sql Prive sqlpriveMysqlGetPossibleDump List possible dumps GET /hosting/privateDatabase/{serviceName}/database/{databaseName}/dumps 

Telephony

Group SoAPI Methods list SoAPI method Description

API equivalent

Telephony telephonySmsUserSend Send a SMS using SMS user

POST /sms/{serviceName}/users/{login}/jobs

GET /telephony/{billingAccount}/service/{serviceName}/voiceConsumption

Telephony telephonyCallList List the number account calls

GET /telephony/{billingAccount}/service/{serviceName}/voiceConsumption/{consumptionId}

Telephony telephonySmsSend Send a SMS

POST /sms/{serviceName}/jobs

GET /sms/{serviceName}/users/{login}/jobs

Telephony telephonySmsUserHistory Get the user SMS history list

GET /sms/{serviceName}/users/{login}/outgoing

Telephony telephonyClick2CallDo Do a click2call

POST /telephony/{billingAccount}/line/{serviceName}/click2Call

GET /sms/{serviceName}/jobs

Telephony telephonySmsHistory Get the SMS history list

GET /sms/{serviceName}/outgoing

Telephony telephonyConferenceGetInfos Get real time informations about a conference (list participants and their state)

GET /telephony/{billingAccount}/conference/{serviceName}/informations

GET /telephony/{billingAccount}/conference/{serviceName}/participants

GET /telephony/{billingAccount}/conference/{serviceName}/participants/{id}  

Telephony telephonyVoicemailMailboxList List the voicemail mailbox messages

TO DO

Telephony telephonyDirectoryModifyPublication Modify telephony universal directory publication infos

PUT /telephony/{billingAccount}/service/{serviceName}/directory

GET /telephony/{billingAccount}/line/{serviceName} 

Telephony telephonyOfferInfo Get offer infos

GET /telephony/{billingAccount}/serviceInfos

Telephony telephonySmsCreditLeft Get the SMS account credit left

GET /sms/{serviceName}

Telephony telephonyLineDetails Give telephony line detail

GET /telephony/{billingAccount}/line/{serviceName}  

Telephony telephonySmsUserMultiSend Send a SMS to mutiple contacts

POST /sms/{serviceName}/users/{login}/jobs

Telephony telephonyHuntingInfo Get telephony hunting infos

GET /telephony/{billingAccount}/miniPabx/{serviceName}/hunting

Telephony telephonyLineOptionsList List line options

GET /telephony/{billingAccount}/line

Telephony telephonyFaxCampaignDetails Detail a campaign from a reference

GET /telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}

Telephony telephonySmsUserCreditLeft Get the SMS account credit left with a user

GET /sms/{serviceName}/users/{login}

Telephony telephonySmsGetUserQuotaForUser Get the available credit quota for an user

GET /sms/{serviceName}/users/{login}

Telephony telephonyBillDetailsCSV Telephony bill details CSV

GET /telephony/{billingAccount}/historyConsumption/{date}/document  

Telephony telephonyFMHuntingModificationMembers Easy PABX, modify members for an hunting

PUT /telephony/{billingAccount}/easyPabx/{serviceName}/hunting/agent/{agentNumber}

Telephony telephonyHuntingModificationMembers Mini PABX, modify members for an hunting

PUT /telephony/{billingAccount}/miniPabx/{serviceName}/hunting/agent/{agentNumber}  

Telephony telephonyBillList Telephony bills list

GET /me/order

GET /me/order/{orderId}

GET /me/order/{orderId}/associatedObject

Telephony telephonyRedirectInfo Get telephony redirect infos

GET /telephony/{billingAccount}/redirect

Telephony telephonyClick2CallDoBySession Do a click2call using session

POST /telephony/{billingAccount}/line/{serviceName}/click2Call

Telephony telephonySmsSenderList List SMS account senders

GET /sms/{serviceName}/senders

Telephony telephonyLineList List telephony lines

GET /telephony/{billingAccount}/line

Telephony telephonyFaxSend Send a fax (up to 10 receivers, for move use fax campaigns)

POST /telephony/{billingAccount}/fax/{serviceName}/settings/sendFax

Telephony telephonyLineOptionsModify Modify line options

PUT /telephony/{billingAccount}/line/{serviceName}/options

Telephony telephonySmsGetUserQuota Get the available credit quota for an user

GET /sms/{serviceName}/users/{login}

Telephony telephonyAbbreviatedNumberOnGroupList List all abbreviated number associated to this group

GET /telephony/{billingAccount}/abbreviatedNumber

Telephony telephonyDirectoryInfo Get telephony universal directory infos

GET /telephony/{billingAccount}/service/{serviceName}/directory

Telephony telephonySmsSetUserQuota Set the available credit quota for an user

PUT /sms/{serviceName}/users/{login}

Telephony telephonyNumberInfo Get number type

GET /telephony/{billingAccount}/service/{serviceName}

Telephony telephonyBillingAccountInfo Telephony billing account details

GET /telephony/{billingAccount}

Telephony telephonySmsUserHistoryCsv Get the user CSV SMS history list

TO DO

Telephony telephonyBillingAccountList List telephony billing accounts

GET /telephony  

Telephony telephonyDirectoryModifyAddress Modify telephony universal directory address infos

PUT /telephony/{billingAccount}/service/{serviceName}/directory 

GET /telephony/{billingAccount}/service/{serviceName}/faxConsumption

Telephony telephonyFaxHistory Fax number history

GET /telephony/{billingAccount}/service/{serviceName}/faxConsumption/{consumptionId}

Telephony telephonySmsAccountList List SMS account

GET /sms

GET /telephony/{billingAccount}/fax/{serviceName}/campaigns

Telephony telephonyFaxCampaignList List fax campaigns

GET /telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}

GET /telephony/{billingAccount}/service/{serviceName}/faxConsumption

Telephony telephonyFaxCallList List the fax calls

GET /telephony/{billingAccount}/service/{serviceName}/faxConsumption/{consumptionId}

Telephony telephonyHuntingGenericScreenOptionsModify Modify the policy redirection when call is made out of defined slots

PUT /telephony/{billingAccount}/timeCondition/{serviceName}/options

Telephony telephonyRedirectModify Modify Redirect number

PUT /telephony/{billingAccount}/redirect/{serviceName}

Telephony telephonyVoicemailMailboxDownload Download the voicemail mailbox message (base64)

TO DO

Telephony telephonyVoicemailMailboxDelete Delete the voicemail mailbox message

TO DO

Telephony telephonyListReversableCallsFromNumber Give all calls reversable from a number

GET /telephony/{billingAccount}/service/{serviceName}/repaymentConsumption

GET /telephony/{billingAccount}/service/{serviceName}/repaymentConsumption/{consumptionId}

Telephony telephonyPhonebookOnGroupContactList List the phonebook contacts

GET /telephony/{billingAccount}/phonebook

Telephony telephonySmsHistoryCsv Get the CSV SMS history list

TO DO

Telephony telephonyHuntingGenericScreenOptions Return the policy redirection when call is made out of defined slots

GET /telephony/{billingAccount}/timeCondition/{serviceName}/options

Telephony telephonyFMHuntingModificationVoicemail Easy PABX, modify voicemail for an hunting

PUT /telephony/{billingAccount}/easyPabx/{serviceName}/hunting

Telephony telephonyHuntingGenericScreenList List telephony hunting generic screen slots

GET /telephony/{billingAccount}/timeCondition/{serviceName}/condition  

Telephony telephonyHuntingGenericScreenStatus Return the status of the telephony hunting generic screen

TO DO

Telephony telephonyHuntingGenericScreenSet Set telephony hunting generic screen slots

POST /telephony/{billingAccount}/timeCondition/{serviceName}/condition

Telephony telephonySmsGetQuotaNotification Display quota notification info

GET /sms/{serviceName}/users

Telephony telephonyVoicemailOptionsList List voicemail options

TO DO

Telephony telephonySpareList List user spares

GET /telephony/spare

GET /xdsl/spare

Telephony telephonyLineGetCodecs get line codecs list and also return available codecs list

GET /telephony/{billingAccount}/line  

Telephony telephonySmsMultiSend Send a SMS to mutiple contacts

POST /sms/{serviceName}/jobs

GET /telephony/{billingAccount}

Telephony telephonyBillingAccountSummary Get billing account and its lines summary

GET /telephony/{billingAccount}/service

Telephony telephonyNumberModify Modify number type

POST /telephony/{billingAccount}/number/{serviceName}/changeFeatureType

Telephony telephonyVoicemailMessagesDownload Download the voicemail message (base64)

TO DO

Telephony telephonyVoicemailMessagesStatus Get telephony voicemail messages status

TO DO

Telephony telephonyPhonebookList List the phonebooks

GET /telephony/{billingAccount}/line/{serviceName}/phone/phonebook

Telephony telephonyPhonebookOnGroupList List the phonebooks for a group

GET /telephony/{billingAccount}/phonebook

Telephony telephonyTonesOptionsList Tones options list

GET /telephony/{billingAccount}/line/{serviceName}/tones

Telephony telephonyNumberGetBillingAccount Get number billing account

DEPRECATED

Telephony telephonyOfferModifyPassword Modify telephony offer password

TO DO

Telephony telephonyToneStatus Get the status of the tones sound files

GET /telephony/{billingAccount}/line/{serviceName}/tones

Telephony telephonyVoicemailMessageDelete Delete telephony voicemail message

TO DO

Telephony telephonyVoicemailModifyPassword Modify telephony voicemail password

TO DO

Telephony telephonyBillingAccountSet Set billing account for numbers

POST /telephony/{billingAccount}/service/{serviceName}/changeOfBillingAccount

Telephony telephonyConferenceGetParams Get conference params

GET /telephony/{billingAccount}/conference/{serviceName}/settings

Telephony telephonyConferenceSetParams Modify a param on your conference room

PUT /telephony/{billingAccount}/conference/{serviceName}/settings

Telephony telephonyHuntingGenericScreenStatusModify Modify the status of the telephony hunting generic screen

PUT /telephony/{billingAccount}/timeCondition/{serviceName}/options

Telephony telephonyRestrictionModify Modify number restrictions

DEPRECATED

Telephony telephonySmsGetCallBack Retreive SMS callback URL

GET /sms/{serviceName}

Telephony telephonySmsUserList List SMS users for a SMS account

GET /sms/{serviceName}/users

Telephony telephonyVoicemailOptionsModify Modify voicemail options

PUT /telephony/{billingAccount}/voicemail/{serviceName}/settings

Telephony telephonyLineSetCodecs set line codecs list

PUT /telephony/{billingAccount}/line/{serviceName}/options

Telephony telephonyDdiModify Modify Ddi number

PUT /telephony/{billingAccount}/ddi/{serviceName}

Telephony telephonyFMHuntingModificationMode Easy PABX, modify mode for an hunting

PUT /telephony/{billingAccount}/easyHunting/{serviceName}

Telephony telephonyOfferModifyName Modify telephony offer name

PUT /telephony/{billingAccount}/service/{serviceName}  

Telephony telephonyPlugAndPhoneInfo Get the Plug And Phone infos

GET /telephony/{billingAccount}/line/{serviceName}/phone

Telephony telephonyRestrictionList List number restrictions

DEPRECATED

Telephony telephonyScreenListBlackWhiteChoice Show telephony incoming and outgoing screening policy

GET /telephony/{billingAccount}/screen

Telephony telephonyLineSetSipDomain set line sip domain

PUT /telephony/{billingAccount}/line/{serviceName}/options

Telephony telephonyBillingAccountDescriptionModify Modify billing account description

PUT /telephony/{billingAccount}

Telephony telephonyFunctionKeyList List function key

GET /telephony/{billingAccount}/line/{serviceName}/phone/functionKey

Telephony telephonyHuntingGroupList List hunting group

GET /telephony/{billingAccount}/miniPabx

Telephony telephonyPhonebookOnGroupContactAdd Add a phonebook contact

POST /telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact

Telephony telephonyPhonebookOnGroupGroupList List the phonebook group

GET /telephony/{billingAccount}/phonebook

Telephony telephonyPhonebookOnSmsContactList List the sms phonebook contacts

DEPRECATED

Telephony telephonyPhonebookOnSmsList List the sms phonebooks

DEPRECATED

Telephony telephonyScreenListInfo List telephony screening type numbers

PUT /telephony/{billingAccount}/screen/{serviceName}

Telephony telephonySmsCancelSending Cancel a delayed SMS send

DELETE /sms/{serviceName}/jobs/{id}

Telephony telephonySmsListCsvAttachment list all csv slot id available for an sms account

GET /sms/{serviceName}/receivers/{slotId}

Telephony telephonySpareCapabilities return spare capabilities

DEPRECATED

Telephony telephonyTonesOptionsModify Tones options modify

PUT /telephony/{billingAccount}/line/{serviceName}/tones

Telephony telephonyTrunkExternalDisplayedNumberList List the external displayed number for the trunk group

DEPRECATED

Telephony telephonyClick2CallUserList List click2call users for a number

DEPRECATED

Telephony telephonyDelClosureEvents Delete event(s)

DELETE /telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}

Telephony telephonyDirectoryInfoGetSameSiret Get list of services with same SIRET

DEPRECATED

Telephony telephonyDirectoryListWayType Get list of way type

GET /telephony/{billingAccount}/service/{serviceName}/directory/getWayTypes

Telephony telephonyFMHuntingModificationSimultaneousCalls Easy PABX, modify simultaneous calls parameters for an hunting

PUT /telephony/{billingAccount}/easyPabx/{serviceName}/hunting

Telephony telephonyFaxOptionsList List fax number options

GET /telephony/{billingAccount}/fax/{serviceName}/settings

Telephony telephonyGetCitiesFromZip Give the list of cities matching a zipcode

DEPRECATED

Telephony telephonyHuntingModificationMode Mini PABX, modify mode for an hunting

PUT /telephony/{billingAccount}/miniPabx/{serviceName}/hunting

Telephony telephonyLineSwitchOffer Switch line offer

DEPRECATED

Telephony telephonyLineSwitchOfferPossibility Switch line offer possibility

DEPRECATED

Telephony telephonyLineSwitchOldOffer Switch line old offer

DEPRECATED

Telephony telephonyLineSwitchOldOfferPossibility Switch line old offer possibility

DEPRECATED

Telephony telephonyListSummationCallsFromBillingAccount Give the summation and calls of reversments for each operator from a billingAccount

DEPRECATED

Telephony telephonyListSummationCallsFromNumber Give the summation amount of reversments for each operator from a number

GET /telephony/{billingAccount}/service/{serviceName}/repaymentConsumption

GET /telephony/{billingAccount}/service/{serviceName}/repaymentConsumption/{consumptionId}

Telephony telephonyNicGetIpRestriction Get default ip restrictions from a nic for a sip line

DEPRECATED

Telephony telephonyNicGetMgcpIpRestriction Get default mgcp ip restrictions from a nic

DEPRECATED

Telephony telephonyNicGetSipDomain get nichandle SIP domain per country

DEPRECATED

Telephony telephonyNicSetIpRestriction Set default ip restrictions from a nic for a sip line

DEPRECATED

Telephony telephonyNicSetMgcpIpRestriction Set default mgcp ip restrictions from a nic

DEPRECATED

Telephony telephonyNicSetSipDomain set nichandle SIP domains per country

DEPRECATED

Telephony telephonyNumberCityForZoneList Return the list of city for a zone

DEPRECATED

Telephony telephonyNumberClean Clean number

DEPRECATED

Telephony telephonyNumberCustomList Give geo, no geo numbers available for reservation

DEPRECATED

Telephony telephonyNumberGetFrWayNamesFromInsee Return the list of ways from an inseeCode

DEPRECATED

Telephony telephonyNumberOrder Order number(s)

DEPRECATED

Telephony telephonyNumberZoneAndPrefixList Return the list of prefix/zone available

DEPRECATED

Telephony telephonyOfferSimultaneousLinesModify Modify telephony offer simultaneous lines

DEPRECATED

Telephony telephonyOrdersFollowingUp get a following up to running orders

GET /order/telephony  

Telephony telephonyPhonebookAdd Add a phonebook

POST /telephony/{billingAccount}/line/{serviceName}/phone/phonebook

Telephony telephonyPhonebookContactAdd Add a phonebook contact

POST /telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact

Telephony telephonyPhonebookContactDel Delete a phonebook contact

DELETE /telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}

Telephony telephonyPhonebookContactList List the phonebook contacts

GET /telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}

Telephony telephonyPhonebookContactModify Modify a phonebook contact

PUT /telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}

Telephony telephonyPhonebookDel Delete a phonebook

DELETE /telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}

Telephony telephonyPhonebookGroupList List the phonebook group

GET /telephony/{billingAccount}/line/{serviceName}/phone/phonebook

Telephony telephonyPhonebookModify Modify a phonebook

PUT /telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}

Telephony telephonyPhonebookOnGroupAdd Add a phonebook

POST /telephony/{billingAccount}/phonebook

Telephony telephonyPhonebookOnGroupContactDel Delete a phonebook contacts

DELETE /telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}

Telephony telephonyPhonebookOnGroupContactModify Modify a phonebook contact

PUT /telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}

Telephony telephonyPhonebookOnGroupDel Delete a phonebook

DELETE /telephony/{billingAccount}/phonebook/{bookKey}

Telephony telephonyPhonebookOnGroupModify Modify a phonebook

PUT /telephony/{billingAccount}/phonebook/{bookKey}

Telephony telephonyPhonebookOnSmsAdd Add a sms phonebook

DEPRECATED

Telephony telephonyPhonebookOnSmsContactAdd Add a sms phonebook contact

DEPRECATED

Telephony telephonyPhonebookOnSmsContactDel Delete a sms phonebook contact

DEPRECATED

Telephony telephonyPhonebookOnSmsContactModify Modify a sms phonebook contact

DEPRECATED

Telephony telephonyPhonebookOnSmsDel Delete a sms phonebook

DEPRECATED

Telephony telephonyPhonebookOnSmsModify Modify a sms phonebook

DEPRECATED

Telephony telephonyPhonebookShare Share the phonebook

DEPRECATED

Telephony telephonyPhonebookSharePeerList List the phonebook share peer

DEPRECATED

Telephony telephonyPlugAndPhoneOperation Perform operation on a plug and phone

POST /telephony/{billingAccount}/line/{serviceName}/phone/phonebook

POST /telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact

POST /telephony/{billingAccount}/line/{serviceName}/phone/reboot

POST /telephony/{billingAccount}/line/{serviceName}/phone/refreshScreen

POST /telephony/{billingAccount}/line/{serviceName}/phone/rma

Telephony telephonyPlugAndPhoneReset Reset a plug&phone configuration

DEPRECATED

Telephony telephonyPlugAndPhoneSkinModify Modify Plug And Phone skin

DEPRECATED

Telephony telephonyPortabilityOrder Order portability

DEPRECATED

Telephony telephonyPortabilityOrderSpecialNumber Order portability for special numbers

DEPRECATED

Telephony telephonyPortabilityStatus Get portability status

GET /telephony/{billingAccount}/portabilities/{id}

Telephony telephonyRatesList Retrieve rates list

DEPRECATED

Telephony telephonyRatesListCsv Retrieve rates list CSV

DEPRECATED

Telephony telephonyReversmentsRefundFromBillingAccount Ask for billing account all special numbers reversment

GET /telephony/{billingAccount}/historyRepaymentConsumption

Telephony telephonyReversmentsRefundIsPending Check if the reversment is allowed from a billing account

DEPRECATED

Telephony telephonyScreenListBlackWhiteChoiceModify Set telephony incoming or outgoing screening policy

PUT /telephony/{billingAccount}/screen/{serviceName}  

Telephony telephonyScreenListInfoModify Set telephony screening list numbers depending on type

DEPRECATED

Telephony telephonySecurityDepositCredit Security deposit credit

DEPRECATED

Telephony telephonySecurityDepositInfo Security deposit info

GET /telephony/{billingAccount}

Telephony telephonySetClosureEvents Import an ICS containing events

DEPRECATED

Telephony telephonySetDefaultPrivateHolidaysEvents Inject defaut public holidays of a specific country

DEPRECATED

Telephony telephonySetTimeZoneNumber Set timezone of a phone number

DEPRECATED

Telephony telephonySipToAliasOffer Ask for a pending change of a SIP line offer to an alias

DEPRECATED

Telephony telephonySmsAddCsvAttachment add a csv for SMS Campaign for an sms account on a specify id slot

POST /sms/{serviceName}/receivers

Telephony telephonySmsBlacklistedSendersDelete List all blacklisted senders

DELETE /sms/{serviceName}/blacklists/{number}

Telephony telephonySmsBlacklistedSendersList List all blacklisted senders

GET /sms/{serviceName}/blacklists/{number}

Telephony telephonySmsDelete Delete selected SMS for an SMS account

DELETE /sms/{serviceName}/jobs/{id}

Telephony telephonySmsDeleteCsvAttachment Delete the specified csv attachment on one or several specific slots for an sms account

DELETE /sms/{serviceName}/receivers/{slotId}

Telephony telephonySmsGetCsvAttachment Display the specified csv attachment from a loaded slot for an sms account

GET /sms/{serviceName}/receivers

Telephony telephonySmsGetQuotaNotificationForUser Display quota notification info

GET /sms/{serviceName}/users

Telephony telephonySmsSenderAdd Add a sender to a SMS account

POST /sms/{serviceName}/senders

Telephony telephonySmsSenderDelete Delete a sender to a sms Account

DELETE /sms/{serviceName}/senders/{sender}

Telephony telephonySmsSenderDescription Custom description for sender

PUT /sms/{serviceName}/senders/{sender}

Telephony telephonySmsSenderValidate Validate a SMS account sender (for mobile number)

POST /sms/{serviceName}/senders/{sender}/validate

Telephony telephonySmsSetCallBack Define SMS callback URL

PUT /sms/{serviceName}

Telephony telephonySmsSetQuotaNotification Change quota notification info

DEPRECATED

Telephony telephonySmsUserAdd Add a SMS user

POST /sms/{serviceName}/users

Telephony telephonySmsUserAddCsvAttachment add a csv for SMS Campaign for an sms user

POST /sms/{serviceName}/users/{login}/receivers

Telephony telephonySmsUserDel Del a SMS user

DELETE /sms/{serviceName}/users/{login}

Telephony telephonySmsUserDeleteCsvAttachment Delete the specified csv attachment on one or several specific slots for an sms user

DEPRECATED

Telephony telephonySmsUserGetCallBack Retreive SMS callback URL

GET /sms/{serviceName}/users/{login}

Telephony telephonySmsUserGetCsvAttachment Display the specified csv attachment from a loaded slot for an sms user

GET /sms/{serviceName}/users/{login}/receivers/{slotId}

Telephony telephonySmsUserListCsvAttachment list all csv slot id available for an sms user

GET /sms/{serviceName}/users/{login}/receivers

Telephony telephonySmsUserPassword Change password of a SMS user

PUT /sms/{serviceName}/users/{login}

Telephony telephonySmsUserSetCallBack Define SMS callback URL for SMS a user

PUT /sms/{serviceName}/users/{login}

Telephony telephonySmsplusIsFreeKeyword Check a keyword is valid for the specified shortcode

DEPRECATED

Telephony telephonySmsplusSendSmsMt Send an sms-mt on demand, in reply to an sms-mo shortcode sending

DEPRECATED

Telephony telephonySmsplusServiceAdd Generate an sms plus service

DEPRECATED

Telephony telephonySmsplusServiceDelete Schedule a termination of an smsplus service for the next renew

DEPRECATED

Telephony telephonySmsplusServiceDetails Give all details of your given couple short ode/keyword service

DEPRECATED

Telephony telephonySmsplusServiceEdit Change cgi link or csv files of the configuration of the sms plus service to send SMS-MT

DEPRECATED

Telephony telephonySmsplusServiceList List sms plus service of the customer

DEPRECATED

Telephony telephonySmsplusServiceReversableTicketsList Give all tickets reversable

DEPRECATED

Telephony telephonySmsplusServiceReversableTicketsSummary Give all tickets reversable summaries

DEPRECATED

Telephony telephonySmsplusShortCodesList Give all smsplus shortcode available to be bought following the given optional criterias

DEPRECATED

Telephony telephonySpareAdd Add a spare

DEPRECATED

Telephony telephonySpareCreateRMA Create a RMA

DEPRECATED

Telephony telephonySpareDel Delete a spare

DEPRECATED

Telephony telephonySpareInfo List user spares

DEPRECATED

Telephony telephonySparePurchase Purshare spares

DEPRECATED

Telephony telephonySpareReplace Replace device by a spare

DEPRECATED

Telephony telephonySpareServiceInfo repleacable phone|modem info

DEPRECATED

Telephony telephonySpareServiceList List repleacable phone|modem for given spare

DEPRECATED

Telephony telephonySpecialNumberCustomList Give special numbers available for reservation

DEPRECATED

Telephony telephonySpecialNumberOrder Order special numbers

DEPRECATED

Telephony telephonySviInfo Retrieve SVI infos

GET /telephony/{billingAccount}/vxml/{serviceName}

Telephony telephonySviModify Modify SVI

PUT /telephony/{billingAccount}/vxml/{serviceName}/settings

Telephony telephonyToneDelete Delete a tone sound file

PUT /telephony/{billingAccount}/line/{serviceName}/tones

Telephony telephonyToneRemoteUpload Personalize tone using a remote URL

POST /telephony/{billingAccount}/line/{serviceName}/tones/toneUpload

Telephony telephonyTrunkExternalDisplayedNumberAdd Add the external displayed number for the trunk group

DEPRECATED

Telephony telephonyTrunkExternalDisplayedNumberCheck Check the number is an offer compatible with external displayed numbers characteristics for trunk

DEPRECATED

Telephony telephonyTrunkExternalDisplayedNumberDel Delete the external displayed number for the trunk group

DEPRECATED

Telephony telephonyVoicemailMessagesRemoteUpload Personalize voicemail message using a remote URL

DEPRECATED

Telephony telephonyLineGetIpRestriction Get ip restrictions for a sip line

DEPRECATED

Telephony telephonyLineGetMgcpIpRestriction Get ip restrictions for an mgcp line

DEPRECATED

Telephony telephonyLineGetSipDomain get line sip domain and list of available sip domains

GET /telephony/{billingAccount}/line/{serviceName}/options

Telephony telephonyLineLogs Get line error logs

GET /telephony/{billingAccount}/service/{serviceName}/diagnosticReports  

Telephony telephonyLineLogsNotificationOptions Get line logs notification options

DEPRECATED

Telephony telephonyLineLogsNotificationOptionsModify Set line logs notification options

DEPRECATED

Telephony telephonyLineLogsOnGroup Get billing account lines error logs

DEPRECATED

Telephony telephonyLineSetIpRestriction Set ip restrictions for a sip line

DEPRECATED

Telephony telephonyLineSetMgcpIpRestriction Set ip restrictions for an mgcp line

DEPRECATED

Telephony telephonyAbbreviatedNumberAdd Add an abbreviated number

POST /telephony/{billingAccount}/line/{serviceName}/abbreviatedNumber

Telephony telephonyAbbreviatedNumberDel Del an abbreviated number

DELETE /telephony/{billingAccount}/line/{serviceName}/abbreviatedNumber/{abbreviatedNumber}

Telephony telephonyAbbreviatedNumberList List all abbreviated number associated to this number

GET /telephony/{billingAccount}/line/{serviceName}/abbreviatedNumber/{abbreviatedNumber}

Telephony telephonyAbbreviatedNumberListPaginated List all abbreviated number associated to this number

DEPRECATED

Telephony telephonyAbbreviatedNumberModify Modify an abbreviated number

PUT /telephony/{billingAccount}/line/{serviceName}/abbreviatedNumber/{abbreviatedNumber}

Telephony telephonyAbbreviatedNumberOnGroupAdd Add an abbreviated number

POST /telephony/{billingAccount}/abbreviatedNumber

Telephony telephonyAbbreviatedNumberOnGroupDel Del an abbreviated number

DELETE /telephony/{billingAccount}/abbreviatedNumber/{abbreviatedNumber}

Telephony telephonyAbbreviatedNumberOnGroupModify Modify an abbreviated number

PUT /telephony/{billingAccount}/abbreviatedNumber/{abbreviatedNumber}

Telephony telephonyAliasToSipOffer Ask for a pending change of an alias to a SIP line

DEPRECATED

Telephony telephonyAliasToSipPossibilities Get telephony alias to line possibilities

DEPRECATED

Telephony telephonyBillDetails Telephony bill details

GET /telephony/{billingAccount}/historyConsumption

Telephony telephonyBillingAccountAdd Add a billing account

POST /order/telephony/new

Telephony telephonyBillingAccountConsumptionCSVByMail Send by email the csv version of the billing account consumption

DEPRECATED

Telephony telephonyBillingAccountDel Delete a billing account

DELETE /telephony/{billingAccount}

Telephony telephonyChangeNicModify Change the telephony service from a nic to another

DEPRECATED

Telephony telephonyClick2CallUserAdd Add a click2call user

TO DO

Telephony telephonyClick2CallUserDel Del a click2call user

DEPRECATED

Telephony telephonyClick2CallUserPassword Change password of a click2call user

DEPRECATED

Telephony telephonyConferenceAction Execute an action in your conference room (kick,mute,...)

POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/deaf

POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/energy

POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/kick

POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/mute

POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/undeaf

POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/unmute

Telephony telephonyConferenceSetAnnounceFile Set the audio announce file for a give conference number

DEPRECATED

Telephony telephonyDdiInfo Get telephony ddi infos

GET /telephony/{billingAccount}/ddi/{serviceName}

Telephony telephonyDefaultPrivateHolidaysEvents Get public holidays

DEPRECATED

Telephony telephonyDeleteLine Delete a line or a number

DEPRECATED

Telephony telephonyDepositMovementModify Move a depositSecurity amount from a billing account to an other

DEPRECATED

Telephony telephonyDirectoryInfoGetSiret Get siret infos

DEPRECATED

Telephony telephonyDirectoryPJCode Get Pages Jaunes heading code

DEPRECATED

Telephony telephonyFMHuntingModificationAnonymousCallRejection Easy PABX, modify anonymous call rejection

PUT /telephony/{billingAccount}/easyPabx/{serviceName}/hunting

Telephony telephonyFaxCampaignCreation Create an instant or differed campaign

TO DO

Telephony telephonyFaxCampaignDelete Stop or start a campaign

DEPRECATED

Telephony telephonyFaxCampaignStartStop Stop or start a campaign

DEPRECATED

Telephony telephonyFaxModifyPassword Change fax number password

POST /telephony/{billingAccount}/fax/{serviceName}/settings/newPassword

Telephony telephonyFaxOptionsModify Modify fax number options

PUT /telephony/{billingAccount}/fax/{serviceName}/settings

Telephony telephonyFreefaxToVoicefax Migrate Freefax to Voicefax

DEPRECATED

Telephony telephonyFreefaxToVoicefaxCheckList List of allowed Freefax to Voicefax services

DEPRECATED

Telephony telephonyFunctionKeyAdd Add a function key

PUT /telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}

Telephony telephonyFunctionKeyDel Delete a function key

PUT /telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}

Telephony telephonyFunctionKeyModify Modify a function key

PUT /telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}

Telephony telephonyGetClosureEventsAsArray Fetch events as array

DEPRECATED

Telephony telephonyGetClosureEventsAsICS Fetch events as ICS

DEPRECATED

Telephony telephonyGetDefaultPrivateHolidaysEvents Get default public holidays events

DEPRECATED

Telephony telephonyGetTimeZoneNumber Get timezone of a phone number

DEPRECATED

Telephony telephonyHuntingModificationAnonymousCallRejection Mini PABX, modify anonymous call rejection

PUT /telephony/{billingAccount}/miniPabx/{serviceName}/hunting

Telephony telephonyHuntingModificationQueue Mini PABX, modify queue for an hunting

PUT /telephony/{billingAccount}/miniPabx/{serviceName}/hunting

Telephony telephonyHuntingModificationSimultaneousCalls Mini PABX, modify simultaneous calls parameters for an hunting

PUT /telephony/{billingAccount}/miniPabx/{serviceName}/hunting

Telephony telephonyLineConsumptionCSVByMail Send by email the csv version of the line consumption

DEPRECATED

Ticket

Group SoAPI Methods list SoAPI method Description

API equivalent

Ticket ticketListIncidents return incidents list for current NIC GET /support/tickets   Filtered by ticketType incident
Ticket ticketGet return the whole ticket detail for a given ID

GET /support/tickets/{ticketId}

Ticket ticketListContact return all the available domains for ticket contact

DEPRECATED

Ticket ticketAnswer answer to a ticket

POST /support/tickets/{ticketId}/reply

Ticket ticketClose close a ticket

POST /support/tickets/{ticketId}/close

Ticket ticketCreate create a new ticket

POST /support/tickets/create

Ticket ticketListIncidentsByDomain return all the tickets for a given domain GET /support/tickets filtered by serviceName
Ticket ticketReopen reopen a closed ticket

POST /support/tickets/{ticketId}/reopen