Imports an AWS cluster

POST 
https://api.spectrocloud.com/v1/spectroclusters/aws/import

Authorization: ApiKey

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

Imports an AWS cluster

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

metadata object

ObjectMeta input entity for object creation

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

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

namestring

Name of the resource

spec object

clusterConfig object

importModestring

Possible values: [read-only]

If the importMode is empty then cluster is imported with full permission mode. By default importMode is empty and cluster is imported in full permission mode.

proxy object

Cluster proxy settings

caContainerMountPathstring

Location to mount Proxy CA cert inside container

caHostPathstring

Location for Proxy CA cert on host nodes

httpProxystring

URL for HTTP requests unless overridden by NoProxy

httpsProxystring

HTTPS requests unless overridden by NoProxy

noProxystring

NoProxy represents the NO_PROXY or no_proxy environment

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/spectroclusters/aws/import' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  },
  "spec": {
    "clusterConfig": {
      "importMode": "read-only",
      "proxy": {
        "caContainerMountPath": "string",
        "caHostPath": "string",
        "httpProxy": "string",
        "httpsProxy": "string",
        "noProxy": "string"
      }
    }
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

ProjectUid — header

Body

{
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  },
  "spec": {
    "clusterConfig": {
      "importMode": "read-only",
      "proxy": {
        "caContainerMountPath": "string",
        "caHostPath": "string",
        "httpProxy": "string",
        "httpsProxy": "string",
        "noProxy": "string"
      }
    }
  }
}