Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 1.68 KB

userStats_get.rst

File metadata and controls

62 lines (39 loc) · 1.68 KB
Raw

userStats_get

GET /users/{uid}/stats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieve statistics for an user.

A list of userstats-object objects are returned. The statistics data includes:

  • Current summary usage information.
  • User's quota.
  • Appliance activity. This is timeline of appliances created and machine images generated from those appliances. It includes a breakdown of operating systems used for the appliances and machine image formats of the machine images.
  • Scan activity. This is the timeline of live machine scans created and machine images generated from those scans. It includes a breakdown of the operating systems detected as part of the scan and machine image formats of the machine images.
  • User's disk usage. This is the disk storage used for the user's software components (in the Software Library); machine images and scan meta-data.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user-object

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/stats" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • quota-object
  • statticket-object
  • userQuotas-get
  • userQuotas-update
  • userStats-get
  • userUsage-get