Skip to main content

Account Endpoints

List Accounts

Lists all Frame accounts.

GET/accounts/

Request Parameters

NameDescriptionParam TypeData TypeRequired
nameName or portion of name you would like to use for searching/filtering.Search QuerystringFalse
organization_idFrame Organization ID you'd would like to use for searching/filteringSearch QuerystringFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts"

List Account Details

Returns details of an account.

GET/accounts/:account_id

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/31cbf42c-8767-486c-9ed3-d6a804q7cfe1"

List Account Availability Zones

Lists all availability zones of a Frame account.

GET/accounts/:id/availability_zones

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/availability_zones"

Get Account User Volumes Settings

Returns user volumes settings of a Frame account.

GET/accounts/:id/user_volumes_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/user_volumes_settings"

Get Account Domain Join Settings

Returns domain join settings of a Frame account.

GET/accounts/:id/domain_join_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/domain_join_settings"

Get Account General Settings

Returns general settings of a Frame account.

GET/accounts/:id/general_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/general_settings"

Get Account Session Settings

Returns session settings of a Frame account.

GET/accounts/:id/session_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/session_settings"

Update Account Enterprise Profiles

Updates enterprise profiles of a Frame account. (Should be used only if enabling enterprise profiles or updating its size. In case you want to disable enterprise profiles, you should use disable_enterprise_profiles endpoint instead.)

POST/accounts/:id/update_enterprise_profiles

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idID of the Org the account will be created underURLStringTrue
user_profileA JSON object that includes values for the following properties: enabled of type boolean and size of type integerDataJSONTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/update_enterprise_profiles"
--data-raw '{
"user_profile": {
"enabled": true,
"size": 1
}
}'

Update Account Personal Drives

Updates personal drives of a Frame account. (Should be used only if enabling personal drives or updating its size. In case you want to disable personal drives, you should use disable_personal_drives endpoint instead.)

POST/accounts/:id/update_personal_drives

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idID of the Org the account will be created underURLStringTrue
enabledBoolean which determines whether personal drives are enabledDataBooleanTrue
sizeInteger which determines size of personal drives if enabledDataIntegerFalse
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/update_personal_drives"
--data-raw '{
"enabled": true,
"size": 1
}'

Disable Account Enterprise Profiles

Disables enterprise profiles of a Frame account and returns the pending task.

POST/accounts/:id/disable_enterprise_profiles

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idID of the Org the account will be created underURLStringTrue
do_backupBoolean which determines whether new backups of existing enterprise profiles should be createdDataBooleanFalse
delete_all_backupsBoolean which determines whether existing backups should be deletedDataBooleanFalse
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/disable_enterprise_profiles"
--data-raw '{
"do_backup": false,
"delete_all_backups": false
}'

Disable Account Personal Drives

Disables personal drives of a Frame account and returns the pending task.

POST/accounts/:id/disable_personal_drives

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idID of the Org the account will be created underURLStringTrue
do_backupBoolean which determines whether new backups of existing enterprise profiles should be createdDataBooleanFalse
delete_all_backupsBoolean which determines whether existing backups should be deletedDataBooleanFalse
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/disable_personal_drives"
--data-raw '{
"do_backup": false,
"delete_all_backups": false
}'

Update Account Domain Join Settings

Updates domain join settings of a Frame account and returns pending task.

POST/accounts/:id/update_domain_join_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idID of the Org the account will be created underURLStringTrue
domain_nameDomain nameDataStringFalse
service_account_nameService account nameDataStringFalse
service_account_passwordService account passwordDataStringFalse
target_ouTarget OUDataStringFalse
dns_serversDNS serversDataStringFalse
logout_local_userBoolean which determines whether local user should be logged outDataBooleanFalse
domain_controller_ipDomain controller IPDataStringFalse
promote_user_to_local_adminBoolean which determines whether user should be promoted to local adminDataBooleanFalse
machine_name_prefixMachine name prefixDataStringFalse
sso_passthrough_enabledBoolean which determines whether SSO Passthrough is enabledDataBooleanFalse
delete_terminated_hostnamesBoolean which determines whether terminated hostnames should be deletedDataBooleanFalse
ad_typeAD typeDataStringFalse
enroll_intuneEnroll intune?DataBooleanFalse
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/update_domain_join_settings"
--data-raw '{
"domain_name": "",
"service_account_name: "",
"service_account_password: "",
"target_ou": "",
"dns_servers": "",
"logout_local_user": false,
"domain_controller_ip": "",
"promote_user_to_local_admin": true,
"machine_name_prefix": "",
"sso_passthrough_enabled": true,
"delete_terminated_hostnames": false,
"ad_type": "",
"enroll_intune": false
}'

Update Account General Settings

Updates general settings of a Frame account.

POST/accounts/:id/update_general_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idID of the Org the account will be created underURLStringTrue
is_terminal_banner_enabledBoolean which determines whether terminal banner is enabledDataBooleanTrue
terminal_banner_settingsA JSON object with string values "background_color", "color" and "message"DataJSONFalse
is_login_banner_enabledBoolean which determines whether login banner is enabledDataBooleanTrue
login_banner_settingsA JSON object with string values "title" and "message"DataJSONFalse
is_light_publish_enabledBoolean which determines whether light publish is enabledDataBooleanTrue
light_publish_settingsA JSON object with integer value "threshold"DataJSONFalse
host_name_prefixHost name prefixDataStringTrue
is_test_publish_enabledBoolean which determines whether test publish is enabledDataBooleanTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/update_general_settings"
--data-raw '{
"is_terminal_banner_enabled" true,
"terminal_banner_settings": {
"background_color": "#FFFFFF",
"color": "#000000",
"message": ""
},
"is_login_banner_enabled": true,
"login_banner_settings": {
"title": "",
"message": ""
},
"is_light_publish_enabled": true,
"light_publish_settings": {
"threshold": 1
},
"host_name_prefix": "",
"is_test_publish_enabled": false
}'

Update Account Session Settings

Updates session settings of a Frame account.

POST/accounts/:id/update_session_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idID of the Org the account will be created underURLStringTrue
is_app_switching_enabledIs application switching enabled?DataBooleanTrue
is_microphone_enabledIs microphone enabled?DataBooleanTrue
is_camera_enabledIs camera enabled?DataBooleanFalse
is_usb_redirection_enabledIs USB redirection enabled?DataBooleanFalse
clipboard_integrationA JSON object with "is_enabled" boolean value and string value "direction" which has possible values: "local_to_remote", "remote_to_local" and "bidirectional"DataJSONTrue
is_download_enabledIs download enabled?DataBooleanTrue
is_cpu_display4k_enabledIs CPU display 4K enabled?DataBooleanTrue
is_upload_enabledIs upload enabled?DataBooleanTrue
is_print_enabledIs print enabled?DataBooleanTrue
reservation_timeout_secondsReservation timeout in secondsDataIntegerTrue
user_inactivity_timeout_minutesUser inactivity timeout in minutesDataIntegerTrue
idle_timeout_minutesIdle timeout in minutesDataIntegerTrue
max_session_duration_minutesMax session duration in minutesDataIntegerTrue
session_preparation_timeout_minutesSession preparation timeout in minutesDataIntegerTrue
max_bandwidth_kbpsMax bandwidth in KBPSDataIntegerTrue
max_frame_rate_fpsMax Frame rate in FPSDataIntegerTrue
max_video_bit_rate_mbpsMax video bit rate in MBPSDataIntegerTrue
max_audio_bit_rate_kbpsMax audio bit rate in KBPSDataIntegerTrue
yuv444Boolean which determines whether YUV444 feature is enabledDataBooleanTrue
scale_videoScale videoDataNumberTrue
max_video_quantizationMax video quantizationDataIntegerTrue
qos_rate_changeQOS rate changeDataIntegerTrue
is_grayscale_enabledIs grayscale enabled?DataBooleanTrue
is_webrtc_enabledIs webRTC enabled?DataBooleanTrue
video_buffer_length_msVideo buffer length in msDataIntegerTrue
is_settings_dialog_enabledIs settings dialog enabled?DataBooleanTrue
advanced_terminal_argumentsAdvanced terminal argumentsDataStringFalse
advanced_server_argumentsAdvanced server argumentsDataStringFalse
terminal_buildTerminal BuildDataStringFalse
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/update_session_settings"
--data-raw '{
"session_settings": {
"is_webrtc_enabled": false,
"advanced_server_arguments": null,
"advanced_terminal_arguments": null,
"clipboard_integration": {
"direction": "bidirectional",
"is_enabled": true
},
"idle_timeout_minutes": 60,
"is_app_switching_enabled": true,
"is_camera_enabled": false,
"is_cpu_display4k_enabled": true,
"is_download_enabled": true,
"is_grayscale_enabled": false,
"is_microphone_enabled": false,
"is_print_enabled": true,
"is_settings_dialog_enabled": true,
"is_upload_enabled": true,
"is_usb_redirection_enabled": false,
"max_audio_bit_rate_kbps": 160,
"max_bandwidth_kbps": 0,
"max_frame_rate_fps": 20,
"max_session_duration_minutes": 0,
"max_video_bit_rate_mbps": 16.0,
"max_video_quantization": 42,
"qos_rate_change": 4,
"reservation_timeout_seconds": 600,
"scale_video": 1.0,
"session_preparation_timeout_minutes": 15,
"terminal_build": "latest",
"user_inactivity_timeout_minutes": 10,
"video_buffer_length_ms": 0,
"yuv444": false
}
}'

Publish a Sandbox

Starts the publish action for an account's Sandbox and returns the task ID.

POST/accounts/:account_id/publish

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/publish"

List Publish Tasks

Lists publishing tasks for the given account ID.

GET/accounts/:account_id/publish/tasks

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/publish/tasks"

Get Publish Status

Returns the publishing status for a given account ID and publish request ID.

GET/accounts/:account_id/publish/:task_id

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
task_idTask id of a publishURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/publish/${request_id}"

Cancel Publish

Returns details of an account.

DELETE/accounts/:account_id/publish/:task_id

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
task_idTask id of a publishURLStringTrue
curl -X DELETE \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/publish/${task_id}"

List Instance Types

Returns a list of available instance types for the account specified.

GET/accounts/:account_id/instance_types

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/instance_types"

Change Instance Type for a Persistent Desktop

Changes the instance type for a Persistent Desktop

POST/accounts/:account_id/servers/:server_id/update_persistent_desktop_instance_type

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLstringTrue
server_idFrame Server ID for the Persistent DesktopURLstringTrue
instance_type_idEndpoint request body payload ({"instance_type_id": "gateway-prod.61616"})Search QuerystringTrue
note

The instance type ID can be found by using the List Instance Types endpoint and specifying the id for the instance type you want to use

curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
--data-raw '{"instance_type_id" : "gateway-prod.61616" }'
"https://api.console.nutanix.com/v1/accounts/${account_id}/servers/reboot"

List Applications

Returns a list of applications for the account specified.

GET/accounts/:account_id/applications

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/applications"

List Session Reports

Returns a list of generated session reports.

note

You must "Enable Session Reports" in the General tab of the Account Settings for this endpoint to work. If you do not enable this feature, you will get an empty array and HTTP 200 response from your request.

GET/accounts/:account_id/session_reports

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/session_reports"

List Active Sessions

Returns a list of active sessions for all pools on a specified account.

GET/accounts/:account_id/active_sessions

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/active_sessions"

List Recent Sessions

Returns a list of sessions for a given period of time.

GET/accounts/:account_id/recent_sessions

Request Parameters

Parameter NameDescriptionParam TypeData TypeRequired
idFrame Account IDURLstringTrue
from_dateThe beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringTrue
to_dateThe ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/recent_sessions?from_date=2021-12-01T23:20:58.128Z&to_date=2021-12-25T23:20:58.128Z"

List Session Details

Returns information regarding a specific session.

GET/accounts/:account_id/sessions/:session_id/

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLStringTrue
session_idID of a sessionURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/sessions/${session_id}"

List Session Trails

Returns Session Trails for the Frame Account specified.

GET/accounts/:account_id/session-trails

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLStringTrue
searchFilters results if the provided string matches against Server ID, Session ID, email address, and a user's full name.Search QueryStringFalse
session_startThe beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringFalse
session_endThe ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringFalse
instance_typeFilters Session Trails based on a specific instance type ID.Search QueryStringFalse
pool_group_typeFilters Session Trails based on the pool group type (e.g. “production” vs “sandbox”).Search QueryStringFalse
pool_idFilters Session Trails based on provided instance type's pool ID.Search QueryStringFalse
offsetUsed to specify where to start the query. Must be used in conjunction with the limit parameter.Search QueryInteger (String)False
limitUsed to specify the “page size” of the query. Must be used in conjunction with the offset parameter.Search QueryInteger (String)False
orderSpecifies the order of the results. Use “asc” for ascending order, and “desc” for descending order.Search QueryStringFalse
order_bySpecifies the field of which the ordering should occur. For example, “session_start”, “session_duration”, etc.Search QueryStringFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/session-trails?limit=50&offset=0&order=desc&order_by=session_start"

List Audit Trails

Returns Audit Trails for an account, constrained by a date range and a number of ways to filter & search for granular queries.

GETaccounts/:account_id/audit-trails

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLStringTrue
searchFilters results if the provided string matches against a user's full name, email, idp, or the Audit Trail kind.Search QueryStringFalse
kindFilters Audit Trails by wildcard matching against the supplied string. For example, a kind of “launchpad” will return Audit Trails for both createLaunchpad and updateLaunchpad actions.Search QueryStringFalse
from_dateThe beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringFalse
to_dateThe ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringFalse
offsetUsed to specify where to start a Audit Trails query. Must be used in conjunction with the limit parameter.Search QueryInteger (String)False
limitUsed to specify the “page size” of the Audit Trails query. Must be used in conjunction with the offset parameter.Search QueryInteger (String)False
orderSpecifies the order of the results. Use “asc” for ascending order, and “desc” for descending order.Search QueryStringFalse
order_bySpecifies the field of which the ordering should occur. For example, “session_start”, “session_duration”, etc.Search QueryStringFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/audit-trails?search=jason.thompson@nutanix.com&kind=launchpad"

Start a Session

Starts a headless/clientless session. Use this endpoint to start a session without a browser or FrameApp. This is typically used for automation and custom workflows (Sandbox installers, CI/CD automations, etc).

Please note that you can use either a token or signed HTTP headers for authentication with this endpoint.

If you use a token for authentication, you will be able to modify metadata for the session (email, first name, last name, etc).

If you use a token, use the header "Authorization: Bearer token" instead of the signed headers.

Also note, if you use the signed HTTP headers (Instead of the token), the first and last name will show up as "X" in the audit logs respectively. Additionaly, your email address will reflect the API provider with a very cryptic looking address.

POST/sessions/start

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
terminal_configuration_idThe desired Launchpad Terminal Configuration IDSearch QueryStringTrue
optionsJSON object with multiple options to choose from (All optional)
{ "user_data": "string", "touch": true }

user_data passes a string into the remote Windows environment variable FRAME_USER_DATA

touch: if true enables touch controls to the session (Touch displays)
Search QueryStringFalse
curl -X POST \
-H "Authorization: Bearer ${token}" \
"https://api.console.nutanix.com/v1/sessions/start" \
--data-raw '{
"options": {
"user_data" : "Any string",
"touch" : "false"
}
}'

Stop a Session

Stops the specified session.

DELETE/accounts/:account_id/sessions/:session_id

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLStringTrue
session_idID of a sessionURLStringTrue
curl -X DELETE \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/sessions/${session_id}"

Get Sandbox Status

Returns the status of a Sandbox pool on a specified account.

GET/accounts/:account_id/sandbox/status

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/sandbox/status"

Start a Sandbox

Starts the Sandbox server on a specified account.

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
POST/accounts/:account_id/sandbox/start
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/sandbox/start"

Reboot a Sandbox

Reboots a Sandbox server on a specified account.

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
POST/accounts/:account_id/sandbox/reboot
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/sandbox/reboot"

Stop a Sandbox

Stops the Sandbox server on specified account.

POST/accounts/:account_id/sandbox/stop

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/sandbox/stop"

List Pools for an Account

GET/accounts/:account_id/pools

Request Parameters

NameDescriptionParam TypeData TypeRequired
idFrame Account ID.URLstringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/pools"

List Account's Overall Capacity Settings

Returns the current min, buffer, and max values configured for all pools/instance types in an account.

GET/accounts/:account_id/elasticity

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/elasticity"

List Persistent Desktop Capacity Settings

Returns the current Persistent Desktop capacity settings for an account. This includes values for number_of_backups_to_save, max_users, and keep_instances_running_for_new_users.

GET/accounts/:persistent_account_id/persistent_desktop_elasticity_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
persistent_account_idFrame Account ID (must be a persistent).URLstringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${persistent_account_id}/persistent_desktop_elasticity_settings"

List Persistent Desktop Backups for an Account

Returns a list of the Backups for Persistent Desktops in an account.

GET/accounts/:persistent_account_id/persistent_desktop_backups

Request Parameters

NameDescriptionParam TypeData TypeRequired
persistent_account_idFrame Account ID (must be a persistent).URLstringTrue
offsetUsed to specify where to start the query from the results (Used for pagination). Must be in conjunction with the limit parameter.Search QueryInteger (String)False
limitUsed to specify the "page size" of the query. Must be used in conjunction with the offset parameterSearch QueryInteger (String)False
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${persistent_account_id}/persistent_desktop_backups"

List Persistent Desktops in an Account

Returns a list of the Persistent Desktops in an account.

GET/accounts/:persistent_account_id/persistent_desktop_servers

Request Parameters

NameDescriptionParam TypeData TypeRequired
persistent_account_idFrame Account ID (must be a persistent).URLstringTrue
offsetUsed to specify where to start the query from the results (Used for pagination). Must be in conjunction with the limit parameter.Search QueryInteger (String)False
limitUsed to specify the "page size" of the query. Must be used in conjunction with the offset parameterSearch QueryInteger (String)False
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${persistent_account_id}/persistent_desktop_servers"

List Logged In Users

Lists all previously logged in users for an account (And the associated IDP).

note

This endpoint is required to reassign persistent desktops for persistent Frame Accounts. However, this endpoint can be used with any other account type.

GET/accounts/:account_id/logged_in_users

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLstringTrue
offsetUsed to specify where to start the query from the results (Used for pagination). Must be in conjunction with the limit parameter.Search QueryInteger (String)False
limitUsed to specify the "page size" of the query. Must be used in conjunction with the offset parameterSearch QueryInteger (String)False
searchUsed to search/filter for specific results from the returned list of logged in usersSearch QueryStringFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/logged_in_users"

Unassign Persistent Desktop

Unassigns the user from their assigned Persistent Desktop server. This allows the administrator to assign that Persistent Desktop server to another user (or terminate the server).

POST/accounts/:persistent_account_id/servers/:server_external_id/unassign

Request Parameters

NameDescriptionParam TypeData TypeRequired
persistent_account_idFrame Account ID (must be a persistent).URLstringTrue
server_external_idFrame "external" server ID (found by querying account servers).URLstringTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${persistent_account_id}/servers/${persistent_server_id}/unassign"

Reassign Persistent Desktop

Reassigns a user to a particular Persistent Desktop server. Please note that the Persistent Desktop server should already be unassigned.

POST/accounts/:persistent_account_id/servers/:server_external_id/reassign

Request Parameters

NameDescriptionParam TypeData TypeRequired
persistent_account_idFrame Account ID (must be a persistent).URLstringTrue
server_external_idFrame "external" server ID (found by querying account servers).URLstringTrue
user_uuidFrame User's UUID (found by querying logged_in_users)URLstringTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${persistent_account_id}/servers/${persistent_server_id}/reassign"

Reboot a Server

Reboots the specified server.

POST/accounts/:account_id/servers/reboot

Request Parameters

NameDescriptionParam TypeData TypeRequired
server_idFrame Server ID.URLstringTrue
account_server_rebootServer reboot payload ({"force": false})Search QuerystringTrue
note

If force is set to true, the server will be rebooted immediately

curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
--data-raw '{
"id" : "server_id",
"account_server_reboot": {
"force" : "false"
}
}'
"https://api.console.nutanix.com/v1/accounts/${account_id}/servers/reboot"

Start a Server

Starts the specified server.

POST/accounts/:account_id/servers/:server_id/start

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account ID.URLstringTrue
server_external_idServer External ID.URLstringTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
--data-raw '{
"account_server_stop": {
"force" : "false"
}
}'
"https://api.console.nutanix.com/v1/accounts/${account_id}/servers/${server_id}/start"

Stop a Server

Shuts down the specified server.

POST/accounts/:account_id/servers/:server_id/stop

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account ID.URLstringTrue
server_external_idServer External ID.URLstringTrue
account_server_stopServer stop payload ({ "force": false})Search QuerystringTrue
note

If force is set to true, the server will be stopped immediately. This will not be considered a clean shutdown by the VM

curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
--data-raw '{
"account_server_stop": {
"force" : "false"
}
}'
"https://api.console.nutanix.com/v1/accounts/${account_id}/servers/${server_id}/stop"

Terminate Server

Terminates the specified server.

POST/accounts/:persistent_account_id/servers/:server_external_id/terminate

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account ID.URLstringTrue
server_external_idFrame "external" server ID (found by querying account servers).URLstringTrue
forceIf set to true, the server will be terminated immediately. If set to false, it will terminate as soon as it's available.Search QuerybooleanTrue
danger

This is an irreversable action, use with caution!

curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${persistent_account_id}/servers/${server_id}/terminate?force=false"

List Production Pool Capacity Settings

Returns the current min, buffer, and max values configured for a specific pool.

GET/pools/:pool_id/elasticity_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
pool_idID of the Instance Type/pool you're getting settings for.URLstringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/pools/${pool_id}/elasticity_settings"

Set Production Pool Capacity Settings

Sets new min, buffer, or max values for a specific production pool. Frame immediately sets new values and orchestrates workloads to match these settings. You can the status of this operation using the returned task ID.

caution

Practice caution and make sure you understand the meanings of minimum, buffer, and maximum server elasticity values before setting them via API. Incorrectly setting these values can be expensive in regards to infrastructure costs and resources.

Please allow these tasks to complete ("DONE" status) before making another request for the same pool.

POST/pools/:pool_id/elasticity_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
pool_idID of the specific pool you'd like to set capacity settings forURLStringTrue
min_serversMinimum servers value for a production poolForm DataStringFalse
buffer_serversBuffer servers value for a production poolForm DataStringFalse
max_serversMaximum server capacity value for a production poolForm DataStringTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/pools/${pool_id}/elasticity_settings" \
-F min_servers=5 \
-F buffer_servers=0 \
-F max_servers=80 \

Set Persistent Desktop Capacity Settings

Sets the current Persistent Desktop capacity settings for an account. This includes values for number_of_backups_to_save, max_users, and keep_instances_running_for_new_users.

caution

Practice caution with these values. For example, setting a lower max_users value below the current number of assigned persistent desktops will result in zero unassigned persistent desktops for new users. Incorrectly setting these values can be expensive in regards to infrastructure costs and resources.

Please allow these tasks to complete ("DONE" status) before making sending more capacity change requests.

POST/accounts/:persistent_account_id/persistent_desktop_elasticity_settings

Request Parameters

NameDescriptionParam TypeData TypeRequired
persistent_account_idID of your persistent Frame account.URLStringTrue
number_of_backups_to_saveLike it says, this value determines the number of persistent desktop backups to save for recovery.Form DataStringFalse
max_usersThis value is the maximum amount of persistent desktops you'd like to provision. Be mindful when lowering this value below the current number of assigned persistent desktops as that will result in zero unassigned persistent desktops for new users.Form DataStringTrue
keep_instances_running_for_new_usersIf true, unassigned persistent desktops will continue running until a new user connects and assigns it.Form DataBooleanTrue

For more information, reference our documentation about persistent desktop capacity settings.

curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${persistent_account_id}/persistent_desktop_elasticity_settings" \
-F number_of_backups_to_save=2 \
-F max_users=20 \
-F keep_instances_running_for_new_users=false \

List Elasticity Logs

Returns logs for elasticity changes.

GET/accounts/:account_id/elasticity-logs

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLStringTrue
instance_type_nameFilters results based on the instance type's name. For example, if our account was hosted in AWS, we could filter by “t2.medium”, “t3.large”, etc.Search QueryStringTrue
from_dateThe beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringTrue
to_dateThe ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/elasticity-logs?instance_type_name=t2.medium&from_date=2021-03-20T23:59:59.128Z&to_date=2022-03-15T23:59:59.128Z"

List Account Roles

Returns an array of available roles and the associated permissions to an account

GET/accounts/:account_id/roles

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idNutanix Account IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/roles"

List Account User Activity

Returns basic user “activity” information for the specified Account constrained by a date range. You'll receive a total count of user activities, as well as a unique count of users for the given time period. Can be ordered by passing a string parameter as well as exclude specified user Identity Provider Ids.

GET/accounts/:account_id/user_activities

Request Parameters

NameDescriptionParam TypeData TypeRequired
account_idFrame Account IDURLStringTrue
from_dateThe beginning date range for the query.Search QueryYYYY-MM-DD Date stringTrue
to_dateThe ending date range for the query.Search QueryYYYY-MM-DD Date stringTrue
orderSpecifies the order of the results. Use “asc” for ascending order, and “desc” for descending order.Search QueryStringFalse
order_bySpecifies the field of which the ordering should occur. For example, “session_start”, “session_duration”, etc.Search QueryStringFalse
skip_user_idps[]User Identity Providers to skip.Search QueryArray (String)False
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/user_activities?from_date=${from_date}&to_date=${to_date}&skip_user_idps[]=example-okta-admins&skip_user_idps[]=example-okta-dev"

List Servers for an Account

Returns all workload servers for an account.

GET/accounts/:account_id/servers

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
account_idYour Frame account ID.URLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${account_id}/servers"

Clone a Sandbox

This endpoint will clone a Sandbox image from one account to the specified target account. The target account and source account must belong to the same Cloud Provider (e.g. clone from AWS to AWS, GCP to GCP, Azure to Azure). You can check the status of this operation using the returned task ID.

caution

This process will overwrite the Sandbox image for the target account which means all existing data will be lost. Be sure to perform a backup before continuing.

POST/accounts/:target_account_id/pools/:source_pool_id/clone

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
target_account_idThis is the target account IDURLStringTrue
source_pool_idThe source account's Sandbox pool IDURLStringTrue
join_domainOptional. Can be true or false. Determines whether Frame should attempt to join the domain after the Sandbox has been cloned.search QueryStringFalse
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/pools/${source_pool_id}/clone"
-F join_domain=false

Get Task Status

Returns the current status of a provided task ID.

GET/accounts/:account_id/task/:task_id

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
task_idFrame Task IDURLStringTrue
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/task/${task_id}"

List Account Usage

Returns usage information for an account within a specified time period.

GET/accounts/:account_id/usage

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDSearch QueryStringTrue
from_dateThe beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringTrue
to_dateThe ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.Search QueryISO 8601 UTC StringTrue
resolution_typeWhat is the resolution type: by_hour, by_day, by_month, by_yearSearch QueryStringFalse
server_typeServer Type: by_hour, by_day, by_month, by_yearSearch QueryStringFalse
pool_idFrame Pool ID.Search QueryStringFalse
instance_type_idFrame Instance Type ID:Search QueryStringFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
-H "resolution_type: by_day" \
"https://api.console.nutanix.com/v1/accounts/${id}/usage?from_date=2021-12-01T23:20:58.128Z&to_date=2021-12-25T23:20:58.128Z"

List Disk Volume Usage

Returns the disk volume usage for a specified account in a specified time period.

GET/accounts/:account_id/disk_volume_usage?params=...

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
idFrame Account IDURLStringTrue
from_dateThe beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.URLISO 8601 UTC StringTrue
to_dateThe ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”.URLISO 8601 UTC StringTrue
server_typeServer Type: by_hour, by_day, by_month, by_yearSearch QueryStringFalse
resolution_typeDefaults to by_hour, options: by_hour, by_day, by_month, by_yearSearch QueryStringFalse
curl -X GET \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/disk_volume_usage?from_date=2020-01-01&to_date=2020-06-30&resolution_type=by_month"

List API Authorization Rules

Returns authorization rules for the account, organization, and customers, respectively.

  • GET/customers/:customer_id/api_authorization_rules
  • GET/organizations/:organization_id/api_authorization_rules
  • GET/accounts/:account_id/api_authorization_rules

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
entity_idFrame Account, Organization, or Customer ID.URLStringTrue
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/api_authorization_rules"

Create an Account

Accounts can be created within an organization with the following endpoint and parameters. Initiating an account creation will give you a task_id. You can check the status of the account creation via the task id.

Creating an account via our API requires a few parameters: cloud_service_external_id, data_center_external_id, sandbox_instance_type_id, image_family, master_image_id and disk_size. Look in each parameter's descriptions for where to find these values. If you're having trouble creating an account, please reach out to your Frame representative for assistance.

POST/accounts

Request Parameters

NameDescriptionParam TypeData TypeRequired
organization_idThe Frame Organization ID that the account will be created under.DataStringTrue
nameA unique name of the new account.DataStringTrue
url_slugA URL-friendly slug that will be used in URLs to access the account.DataStringTrue
cloud_service_external_idThis represents which Cloud Service (BYO) or Cloud Provider (Frame IaaS) the account will be created with. Use List Cloud Providers or List Cloud Services to locate these IDs. For example: gateway-prod.xx.DataStringTrue
data_center_external_idThis is the ID of a datacenter or “region” that will be used for the account. Use List Datacenters to locate these IDs. For example gateway-prod.xx.DataStringTrue
sandbox_instance_type_idThis ID is used to specify the instance type of the Sandbox. Use List Datacenters to find the Image Family and instance type you'd like, then use the instance type's ID here. For example: gateway-prod.xxDataStringTrue
image_familyThis references the name of an OS image that is supported by Frame. Use List Image Families to help find this value by each Image Family's name field.DataStringTrue
master_image_idRequired. ID of the master image that will be used to create the sandbox. Please query List Customer Master Images, or List Organization Master Images. For example: nutanix-prod.xxxxxx.DataStringTrue
disk_sizeOptional. Desired size of the sandbox image (in GiB). If this value is not provided, our system uses a default of 45 GiB. However, some operating systems images have different disk size requirements (e.g. Windows 2016 on AWS has a minimum of 64 GiB)DataStringFalse
curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/" \
-F organization_id=d63caa09-5723-4ab9-a1ea-6659b349aabe \
-F 'name=API Example Account on AWS' \
-F url_slug=example-account \
-F cloud_service_external_id=gateway-prod.55 \
-F data_center_external_id=gateway-prod.15 \
-F image_family=FrameAWSWindows2016 \
-F sandbox_instance_type_id=gateway-prod.33 \
-F master_image_id=gateway-prod.38512 \
-F disk_size=64

Create an Account Launchpad

Creates a Launchpad based on supplied parameters.

POST/accounts/:account_id/launchpad

Request Parameters

ParameterDescriptionParam TypeData TypeRequired
account_idID of the account the Launchpad will be created under.URLStringTrue
nameName of the new Launchpad.DataStringTrue
url_slugA URL-friendly slug that will be used in URLs to access the LaunchpadDataStringTrue
kindThis determines the kind of Launchpad you want to create. You can create two kinds: application and desktopDataStringTrue
tip

You can combine launchpad creation with other automation APIs, such as onboarding apps to your sandbox, publishing, and toggling apps and instance types on a Launchpad. All of these endpoints are documented here.

curl -X POST \
-H "X-Frame-ClientId: ${client_id}" \
-H "X-Frame-Timestamp: ${timestamp}" \
-H "X-Frame-Signature: ${signature}" \
"https://api.console.nutanix.com/v1/accounts/${id}/launchpad" \
-F 'name=Windows 2019 Desktop' \
-F url_slug=w2019-desktop \
-F kind=desktop \