Reference For: developers
API: content
Operations of the content tag of the native REST API.
Local content libraries and ISO/OVF items that reference datastore files (Wave C4 thin slice)
GET /v1/content/libraries
GET /v1/content/libraries
- CLI
kyvernon content libraries list
Responses
| Status | Description | Schema |
|---|
| 200 | Local content libraries | array of LibraryView |
|---|
POST /v1/content/libraries
POST /v1/content/libraries
- CLI
kyvernon content libraries create <name> --datastore <id>
Request body
application/json: CreateLibraryRequest
| Name | Type | Required | Description |
|---|
clientToken | string or null | | Optional client token for idempotent create. |
|---|
datastoreId | string | yes | Datastore that backs item files. |
|---|
description | string or null | | Optional description. |
|---|
name | string | yes | Display name (1..=80). |
|---|
Responses
GET /v1/content/libraries/{id}
GET /v1/content/libraries/{id}
- CLI
kyvernon content libraries get <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Library id |
|---|
Responses
DELETE /v1/content/libraries/{id}
DELETE /v1/content/libraries/{id}
- CLI
kyvernon content libraries delete <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Library id |
|---|
Responses
| Status | Description | Schema |
|---|
| 204 | Deleted | |
|---|
GET /v1/content/library-items
GET /v1/content/library-items
- CLI
kyvernon content items list
Parameters
| Name | In | Type | Required | Description |
|---|
libraryId | query | string or null | | Restrict to one library. |
|---|
Responses
POST /v1/content/library-items
POST /v1/content/library-items
- CLI
kyvernon content items create <name> --library <id> --type <iso|ovf>
Request body
application/json: CreateLibraryItemRequest
| Name | Type | Required | Description |
|---|
clientToken | string or null | | Optional client token for idempotent create. |
|---|
datastoreId | string or null | | Override the library's datastore backing. |
|---|
description | string or null | | Optional description. |
|---|
filePath | string or null | | Datastore-relative path; omit or empty when uploading via update session. |
|---|
libraryId | string | yes | Owning library id. |
|---|
name | string | yes | Display name. |
|---|
size | integer (int64) or null | | Optional size hint in bytes. |
|---|
type | string | yes | iso, ovf, or vm-template. |
|---|
Responses
GET /v1/content/library-items/{id}
GET /v1/content/library-items/{id}
- CLI
kyvernon content items get <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Item id |
|---|
Responses
DELETE /v1/content/library-items/{id}
DELETE /v1/content/library-items/{id}
- CLI
kyvernon content items delete <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Item id |
|---|
Responses
| Status | Description | Schema |
|---|
| 204 | Deleted | |
|---|
GET /v1/content/update-sessions
GET /v1/content/update-sessions
- CLI
kyvernon content sessions list
Parameters
| Name | In | Type | Required | Description |
|---|
libraryItemId | query | string or null | | Restrict to one library item. |
|---|
Responses
POST /v1/content/update-sessions
POST /v1/content/update-sessions
- CLI
kyvernon content sessions create <item>
Request body
application/json: CreateUpdateSessionRequest
| Name | Type | Required | Description |
|---|
clientToken | string or null | | Optional client token for idempotent create. |
|---|
libraryItemId | string | yes | Library item id. |
|---|
Responses
GET /v1/content/update-sessions/{id}
GET /v1/content/update-sessions/{id}
- CLI
kyvernon content sessions get <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Update session id |
|---|
Responses
DELETE /v1/content/update-sessions/{id}
DELETE /v1/content/update-sessions/{id}: cancel.
- CLI
kyvernon content sessions cancel <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Update session id |
|---|
Responses
| Status | Description | Schema |
|---|
| 204 | Done; no body | |
|---|
POST /v1/content/update-sessions/{id}/complete
POST /v1/content/update-sessions/{id}/complete
- CLI
kyvernon content sessions complete <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Update session id |
|---|
Responses
GET /v1/content/update-sessions/{id}/files
GET /v1/content/update-sessions/{id}/files
- CLI
kyvernon content sessions files <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Update session id |
|---|
Responses
POST /v1/content/update-sessions/{id}/files
POST /v1/content/update-sessions/{id}/files
- CLI
kyvernon content sessions add-file <id> <name>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Update session id |
|---|
Request body
application/json: AddUpdateSessionFileRequest
| Name | Type | Required | Description |
|---|
name | string | yes | File name (basename, e.g. ubuntu.iso). |
|---|
size | integer (int64) or null | | Optional expected size in bytes. |
|---|
sourceType | string | | Source type; only PUSH is supported. |
|---|
Responses
PUT /v1/content/update-sessions/{id}/files/{name}/content
PUT /v1/content/update-sessions/{id}/files/{name}/content
- CLI
kyvernon content sessions upload <id> <name> <file>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Update session id |
|---|
name | path | string | yes | File name |
|---|
Request body
application/octet-stream: array of integer (int32)
Responses
Version 0.1.