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

StatusDescriptionSchema
200Local content librariesarray of LibraryView

POST /v1/content/libraries

POST /v1/content/libraries

CLI
kyvernon content libraries create <name> --datastore <id>

Request body

application/json: CreateLibraryRequest

NameTypeRequiredDescription
clientTokenstring or nullOptional client token for idempotent create.
datastoreIdstringyesDatastore that backs item files.
descriptionstring or nullOptional description.
namestringyesDisplay name (1..=80).

Responses

StatusDescriptionSchema
201Created libraryLibraryView

GET /v1/content/libraries/{id}

GET /v1/content/libraries/{id}

CLI
kyvernon content libraries get <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesLibrary id

Responses

StatusDescriptionSchema
200OKLibraryView

DELETE /v1/content/libraries/{id}

DELETE /v1/content/libraries/{id}

CLI
kyvernon content libraries delete <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesLibrary id

Responses

StatusDescriptionSchema
204Deleted

GET /v1/content/library-items

GET /v1/content/library-items

CLI
kyvernon content items list

Parameters

NameInTypeRequiredDescription
libraryIdquerystring or nullRestrict to one library.

Responses

StatusDescriptionSchema
200OKarray of LibraryItemView

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

NameTypeRequiredDescription
clientTokenstring or nullOptional client token for idempotent create.
datastoreIdstring or nullOverride the library's datastore backing.
descriptionstring or nullOptional description.
filePathstring or nullDatastore-relative path; omit or empty when uploading via update session.
libraryIdstringyesOwning library id.
namestringyesDisplay name.
sizeinteger (int64) or nullOptional size hint in bytes.
typestringyesiso, ovf, or vm-template.

Responses

StatusDescriptionSchema
201CreatedLibraryItemView

GET /v1/content/library-items/{id}

GET /v1/content/library-items/{id}

CLI
kyvernon content items get <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesItem id

Responses

StatusDescriptionSchema
200OKLibraryItemView

DELETE /v1/content/library-items/{id}

DELETE /v1/content/library-items/{id}

CLI
kyvernon content items delete <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesItem id

Responses

StatusDescriptionSchema
204Deleted

GET /v1/content/update-sessions

GET /v1/content/update-sessions

CLI
kyvernon content sessions list

Parameters

NameInTypeRequiredDescription
libraryItemIdquerystring or nullRestrict to one library item.

Responses

StatusDescriptionSchema
200OKarray of UpdateSessionView

POST /v1/content/update-sessions

POST /v1/content/update-sessions

CLI
kyvernon content sessions create <item>

Request body

application/json: CreateUpdateSessionRequest

NameTypeRequiredDescription
clientTokenstring or nullOptional client token for idempotent create.
libraryItemIdstringyesLibrary item id.

Responses

StatusDescriptionSchema
201CreatedUpdateSessionView

GET /v1/content/update-sessions/{id}

GET /v1/content/update-sessions/{id}

CLI
kyvernon content sessions get <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesUpdate session id

Responses

StatusDescriptionSchema
200OKUpdateSessionView

DELETE /v1/content/update-sessions/{id}

DELETE /v1/content/update-sessions/{id}: cancel.

CLI
kyvernon content sessions cancel <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesUpdate session id

Responses

StatusDescriptionSchema
204Done; no body

POST /v1/content/update-sessions/{id}/complete

POST /v1/content/update-sessions/{id}/complete

CLI
kyvernon content sessions complete <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesUpdate session id

Responses

StatusDescriptionSchema
200OKLibraryItemView

GET /v1/content/update-sessions/{id}/files

GET /v1/content/update-sessions/{id}/files

CLI
kyvernon content sessions files <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesUpdate session id

Responses

StatusDescriptionSchema
200OKarray of UpdateSessionFileView

POST /v1/content/update-sessions/{id}/files

POST /v1/content/update-sessions/{id}/files

CLI
kyvernon content sessions add-file <id> <name>

Parameters

NameInTypeRequiredDescription
idpathstringyesUpdate session id

Request body

application/json: AddUpdateSessionFileRequest

NameTypeRequiredDescription
namestringyesFile name (basename, e.g. ubuntu.iso).
sizeinteger (int64) or nullOptional expected size in bytes.
sourceTypestringSource type; only PUSH is supported.

Responses

StatusDescriptionSchema
201CreatedUpdateSessionFileView

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

NameInTypeRequiredDescription
idpathstringyesUpdate session id
namepathstringyesFile name

Request body

application/octet-stream: array of integer (int32)

Responses

StatusDescriptionSchema
200OKUpdateSessionFileView

Version 0.1.