1. Home
  2. Docs
  3. Kiwire ( v3 ) – API
  4. Auto Reset

Auto Reset



Create

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/auto_reset/

Parameters Required

ParameterValueDescription
tenant_idstringTenant ID or Tenant name of the API key
updated_datedatetimeThe last updated date and time
exec_whenstring

Options for Reset profile are every

  • 30 Minutes
  • Hourly
  • Daily
  • Weekly
  • Monthly
  • Yearly
  • Once Reached Limit
profilestringThe profile the attribute will be assign to.



Delete

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/auto_reset/{{id}}/




Get

Use GET method to retrieve resource information only and not to modify it in any way.

Example request URIs

[GET] https://{{kiwire_ip}}/api/auto_reset/

[GET] https://{{kiwire_ip}}/api/auto_reset/{{id}}/

[GET] https://{{kiwire_ip}}/api/auto_reset/{{offset}}/{{limit}}/{{column}}/{{order}}/

 ValueDescription
offsetintegerStart data count
limitintegerLimit data count
columnstringColumn name
orderdesc or ascSort the result set in ascending or descending order.

NOTE:

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then Kiwire will return default value eg :

https://{{kiwire_ip}}/api/auto_reset/0/10/id/desc/