Documentation Reference REST API reference API: nfc Reference For: developers
API: nfc
Operations of the nfc tag of the native REST API.
ImportVApp / ExportVm HttpNfcLease lifecycle and file transfer
GET /v1/nfc-leases/{id}GET /v1/nfc-leases/{id}: lease state (SOAP PropertyCollector on HttpNfcLease).
CLI kyvernon nfc get <id>Parameters
Name In Type Required Description idpath stringyes Id of the transfer lease
Responses
POST /v1/nfc-leases/{id}/abortPOST /v1/nfc-leases/{id}/abort: SOAP HttpNfcLeaseAbort.
CLI kyvernon nfc abort <id>Parameters
Name In Type Required Description idpath stringyes Id of the transfer lease
Responses
POST /v1/nfc-leases/{id}/completePOST /v1/nfc-leases/{id}/complete: SOAP HttpNfcLeaseComplete.
CLI kyvernon nfc complete <id>Parameters
Name In Type Required Description idpath stringyes Id of the transfer lease
Responses
GET /v1/nfc-leases/{id}/files/{name}GET /v1/nfc-leases/{id}/files/{name}: export download (SOAP /nfc GET).
CLI kyvernon nfc download <id> <name>Parameters
Name In Type Required Description idpath stringyes Id of the transfer lease namepath stringyes File name inside the library item
Responses
Status Description Schema 200 octet-stream 404 Not found (or not visible to the caller) ErrorBody
PUT /v1/nfc-leases/{id}/files/{name}PUT /v1/nfc-leases/{id}/files/{name}: import upload (SOAP /nfc PUT).
CLI kyvernon nfc upload <id> <name> <file>Parameters
Name In Type Required Description idpath stringyes Id of the transfer lease namepath stringyes File name inside the library item
Request body
application/octet-stream: array of integer (int32)
Responses
POST /v1/nfc-leases/{id}/progressPOST /v1/nfc-leases/{id}/progress: SOAP HttpNfcLeaseProgress.
CLI kyvernon nfc progress <id> --percent <n>Parameters
Name In Type Required Description idpath stringyes Id of the transfer lease
Request body
application/json: NfcLeaseProgressRequest
Name Type Required Description percentinteger (int32)yes Percent complete (0 to 100).
Responses
POST /v1/resource-pools/{id}/import-vappPOST /v1/resource-pools/{id}/import-vapp: SOAP ResourcePool.ImportVApp.
From a browser: an OVA is a tar archive whose first entry is the .ovf descriptor. The console reads that entry from the selected file, sends it here, and uploads each disk entry of the archive (a slice of the file at the entry's offset and size) with PUT to the url of the matching lease file; bytesReceived on the lease shows the progress, POST .../progress keeps the lease alive (it expires after 15 minutes without use), and POST .../complete converts the disks and finishes the import. An OVF with separate disk files works the same with one file per disk.
CLI kyvernon ovf import-vapp --pool <id> --body <json>Parameters
Name In Type Required Description idpath stringyes Resource pool id
Request body
application/json: ImportVAppRequest
Name Type Required Description datastoreIdstringyes Target datastore (datastore-N). deploymentOptionstring or nullOptional deployment configuration id. entityNamestring or nullOverride entity name; defaults to the package VirtualSystem name. folderIdstring or nullDestination VM folder (group-vN); defaults to the datacenter VM folder. hostIdstring or nullDestination host (host-N). networkMappingarray of OvfNetworkMappingRequest OVF network name → inventory network mappings. ovfDescriptorstringyes OVF envelope XML.
Responses
Status Description Schema 200 OK NfcLeaseView400 Invalid argument; the error body names the field ErrorBody403 Permission denied; args.privilege names the missing privilege ErrorBody404 Not found (or not visible to the caller) ErrorBody
POST /v1/vms/{id}/exportPOST /v1/vms/{id}/export: SOAP VirtualMachine.ExportVm.
CLI kyvernon vm export <id>Parameters
Name In Type Required Description idpath stringyes Virtual machine id
Responses
Status Description Schema 200 OK NfcLeaseView400 Invalid argument; the error body names the field ErrorBody403 Permission denied; args.privilege names the missing privilege ErrorBody404 Not found (or not visible to the caller) ErrorBody
Guides
Previous API: networks Next API: ovf Version 0.1.