POSThttps://api.spotinst.io/azure/compute/vm/signal?accountId={ACCOUNT_ID}

The VM signal API is used for notifying Spot about the VM state so that Spot can act accordingly. Supported signals are:

vmReady – Whenever this signal is sent, Spot will register the instance to the relevant Load Balancer and Application Gateway.

vmReadyToShutdown – When this signal is received after a vm is detached; we will immediately terminate the vm.

You must define the expected signals for your Elastigroup in the group configuration.

Parameter Type Description
ACCOUNT_ID String

Your Spot accountId associated with your token.

Example: act-123abc
Request

Headers
Copied!
Downloaded!
{
    "Content-Type": "application/json",
    "Authorization": "Bearer ${token}"
}
Body
Copied!
Downloaded!
{
  "vmName": "vm-123456",
  "signalType": "vmReady"
}

Body Attributes


Attribute Type Description
vmName * String

The virtual machine ID the signal refers to.

Example: vm-123456
signalType * enum: Enumeration

The specific signal you want to trigger. Valid Values: [vmReady,vmReadyToShutdown]

Example: instanceReady
Response - 200

Headers
Copied!
Downloaded!
{
    "Content-Type": "application/json"
}
Body
Copied!
Downloaded!
{
  "request": {
    "id": "3213e42e-455e-4901-a185-cc3eb65fac5f",
    "url": "/azure/compute/vm/signal",
    "method": "POST",
    "time": "2016-02-10T15:49:11.911Z"
  },
  "response": {
    "status": {
      "code": 200,
      "message": "OK"
    }
  }
}