Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMicrovmShellAuthToken

Creates a shell authentication token for interactive shell access to a running MicroVM. The MicroVM must have been run with the SHELL_INGRESS network connector attached.

Request Syntax


POST /2025-09-09/microvms/microvmIdentifier/shell-auth-token HTTP/1.1
Content-type: application/json

{
   "expirationInMinutes": number
}

URI Request Parameters

The request uses the following URI parameters.

microvmIdentifier

The ID of the MicroVM to create a shell authentication token for.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

expirationInMinutes

The duration in minutes before the shell authentication token expires.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "authToken": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

authToken

The generated shell authentication token key-value pairs for accessing the MicroVM.

Type: String to string map

Map Entries: Maximum number of 10 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [^\s]+

Value Length Constraints: Minimum length of 0. Maximum length of 8000.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. Retry the request later.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling. Retry the request later.

quotaCode: The quota code of the throttled service quota.
retryAfterSeconds: The number of seconds to wait before retrying the request.
serviceCode: The service code of the throttled service quota.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by the service.

HTTP Status Code: 400