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

Return to the regular view of this page.

Create Nodepool

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

post /v1/nodepools

Description

create a nodepool

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		NodepoolCreateRequestV1Dot3

Responses

HTTP Code	Description	Schema
200	OK	NodepoolShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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"
        }
    }
}

2 - 1.2

post /v1/nodepools

Description

create a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261014

Parameters

Type	Name	Description	Schema	Default
body	body required		NodepoolCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	NodepoolShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 - 1.1

post /v1/nodepools

Description

create a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
body	body required		NodepoolCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	NodepoolShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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"
        }
    }
}

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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		NodepoolCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	NodepoolShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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"
        }
    }
}