Imports a cluster profile

POST 
https://api.spectrocloud.com/v1/clusterprofiles/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 a cluster profile

Request

Query Parameters

publish boolean

If true then cluster profile will be published post successful import

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

metadata object

Cluster profile import metadata

descriptionstring

Cluster profile description

labels object

Cluster profile labels

property name*string

namestring

Cluster profile name

spec object

Cluster profile import spec

template object

Cluster profile import template

cloudTypestring

Cluster profile cloud type

packs object[]

Cluster profile packs array

Array [

layerstring

Pack layer [ "os", "k8s", "cni", "csi", "addon" ]

manifests object[]

Pack manifests array

Array [

contentstring

Pack manifest content in yaml

namestring

Pack manifest name

]

namestring

Pack name

registry object

Pack registry import entity

matchingRegistries object[]

Array [

isPrivateboolean

If true then pack registry is private and is not accessible for the pack sync

kindstring

Pack registry kind [ "pack", "helm", "oci" ]

namestring

Pack registry name

uidstring

Pack registry uid

]

metadata object

Pack registry metadata

isPrivateboolean

If true then pack registry is private and is not accessible for the pack sync

kindstring

Pack registry kind [ "pack", "helm", "oci" ]

namestring

Pack registry name

uidstring

Pack registry uid

tagstring

Pack version tag

typestring

Pack type [ "spectro", "helm", "manifest", "oci" ]

valuesstring

Pack values are the customizable configurations for the pack

versionstring

Pack version

]

typestring

Cluster profile type [ "cluster", "infra", "add-on", "system" ]

versionstring

Cluster profile version

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/clusterprofiles/import' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "metadata": {
    "description": "string",
    "labels": {},
    "name": "string"
  },
  "spec": {
    "template": {
      "cloudType": "string",
      "packs": [
        {
          "layer": "string",
          "manifests": [
            {
              "content": "string",
              "name": "string"
            }
          ],
          "name": "string",
          "registry": {
            "matchingRegistries": [
              {
                "isPrivate": true,
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "metadata": {
              "isPrivate": true,
              "kind": "string",
              "name": "string",
              "uid": "string"
            }
          },
          "tag": "string",
          "type": "string",
          "values": "string",
          "version": "string"
        }
      ],
      "type": "string"
    },
    "version": "string"
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

publish — query

---truefalse

ProjectUid — header

Body

{
  "metadata": {
    "description": "string",
    "labels": {},
    "name": "string"
  },
  "spec": {
    "template": {
      "cloudType": "string",
      "packs": [
        {
          "layer": "string",
          "manifests": [
            {
              "content": "string",
              "name": "string"
            }
          ],
          "name": "string",
          "registry": {
            "matchingRegistries": [
              {
                "isPrivate": true,
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "metadata": {
              "isPrivate": true,
              "kind": "string",
              "name": "string",
              "uid": "string"
            }
          },
          "tag": "string",
          "type": "string",
          "values": "string",
          "version": "string"
        }
      ],
      "type": "string"
    },
    "version": "string"
  }
}