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

Cloud



CREATE

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/cloud/ Parameters Required
Parameter Value Description
username string The username of the tenant account.
password string Password of the administrator user id.
email_address string The email address of the administrator user id. It uses to send notification email.
tenant_id string A unique tenant id for each tenant.
tenant_name string The name of the tenant account.
updated_date datetime The last updated date and time
status y or n The status of the tenant whether active or not.



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/cloud/{{id}}/ Parameters Required
Parameter Value Description
username string The username of the tenant account.
password string Password of the administrator user id.
email_address string The email address of the administrator user id. It uses to send notification email.
tenant_id string A unique tenant id for each tenant.
tenant_name string The name of the tenant account.
updated_date datetime The last updated date and time
status y or n The status of the tenant whether active or not.



DELETE

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/cloud/{{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/cloud/ [GET] https://{{kiwire_ip}}/api/cloud/{{id}}/ [GET] https://{{kiwire_ip}}/api/cloud/{{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/cloud/0/10/id/desc/