Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Querying the Sysprep Version

Updated on 2025-07-14 GMT+08:00

View PDF

Querying the Sysprep Version

Queries the Sysprep version.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

GET /v2/{project_id}/desktops/{desktop_id}/sysprep

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
desktop_id	Yes	String	Desktop ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
sysprep_version	String	Sysprep version.
support_create_image	Boolean	Whether images can be created.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

None

Status code: 200

Response to the request for querying the Sysprep version.

{
  "sysprep_version" : "string",
  "support_create_image" : true
}

Status Code	Description
200	Response to the request for querying the Sysprep version.
400	The request cannot be understood by the server due to malformed syntax.
500	An internal service error occurred. For details, see the error code description.