API:QuotaSystem - Revision history

Timo: Adding abuse notice

2020-06-15T14:49:48Z

Adding abuse notice

Timo: Wording

2015-09-04T17:25:22Z

Wording

WikiAdmin at 08:16, 4 September 2012

2012-09-04T08:16:23Z

188.107.121.138: /* Quota related XIRCA user relations */

2012-08-28T13:49:52Z

‎Quota related XIRCA user relations

188.107.121.138 at 13:48, 28 August 2012

2012-08-28T13:48:09Z

188.107.121.138: Created page with "{{Sidebar}} NOTOC == System Usage Restrictions == To save the security and availability of our network resources, HEXONET users are not allowed to send an unlimited amou..."

2012-08-28T13:47:12Z

Created page with "{{Sidebar}} __NOTOC__ == System Usage Restrictions == To save the security and availability of our network resources, HEXONET users are not allowed to send an unlimited amou..."

New page

{{Sidebar}}
__NOTOC__

== System Usage Restrictions ==

To save the security and availability of our network resources, HEXONET users are not allowed to send an unlimited amount of API requests within a too short time. To regulate the amount of allowed requests, we use a quota system, which regulates the API connection by using quota points

=== Commands adding quota points ===

Currently, the following commands are adding quota points to the user account of the user executing them:

* [[API:CheckDomain | CheckDomain]]: 1 point
* [[API:CheckDomains | CheckDomains]]: 1 points for each given domain name (DOMAIN# parameter)

* [[API:AddDomain | AddDomain]]: 10 points
* [[API:TradeDomain | TradeDomain]]: 10 point
* [[API:TransferDomain | TransferDomain]]: 10 point

* CheckDomainApplication: 1 point

* [[API:AddContact | AddContact]]: 10 points

=== Soft and hard quota marks ===

Every HEXONET account has a
* soft quota mark (300 points by default)
* hard quota mark (500 points by default)

If the soft quota mark is reached, the system responses will get a delay of 5 seconds. That means that the response time is slowed down so that the user recognizes that he may sent too many requests within a short time.

If an account reached the hard quota mark, the account will get temporarily locked and the system will respond "Service temporarily locked; usage exceeded".
Further API requests will not be accepted and will be answered with this message, although they keep increasing the quota points!

=== Reducing quota points ===

The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied with 0.8, meaning that your quota point amount gets reduced by 20 % every minute.

=== Quota related XIRCA user relations ===

The following [[XIRCA_User_Relations|XIRCA user relations]] exist to use the quota system:

===== quota for domain related commands: =====
<pre>SERVICE_USAGE_DOMAINREGISTRY_HARDQUOTA</pre> = (INTEGER)
<pre>SERVICE_USAGE_DOMAINREGISTRY_SOFTQUOTA</pre> = (INTEGER)

===== common system quota (currently not used): =====
<pre>SERVICE_USAGE_SYSTEM_HARDQUOTA</pre> = (INTEGER)
<pre>SERVICE_USAGE_SYSTEM_SOFTQUOTA</pre> = (INTEGER)

← Older revision		Revision as of 14:49, 15 June 2020
Line 47:		Line 47:
	<pre>SERVICE_USAGE_SYSTEM_HARDQUOTA = (INTEGER)</pre>		<pre>SERVICE_USAGE_SYSTEM_HARDQUOTA = (INTEGER)</pre>
	<pre>SERVICE_USAGE_SYSTEM_SOFTQUOTA = (INTEGER)</pre>		<pre>SERVICE_USAGE_SYSTEM_SOFTQUOTA = (INTEGER)</pre>
		+
		+	== Note regarding abuse ==
		+	Please note that while these numbers are guides, our Terms of Service still apply: https://www.hexonet.net/legal/service-agreements.

@@ Line 2: / Line 2: @@
 == System Usage Restrictions ==
-To save the security and availability of our network resources, HEXONET users are not allowed to send an unlimited amount of API requests within a too short time. To regulate the amount of allowed requests, we use a quota system, which regulates the API connection by using quota points
+To increase the security and save availability of our network resources, HEXONET users are only allowed to send a limited amount of API requests in a short time period. To regulate the amount of allowed requests we use a quota system, which regulates the API connection by using quota points.
 === Commands adding quota points ===
-Currently, the following commands are adding quota points to the user account of the user executing them:
+Currently, the following commands will add quota points to the user account of the user executing them:
 * [[API:CheckDomain | CheckDomain]]: 1 point
@@ Line 34: / Line 34: @@
 === Reducing quota points ===
-The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied with 0.8, meaning that your quota point amount gets reduced by 20 % every minute.
+The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied by 0.8, meaning that your quota point amount gets reduced by 20% every minute.
 === Quota related XIRCA user relations ===

@@ Line 1: / Line 1: @@
-{{Sidebar}}
+{{Sidebar}}__NOTOC__
 __NOTOC__
-−
 == System Usage Restrictions ==

@@ Line 40: / Line 40: @@
 === Quota related XIRCA user relations ===
-The following [[XIRCA_User_Relations|XIRCA user relations]] exist to use the quota system:
+The following XIRCA user relations exist to use the quota system:
 ===== quota for domain related commands: =====

@@ Line 43: / Line 43: @@
 ===== quota for domain related commands: =====
-<pre>SERVICE_USAGE_DOMAINREGISTRY_HARDQUOTA</pre> = (INTEGER)
+<pre>SERVICE_USAGE_DOMAINREGISTRY_HARDQUOTA = (INTEGER)</pre>
-<pre>SERVICE_USAGE_DOMAINREGISTRY_SOFTQUOTA</pre> = (INTEGER)
+<pre>SERVICE_USAGE_DOMAINREGISTRY_SOFTQUOTA = (INTEGER)</pre>
 ===== common system quota (currently not used): =====
-<pre>SERVICE_USAGE_SYSTEM_HARDQUOTA</pre> = (INTEGER)
+<pre>SERVICE_USAGE_SYSTEM_HARDQUOTA = (INTEGER)</pre>
-<pre>SERVICE_USAGE_SYSTEM_SOFTQUOTA</pre> = (INTEGER)
+<pre>SERVICE_USAGE_SYSTEM_SOFTQUOTA = (INTEGER)</pre>