Updates the specified machine to cloud config's machine pool

PUT 
https://api.spectrocloud.com/v1/cloudconfigs/edge-native/:configUid/machinePools/:machinePoolName/machines/:machineUid

Updates the specified machine to cloud config's machine pool

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

machinePoolName stringrequired

Machine pool name

machineUid stringrequired

Machine uid

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

kindstring

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

Populated by the system. Read-only.

spec

object

EdgeNative cloud VM definition spec

edgeHostUidstring

instanceType

object

EdgeNativeInstanceType defines the instance configuration for a docker container node

diskGiBint32

DiskGiB is the size of a virtual machine's disk

memoryMiBint32

MemoryMiB is the size of a virtual machine's memory, in MiB

namestring

Name is the instance name

numCPUsint32

NumCPUs is the number of CPUs

nics

object[]

Array [

indexint8

networkNamestring

privateIPsstring[]

publicIpstring

]

status

object

cloud machine status

health

object

Machine health state

conditions

object[]

Array [

messagestring

reasonstring

statusstring

typestring

]

lastHeartBeatTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

statestring

instanceStatestring

Possible values: [Pending, Provisioning, Provisioned, Running, Deleting, Deleted, Failed, Unknown]

maintenanceStatus

object

Machine maintenance status

actionstring

messagestring

statestring

Responses

204

The resource was updated successfully

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X PUT 'https://api.spectrocloud.com/v1/cloudconfigs/edge-native/:configUid/machinePools/:machinePoolName/machines/:machineUid' \
-H 'Content-Type: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
-d '{
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-29T15:51:28.071Z",
    "deletionTimestamp": "2024-07-29T15:51:28.071Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "edgeHostUid": "string",
    "instanceType": {
      "diskGiB": 0,
      "memoryMiB": 0,
      "name": "string",
      "numCPUs": 0
    },
    "nics": [
      {
        "index": 0,
        "networkName": "string",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ]
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2024-07-29T15:51:28.071Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

configUid — pathrequired

machinePoolName — pathrequired

machineUid — pathrequired

ProjectUid — header

Body

{
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-29T15:51:28.071Z",
    "deletionTimestamp": "2024-07-29T15:51:28.071Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "edgeHostUid": "string",
    "instanceType": {
      "diskGiB": 0,
      "memoryMiB": 0,
      "name": "string",
      "numCPUs": 0
    },
    "nics": [
      {
        "index": 0,
        "networkName": "string",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ]
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2024-07-29T15:51:28.071Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}