Kiwire ( v3 ) - API

  2. Home
  4. Docs
  6. Kiwire ( v3 ) – API
  8. Zone Restriction

Zone Restriction

CREATE

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/allowed_zone/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
name string The name of the zone
zone string (Optional)Type of zone

PATCH

Use PATCH method is to make a partial update on a resource. 

The differences between PATCH and PUT, PUT method also modify a resource entity but PATCH method is used for partially updating an existing resource. PUT should be used if you are entirety replacing a resource.

Example request URIs

[PATCH] https://{{kiwire_ip}}/api/allowed_zone/{{id}}/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
name string The name of the zone
zone string (Optional)Type of zone

DELETE

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/allowed_zone/{{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/allowed_zone/ [GET] https://{{kiwire_ip}}/api/allowed_zone/{{id}}/ [GET] https://{{kiwire_ip}}/api/allowed_zone/{{offset}}/{{limit}}/{{column}}/{{order}}/
Value Description
offset integer Start data count
limit integer Limit data count
column string Column name
order desc or asc Sort 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/allowed_zone/0/10/id/desc/