Updates the specified machine to the cloud config's machine pool

PUT https://api.spectrocloud.com/v1/cloudconfigs/aks/:configUid/machinePools/:machinePoolName/machines/:machineUid

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

machinePoolName stringrequired

Machine pool name

machineUid stringrequired

Machine uid

application/json

Body

apiVersionstring

kindstring

metadata

object

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

annotations

object

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

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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespacestring

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

resourceVersionstring

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLinkstring

SelfLink is a URL representing this object. Populated by the system. Read-only.

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object

status

object

Responses

The resource was updated successfully

curl
python
go
nodejs
java

CURL

curl -L -X PUT 'https://api.spectrocloud.com/v1/cloudconfigs/aks/:configUid/machinePools/:machinePoolName/machines/:machineUid' \
-H 'Content-Type: application/json' \
--data-raw '{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-01T22:50:51.491Z",
    "deletionTimestamp": "2024-07-01T22:50:51.491Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-01T22:50:51.491Z",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "additionalTags": {},
    "allocatePublicIP": true,
    "availabilityZone": {
      "enabled": true,
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": 0,
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": 0,
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "Linux"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2024-07-01T22:50:51.491Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}'

Base URL

https://api.spectrocloud.com

Parameters

configUid — pathrequired

machinePoolName — pathrequired

machineUid — pathrequired

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-01T22:50:51.491Z",
    "deletionTimestamp": "2024-07-01T22:50:51.491Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-01T22:50:51.491Z",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "additionalTags": {},
    "allocatePublicIP": true,
    "availabilityZone": {
      "enabled": true,
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": 0,
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": 0,
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "Linux"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2024-07-01T22:50:51.491Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}

Updates the specified machine to the cloud config's machine pool

https://api.spectrocloud.com/v1/cloudconfigs/aks/:configUid/machinePools/:machinePoolName/machines/:machineUid

Request​

Path Parameters

Body

Responses​

Request

Responses