Last updated on: 2023-05-25 08:49:13.
QKView Collection Methods¶
The QKViews uploaded using a single set of credentials forms a
collection of QKView resources. These may be accessed in
straightforward fashion individually, or the collection may be
addressed as a whole. The collection as a whole has three available
methods: list, add, and delete.
List¶
Obtains a list of IDs for all QKViews in the collection (verb: GET) query:
curl -H"Authorization: Bearer {auth token}" -H"Accept: application/vnd.f5.ihealth.api" --user-agent "MyGreatiHealthClient" -o - https://ihealth2-api.f5.com/qkview-analyzer/api/qkviews
Possible responses:
| HTTP CODE | message | notes |
|---|---|---|
| 303 | See Other | Redirect Location: [resource uri for qkview] |
| 400 | Bad request | |
| 403 | Forbidden | |
| 406 | Not Acceptable |
Add¶
Adds a QKView to the collection (verb: POST) query:
curl -H"Authorization: Bearer {auth token}" -H"Accept: application/vnd.f5.ihealth.api" --user-agent "MyGreatiHealthClient" -o - -F qkview=@<location of tarball> https://ihealth2-api.f5.com/qkview-analyzer/api/qkviews
Additional parameters:
- visible_in_gui
- description
- f5_support_case
- share_with_case_owner
So to upload a file, make it visible in the UI, and assign associate
it with an F5 case:
query:
curl -H"Authorization: Bearer {auth token}" -H"Accept: application/vnd.f5.ihealth.api" --user-agent "MyGreatiHealthClient" -o - -F qkview=@<location of tarball> -F ‘visible_in_gui=True’ -F ‘f5_support_case=<support_case id> https://ihealth2-api.f5.com/qkview-analyzer/api/qkviews
Possible responses:
| HTTP CODE | message | notes |
|---|---|---|
| 303 | See Other | Redirect Location: [resource uri for qkview] |
| 400 | Bad request | |
| 403 | Forbidden | |
| 406 | Not Acceptable |
If there is an issue with one of the parameters, you will still
receive a 303, and the upload will succeed, however warnings about a
failed parameter will be contained in the body of the 303. Since
sending qkviews is expensive the upload will continue successfully
even if, for instance, the F5 case id is incorrect. Please check the
body before assuming that the parameters succeeded as well.
Delete¶
deletes a QKView from the collection (verb: DELETE)
query:
curl -X DELETE -H"Authorization: Bearer {auth token}" -H"Accept: application/vnd.f5.ihealth.api" --user-agent "MyGreatiHealthClient" -o - https://ihealth2-api.f5.com/qkview-analyzer/api/qkviews/<qkview_id>
Possible responses:
| HTTP CODE | message | notes |
|---|---|---|
| 200 | OK | body contains IDs of deleted qkviews if any were found to delete |
| 404 | Not Found | if there were no resources found to delete |
Delete ALL¶
Deletes all QKViews in collection (verb: DELETE)
query:
curl -X DELETE -H"Authorization: Bearer {auth token}" -H"Accept: application/vnd.f5.ihealth.api" --user-agent "MyGreatiHealthClient" -o - https://ihealth2-api.f5.com/qkview-analyzer/api/qkviews
Possible responses:
| HTTP CODE | message | notes |
|---|---|---|
| 200 | OK | body contains IDs of deleted qkviews if any were found to delete |
| 404 | Not Found | if there were no resources found to delete 404 Not Found if none of the requested resources can be found |