2.4.x to 3.0.0+: API Mapping

How do Orka 2.4.x API endpoints map to Orka 3.0.0?

Use the following mapping to figure out how to migrate your API-based custom automation to Orka 3.0.0.

Orka 2.4.x APIOrka3 API
{GET|POST|DELETE|PUT} /usersRemoved. See Cluster Access Management: Overview.
POST /users/passwordRemoved. See Cluster Access Management: Overview.
POST /users/groups/myUserGroupRemoved. Grouping is now handled via namespaces and role bindings. See Orka Cluster: Manage Access to Resources.
POST /users/groups/$ungroupedRemoved. Grouping is now handled via namespaces and role bindings. See Orka Cluster: Manage Access to Resources.
POST /tokenFor a user: orka3 user get-token
For a service account: POST /api/v1/namespaces/{namespace}/serviceaccounts/{serviceaccount}/token
DELETE /tokenRemoved.
Tokens are invalidated at the end of their duration (1 hour for users, or 1 year or custom for service accounts).
OR
Tokens are invalidated when the respective user or service account is removed from the cluster.
GET /resources/vm/listGET /api/v1/namespaces/{namespace}/vms
GET /api/v1/namespaces/{namespace}/vmconfigs
GET /resources/vm/list/allRemoved. GET /api/v1/namespaces/{namespace}/vms and GET /api/v1/namespaces/{namespace}/vmconfigs now list all VMs and VM configurations for all users in the namespace.
GET /resources/vm/list/{user}Removed. GET /api/v1/namespaces/{namespace}/vms and GET /api/v1/namespaces/{namespace}/vmconfigs now list all VMs and VM configurations for all users in the namespace.
GET /resources/vm/status/{vm}GET /api/v1/namespaces/{namespace}/vms/{vm}
GET /resources/vm/configsGET /api/v1/namespaces/{namespace}/vmconfigs
GET /resources/vm/configs/myorkavmGET /api/v1/namespaces/{namespace}/vmconfigs/{vmconfig}
POST /resources/vm/createPOST /api/v1/namespaces/{namespace}/vmconfigs
POST /resources/vm/deployPOST /api/v1/namespaces/{namespace}/vms
DELETE /resources/vm/deleteDELETE /api/v1/namespaces/{namespace}/vms/{vm}
DELETE /resources/vm/purgeDELETE /api/v1/namespaces/{namespace}/vms/{vm}
DELETE /api/v1/namespaces/{namespace}/vmconfigs/{vmconfig}
POST /resources/vm/exec/start
POST /resources/vm/exec/stop
POST /resources/vm/exec/resume
POST /resources/vm/exec/suspend
POST /api/v1/namespaces/{namespace}/vms/{vm}/exec
POST /resources/vm/exec/revertPOST /api/v1/namespaces/{namespace}/vms/{vm}/exec
POST /resources/vm/list-disksRemoved. Attached disks are no longer available.
POST /resources/vm/attach-diskRemoved. Attached disks are no longer available.
POST /resources/vm/configs/save-stateRemoved. VM states are no longer available.
POST /resources/vm/configs/myorkavm/delete-stateRemoved. VM states are no longer available.
GET /resources/node/listGET /api/v1/namespaces/{namespace}/nodes
GET /resources/node/list/allRemoved.
GET /resources/node/status/{node}Removed.
Use GET /api/v1/namespaces/{namespace}/nodes instead.
GET /resources/portsRemoved.
POST /resources/node/sandboxRemoved. Sandboxing is now handled via namespaces.
DELETE /resources/node/sandboxRemoved. Sandboxing is now handled via namespaces.
POST /resources/node/groups/myUserGroupRemoved. Grouping is now handled via namespaces and role bindings. See Orka Cluster: Manage Access to Resources.
POST /resources/node/groups/$ungroupedRemoved. Grouping is now handled via namespaces and role bindings. See Orka Cluster: Manage Access to Resources.
POST /resources/node/tag/{tag}POST /api/v1/namespaces/{namespace}/nodes/{name}/tag
DELETE /resources/node/tag/{tag}POST /api/v1/namespaces/{namespace}/nodes/{name}/untag
GET /resources/image/listGET /api/v1/namespaces/{namespace}/images
POST /resources/image/renameRemoved. Use POST /api/v1/namespaces/{namespace}/images/{image}/description to set a user-friendly custom description instead.
POST /resources/image/copyPOST /api/v1/namespaces/{namespace}/images/{image}/copy
GET /resources/image/list-remoteGET /api/v1/namespaces/{namespace}/remoteimages
POST /resources/image/pullPOST /api/v1/namespaces/{namespace}/remoteimages/{remoteimage}/pull
POST /resources/image/deleteDELETE /api/v1/namespaces/{namespace}/images/{image}
POST /resources/image/commitPOST /api/v1/namespaces/{namespace}/vms/{vm}/commit
POST /resources/image/savePOST /api/v1/namespaces/{namespace}/vms/{vm}/save
POST /resources/image/resizeNo API endpoint is available. Use orka3 vm resize instead.
POST /resources/image/generatePOST /api/v1/namespaces/{namespace}/images
POST /resources/image/uploadPOST /api/v1/namespaces/{namespace}/upload/image
GET /resources/image/download/{image}GET /api/v1/namespaces/{namespace}/images/{image}/download
GET /resources/image/checksum/{image}No API endpoint is available.
GET /resources/iso/listGET /api/v1/namespaces/{namespace}/isos
GET /resources/iso/list-remoteGET /api/v1/namespaces/{namespace}/remoteimages
POST /resources/iso/pullPOST /api/v1/namespaces/{namespace}/remoteisos/{remoteiso}/pull
POST /resources/iso/renameRemoved. Use POST /api/v1/namespaces/{namespace}/isos/{iso}/description to set a user-friendly custom description instead
POST /resources/iso/copyPOST /api/v1/namespaces/{namespace}/isos/{iso}/copy
POST /resources/iso/deleteDELETE /api/v1/namespaces/{namespace}/isos/{iso}
POST /resources/iso/uploadPOST /api/v1/namespaces/{namespace}/upload/iso
{GET|POST|DELETE} /resources/kube-accountRemoved.
POST /resources/kube-account/regenerateRemoved.
GET /resources/kube-account/downloadRemoved.
POST /logs/query?limit=10Removed.
DELETE /logsRemoved.
POST /logs/query?logs20=trueRemoved.
GET /tokenRemoved.
GET /health-checkRemoved.
GET /versionRemoved.
GET /version/?all=trueRemoved.
GET /validation-requirementsRemoved. User credentials are handled via the MacStadium Customer Portal.
GET /validate-license-keyRemoved. License keys are obsolete.
GET /default-base-imageRemoved.
POST /resources/cert/setPOST /api/v1/upload/cert

See also


© 2019-2023 Copyright MacStadium, Inc. – Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.