Adds the machine to cloud config's machine pool

POST 
https://api.spectrocloud.com/v1/cloudconfigs/aws/:configUid/machinePools/:machinePoolName/machines

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Adds the machine to cloud config's machine pool

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

machinePoolName stringrequired

Machine pool name

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
AWS cloud VM definition spec
additionalSecurityGroups object[]
Additional Security groups
Array [
arnstring
ARN of resource
filters object[]
Filters is a set of key/value pairs used to identify a resource
Array [
namestring
Name of the filter. Filter names are case-sensitive
valuesstring[]
Values includes one or more filter values. Filter values are case-sensitive
]
idstring
ID of resource
]
amistringrequired
azstring
dnsNamestring
iamProfilestring
instanceTypestringrequired
nics object[]
Array [
indexint8
privateIPsstring[]
publicIpstring
]
phasestring
sshKeyNamestring
subnetIdstring
typestring
vpcIdstringrequired
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

201

Created successfully

Response Headers

• AuditUid string

  Audit uid for the request

application/json

Schema

Schema

uidstringrequired

Example (from schema)

{
  "uid": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/cloudconfigs/aws/:configUid/machinePools/:machinePoolName/machines' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2023-12-01T21:31:48.007Z",
    "deletionTimestamp": "2023-12-01T21:31:48.007Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.007Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "additionalSecurityGroups": [
      {
        "arn": "string",
        "filters": [
          {
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "id": "string"
      }
    ],
    "ami": "string",
    "az": "string",
    "dnsName": "string",
    "iamProfile": "string",
    "instanceType": "string",
    "nics": [
      {
        "index": 0,
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "phase": "string",
    "sshKeyName": "string",
    "subnetId": "string",
    "type": "string",
    "vpcId": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2023-12-01T21:31:48.008Z",
      "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

ProjectUid — header

Body

{
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2023-12-01T21:31:48.007Z",
    "deletionTimestamp": "2023-12-01T21:31:48.007Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.007Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "additionalSecurityGroups": [
      {
        "arn": "string",
        "filters": [
          {
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "id": "string"
      }
    ],
    "ami": "string",
    "az": "string",
    "dnsName": "string",
    "iamProfile": "string",
    "instanceType": "string",
    "nics": [
      {
        "index": 0,
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "phase": "string",
    "sshKeyName": "string",
    "subnetId": "string",
    "type": "string",
    "vpcId": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2023-12-01T21:31:48.008Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}