This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

APIs

1 - Create Cluster

1.1 - 1.3

post /v1/clusters

Description

create a cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ClusterCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "cloud_logging_enabled": "true",
    "kubernetes_version": "v1.29.8",
    "name": "sample-cluster",
    "private_endpoint_access_control_resources": [],
    "public_endpoint_access_control_ip": "192.168.0.0",
    "security_group_id_list": [
        "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
    ],
    "service_watch_logging_enabled": "true",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": [],
    "volume_id": [
        "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    ],
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.2 - 1.2

post /v1/clusters

Description

create a cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ClusterCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "cloud_logging_enabled": "true",
    "kubernetes_version": "v1.29.8",
    "name": "sample-cluster",
    "private_endpoint_access_control_resources": [],
    "public_endpoint_access_control_ip": "192.168.0.0",
    "security_group_id_list": [
        "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
    ],
    "service_watch_logging_enabled": "true",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": [],
    "volume_id": [
        "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    ],
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.3 - 1.1

post /v1/clusters

Description

create a cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ClusterCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "cloud_logging_enabled": "true",
    "kubernetes_version": "v1.29.8",
    "name": "sample-cluster",
    "private_endpoint_access_control_resources": [],
    "public_endpoint_access_control_ip": "192.168.0.0",
    "security_group_id_list": [
        "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
    ],
    "service_watch_logging_enabled": "true",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": [],
    "volume_id": [
        "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    ],
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.4 - 1.0

post /v1/clusters

Description

create a cluster V1.0

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ClusterCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "cloud_logging_enabled": "true",
    "kubernetes_version": "v1.29.8",
    "name": "sample-cluster",
    "private_endpoint_access_control_resources": [],
    "public_endpoint_access_control_ip": "192.168.0.0",
    "security_group_id_list": [
        "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
    ],
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": [],
    "volume_id": [
        "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    ],
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

2 - Create Cluster Kubeconfig

2.1 - 1.3

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

2.2 - 1.2

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

2.3 - 1.1

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

2.4 - 1.0

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

3 - Create Nodepool

3.1 - 1.3

post /v1/nodepools

Description

create a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NodepoolCreateRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "advanced_settings": {
        "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
        "container_log_max_files": "5",
        "container_log_max_size": "10",
        "image_gc_high_threshold": "85",
        "image_gc_low_threshold": "80",
        "max_pods": "110",
        "pod_max_pids": "4096"
    },
    "cluster_id": "70a599e031e749b7b260868f441e862b",
    "custom_image_id": "10a599e031e749b7b260868f441e862b",
    "desired_node_count": "2",
    "image_os": "ubuntu",
    "image_os_version": "22.04",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "keypair_name": "test_keypair",
    "kubernetes_version": "v1.29.8",
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "linked_resources": [
        {
            "id": "res-12345678",
            "name": "my-resource",
            "type": "security_group"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
    "server_type_id": "10a599e031e749b7b260868f441e862b",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD"
}

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "linked_resources": [
            {
                "id": "res-12345678",
                "name": "my-resource",
                "type": "security_group"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

3.2 - 1.2

post /v1/nodepools

Description

create a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NodepoolCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "advanced_settings": {
        "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
        "container_log_max_files": "5",
        "container_log_max_size": "10",
        "image_gc_high_threshold": "85",
        "image_gc_low_threshold": "80",
        "max_pods": "110",
        "pod_max_pids": "4096"
    },
    "cluster_id": "70a599e031e749b7b260868f441e862b",
    "custom_image_id": "10a599e031e749b7b260868f441e862b",
    "desired_node_count": "2",
    "image_os": "ubuntu",
    "image_os_version": "22.04",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "keypair_name": "test_keypair",
    "kubernetes_version": "v1.29.8",
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
    "server_type_id": "10a599e031e749b7b260868f441e862b",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD"
}

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

3.3 - 1.1

post /v1/nodepools

Description

create a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NodepoolCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "advanced_settings": {
        "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
        "container_log_max_files": "5",
        "container_log_max_size": "10",
        "image_gc_high_threshold": "85",
        "image_gc_low_threshold": "80",
        "max_pods": "110",
        "pod_max_pids": "4096"
    },
    "cluster_id": "70a599e031e749b7b260868f441e862b",
    "custom_image_id": "10a599e031e749b7b260868f441e862b",
    "desired_node_count": "2",
    "image_os": "ubuntu",
    "image_os_version": "22.04",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "keypair_name": "test_keypair",
    "kubernetes_version": "v1.29.8",
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
    "server_type_id": "10a599e031e749b7b260868f441e862b",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD"
}

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

3.4 - 1.0

post /v1/nodepools

Description

create a nodepool v1.0

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NodepoolCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "cluster_id": "70a599e031e749b7b260868f441e862b",
    "custom_image_id": "10a599e031e749b7b260868f441e862b",
    "desired_node_count": "2",
    "image_os": "ubuntu",
    "image_os_version": "22.04",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "keypair_name": "test_keypair",
    "kubernetes_version": "v1.29.8",
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "server_type_id": "10a599e031e749b7b260868f441e862b",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD"
}

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

4 - Delete Cluster

4.1 - 1.3

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

4.2 - 1.2

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

4.3 - 1.1

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

4.4 - 1.0

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

5 - Delete Nodepool

5.1 - 1.3

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

5.2 - 1.2

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

5.3 - 1.1

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

5.4 - 1.0

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

6 - List Clusters

6.1 - 1.3

get /v1/clusters

Description

get clusters list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
Cluster Name
Example : sample-cluster
any of [string, null]None
querystatus
optional
Cluster Status
Example : RUNNING
any of [array[string], string, null]None
querykubernetes_version
optional
Cluster Version
Example : v1.29.8
any of [array[string], string, null]None
querysubnet_id
optional
Cluster Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKClusterListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

{
    "clusters": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "created_at": "2025-03-31T00:23:17Z",
            "id": "70a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "modified_at": "2025-06-31T00:23:17Z",
            "name": "sample-cluster",
            "node_count": "5",
            "status": "RUNNING",
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.2 - 1.2

get /v1/clusters

Description

get clusters list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
Cluster Name
Example : sample-cluster
any of [string, null]None
querystatus
optional
Cluster Status
Example : RUNNING
any of [array[string], string, null]None
querykubernetes_version
optional
Cluster Version
Example : v1.29.8
any of [array[string], string, null]None
querysubnet_id
optional
Cluster Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKClusterListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

{
    "clusters": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "created_at": "2025-03-31T00:23:17Z",
            "id": "70a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "modified_at": "2025-06-31T00:23:17Z",
            "name": "sample-cluster",
            "node_count": "5",
            "status": "RUNNING",
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.3 - 1.1

get /v1/clusters

Description

get clusters list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
Cluster Name
Example : sample-cluster
any of [string, null]None
querystatus
optional
Cluster Status
Example : RUNNING
any of [array[string], string, null]None
querykubernetes_version
optional
Cluster Version
Example : v1.29.8
any of [array[string], string, null]None
querysubnet_id
optional
Cluster Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKClusterListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "clusters": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "created_at": "2025-03-31T00:23:17Z",
            "id": "70a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "modified_at": "2025-06-31T00:23:17Z",
            "name": "sample-cluster",
            "node_count": "5",
            "status": "RUNNING",
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.4 - 1.0

get /v1/clusters

Description

get clusters list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
Cluster Name
Example : sample-cluster
any of [string, null]None
querystatus
optional
Cluster Status
Example : RUNNING
any of [array[string], string, null]None
querykubernetes_version
optional
Cluster Version
Example : v1.29.8
any of [array[string], string, null]None
querysubnet_id
optional
Cluster Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKClusterListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "clusters": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "created_at": "2025-03-31T00:23:17Z",
            "id": "70a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "modified_at": "2025-06-31T00:23:17Z",
            "name": "sample-cluster",
            "node_count": "5",
            "status": "RUNNING",
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

7 - List Images

7.1 - 1.3

get /v1/images

Description

List ske node images available for nodepool creation

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querykubernetes_version
optional
Kubernetes Version
Example : v1.29.8
any of [string, null]None
queryscp_original_image_type
required
scp original image type (k8s, k8s_gpu)
Example : k8s
stringNone
queryos
optional
Image OS
Example : ubuntu
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolImageListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/images?scp_original_image_type={scp_original_image_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepool_images": [
        {
            "end_of_support": false,
            "id": "10a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "name": "ubuntu-22.04-k8s-v1.29.8",
            "os": "ubuntu",
            "os_version": "22.04",
            "scp_image_type": "k8s",
            "scp_original_image_type": "k8s",
            "volume": {
                "size": 100
            }
        }
    ]
}

7.2 - 1.2

get /v1/images

Description

List ske node images available for nodepool creation

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querykubernetes_version
optional
Kubernetes Version
Example : v1.29.8
any of [string, null]None
queryscp_original_image_type
required
scp original image type (k8s, k8s_gpu)
Example : k8s
stringNone
queryos
optional
Image OS
Example : ubuntu
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolImageListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/images?scp_original_image_type={scp_original_image_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepool_images": [
        {
            "end_of_support": false,
            "id": "10a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "name": "ubuntu-22.04-k8s-v1.29.8",
            "os": "ubuntu",
            "os_version": "22.04",
            "scp_image_type": "k8s",
            "scp_original_image_type": "k8s",
            "volume": {
                "size": 100
            }
        }
    ]
}

8 - List Kubernetes Versions

8.1 - 1.3

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Responses

HTTP CodeDescriptionSchema
200OKKubernetesVersionListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "end_dt": "2025-06-31T00:00:00Z",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

8.2 - 1.2

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Responses

HTTP CodeDescriptionSchema
200OKKubernetesVersionListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "end_dt": "2025-06-31T00:00:00Z",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

8.3 - 1.1

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Responses

HTTP CodeDescriptionSchema
200OKKubernetesVersionListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "end_dt": "2025-06-31T00:00:00Z",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

8.4 - 1.0

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Responses

HTTP CodeDescriptionSchema
200OKKubernetesVersionListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "end_dt": "2025-06-31T00:00:00Z",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

9 - List Nodepool Nodes

9.1 - 1.3

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynode_name
optional
Node Name
Example : ske-aug-rhel-0805-1-84d799f767-8dr2p
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodeListInNodepoolResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodes": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "kubernetes_version": "v1.29.8",
            "name": "ske-aug-rhel-0805-1-84d799f767-8dr2p",
            "status": "RUNNING"
        }
    ]
}

9.2 - 1.2

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynode_name
optional
Node Name
Example : ske-aug-rhel-0805-1-84d799f767-8dr2p
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodeListInNodepoolResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodes": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "kubernetes_version": "v1.29.8",
            "name": "ske-aug-rhel-0805-1-84d799f767-8dr2p",
            "status": "RUNNING"
        }
    ]
}

9.3 - 1.1

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynode_name
optional
Node Name
Example : ske-aug-rhel-0805-1-84d799f767-8dr2p
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodeListInNodepoolResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodes": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "kubernetes_version": "v1.29.8",
            "name": "ske-aug-rhel-0805-1-84d799f767-8dr2p",
            "status": "RUNNING"
        }
    ]
}

9.4 - 1.0

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynode_name
optional
Node Name
Example : ske-aug-rhel-0805-1-84d799f767-8dr2p
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodeListInNodepoolResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodes": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "kubernetes_version": "v1.29.8",
            "name": "ske-aug-rhel-0805-1-84d799f767-8dr2p",
            "status": "RUNNING"
        }
    ]
}

10 - List Nodepools

10.1 - 1.3

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynodepool_name
optional
Nodepool Name
Example : sample-nodepool
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepools": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "auto_recovery_enabled": "",
            "auto_scale_enabled": "",
            "current_node_count": "1",
            "desired_node_count": "2",
            "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
            "image": {
                "custom_image_name": "custom-image",
                "os": "ubuntu",
                "os_version": "22.04"
            },
            "kubernetes_version": "v1.29.8",
            "name": "sample-nodepool",
            "server_type": {
                "description": "Standard",
                "id": "10a599e031e749b7b260868f441e862b"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD"
            }
        }
    ]
}

10.2 - 1.2

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynodepool_name
optional
Nodepool Name
Example : sample-nodepool
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepools": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "auto_recovery_enabled": "",
            "auto_scale_enabled": "",
            "current_node_count": "1",
            "desired_node_count": "2",
            "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
            "image": {
                "custom_image_name": "custom-image",
                "os": "ubuntu",
                "os_version": "22.04"
            },
            "kubernetes_version": "v1.29.8",
            "name": "sample-nodepool",
            "server_type": {
                "description": "Standard",
                "id": "10a599e031e749b7b260868f441e862b"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD"
            }
        }
    ]
}

10.3 - 1.1

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynodepool_name
optional
Nodepool Name
Example : sample-nodepool
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepools": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "auto_recovery_enabled": "",
            "auto_scale_enabled": "",
            "current_node_count": "1",
            "desired_node_count": "2",
            "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
            "image": {
                "custom_image_name": "custom-image",
                "os": "ubuntu",
                "os_version": "22.04"
            },
            "kubernetes_version": "v1.29.8",
            "name": "sample-nodepool",
            "server_type": {
                "description": "Standard",
                "id": "10a599e031e749b7b260868f441e862b"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD"
            }
        }
    ]
}

10.4 - 1.0

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynodepool_name
optional
Nodepool Name
Example : sample-nodepool
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepools": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "auto_recovery_enabled": "",
            "auto_scale_enabled": "",
            "current_node_count": "1",
            "desired_node_count": "2",
            "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
            "image": {
                "custom_image_name": "custom-image",
                "os": "ubuntu",
                "os_version": "22.04"
            },
            "kubernetes_version": "v1.29.8",
            "name": "sample-nodepool",
            "server_type": {
                "description": "Standard",
                "id": "10a599e031e749b7b260868f441e862b"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD"
            }
        }
    ]
}

11 - Set Cluster Logging

11.1 - 1.3

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

11.2 - 1.2

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

11.3 - 1.1

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

11.4 - 1.0

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

12 - Set Cluster Private Access Control

12.1 - 1.3

put /v1/clusters/{cluster_id}/private-access-control

Description

set a private access control specific cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPrivateAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/private-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "private_endpoint_access_control_resources": [
        {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name",
            "type": "vm"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

12.2 - 1.2

put /v1/clusters/{cluster_id}/private-access-control

Description

set a private access control specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPrivateAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/private-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "private_endpoint_access_control_resources": [
        {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name",
            "type": "vm"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

12.3 - 1.1

put /v1/clusters/{cluster_id}/private-access-control

Description

set a private access control specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPrivateAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/private-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "private_endpoint_access_control_resources": [
        {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name",
            "type": "vm"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

12.4 - 1.0

put /v1/clusters/{cluster_id}/private-access-control

Description

set a private access control specific cluster

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPrivateAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/private-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "private_endpoint_access_control_resources": [
        {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name",
            "type": "vm"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

13 - Set Cluster Public Access Control

13.1 - 1.3

put /v1/clusters/{cluster_id}/public-access-control

Description

set a public access control specific cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPublicAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/public-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

13.2 - 1.2

put /v1/clusters/{cluster_id}/public-access-control

Description

set a public access control specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPublicAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/public-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

13.3 - 1.1

put /v1/clusters/{cluster_id}/public-access-control

Description

set a public access control specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPublicAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/public-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

13.4 - 1.0

put /v1/clusters/{cluster_id}/public-access-control

Description

set a public access control specific cluster

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPublicAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/public-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

14 - Set Cluster Security Groups

14.1 - 1.3

put /v1/clusters/{cluster_id}/security-groups

Description

Set Cluster Security Groups

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterSecurityGroupsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "security_group_id_list": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
}

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

14.2 - 1.2

put /v1/clusters/{cluster_id}/security-groups

Description

Set Cluster Security Groups

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterSecurityGroupsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "security_group_id_list": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
}

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

14.3 - 1.1

put /v1/clusters/{cluster_id}/security-groups

Description

Set Cluster Security Groups

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterSecurityGroupsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "security_group_id_list": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
}

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

14.4 - 1.0

put /v1/clusters/{cluster_id}/security-groups

Description

Set Cluster Security Groups

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterSecurityGroupsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "security_group_id_list": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
}

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

15 - Set Cluster Service Watch Logging

15.1 - 1.3

put /v1/clusters/{cluster_id}/service-watch-logging

Description

Set Service Watch logging on the cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterServiceWatchLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/service-watch-logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "service_watch_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

15.2 - 1.2

put /v1/clusters/{cluster_id}/service-watch-logging

Description

Set Service Watch logging on the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterServiceWatchLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/service-watch-logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "service_watch_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

15.3 - 1.1

put /v1/clusters/{cluster_id}/service-watch-logging

Description

Set Service Watch logging on the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterServiceWatchLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/service-watch-logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "service_watch_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

16 - Set Cluster Upgrade

16.1 - 1.3

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

16.2 - 1.2

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

16.3 - 1.1

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

16.4 - 1.0

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

17 - Set Nodepool

17.1 - 1.3

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "desired_node_count": "2",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "max_node_count": "5",
    "min_node_count": "1"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

17.2 - 1.2

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "desired_node_count": "2",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "max_node_count": "5",
    "min_node_count": "1"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

17.3 - 1.1

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "desired_node_count": "2",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "max_node_count": "5",
    "min_node_count": "1"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

17.4 - 1.0

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "desired_node_count": "2",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "max_node_count": "5",
    "min_node_count": "1"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

18 - Set Nodepool Labels

18.1 - 1.3

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolLabelsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

18.2 - 1.2

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolLabelsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

18.3 - 1.1

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolLabelsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

18.4 - 1.0

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolLabelsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

19 - Set Nodepool Linked Resources

19.1 - 1.3

put /v1/nodepools/{nodepool_id}/linked-resources

Description

set nodepool linked resources

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolLinkedResourcesSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/linked-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "linked_resources": [
        {
            "id": "res-12345678",
            "name": "my-resource",
            "type": "security_group"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

20 - Set Nodepool Taints

20.1 - 1.3

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolTaintsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

20.2 - 1.2

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolTaintsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

20.3 - 1.1

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolTaintsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

20.4 - 1.0

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolTaintsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

21 - Set Nodepool Upgrade

21.1 - 1.3

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Request body

{
    "os_version": "22.04"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

21.2 - 1.2

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Request body

{
    "os_version": "22.04"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

21.3 - 1.1

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "os_version": "22.04"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

21.4 - 1.0

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool v1.0

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

22 - Show Cluster

22.1 - 1.3

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "service_watch_logging_enabled": "true",
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

22.2 - 1.2

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "service_watch_logging_enabled": "true",
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

22.3 - 1.1

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "service_watch_logging_enabled": "true",
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

22.4 - 1.0

get /v1/clusters/{cluster_id}

Description

show a cluster v1.0

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "private_kubeconfig_download_yn": "N",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

23 - Show Cluster User Kubeconfig

23.1 - 1.3

get /v1/clusters/{cluster_id}/user-kubeconfig

Description

Show user kubeconfig for the cluster

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/user-kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

23.2 - 1.2

get /v1/clusters/{cluster_id}/user-kubeconfig

Description

Show user kubeconfig for the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/user-kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

23.3 - 1.1

get /v1/clusters/{cluster_id}/user-kubeconfig

Description

Show user kubeconfig for the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/user-kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

23.4 - 1.0

get /v1/clusters/{cluster_id}/user-kubeconfig

Description

Show user kubeconfig for the cluster

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/user-kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

24 - Show Nodepool

24.1 - 1.3

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.3"

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "linked_resources": [
            {
                "id": "res-12345678",
                "name": "my-resource",
                "type": "security_group"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

24.2 - 1.2

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261014

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.2"

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

24.3 - 1.1

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

24.4 - 1.0

get /v1/nodepools/{nodepool_id}

Description

show a nodepool v1.0

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}