This guide provides a brief description of Container Registry service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.1	CURRENT	-
1.0	SUPPORTED	20260630

OpenAPI URL

https://scr.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

API Version History

1.1

Container Registry has been updated to version 1.1.

Changes

[Updated] POST /repositories - The following field has been added to the request.
- lifecycle_policy
  - outdated_rule_tag_expression
[Updated] GET /images/{image_id} - The following field has been added to the response.
- lifecycle_policy
  - outdated_rule_tag_expression
[Updated] GET /images/{image_id}/lifecycle-policy/preview - The following field has been added to the response.
- outdated_rule_tag_expression
[Updated] GET /repositories/{repository_id} - The following field has been added to the response.
- lifecycle_policy
  - outdated_rule_tag_expression
[Updated] PUT /images/{image_id}/lifecycle-policy - The following field has been added to the request.
- outdated_rule_tag_expression
[Updated] PUT /repositories/{repository_id}/lifecycle-policy - The following field has been added to the request.
- outdated_rule_tag_expression

1.0

Container Registry version 1.0 has been released.

Changes

[New] GET /container-registries/check-duplication/name - Check Registry Name Duplication API has been added.
[New] GET /repositories/check-duplication/name - Check Repository Name Duplication API has been added.
[New] PUT /tagses/{tags_id}/check-vulnerability - Check Tags Vulnerability API has been added.
[New] POST /container-registries - Create Registry API has been added.
[New] POST /repositories - Create Repository API has been added.
[New] DELETE /images/{image_id} - Delete Image API has been added.
[New] DELETE /container-registries/{registry_id} - Delete Registry API has been added.
[New] DELETE /repositories/{repository_id} - Delete Repository API has been added.
[New] DELETE /tagses/{tags_id} - Delete Tags API has been added.
[New] DELETE /tagses - Delete Tagses API has been added.
[New] GET /tagses/{tags_id}/download/manifest - Download Manifest API has been added.
[New] GET /container-registries/connectable-resources - List Connectable Resources API has been added.
[New] GET /repositories/{repository_id}/images - List Images API has been added.
[New] GET /container-registries - List Registries API has been added.
[New] GET /container-registrie/{registry_id}/repositories - List Repositories API has been added.
[New] GET /images/{image_id}/tagses - List tagses API has been added.
[New] POST /images/{image_id}/lifecycle-policy/preview - Run Image Lifecycle Policy Preview API has been added.
[New] GET /images/{image_id} - Show Image API has been added.
[New] GET /images/{image_id}/lifecycle-policy/preview - Show Image Lifecycle Policy Preview API has been added.
[New] GET /container-registries/{registry_id} - Show Registry API has been added.
[New] GET /repositories/{repository_id} - Show Repository API has been added.
[New] GET /tagses/{tags_id} - Show Tags API has been added.
[New] GET /tagses/{tags_id}/packages - Show Tags Packages API has been added.
[New] GET /tagses/{tags_id}/secrets - Show Tags Secrets API has been added.
[New] GET /tagses/{tags_id}/vulnerabilities - Show Tags Vulnerabilities API has been added.
[New] PUT /images/{image_id}/description - Update Image Description API has been added.
[New] PUT /images/{image_id}/lifecycle-policy - Update Image Lifecycle Policy API has been added.
[New] PUT /images/{image_id}/lock-policy - Update Image Lock Policy API has been added.
[New] PUT /images/{image_id}/pull-policy - Update Image Pull Policy API has been added.
[New] PUT /images/{image_id}/scan-policy - Update Image Scan Policy API has been added.
[New] PUT /container-registries/{registry_id}/private-acl - Update Pricate Acl API has been added.
[New] PUT /container-registries/{registry_id}/public-acl - Update Public Acl API has been added.
[New] PUT /container-registries/{registry_id}/enable-public-endpoint - Update Public Endpoint Enabled API has been added.
[New] PUT /repositories/{repository_id}/description - Update Repository Description API has been added.
[New] PUT /repositories/{repository_id}/lifecycle-policy - Update Repository Lifecycle Policy API has been added.
[New] PUT /repositories/{repository_id}/lock-policy - Update Repository Lock Policy API has been added.
[New] PUT /repositories/{repository_id}/pull-policy - Update Repository Pull Policy API has been added.
[New] PUT /repositories/{repository_id}/scan-policy - Update Repository Scan Policy API has been added.
[New] PUT /tagses/{tags_id}/lock-policy - Update Tags Lock Policy API has been added.

1.1 - APIs

1.1.1 - Check Registry Name Duplication

1.1.1.1 - 1.1

get /v1/container-registries/check-duplication/name

Description

check registry name duplication

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	name required	Registry name Example : `sample`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/check-duplication/name?name={name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.1.2 - 1.0

get /v1/container-registries/check-duplication/name

Description

check registry name duplication

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
query	name required	Registry name Example : `sample`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/check-duplication/name?name={name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.2 - Check Repository Name Duplication

1.1.2.1 - 1.1

get /v1/repositories/check-duplication/name

Description

check repository name duplication

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
query	name required	Repository name Example : `sample`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories/check-duplication/name?registry_id={registry_id}&name={name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.2.2 - 1.0

get /v1/repositories/check-duplication/name

Description

check repository name duplication

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
query	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
query	name required	Repository name Example : `sample`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories/check-duplication/name?registry_id={registry_id}&name={name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.3 - Check Tags Vulnerability

1.1.3.1 - 1.1

put /v1/tagses/{tags_id}/check-vulnerability

Description

check tags vulnerability

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/check-vulnerability

Request header

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

Example HTTP response

Response 200

1.1.3.2 - 1.0

put /v1/tagses/{tags_id}/check-vulnerability

Description

check tags vulnerability

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/check-vulnerability

Request header

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

Example HTTP response

Response 200

1.1.4 - Create Registry

1.1.4.1 - 1.1

post /v1/container-registries

Description

create registry

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ContainerRegistryCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	ContainerRegistryCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries

Request header

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

Request body

{
    "name": "sample",
    "private_acl_enabled": true,
    "private_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ],
    "public_acl_enabled": true,
    "public_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ],
    "public_endpoint_enabled": true,
    "public_visible_enabled": true,
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "rpqtmqgec3174541bbf77eecf2cd3585",
    "message": "Carpe diem.",
    "state": "Running"
}

1.1.4.2 - 1.0

post /v1/container-registries

Description

create registry

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		ContainerRegistryCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	ContainerRegistryCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries

Request header

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

Request body

{
    "name": "sample",
    "private_acl_enabled": true,
    "private_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ],
    "public_acl_enabled": true,
    "public_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ],
    "public_endpoint_enabled": true,
    "public_visible_enabled": true,
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "rpqtmqgec3174541bbf77eecf2cd3585",
    "message": "Carpe diem.",
    "state": "Running"
}

1.1.5 - Create Repository

1.1.5.1 - 1.1

post /v1/repositories

Description

create repository

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		RepositoryCreateRequestV1_1

Responses

HTTP Code	Description	Schema
201	Created	RepositoryCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories

Request header

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

Request body

{
    "description": "Carpe diem.",
    "lifecycle_policy": {
        "lifecycle_policy_enabled": true,
        "outdated_rule_duration": 90,
        "outdated_rule_enabled": true,
        "outdated_rule_tag_expression": "*",
        "untagged_rule_duration": 90,
        "untagged_rule_enabled": true
    },
    "lock_policy": {
        "locked": true
    },
    "name": "sample",
    "pull_policy": {
        "critical_limit": 20,
        "high_limit": 20,
        "unmodified_excepted": true,
        "unscanned_image_pull_prevented": true,
        "vulnerable_image_pull_prevented": true
    },
    "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
    "scan_policy": {
        "auto_scan_enabled": true,
        "fixed_version_excepted": true,
        "language_excepted": true,
        "scan_policy_enabled": true,
        "secret_excepted": true,
        "severity_limit": "High"
    },
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "e5611ca6c1484df480668c5adce8b078",
    "message": "Carpe diem.",
    "state": "Active"
}

1.1.5.2 - 1.0

post /v1/repositories

Description

create repository

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		RepositoryCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	RepositoryCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories

Request header

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

Request body

{
    "description": "Carpe diem.",
    "lifecycle_policy": {
        "lifecycle_policy_enabled": true,
        "outdated_rule_duration": 90,
        "outdated_rule_enabled": true,
        "untagged_rule_duration": 90,
        "untagged_rule_enabled": true
    },
    "lock_policy": {
        "locked": true
    },
    "name": "sample",
    "pull_policy": {
        "critical_limit": 20,
        "high_limit": 20,
        "unmodified_excepted": true,
        "unscanned_image_pull_prevented": true,
        "vulnerable_image_pull_prevented": true
    },
    "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
    "scan_policy": {
        "auto_scan_enabled": true,
        "fixed_version_excepted": true,
        "language_excepted": true,
        "scan_policy_enabled": true,
        "secret_excepted": true,
        "severity_limit": "High"
    },
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "e5611ca6c1484df480668c5adce8b078",
    "message": "Carpe diem.",
    "state": "Active"
}

1.1.6 - Delete Image

1.1.6.1 - 1.1

delete /v1/images/{image_id}

Description

delete image

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None
423	Locked	None

Example HTTP request

Request path

/v1/images/{image_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 = scr 1.1"

Example HTTP response

Response 202

1.1.6.2 - 1.0

delete /v1/images/{image_id}

Description

delete image

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None
423	Locked	None

Example HTTP request

Request path

/v1/images/{image_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 = scr 1.0"

Example HTTP response

Response 202

1.1.7 - Delete Registry

1.1.7.1 - 1.1

delete /v1/container-registries/{registry_id}

Description

delete registry

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/container-registries/{registry_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 = scr 1.1"

Example HTTP response

Response 202

1.1.7.2 - 1.0

delete /v1/container-registries/{registry_id}

Description

delete registry

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/container-registries/{registry_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 = scr 1.0"

Example HTTP response

Response 202

1.1.8 - Delete Repository

1.1.8.1 - 1.1

delete /v1/repositories/{repository_id}

Description

delete repository

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/repositories/{repository_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 = scr 1.1"

Example HTTP response

Response 202

1.1.8.2 - 1.0

delete /v1/repositories/{repository_id}

Description

delete repository

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/repositories/{repository_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 = scr 1.0"

Example HTTP response

Response 202

1.1.9 - Delete Tags

1.1.9.1 - 1.1

delete /v1/tagses/{tags_id}

Description

delete tags

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
body	body required		TagDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None
423	Locked	None

Example HTTP request

Request path

/v1/tagses/{tags_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 = scr 1.1"

Request body

{
    "tag_names": "[\"sample\"]"
}

Example HTTP response

Response 204

1.1.9.2 - 1.0

delete /v1/tagses/{tags_id}

Description

delete tags

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
body	body required		TagDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None
423	Locked	None

Example HTTP request

Request path

/v1/tagses/{tags_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 = scr 1.0"

Request body

{
    "tag_names": "[\"sample\"]"
}

Example HTTP response

Response 204

1.1.10 - Delete Tagses

1.1.10.1 - 1.1

delete /v1/tagses

Description

delete tagses

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		TagsDeleteRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None
423	Locked	None

Example HTTP request

Request path

/v1/tagses

Request header

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

Request body

{
    "tags_ids": "[\"b48210c7a226460fa15b6e3e221b30b0\"]"
}

Example HTTP response

Response 202

1.1.10.2 - 1.0

delete /v1/tagses

Description

delete tagses

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		TagsDeleteRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None
423	Locked	None

Example HTTP request

Request path

/v1/tagses

Request header

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

Request body

{
    "tags_ids": "[\"b48210c7a226460fa15b6e3e221b30b0\"]"
}

Example HTTP response

Response 202

1.1.11 - Download Manifest

1.1.11.1 - 1.1

get /v1/tagses/{tags_id}/download/manifest

Description

download manifest file

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/download/manifest

Request header

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

Example HTTP response

Response 200

1.1.11.2 - 1.0

get /v1/tagses/{tags_id}/download/manifest

Description

download manifest file

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/download/manifest

Request header

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

Example HTTP response

Response 200

1.1.12 - List Connectable Resources

1.1.12.1 - 1.1

get /v1/container-registries/connectable-resources

Description

get connectable domains

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Responses

HTTP Code	Description	Schema
200	OK	ConnectableResourceListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/connectable-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 = scr 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "resources": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "id": "558496f6c49d43459e61e191fb3c08fe",
            "name": "sample",
            "private_domain": "sample.scr.private.{region}.{environment}.samsungsdscloud.com",
            "public_domain": "sample.scr.{region}.{environment}.samsungsdscloud.com",
            "type": "container-registry"
        }
    ]
}

1.1.12.2 - 1.0

get /v1/container-registries/connectable-resources

Description

get connectable domains

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Responses

HTTP Code	Description	Schema
200	OK	ConnectableResourceListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/connectable-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 = scr 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "resources": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "id": "558496f6c49d43459e61e191fb3c08fe",
            "name": "sample",
            "private_domain": "sample.scr.private.{region}.{environment}.samsungsdscloud.com",
            "public_domain": "sample.scr.{region}.{environment}.samsungsdscloud.com",
            "type": "container-registry"
        }
    ]
}

1.1.13 - List Images

1.1.13.1 - 1.1

get /v1/repositories/{repository_id}/images

Description

get images

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	name optional	Image name Example : `sample`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ImageListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories/{repository_id}/images

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "images": [
        {
            "created_at": "2024-08-15T13:05:09.701645823+09:00",
            "id": "5b5ed4f2881a440583536fc1a8c39a28",
            "modified_at": "2024-08-16T16:06:09.701645823+09:00",
            "name": "sample",
            "private_endpoint_url": "sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817",
            "public_endpoint_url": "sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817",
            "pull_count": 20,
            "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
            "repository_id": "e5611ca6c1484df480668c5adce8b078",
            "state": "Active"
        }
    ]
}

1.1.13.2 - 1.0

get /v1/repositories/{repository_id}/images

Description

get images

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	name optional	Image name Example : `sample`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ImageListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories/{repository_id}/images

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "images": [
        {
            "created_at": "2024-08-15T13:05:09.701645823+09:00",
            "id": "5b5ed4f2881a440583536fc1a8c39a28",
            "modified_at": "2024-08-16T16:06:09.701645823+09:00",
            "name": "sample",
            "private_endpoint_url": "sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817",
            "public_endpoint_url": "sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817",
            "pull_count": 20,
            "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
            "repository_id": "e5611ca6c1484df480668c5adce8b078",
            "state": "Active"
        }
    ]
}

1.1.14 - List Registries

1.1.14.1 - 1.1

get /v1/container-registries

Description

get registries

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	name optional	Registry name Example : `sample`	any of [string, null]	None
query	state optional	Registry state Example : `Running`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ContainerRegistryListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "registries": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "bucket_name": "4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "sample",
            "private_domain": "sample.scr.private.{region}.{environment}.samsungsdscloud.com",
            "public_domain": "sample.scr.{region}.{environment}.samsungsdscloud.com",
            "public_visible_enabled": true,
            "state": "Running"
        }
    ]
}

1.1.14.2 - 1.0

get /v1/container-registries

Description

get registries

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	name optional	Registry name Example : `sample`	any of [string, null]	None
query	state optional	Registry state Example : `Running`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ContainerRegistryListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "registries": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "bucket_name": "4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "sample",
            "private_domain": "sample.scr.private.{region}.{environment}.samsungsdscloud.com",
            "public_domain": "sample.scr.{region}.{environment}.samsungsdscloud.com",
            "public_visible_enabled": true,
            "state": "Running"
        }
    ]
}

1.1.15 - List Repositories

1.1.15.1 - 1.1

get /v1/container-registries/{registry_id}/repositories

Description

get repositories

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	name optional	Repository name Example : `sample`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RepositoryListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/{registry_id}/repositories

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "repositories": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "sample",
            "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
            "state": "Active"
        }
    ]
}

1.1.15.2 - 1.0

get /v1/container-registries/{registry_id}/repositories

Description

get repositories

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	name optional	Repository name Example : `sample`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RepositoryListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/{registry_id}/repositories

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "repositories": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "sample",
            "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
            "state": "Active"
        }
    ]
}

1.1.16 - List Tagses

1.1.16.1 - 1.1

get /v1/images/{image_id}/tagses

Description

get tagses

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	List of tags in reference Example : `["sample"]`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	TagsListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/tagses

Request header

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

Example HTTP response

Response 200

{
    "count": 10,
    "tagses": [
        {
            "hash_digest": "",
            "id": "b48210c7a226460fa15b6e3e221b30b0",
            "last_scanned_at": "2024-08-15T13:05:09.701645823+09:00",
            "lock_policy": {
                "locked": true
            },
            "modified_at": "2024-08-16T16:06:09.701645823+09:00",
            "private_endpoint_url": "sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd",
            "public_endpoint_url": "sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd",
            "re_scan_needed": true,
            "reference_tags": "[\"sample\"]",
            "referenced_by": "",
            "scan_state": "Scanning state",
            "scan_summary": {
                "critical": 10,
                "high": 10,
                "low": 10,
                "medium": 10,
                "negligible": 10,
                "total_vulnerability": 60,
                "unknown": 10
            },
            "size": 10,
            "state": "Active"
        }
    ]
}

1.1.16.2 - 1.0

get /v1/images/{image_id}/tagses

Description

get tagses

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	List of tags in reference Example : `["sample"]`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	TagsListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/tagses

Request header

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

Example HTTP response

Response 200

{
    "count": 10,
    "tagses": [
        {
            "hash_digest": "",
            "id": "b48210c7a226460fa15b6e3e221b30b0",
            "last_scanned_at": "2024-08-15T13:05:09.701645823+09:00",
            "lock_policy": {
                "locked": true
            },
            "modified_at": "2024-08-16T16:06:09.701645823+09:00",
            "private_endpoint_url": "sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd",
            "public_endpoint_url": "sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd",
            "re_scan_needed": true,
            "reference_tags": "[\"sample\"]",
            "referenced_by": "",
            "scan_state": "Scanning state",
            "scan_summary": {
                "critical": 10,
                "high": 10,
                "low": 10,
                "medium": 10,
                "negligible": 10,
                "total_vulnerability": 60,
                "unknown": 10
            },
            "size": 10,
            "state": "Active"
        }
    ]
}

1.1.17 - Run Image Lifecycle Policy Preview

1.1.17.1 - 1.1

post /v1/images/{image_id}/lifecycle-policy/preview

Description

Run Image Lifecycle Policy Preview

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/lifecycle-policy/preview

Request header

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

Example HTTP response

Response 200

1.1.17.2 - 1.0

post /v1/images/{image_id}/lifecycle-policy/preview

Description

Run Image Lifecycle Policy Preview

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/lifecycle-policy/preview

Request header

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

Example HTTP response

Response 200

1.1.18 - Show Image

1.1.18.1 - 1.1

get /v1/images/{image_id}

Description

get image

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ImageShowResponseV1_1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_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 = scr 1.1"

Example HTTP response

Response 200

{
    "image": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Carpe diem.",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lifecycle_policy": {
            "lifecycle_policy_enabled": true,
            "outdated_rule_duration": 90,
            "outdated_rule_enabled": true,
            "outdated_rule_tag_expression": "*",
            "untagged_rule_duration": 90,
            "untagged_rule_enabled": true
        },
        "lock_policy": {
            "locked": true
        },
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample",
        "pull_count": 100,
        "pull_policy": {
            "critical_limit": 20,
            "high_limit": 20,
            "unmodified_excepted": true,
            "unscanned_image_pull_prevented": true,
            "vulnerable_image_pull_prevented": true
        },
        "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "repository_id": "e5611ca6c1484df480668c5adce8b078",
        "scan_policy": {
            "auto_scan_enabled": true,
            "fixed_version_excepted": true,
            "language_excepted": true,
            "scan_policy_enabled": true,
            "secret_excepted": true,
            "severity_limit": "High"
        },
        "state": "Active"
    }
}

1.1.18.2 - 1.0

get /v1/images/{image_id}

Description

get image

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ImageShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_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 = scr 1.0"

Example HTTP response

Response 200

{
    "image": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Carpe diem.",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lifecycle_policy": {
            "lifecycle_policy_enabled": true,
            "outdated_rule_duration": 90,
            "outdated_rule_enabled": true,
            "untagged_rule_duration": 90,
            "untagged_rule_enabled": true
        },
        "lock_policy": {
            "locked": true
        },
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample",
        "pull_count": 100,
        "pull_policy": {
            "critical_limit": 20,
            "high_limit": 20,
            "unmodified_excepted": true,
            "unscanned_image_pull_prevented": true,
            "vulnerable_image_pull_prevented": true
        },
        "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "repository_id": "e5611ca6c1484df480668c5adce8b078",
        "scan_policy": {
            "auto_scan_enabled": true,
            "fixed_version_excepted": true,
            "language_excepted": true,
            "scan_policy_enabled": true,
            "secret_excepted": true,
            "severity_limit": "High"
        },
        "state": "Active"
    }
}

1.1.19 - Show Image Lifecycle Policy Preview

1.1.19.1 - 1.1

get /v1/images/{image_id}/lifecycle-policy/preview

Description

show image lifecycle policy preview

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	List of tags in reference Example : `["sample"]`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	LifecyclePolicyPreviewResponseV1_1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/lifecycle-policy/preview

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "outdated_rule_duration": 10,
    "outdated_rule_enabled": true,
    "outdated_rule_tag_expression": "*",
    "preview_run_at": "2024-08-15T13:05:09.701645823+09:00",
    "preview_run_state": "Active",
    "previews": [
        {
            "created_at": "2024-08-15T13:05:09.701645823+09:00",
            "hash_digest": "",
            "reference_tags": "[\"sample\"]",
            "state": "Active"
        }
    ],
    "untagged_rule_duration": 10,
    "untagged_rule_enabled": true
}

1.1.19.2 - 1.0

get /v1/images/{image_id}/lifecycle-policy/preview

Description

show image lifecycle policy preview

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	List of tags in reference Example : `["sample"]`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	TagsListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/images/{image_id}/lifecycle-policy/preview

Request header

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

Example HTTP response

Response 200

{
    "count": 10,
    "tagses": [
        {
            "hash_digest": "",
            "id": "b48210c7a226460fa15b6e3e221b30b0",
            "last_scanned_at": "2024-08-15T13:05:09.701645823+09:00",
            "lock_policy": {
                "locked": true
            },
            "modified_at": "2024-08-16T16:06:09.701645823+09:00",
            "private_endpoint_url": "sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd",
            "public_endpoint_url": "sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd",
            "re_scan_needed": true,
            "reference_tags": "[\"sample\"]",
            "referenced_by": "",
            "scan_state": "Scanning state",
            "scan_summary": {
                "critical": 10,
                "high": 10,
                "low": 10,
                "medium": 10,
                "negligible": 10,
                "total_vulnerability": 60,
                "unknown": 10
            },
            "size": 10,
            "state": "Active"
        }
    ]
}

1.1.20 - Show Registry

1.1.20.1 - 1.1

get /v1/container-registries/{registry_id}

Description

get registry

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ContainerRegistryShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/{registry_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 = scr 1.1"

Example HTTP response

Response 200

{
    "registry": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "bucket_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "bucket_name": "4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup",
        "bucket_usage": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample",
        "private_acl_enabled": true,
        "private_acl_resources": [
            {
                "resource_id": "558496f6c49d43459e61e191fb3c08fe",
                "resource_ips": "[]",
                "resource_name": "sample",
                "resource_type": "virtualServer"
            }
        ],
        "private_domain": "sample.scr.private.{region}.{environment}.samsungsdscloud.com",
        "public_acl_enabled": true,
        "public_acl_resources": [
            {
                "resource_id": "558496f6c49d43459e61e191fb3c08fe",
                "resource_ips": "[]",
                "resource_name": "sample",
                "resource_type": "virtualServer"
            }
        ],
        "public_domain": "sample.scr.{region}.{environment}.samsungsdscloud.com",
        "public_endpoint_enabled": true,
        "public_visible_enabled": true,
        "state": "Running"
    }
}

1.1.20.2 - 1.0

get /v1/container-registries/{registry_id}

Description

get registry

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ContainerRegistryShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/container-registries/{registry_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 = scr 1.0"

Example HTTP response

Response 200

{
    "registry": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "bucket_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "bucket_name": "4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup",
        "bucket_usage": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample",
        "private_acl_enabled": true,
        "private_acl_resources": [
            {
                "resource_id": "558496f6c49d43459e61e191fb3c08fe",
                "resource_ips": "[]",
                "resource_name": "sample",
                "resource_type": "virtualServer"
            }
        ],
        "private_domain": "sample.scr.private.{region}.{environment}.samsungsdscloud.com",
        "public_acl_enabled": true,
        "public_acl_resources": [
            {
                "resource_id": "558496f6c49d43459e61e191fb3c08fe",
                "resource_ips": "[]",
                "resource_name": "sample",
                "resource_type": "virtualServer"
            }
        ],
        "public_domain": "sample.scr.{region}.{environment}.samsungsdscloud.com",
        "public_endpoint_enabled": true,
        "public_visible_enabled": true,
        "state": "Running"
    }
}

1.1.21 - Show Repository

1.1.21.1 - 1.1

get /v1/repositories/{repository_id}

Description

get repository

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None

Responses

HTTP Code	Description	Schema
200	OK	RepositoryShowResponseV1_1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories/{repository_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 = scr 1.1"

Example HTTP response

Response 200

{
    "repository": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Carpe diem.",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lifecycle_policy": {
            "lifecycle_policy_enabled": true,
            "outdated_rule_duration": 90,
            "outdated_rule_enabled": true,
            "outdated_rule_tag_expression": "*",
            "untagged_rule_duration": 90,
            "untagged_rule_enabled": true
        },
        "lock_policy": {
            "locked": true
        },
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample",
        "private_endpoint_url": "sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo",
        "public_endpoint_url": "sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo",
        "pull_policy": {
            "critical_limit": 20,
            "high_limit": 20,
            "unmodified_excepted": true,
            "unscanned_image_pull_prevented": true,
            "vulnerable_image_pull_prevented": true
        },
        "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "scan_policy": {
            "auto_scan_enabled": true,
            "fixed_version_excepted": true,
            "language_excepted": true,
            "scan_policy_enabled": true,
            "secret_excepted": true,
            "severity_limit": "High"
        },
        "state": "Active"
    }
}

1.1.21.2 - 1.0

get /v1/repositories/{repository_id}

Description

get repository

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None

Responses

HTTP Code	Description	Schema
200	OK	RepositoryShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/repositories/{repository_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 = scr 1.0"

Example HTTP response

Response 200

{
    "repository": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Carpe diem.",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lifecycle_policy": {
            "lifecycle_policy_enabled": true,
            "outdated_rule_duration": 90,
            "outdated_rule_enabled": true,
            "untagged_rule_duration": 90,
            "untagged_rule_enabled": true
        },
        "lock_policy": {
            "locked": true
        },
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample",
        "private_endpoint_url": "sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo",
        "public_endpoint_url": "sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo",
        "pull_policy": {
            "critical_limit": 20,
            "high_limit": 20,
            "unmodified_excepted": true,
            "unscanned_image_pull_prevented": true,
            "vulnerable_image_pull_prevented": true
        },
        "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "scan_policy": {
            "auto_scan_enabled": true,
            "fixed_version_excepted": true,
            "language_excepted": true,
            "scan_policy_enabled": true,
            "secret_excepted": true,
            "severity_limit": "High"
        },
        "state": "Active"
    }
}

1.1.22 - Show Tags

1.1.22.1 - 1.1

get /v1/tagses/{tags_id}

Description

get tags

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None

Responses

HTTP Code	Description	Schema
200	OK	TagsShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_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 = scr 1.1"

Example HTTP response

Response 200

{
    "tags": {
        "created_at": "2024-08-15T13:05:09.701645823+09:00",
        "hash_digest": "",
        "id": "b48210c7a226460fa15b6e3e221b30b0",
        "image_id": "5b5ed4f2881a440583536fc1a8c39a28",
        "lock_policy": {
            "locked": true
        },
        "manifest": "",
        "manifest_media_type": "",
        "modified_at": "2024-08-16T16:06:09.701645823+09:00",
        "reference_tags": "[\"sample\"]",
        "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "repository_id": "e5611ca6c1484df480668c5adce8b078",
        "state": "Active"
    }
}

1.1.22.2 - 1.0

get /v1/tagses/{tags_id}

Description

get tags

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None

Responses

HTTP Code	Description	Schema
200	OK	TagsShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_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 = scr 1.0"

Example HTTP response

Response 200

{
    "tags": {
        "created_at": "2024-08-15T13:05:09.701645823+09:00",
        "hash_digest": "",
        "id": "b48210c7a226460fa15b6e3e221b30b0",
        "image_id": "5b5ed4f2881a440583536fc1a8c39a28",
        "lock_policy": {
            "locked": true
        },
        "manifest": "",
        "manifest_media_type": "",
        "modified_at": "2024-08-16T16:06:09.701645823+09:00",
        "reference_tags": "[\"sample\"]",
        "registry_id": "rpqtmqgec3174541bbf77eecf2cd3585",
        "repository_id": "e5611ca6c1484df480668c5adce8b078",
        "state": "Active"
    }
}

1.1.23 - Show Tags Packages

1.1.23.1 - 1.1

get /v1/tagses/{tags_id}/packages

Description

get tags packages

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS or language Example : `Java`	any of [string, null]	None
query	package_name optional	Package name Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PackageListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_id}/packages

Request header

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

Example HTTP response

Response 200

{
    "filtered_count": 30,
    "last_scanned_at": "2024-08-15T13:05:09.701645823+09:00",
    "package_reports": [
        {
            "category": "Language",
            "os_language": "Java",
            "package_name": "com.example.sample",
            "scan_summary": {
                "critical": 10,
                "high": 10,
                "low": 10,
                "medium": 10,
                "negligible": 10,
                "total_vulnerability": 60,
                "unknown": 10
            },
            "type": "os-pkg(binary)",
            "version": "0.7.2-r3"
        }
    ],
    "package_reports_count": 30,
    "release_version": "alpine:3.14.10",
    "scan_summary": {
        "critical": 10,
        "high": 10,
        "low": 10,
        "medium": 10,
        "negligible": 10,
        "total_vulnerability": 60,
        "unknown": 10
    }
}

1.1.23.2 - 1.0

get /v1/tagses/{tags_id}/packages

Description

get tags packages

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS or language Example : `Java`	any of [string, null]	None
query	package_name optional	Package name Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PackageListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_id}/packages

Request header

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

Example HTTP response

Response 200

{
    "filtered_count": 30,
    "last_scanned_at": "2024-08-15T13:05:09.701645823+09:00",
    "package_reports": [
        {
            "category": "Language",
            "os_language": "Java",
            "package_name": "com.example.sample",
            "scan_summary": {
                "critical": 10,
                "high": 10,
                "low": 10,
                "medium": 10,
                "negligible": 10,
                "total_vulnerability": 60,
                "unknown": 10
            },
            "type": "os-pkg(binary)",
            "version": "0.7.2-r3"
        }
    ],
    "package_reports_count": 30,
    "release_version": "alpine:3.14.10",
    "scan_summary": {
        "critical": 10,
        "high": 10,
        "low": 10,
        "medium": 10,
        "negligible": 10,
        "total_vulnerability": 60,
        "unknown": 10
    }
}

1.1.24 - Show Tags Secrets

1.1.24.1 - 1.1

get /v1/tagses/{tags_id}/secrets

Description

get tags secrets

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	file_name optional	Secret file name Example : `/certs/sample-key1.key`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecretListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_id}/secrets

Request header

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

Example HTTP response

Response 200

{
    "filtered_count": 30,
    "last_scanned_at": "2024-08-16T16:06:09.701645823+09:00",
    "release_version": "alpine:3.14.10",
    "secret_reports": [
        {
            "category": "Language",
            "file_name": "/certs/sample-key1.key",
            "match": "-----BEGIN SAMPLE KEY-----*********************...",
            "rule_id": "private-key",
            "severity": "High",
            "start_line": 1,
            "target": "/certs/sample-key1.key",
            "title": "Asymmetric Private Key",
            "vulnerability_class": "secret"
        }
    ],
    "secret_summary": {
        "critical": 10,
        "high": 10,
        "low": 10,
        "medium": 10,
        "total_secret": 50,
        "unknown": 10
    }
}

1.1.24.2 - 1.0

get /v1/tagses/{tags_id}/secrets

Description

get tags secrets

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	file_name optional	Secret file name Example : `/certs/sample-key1.key`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecretListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_id}/secrets

Request header

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

Example HTTP response

Response 200

{
    "filtered_count": 30,
    "last_scanned_at": "2024-08-16T16:06:09.701645823+09:00",
    "release_version": "alpine:3.14.10",
    "secret_reports": [
        {
            "category": "Language",
            "file_name": "/certs/sample-key1.key",
            "match": "-----BEGIN SAMPLE KEY-----*********************...",
            "rule_id": "private-key",
            "severity": "High",
            "start_line": 1,
            "target": "/certs/sample-key1.key",
            "title": "Asymmetric Private Key",
            "vulnerability_class": "secret"
        }
    ],
    "secret_summary": {
        "critical": 10,
        "high": 10,
        "low": 10,
        "medium": 10,
        "total_secret": 50,
        "unknown": 10
    }
}

1.1.25 - Show Tags Vulnerabilities

1.1.25.1 - 1.1

get /v1/tagses/{tags_id}/vulnerabilities

Description

get tags vulnerabilities

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS or language Example : `Java`	any of [string, null]	None
query	package_name optional	Package name Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	update_version_available optional	Updated version Example : `True`	any of [boolean, null]	None
query	severity optional	Severity Example : `High`	any of [array[string], string, null]	None
query	category optional	Category Example : `Language`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VulnerabilityListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_id}/vulnerabilities

Request header

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

Example HTTP response

Response 200

{
    "filtered_count": 30,
    "vector_info": {
        "attack_complexity": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "attack_vector": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "availability": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "confidentiality": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "integrity": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "privileges_required": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "scope": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "user_interaction": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ]
    },
    "vulnerability_report": {
        "cves": [
            {
                "category": "Language",
                "current_version": "2.9.9.1",
                "cve_code": "CVE-2019-1454",
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "links": "https://nvd.nist.gov/vuln/detail/CVE-2019-1454",
                "os_language": "Java",
                "package_name": "com.example.sample",
                "severity": "High",
                "update_version": "2.9.10, 2.8.11.5, 2.6.7.3",
                "vectors": {
                    "attack_complexity": "High",
                    "attack_vector": "NETWORK",
                    "availability": "High",
                    "base_severity": "",
                    "confidentiality": "High",
                    "cvss": 9.8,
                    "integrity": "High",
                    "privileges_required": "Low",
                    "scope": "",
                    "user_interaction": "Low"
                }
            }
        ],
        "last_scanned_at": "2024-08-16T16:06:09.701645823+09:00",
        "release_version": "alpine:3.14.10",
        "scan_summary": {
            "critical": 10,
            "high": 10,
            "low": 10,
            "medium": 10,
            "negligible": 10,
            "total_vulnerability": 60,
            "unknown": 10
        }
    }
}

1.1.25.2 - 1.0

get /v1/tagses/{tags_id}/vulnerabilities

Description

get tags vulnerabilities

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS or language Example : `Java`	any of [string, null]	None
query	package_name optional	Package name Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	update_version_available optional	Updated version Example : `True`	any of [boolean, null]	None
query	severity optional	Severity Example : `High`	any of [array[string], string, null]	None
query	category optional	Category Example : `Language`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VulnerabilityListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/tagses/{tags_id}/vulnerabilities

Request header

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

Example HTTP response

Response 200

{
    "filtered_count": 30,
    "vector_info": {
        "attack_complexity": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "attack_vector": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "availability": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "confidentiality": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "integrity": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "privileges_required": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "scope": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ],
        "user_interaction": [
            {
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "level": "1",
                "metric": "Physical"
            }
        ]
    },
    "vulnerability_report": {
        "cves": [
            {
                "category": "Language",
                "current_version": "2.9.9.1",
                "cve_code": "CVE-2019-1454",
                "description": "A Polymorphic Typing issue was discovered in FasterXML.",
                "links": "https://nvd.nist.gov/vuln/detail/CVE-2019-1454",
                "os_language": "Java",
                "package_name": "com.example.sample",
                "severity": "High",
                "update_version": "2.9.10, 2.8.11.5, 2.6.7.3",
                "vectors": {
                    "attack_complexity": "High",
                    "attack_vector": "NETWORK",
                    "availability": "High",
                    "base_severity": "",
                    "confidentiality": "High",
                    "cvss": 9.8,
                    "integrity": "High",
                    "privileges_required": "Low",
                    "scope": "",
                    "user_interaction": "Low"
                }
            }
        ],
        "last_scanned_at": "2024-08-16T16:06:09.701645823+09:00",
        "release_version": "alpine:3.14.10",
        "scan_summary": {
            "critical": 10,
            "high": 10,
            "low": 10,
            "medium": 10,
            "negligible": 10,
            "total_vulnerability": 60,
            "unknown": 10
        }
    }
}

1.1.26 - Update Image Description

1.1.26.1 - 1.1

put /v1/images/{image_id}/description

Description

update image description

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		ImageSetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.26.2 - 1.0

put /v1/images/{image_id}/description

Description

update image description

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		ImageSetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.27 - Update Image Lifecycle Policy

1.1.27.1 - 1.1

put /v1/images/{image_id}/lifecycle-policy

Description

update image lifecycle-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		LifecyclePolicySetRequestV1_1

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/lifecycle-policy

Request header

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

Request body

{
    "lifecycle_policy": {
        "lifecycle_policy_enabled": true,
        "outdated_rule_duration": 90,
        "outdated_rule_enabled": true,
        "outdated_rule_tag_expression": "*",
        "untagged_rule_duration": 90,
        "untagged_rule_enabled": true
    }
}

Example HTTP response

Response 200

1.1.27.2 - 1.0

put /v1/images/{image_id}/lifecycle-policy

Description

update image lifecycle-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		LifecyclePolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/lifecycle-policy

Request header

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

Request body

{
    "lifecycle_policy": {
        "lifecycle_policy_enabled": true,
        "outdated_rule_duration": 90,
        "outdated_rule_enabled": true,
        "untagged_rule_duration": 90,
        "untagged_rule_enabled": true
    }
}

Example HTTP response

Response 200

1.1.28 - Update Image Lock Policy

1.1.28.1 - 1.1

put /v1/images/{image_id}/lock-policy

Description

update image lock-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		LockPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/lock-policy

Request header

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

Request body

{
    "lock_policy": {
        "locked": true
    }
}

Example HTTP response

Response 200

1.1.28.2 - 1.0

put /v1/images/{image_id}/lock-policy

Description

update image lock-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		LockPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/lock-policy

Request header

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

Request body

{
    "lock_policy": {
        "locked": true
    }
}

Example HTTP response

Response 200

1.1.29 - Update Image Pull Policy

1.1.29.1 - 1.1

put /v1/images/{image_id}/pull-policy

Description

update image pull-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		PullPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/pull-policy

Request header

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

Request body

{
    "pull_policy": {
        "critical_limit": 20,
        "high_limit": 20,
        "unmodified_excepted": true,
        "unscanned_image_pull_prevented": true,
        "vulnerable_image_pull_prevented": true
    }
}

Example HTTP response

Response 200

1.1.29.2 - 1.0

put /v1/images/{image_id}/pull-policy

Description

update image pull-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		PullPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/pull-policy

Request header

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

Request body

{
    "pull_policy": {
        "critical_limit": 20,
        "high_limit": 20,
        "unmodified_excepted": true,
        "unscanned_image_pull_prevented": true,
        "vulnerable_image_pull_prevented": true
    }
}

Example HTTP response

Response 200

1.1.30 - Update Image Scan Policy

1.1.30.1 - 1.1

put /v1/images/{image_id}/scan-policy

Description

update image scan-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		ScanPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/scan-policy

Request header

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

Request body

{
    "scan_policy": {
        "auto_scan_enabled": true,
        "fixed_version_excepted": true,
        "language_excepted": true,
        "scan_policy_enabled": true,
        "secret_excepted": true,
        "severity_limit": "High"
    }
}

Example HTTP response

Response 200

1.1.30.2 - 1.0

put /v1/images/{image_id}/scan-policy

Description

update image scan-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
body	body required		ScanPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/scan-policy

Request header

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

Request body

{
    "scan_policy": {
        "auto_scan_enabled": true,
        "fixed_version_excepted": true,
        "language_excepted": true,
        "scan_policy_enabled": true,
        "secret_excepted": true,
        "severity_limit": "High"
    }
}

Example HTTP response

Response 200

1.1.31 - Update Private Acl

1.1.31.1 - 1.1

put /v1/container-registries/{registry_id}/private-acl

Description

update private acl

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
body	body required		PrivateAclSetRequest

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}/private-acl

Request header

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

Request body

{
    "private_acl_enabled": true,
    "private_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ]
}

Example HTTP response

Response 200

1.1.31.2 - 1.0

put /v1/container-registries/{registry_id}/private-acl

Description

update private acl

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
body	body required		PrivateAclSetRequest

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}/private-acl

Request header

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

Request body

{
    "private_acl_enabled": true,
    "private_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ]
}

Example HTTP response

Response 200

1.1.32 - Update Public Acl

1.1.32.1 - 1.1

put /v1/container-registries/{registry_id}/public-acl

Description

update public acl

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
body	body required		PublicAclSetRequest

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/container-registries/{registry_id}/public-acl

Request header

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

Request body

{
    "public_acl_enabled": true,
    "public_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ]
}

Example HTTP response

Response 200

1.1.32.2 - 1.0

put /v1/container-registries/{registry_id}/public-acl

Description

update public acl

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
body	body required		PublicAclSetRequest

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/container-registries/{registry_id}/public-acl

Request header

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

Request body

{
    "public_acl_enabled": true,
    "public_acl_resources": [
        {
            "resource_id": "558496f6c49d43459e61e191fb3c08fe",
            "resource_ips": "[]",
            "resource_name": "sample",
            "resource_type": "virtualServer"
        }
    ]
}

Example HTTP response

Response 200

1.1.33 - Update Public Endpoint Enabled

1.1.33.1 - 1.1

put /v1/container-registries/{registry_id}/enable-public-endpoint

Description

update public endpoint enabled

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
body	body required		PublicEndpointEnabledSetRequest

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}/enable-public-endpoint

Request header

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

Request body

{
    "public_endpoint_enabled": true
}

Example HTTP response

Response 200

1.1.33.2 - 1.0

put /v1/container-registries/{registry_id}/enable-public-endpoint

Description

update public endpoint enabled

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string	None
body	body required		PublicEndpointEnabledSetRequest

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}/enable-public-endpoint

Request header

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

Request body

{
    "public_endpoint_enabled": true
}

Example HTTP response

Response 200

1.1.34 - Update Repository Description

1.1.34.1 - 1.1

put /v1/repositories/{repository_id}/description

Description

update repository description

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		RepositorySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.34.2 - 1.0

put /v1/repositories/{repository_id}/description

Description

update repository description

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		RepositorySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.35 - Update Repository Lifecycle Policy

1.1.35.1 - 1.1

put /v1/repositories/{repository_id}/lifecycle-policy

Description

update repository lifecycle-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		LifecyclePolicySetRequestV1_1

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/lifecycle-policy

Request header

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

Request body

{
    "lifecycle_policy": {
        "lifecycle_policy_enabled": true,
        "outdated_rule_duration": 90,
        "outdated_rule_enabled": true,
        "outdated_rule_tag_expression": "*",
        "untagged_rule_duration": 90,
        "untagged_rule_enabled": true
    }
}

Example HTTP response

Response 200

1.1.35.2 - 1.0

put /v1/repositories/{repository_id}/lifecycle-policy

Description

update repository lifecycle-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		LifecyclePolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/lifecycle-policy

Request header

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

Request body

{
    "lifecycle_policy": {
        "lifecycle_policy_enabled": true,
        "outdated_rule_duration": 90,
        "outdated_rule_enabled": true,
        "untagged_rule_duration": 90,
        "untagged_rule_enabled": true
    }
}

Example HTTP response

Response 200

1.1.36 - Update Repository Lock Policy

1.1.36.1 - 1.1

put /v1/repositories/{repository_id}/lock-policy

Description

update repository lock-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		LockPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/lock-policy

Request header

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

Request body

{
    "lock_policy": {
        "locked": true
    }
}

Example HTTP response

Response 200

1.1.36.2 - 1.0

put /v1/repositories/{repository_id}/lock-policy

Description

update repository lock-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		LockPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/lock-policy

Request header

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

Request body

{
    "lock_policy": {
        "locked": true
    }
}

Example HTTP response

Response 200

1.1.37 - Update Repository Pull Policy

1.1.37.1 - 1.1

put /v1/repositories/{repository_id}/pull-policy

Description

update repository pull-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		PullPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/pull-policy

Request header

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

Request body

{
    "pull_policy": {
        "critical_limit": 20,
        "high_limit": 20,
        "unmodified_excepted": true,
        "unscanned_image_pull_prevented": true,
        "vulnerable_image_pull_prevented": true
    }
}

Example HTTP response

Response 200

1.1.37.2 - 1.0

put /v1/repositories/{repository_id}/pull-policy

Description

update repository pull-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		PullPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/pull-policy

Request header

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

Request body

{
    "pull_policy": {
        "critical_limit": 20,
        "high_limit": 20,
        "unmodified_excepted": true,
        "unscanned_image_pull_prevented": true,
        "vulnerable_image_pull_prevented": true
    }
}

Example HTTP response

Response 200

1.1.38 - Update Repository Scan Policy

1.1.38.1 - 1.1

put /v1/repositories/{repository_id}/scan-policy

Description

update repository scan-policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		ScanPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/scan-policy

Request header

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

Request body

{
    "scan_policy": {
        "auto_scan_enabled": true,
        "fixed_version_excepted": true,
        "language_excepted": true,
        "scan_policy_enabled": true,
        "secret_excepted": true,
        "severity_limit": "High"
    }
}

Example HTTP response

Response 200

1.1.38.2 - 1.0

put /v1/repositories/{repository_id}/scan-policy

Description

update repository scan-policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string	None
body	body required		ScanPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/scan-policy

Request header

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

Request body

{
    "scan_policy": {
        "auto_scan_enabled": true,
        "fixed_version_excepted": true,
        "language_excepted": true,
        "scan_policy_enabled": true,
        "secret_excepted": true,
        "severity_limit": "High"
    }
}

Example HTTP response

Response 200

1.1.39 - Update Tags Lock Policy

1.1.39.1 - 1.1

put /v1/tagses/{tags_id}/lock-policy

Description

update tags lock

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
body	body required		LockPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/lock-policy

Request header

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

Request body

{
    "lock_policy": {
        "locked": true
    }
}

Example HTTP response

Response 200

1.1.39.2 - 1.0

put /v1/tagses/{tags_id}/lock-policy

Description

update tags lock

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
body	body required		LockPolicySetRequest

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/lock-policy

Request header

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

Request body

{
    "lock_policy": {
        "locked": true
    }
}

Example HTTP response

Response 200

1.2 - Models

1.2.1 - CheckDuplicationResponse

Name	Description	Schema	Default
result required	Name duplicated Example : `True`	boolean

1.2.2 - ConnectableResource

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
id required	Resource ID Example : `558496f6c49d43459e61e191fb3c08fe`	string
name required	Registry name Example : `sample`	string
private_domain required	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com`	string
public_domain optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com`	any of [string, null]
type required	Resource type Example : `container-registry`	string

1.2.3 - ConnectableResourceListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
resources required	Contents	array[ConnectableResource]

1.2.4 - ContainerRegistry

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
bucket_id required	Bucket ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
bucket_name required	Bucket name Example : `4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup`	string
bucket_usage required	Bucket Usage Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Registry name Example : `sample`	string
private_acl_enabled required	Private ACL enabled Example : `True`	boolean
private_acl_resources required	Private ACL resources	array[Resource]
private_domain required	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com`	string
public_acl_enabled optional	Public ACL enabled Example : `True`	any of [boolean, null]
public_acl_resources required	Public ACL resources	array[Resource]
public_domain optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com`	any of [string, null]
public_endpoint_enabled optional	Public endpoint enabled Example : `True`	any of [boolean, null]
public_visible_enabled required	Public visible enabled Example : `True`	boolean
state required	Registry state Example : `Running`	string

1.2.5 - ContainerRegistryCreateRequest

Name	Description	Schema
name required	Registry name Example : `sample` Pattern : `^[a-z][a-z0-9]$` Minimum length* : `3` Maximum length : `25`	string
private_acl_enabled required	Private ACL enabled Example : `True`	boolean
private_acl_resources required	Private ACL resources	array[Resource]
public_acl_enabled optional	Public ACL enabled Example : `True`	any of [boolean, null]
public_acl_resources required	Public ACL resources	array[Resource]
public_endpoint_enabled optional	Public endpoint enabled Example : `True`	any of [boolean, null]
public_visible_enabled required	Public visible enabled Example : `True`	boolean
tags optional	Tag List	any of [array[Tag], null]

1.2.6 - ContainerRegistryCreateResponse

Name	Description	Schema
id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
message required	Description Example : `Carpe diem.`	string
state required	Registry state Example : `Running`	string

1.2.7 - ContainerRegistryForList

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
bucket_name required	Bucket name Example : `4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Registry name Example : `sample`	string
private_domain optional	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com`	any of [string, null]
public_domain optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com`	any of [string, null]
public_visible_enabled required	Public visible enabled Example : `True`	boolean
state required	Registry state Example : `Running`	string

1.2.8 - ContainerRegistryListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
registries required	Contents	array[ContainerRegistryForList]

1.2.9 - ContainerRegistryShowResponse

Name	Description	Schema	Default
registry required		ContainerRegistry

1.2.10 - Cve

Name	Description	Schema
category required	Category Example : `Language`	string
current_version required	Current version Example : `2.9.9.1`	string
cve_code required	Cve code Example : `CVE-2019-1454`	string
description required	Description Example : `A Polymorphic Typing issue was discovered in FasterXML.`	string
links required	Page link Example : `https://nvd.nist.gov/vuln/detail/CVE-2019-1454`	string
os_language optional	OS or language Example : `Java`	any of [string, null]
package_name optional	Package name Example : `com.example.sample`	any of [string, null]
severity required	Severity Example : `High`	string
update_version required	Updated version Example : `2.9.10, 2.8.11.5, 2.6.7.3`	string
vectors required		Vectors

1.2.11 - Image

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example : `Carpe diem.`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lifecycle_policy optional	Lifecycle policy	any of [LifecyclePolicy, null]
lock_policy optional	Lock Policy	any of [LockPolicy, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Image name Example : `sample`	string
pull_count required	Pull count Example : `100`	integer
pull_policy optional	Pull policy	any of [PullPolicy, null]
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
scan_policy optional	Scan policy	any of [ScanPolicy, null]
state required	Image state Example : `Active`	string

1.2.12 - ImageForList

Name	Description	Schema
created_at required	Created at Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string
modified_at required	Modified at Example : `2024-08-16T16:06:09.701645823+09:00`	string (date-time)
name required	Image name Example : `sample`	string
private_endpoint_url optional	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817`	any of [string, null]
public_endpoint_url optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817`	any of [string, null]
pull_count required	Pull count Example : `20`	integer
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
state required	Image state Example : `Active`	string

1.2.13 - ImageListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
images required	Contents	array[ImageForList]

1.2.14 - ImageSetRequest

Name	Description	Schema	Default
description required	Description Example : `Carpe diem.` Maximum length : `50`	string

1.2.15 - ImageShowResponse

Name	Description	Schema	Default
image required		Image

1.2.16 - ImageShowResponseV1_1

Name	Description	Schema	Default
image required		ImageV1_1

1.2.17 - ImageV1_1

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example : `Carpe diem.`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lifecycle_policy optional	Lifecycle policy	any of [LifecyclePolicyV1_1, null]
lock_policy optional	Lock Policy	any of [LockPolicy, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Image name Example : `sample`	string
pull_count required	Pull count Example : `100`	integer
pull_policy optional	Pull policy	any of [PullPolicy, null]
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
scan_policy optional	Scan policy	any of [ScanPolicy, null]
state required	Image state Example : `Active`	string

1.2.18 - LifecyclePolicy

Name	Description	Schema
lifecycle_policy_enabled required	Lifecycle policy enabled Example : `True`	boolean
outdated_rule_duration required	Tagged rule duration Example : `90` Maximum : `999`	integer
outdated_rule_enabled required	Tagged rule enabled Example : `True`	boolean
untagged_rule_duration required	Untagged rule duration Example : `90` Maximum : `999`	integer
untagged_rule_enabled required	Untagged rule enabled Example : `True`	boolean

1.2.19 - LifecyclePolicyPreview

Name	Description	Schema
created_at required	Created at Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
hash_digest required	Hash digest Example :	string
reference_tags required	List of tags in reference Example : `["sample"]`	array[string]
state required	Tags state Example : `Active`	string

1.2.20 - LifecyclePolicyPreviewResponseV1_1

Name	Description	Schema
count required	Total Count Example : `20`	any of [integer, null]
outdated_rule_duration required	Tagged rule duration Example : `10`	any of [integer, null]
outdated_rule_enabled required	Tagged rule enabled Example : `True`	any of [boolean, null]
outdated_rule_tag_expression required	Tagged rule tag expression Example : `*`	any of [string, null]
preview_run_at optional	Lifecycle policy preview run at Example : `2024-08-15T13:05:09.701645823+09:00`	any of [string (date-time), null]
preview_run_state required	Lifecycle policy preview run state Example : `Active`	string
previews required	Contents	any of [array[LifecyclePolicyPreview], null]
untagged_rule_duration required	Untagged rule duration Example : `10`	any of [integer, null]
untagged_rule_enabled required	Untagged rule enabled Example : `True`	any of [boolean, null]

1.2.21 - LifecyclePolicySetRequest

Name	Description	Schema	Default
lifecycle_policy required		LifecyclePolicy

1.2.22 - LifecyclePolicySetRequestV1_1

Name	Description	Schema	Default
lifecycle_policy required		LifecyclePolicyV1_1

1.2.23 - LifecyclePolicyV1_1

Name	Description	Schema
lifecycle_policy_enabled required	Lifecycle policy enabled Example : `True`	boolean
outdated_rule_duration required	Tagged rule duration Example : `90` Maximum : `999`	integer
outdated_rule_enabled required	Tagged rule enabled Example : `True`	boolean
outdated_rule_tag_expression required	Tagged rule tag expression Example : `` Pattern* : `^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,130}$` Minimum length : `1` Maximum length : `130`	string
untagged_rule_duration required	Untagged rule duration Example : `90` Maximum : `999`	integer
untagged_rule_enabled required	Untagged rule enabled Example : `True`	boolean

1.2.24 - LockPolicy

Name	Description	Schema	Default
locked required	Locked Example : `True`	boolean

1.2.25 - LockPolicySetRequest

Name	Description	Schema	Default
lock_policy required		LockPolicy

1.2.26 - PackageListResponse

Name	Description	Schema
filtered_count required	Filtered Count Example : `30`	integer
last_scanned_at required	Last scanned at Example : `2024-08-15T13:05:09.701645823+09:00`	string
package_reports required	Contents	array[PackageReport]
package_reports_count required	Total Count Example : `30`	integer
release_version required	OS release version Example : `alpine:3.14.10`	string
scan_summary required		ScanSummary

1.2.27 - PackageReport

Name	Description	Schema
category required	Category Example : `Language`	string
os_language optional	OS or language Example : `Java`	any of [string, null]
package_name optional	Package name Example : `com.example.sample`	any of [string, null]
scan_summary required		ScanSummary
type required	Pipeline type Example : `os-pkg(binary)`	string
version required	Pipeline version Example : `0.7.2-r3`	string

1.2.28 - PrivateAclSetRequest

Name	Description	Schema	Default
private_acl_enabled required	Private ACL enabled Example : `True`	boolean
private_acl_resources required	Private ACL resources	array[Resource]

1.2.29 - PublicAclSetRequest

Name	Description	Schema	Default
public_acl_enabled required	Public ACL enabled Example : `True`	boolean
public_acl_resources required	Public ACL resources	array[Resource]

1.2.30 - PublicEndpointEnabledSetRequest

Name	Description	Schema	Default
public_endpoint_enabled required	Public endpoint enabled Example : `True`	boolean

1.2.31 - PullPolicy

Name	Description	Schema
critical_limit optional	Critical limit Example : `20`	any of [integer, null]
high_limit optional	High limit Example : `20`	any of [integer, null]
unmodified_excepted required	Unmodified exception Example : `True`	boolean
unscanned_image_pull_prevented required	Unscanned image pull prevented Example : `True`	boolean
vulnerable_image_pull_prevented required	Vulnerable image pull prevented Example : `True`	boolean

1.2.32 - PullPolicySetRequest

Name	Description	Schema	Default
pull_policy required		PullPolicy

1.2.33 - Repository

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example : `Carpe diem.`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lifecycle_policy optional	Lifecycle policy	any of [LifecyclePolicy, null]
lock_policy optional	Lock Policy	any of [LockPolicy, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Repository name Example : `sample`	string
private_endpoint_url optional	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo`	any of [string, null]
public_endpoint_url optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo`	any of [string, null]
pull_policy optional	Pull policy	any of [PullPolicy, null]
registry_id optional	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
scan_policy optional	Scan policy	any of [ScanPolicy, null]
state required	Repository state Example : `Active`	string

1.2.34 - RepositoryCreateRequest

Name	Description	Schema
description required	Description Example : `Carpe diem.` Maximum length : `50`	string
lifecycle_policy optional	Lifecycle policy	any of [LifecyclePolicy, null]
lock_policy optional	Lock Policy	any of [LockPolicy, null]
name required	Repository name Example : `sample` Pattern : `^[a-z0-9][a-z0-9-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
pull_policy optional	Pull policy	any of [PullPolicy, null]
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
scan_policy optional	Scan policy	any of [ScanPolicy, null]
tags optional	Tag List	any of [array[Tag], null]

1.2.35 - RepositoryCreateRequestV1_1

Name	Description	Schema
description required	Description Example : `Carpe diem.` Maximum length : `50`	string
lifecycle_policy optional	Lifecycle policy	any of [LifecyclePolicyV1_1, null]
lock_policy optional	Lock Policy	any of [LockPolicy, null]
name required	Repository name Example : `sample` Pattern : `^[a-z0-9][a-z0-9-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
pull_policy optional	Pull policy	any of [PullPolicy, null]
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
scan_policy optional	Scan policy	any of [ScanPolicy, null]
tags optional	Tag List	any of [array[Tag], null]

1.2.36 - RepositoryCreateResponse

Name	Description	Schema
id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
message required	Description Example : `Carpe diem.`	string
state required	Repository state Example : `Active`	string

1.2.37 - RepositoryForList

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Repository name Example : `sample`	string
registry_id optional	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
state required	Repository state Example : `Active`	string

1.2.38 - RepositoryListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
repositories required		array[RepositoryForList]

1.2.39 - RepositorySetRequest

Name	Description	Schema	Default
description required	Description Example : `Carpe diem.` Maximum length : `50`	string

1.2.40 - RepositoryShowResponse

Name	Description	Schema	Default
repository required		Repository

1.2.41 - RepositoryShowResponseV1_1

Name	Description	Schema	Default
repository required		RepositoryV1_1

1.2.42 - RepositoryV1_1

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example : `Carpe diem.`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lifecycle_policy optional	Lifecycle policy	any of [LifecyclePolicyV1_1, null]
lock_policy optional	Lock Policy	any of [LockPolicy, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Repository name Example : `sample`	string
private_endpoint_url optional	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo`	any of [string, null]
public_endpoint_url optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo`	any of [string, null]
pull_policy optional	Pull policy	any of [PullPolicy, null]
registry_id optional	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
scan_policy optional	Scan policy	any of [ScanPolicy, null]
state required	Repository state Example : `Active`	string

1.2.43 - Resource

Name	Description	Schema
resource_id optional	Resource ID Example : `558496f6c49d43459e61e191fb3c08fe`	any of [string, null]
resource_ips optional	Resource IP list Example : `[]`	any of [array[string], null]
resource_name optional	Resource name Example : `sample`	any of [string, null]
resource_type optional	Resource type Example : `virtualServer`	any of [string, null]

1.2.44 - ScanPolicy

Name	Description	Schema
auto_scan_enabled required	Auto scan enabled Example : `True`	boolean
fixed_version_excepted required	Fixed version exception Example : `True`	boolean
language_excepted required	Language exception Example : `True`	boolean
scan_policy_enabled required	Scan policy enabled Example : `True`	boolean
secret_excepted required	Secret exception Example : `True`	boolean
severity_limit required	Severity limit Example : `High`	string

1.2.45 - ScanPolicySetRequest

Name	Description	Schema	Default
scan_policy required		ScanPolicy

1.2.46 - ScanSummary

Name	Description	Schema
critical required	Number of critical vulnerabilities Example : `10`	integer
high required	Number of high vulnerabilities Example : `10`	integer
low required	Number of low vulnerabilities Example : `10`	integer
medium required	Number of medium vulnerabilities Example : `10`	integer
negligible required	Number of negligible vulnerabilities Example : `10`	integer
total_vulnerability required	Total number of vulnerability creation Example : `60`	integer
unknown required	Number of unknown vulnerabilities Example : `10`	integer

1.2.47 - SecretListResponse

Name	Description	Schema
filtered_count required	Filtered Count Example : `30`	integer
last_scanned_at required	Last scanned at Example : `2024-08-16T16:06:09.701645823+09:00`	string
release_version required	OS release version Example : `alpine:3.14.10`	string
secret_reports required	Contents	array[SecretReport]
secret_summary required		SecretSummary

1.2.48 - SecretReport

Name	Description	Schema
category required	Category Example : `Language`	string
file_name required	Secret file name Example : `/certs/sample-key1.key`	string
match required	Secret match Example : `-----BEGIN SAMPLE KEY-----*********************...`	string
rule_id required	Rule ID Example : `private-key`	string
severity required	Severity Example : `High`	string
start_line required	Secret start line Example : `1`	integer
target required	Target Example : `/certs/sample-key1.key`	string
title required	Secret title Example : `Asymmetric Private Key`	string
vulnerability_class required	Vulnerability class Example : `secret`	string

1.2.49 - SecretSummary

Name	Description	Schema
critical required	Number of critical vulnerabilities Example : `10`	integer
high required	Number of high vulnerabilities Example : `10`	integer
low required	Number of low vulnerabilities Example : `10`	integer
medium required	Number of medium vulnerabilities Example : `10`	integer
total_secret required	Total Count Example : `50`	integer
unknown required	Number of unknown vulnerabilities Example : `10`	integer

1.2.50 - Tag

Name	Description	Schema	Default
key required	Tag Key Example :	string
value required	Tag Value Example :	any of [string, null]

1.2.51 - TagDeleteRequest

Name	Description	Schema	Default
tag_names required	Tag names Example : `["sample"]`	array[string]

1.2.52 - Tags

Name	Description	Schema
created_at required	Created at Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
hash_digest required	Hash digest Example :	string
id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string
image_id required	Image ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string
lock_policy optional	Lock Policy	any of [LockPolicy, null]
manifest required	Manifest Example :	string
manifest_media_type required	Manifest media type Example :	string
modified_at required	Modified at Example : `2024-08-16T16:06:09.701645823+09:00`	string (date-time)
reference_tags required	List of tags in reference Example : `["sample"]`	array[string]
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
state required	Tags state Example : `Active`	string

1.2.53 - TagsDeleteRequest

Name	Description	Schema	Default
tags_ids required	Tags IDs Example : `["b48210c7a226460fa15b6e3e221b30b0"]`	array[string]

1.2.54 - TagsForList

Name	Description	Schema
hash_digest required	Hash digest Example :	string
id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string
last_scanned_at required	Last scanned at Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
lock_policy optional	Lock Policy	any of [LockPolicy, null]
modified_at required	Modified at Example : `2024-08-16T16:06:09.701645823+09:00`	string (date-time)
private_endpoint_url required	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd`	string
public_endpoint_url required	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd`	string
re_scan_needed required	Need for retrying vulnerability inspection Example : `True`	boolean
reference_tags required	List of tags in reference Example : `["sample"]`	array[string]
referenced_by required	Reference necessity Example :	string
scan_state required	Scanning state Example : `Scanning state`	string
scan_summary required		ScanSummary
size required	Size Example : `10`	integer
state required	Tags state Example : `Active`	string

1.2.55 - TagsListResponse

Name	Description	Schema	Default
count required	Total Count Example : `10`	integer
tagses required	Total Count	array[TagsForList]

1.2.56 - TagsShowResponse

Name	Description	Schema	Default
tags required		Tags

1.2.57 - VectorInfo

Name	Description	Schema
description required	Description Example : `A Polymorphic Typing issue was discovered in FasterXML.`	string
level required	Level Example : `1`	string
metric required	Metric Example : `Physical`	string

1.2.58 - VectorInfos

Name	Description	Schema
attack_complexity required	Attack complexity	array[VectorInfo]
attack_vector required	Attack vector	array[VectorInfo]
availability required	Availability	array[VectorInfo]
confidentiality required	Confidentiality	array[VectorInfo]
integrity required	Integrity	array[VectorInfo]
privileges_required required	Necessary authority	array[VectorInfo]
scope required	Attack scope	array[VectorInfo]
user_interaction required	Degree of user participation	array[VectorInfo]

1.2.59 - Vectors

Name	Description	Schema
attack_complexity required	Attack complexity Example : `High`	string
attack_vector required	Attack vector Example : `NETWORK`	string
availability required	Availability Example : `High`	string
base_severity required	Base severity Example :	string
confidentiality required	Confidentiality Example : `High`	string
cvss required	Vulnerability rating system Example : `9.8`	object
integrity required	Integrity Example : `High`	string
privileges_required required	Necessary authority Example : `Low`	string
scope required	Attack scope Example :	string
user_interaction required	Degree of user participation Example : `Low`	string

1.2.60 - VulnerabilityListResponse

Name	Description	Schema
filtered_count required	Filtered Count Example : `30`	integer
vector_info required		VectorInfos
vulnerability_report required	Contents	VulnerabilityReport

1.2.61 - VulnerabilityReport

Name	Description	Schema
cves required		array[Cve]
last_scanned_at required	Last scanned at Example : `2024-08-16T16:06:09.701645823+09:00`	string
release_version required	OS release version Example : `alpine:3.14.10`	string
scan_summary required		ScanSummary

2 - Kubernetes

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of KUBERNETES service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.4	CURRENT	-
1.3	SUPPORTED	20261121
1.2	SUPPORTED	20261021
1.1	SUPPORTED	20260919
1.0	DEPRECATED	20251231

OpenAPI URL

https://ske.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

API Version History

1.4

Kubernetes Engine has been updated to version 1.4.

Changes

[Updated] POST /ske/1.4/nodepools - The following fields have been added to the request.
- scp_gpu_driver
- volume_max_iops
- volume_max_throughput
[Updated] GET /ske/1.4/nodepools/{nodepool_id} - The following fields have been added to the response.
- scp_gpu_driver
- volume_max_iops
- volume_max_throughput
[Updated] PUT /ske/1.4/nodepools/{nodepool_id}/upgrade - The following field has been added to the request.
- scp_gpu_driver
[Updated] GET /ske/1.4/images - The following fields have been added to the response.
- scp_gpu_driver
- scp_supported_class_types

1.3

Kubernetes Engine has been updated to version 1.3.

Changes

[New] PUT /ske/1.3/nodepools/{nodepool_id}/linked-resources - Set Nodepool Linked Resources API has been added.
[Updated] POST /ske/1.3/nodepools - The following field has been added to the request.
- linked_resources
[Updated] GET /ske/1.3/nodepools/{nodepool_id} - The following field has been added to the response.
- linked_resources

1.2

Kubernetes Engine has been updated to version 1.2.

Changes

[New] GET /ske/1.2/images - List Images API has been added.

1.1

Kubernetes Engine has been updated to version 1.1.

Changes

[New] PUT /ske/1.1/clusters/{cluster_id}/service-watch-logging - Set Cluster Service Watch Logging API has been added.
[Updated] POST /ske/1.1/clusters - The following field has been added to the request.
- service_watch_logging_enabled
[Updated] GET /ske/1.1/clusters/{cluster_id} - The following field has been added to the response.
- service_watch_logging_enabled
[Updated] POST /ske/1.1/nodepools - The following fields have been added to the request.
- advanced_settings
- server_group_id
[Updated] GET /ske/1.1/nodepools/{nodepool_id} - The following fields have been added to the response.
- advanced_settings
- server_group_id
[Updated] PUT /ske/1.1/nodepools/{nodepool_id}/upgrade - The following fields have been added to the request.
- os_version

1.0

Kubernetes Engine has been released.

Changes

[New] GET /clusters – List Clusters API has been added.
[New] POST /clusters – Create Cluster API has been added.
[New] DELETE /clusters/{cluster_id} – Delete Cluster API has been added.
[New] GET /clusters/{cluster_id} – Show Cluster API has been added.
[New] GET /clusters/{cluster_id}/kubeconfig – Create Cluster Kubeconfig API has been added.
[New] PUT /clusters/{cluster_id}/logging – Set Cluster Logging API has been added.
[New] PUT /clusters/{cluster_id}/private-access-control – Set Cluster Private Access Control API has been added.
[New] PUT /clusters/{cluster_id}/public-access-control – Set Cluster Public Access Control API has been added.
[New] PUT /clusters/{cluster_id}/security-groups – Set Cluster Security Groups API has been added.
[New] PUT /clusters/{cluster_id}/upgrade – Set Cluster Upgrade API has been added.
[New] GET /clusters/{cluster_id}/user-kubeconfig – Show Cluster User Kubeconfig API has been added.
[New] GET /clusters/{cluster_id}/nodepools – List Nodepools API has been added.
[New] POST /nodepools – Create Nodepool API has been added.
[New] DELETE /nodepools/{nodepool_id} – Delete Nodepool API has been added.
[New] GET /nodepools/{nodepool_id} – Show Nodepool API has been added.
[New] PUT /nodepools/{nodepool_id} – Set Nodepool API has been added.
[New] PUT /nodepools/{nodepool_id}/labels – Set Nodepool Labels API has been added.
[New] GET /nodepools/{nodepool_id}/nodes – List Nodepool Nodes API has been added.
[New] PUT /nodepools/{nodepool_id}/taints – Set Nodepool Taints API has been added.
[New] PUT /nodepools/{nodepool_id}/upgrade – Set Nodepool Upgrade API has been added.
[New] GET /kubernetes-versions – List Kubernetes Versions API has been added.

2.1 - APIs

2.1.1 - Create Cluster

2.1.1.1 - 1.4

post /v1/clusters

Description

create a cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ClusterCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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.4"

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

2.1.1.2 - 1.3

post /v1/clusters

Description

create a cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
body	body required		ClusterCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.1.3 - 1.2

post /v1/clusters

Description

create a cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
body	body required		ClusterCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.1.4 - 1.1

post /v1/clusters

Description

create a cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
body	body required		ClusterCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.1.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		ClusterCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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.1.2 - Create Cluster Kubeconfig

2.1.2.1 - 1.4

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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.4"

Example HTTP response

Response 200

2.1.2.2 - 1.3

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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.1.2.3 - 1.2

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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.1.2.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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

2.1.3 - Create Nodepool

2.1.3.1 - 1.4

post /v1/nodepools

Description

create a nodepool

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		NodepoolCreateRequestV1Dot4

Responses

HTTP Code	Description	Schema
200	OK	NodepoolShowResponseV1Dot4
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.4"

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": "fs"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "scp_gpu_driver": "",
    "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
    "server_type_id": "s1v1m2",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_max_iops": "5000",
    "volume_max_throughput": "250",
    "volume_size": "104",
    "volume_type_name": "SSD_Provisioned"
}

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",
            "scp_gpu_driver": ""
        },
        "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": "fs"
            }
        ],
        "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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_max_iops": "5000",
        "volume_max_throughput": "250",
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.3.2 - 1.3

post /v1/nodepools

Description

create a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

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": "fs"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
    "server_type_id": "s1v1m2",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD_Provisioned"
}

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": "fs"
            }
        ],
        "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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.3.3 - 1.2

post /v1/nodepools

Description

create a nodepool v1.1

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

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": "s1v1m2",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD_Provisioned"
}

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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.3.4 - 1.1

post /v1/nodepools

Description

create a nodepool v1.1

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": "s1v1m2",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD_Provisioned"
}

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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.3.5 - 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": "s1v1m2",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD_Provisioned"
}

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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.4 - Delete Cluster

2.1.4.1 - 1.4

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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.4"

Example HTTP response

Response 202

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

2.1.4.2 - 1.3

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.4.3 - 1.2

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.4.4 - 1.1

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.4.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.5 - Delete Nodepool

2.1.5.1 - 1.4

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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.4"

Example HTTP response

Response 202

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

2.1.5.2 - 1.3

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.5.3 - 1.2

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.5.4 - 1.1

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.5.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.6 - List Clusters

2.1.6.1 - 1.4

get /v1/clusters

Description

get clusters list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Cluster Name Example : `sample-cluster`	any of [string, null]	None
query	status optional	Cluster Status Example : `RUNNING`	any of [array[string], string, null]	None
query	kubernetes_version optional	Cluster Version Example : `v1.29.8`	any of [array[string], string, null]	None
query	subnet_id optional	Cluster Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None

Responses

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

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.4"

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

2.1.6.2 - 1.3

get /v1/clusters

Description

get clusters list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Cluster Name Example : `sample-cluster`	any of [string, null]	None
query	status optional	Cluster Status Example : `RUNNING`	any of [array[string], string, null]	None
query	kubernetes_version optional	Cluster Version Example : `v1.29.8`	any of [array[string], string, null]	None
query	subnet_id optional	Cluster Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None

Responses

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

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

2.1.6.3 - 1.2

get /v1/clusters

Description

get clusters list

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Cluster Name Example : `sample-cluster`	any of [string, null]	None
query	status optional	Cluster Status Example : `RUNNING`	any of [array[string], string, null]	None
query	kubernetes_version optional	Cluster Version Example : `v1.29.8`	any of [array[string], string, null]	None
query	subnet_id optional	Cluster Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None

Responses

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

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

2.1.6.4 - 1.1

get /v1/clusters

Description

get clusters list

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Cluster Name Example : `sample-cluster`	any of [string, null]	None
query	status optional	Cluster Status Example : `RUNNING`	any of [array[string], string, null]	None
query	kubernetes_version optional	Cluster Version Example : `v1.29.8`	any of [array[string], string, null]	None
query	subnet_id optional	Cluster Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None

Responses

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

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

2.1.6.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Cluster Name Example : `sample-cluster`	any of [string, null]	None
query	status optional	Cluster Status Example : `RUNNING`	any of [array[string], string, null]	None
query	kubernetes_version optional	Cluster Version Example : `v1.29.8`	any of [array[string], string, null]	None
query	subnet_id optional	Cluster Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None

Responses

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

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

2.1.7 - List Images

2.1.7.1 - 1.4

get /v1/images

Description

List ske node images available for nodepool creation V1.4

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	kubernetes_version optional	Kubernetes Version Example : `v1.29.8`	any of [string, null]	None
query	scp_original_image_type required	scp original image type (k8s, k8s_gpu) Example : `k8s`	string	None
query	os optional	Image OS Example : `ubuntu`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	NodepoolImageListResponseV1Dot4
400	Bad Request	None
403	Forbidden	None

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.4"

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_gpu_driver": "ND_570.195.03",
            "scp_image_type": "k8s",
            "scp_original_image_type": "k8s",
            "scp_supported_class_types": [
                "GPU-A100-1",
                "GPU-H100-2",
                "GPU-B300-3"
            ],
            "volume": {
                "size": 100
            }
        }
    ]
}

2.1.7.2 - 1.3

get /v1/images

Description

List ske node images available for nodepool creation

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	kubernetes_version optional	Kubernetes Version Example : `v1.29.8`	any of [string, null]	None
query	scp_original_image_type required	scp original image type (k8s, k8s_gpu) Example : `k8s`	string	None
query	os optional	Image OS Example : `ubuntu`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	NodepoolImageListResponse
400	Bad Request	None
403	Forbidden	None

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

2.1.7.3 - 1.2

get /v1/images

Description

List ske node images available for nodepool creation

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	kubernetes_version optional	Kubernetes Version Example : `v1.29.8`	any of [string, null]	None
query	scp_original_image_type required	scp original image type (k8s, k8s_gpu) Example : `k8s`	string	None
query	os optional	Image OS Example : `ubuntu`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	NodepoolImageListResponse
400	Bad Request	None
403	Forbidden	None

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

2.1.8 - List Kubernetes Versions

2.1.8.1 - 1.4

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Responses

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

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.4"

Example HTTP response

Response 200

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

2.1.8.2 - 1.3

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Responses

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

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

2.1.8.3 - 1.2

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Responses

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

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

2.1.8.4 - 1.1

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Responses

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

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

2.1.8.5 - 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.

Version	Not Before
1.0	20251231

Responses

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

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

2.1.9 - List Nodepool Nodes

2.1.9.1 - 1.4

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	node_name optional	Node Name Example : `ske-aug-rhel-0805-1-84d799f767-8dr2p`	any of [string, null]	None

Responses

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

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.4"

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

2.1.9.2 - 1.3

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	node_name optional	Node Name Example : `ske-aug-rhel-0805-1-84d799f767-8dr2p`	any of [string, null]	None

Responses

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

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

2.1.9.3 - 1.2

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	node_name optional	Node Name Example : `ske-aug-rhel-0805-1-84d799f767-8dr2p`	any of [string, null]	None

Responses

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

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

2.1.9.4 - 1.1

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	node_name optional	Node Name Example : `ske-aug-rhel-0805-1-84d799f767-8dr2p`	any of [string, null]	None

Responses

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

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

2.1.9.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	node_name optional	Node Name Example : `ske-aug-rhel-0805-1-84d799f767-8dr2p`	any of [string, null]	None

Responses

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

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

2.1.10 - List Nodepools

2.1.10.1 - 1.4

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	nodepool_name optional	Nodepool Name Example : `sample-nodepool`	any of [string, null]	None

Responses

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

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.4"

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",
                "scp_gpu_driver": ""
            },
            "kubernetes_version": "v1.29.8",
            "name": "sample-nodepool",
            "server_type": {
                "description": "Standard",
                "id": "s1v1m2"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD_Provisioned"
            }
        }
    ]
}

2.1.10.2 - 1.3

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list v1.0

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	nodepool_name optional	Nodepool Name Example : `sample-nodepool`	any of [string, null]	None

Responses

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

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": "s1v1m2"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD_Provisioned"
            }
        }
    ]
}

2.1.10.3 - 1.2

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list v1.0

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	nodepool_name optional	Nodepool Name Example : `sample-nodepool`	any of [string, null]	None

Responses

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

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": "s1v1m2"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD_Provisioned"
            }
        }
    ]
}

2.1.10.4 - 1.1

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list v1.0

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	nodepool_name optional	Nodepool Name Example : `sample-nodepool`	any of [string, null]	None

Responses

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

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": "s1v1m2"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD_Provisioned"
            }
        }
    ]
}

2.1.10.5 - 1.0

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list 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
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	nodepool_name optional	Nodepool Name Example : `sample-nodepool`	any of [string, null]	None

Responses

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

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": "s1v1m2"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD_Provisioned"
            }
        }
    ]
}

2.1.11 - Set Cluster Logging

2.1.11.1 - 1.4

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterLoggingSetRequest

Responses

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

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.4"

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

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

2.1.11.2 - 1.3

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterLoggingSetRequest

Responses

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

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

2.1.11.3 - 1.2

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterLoggingSetRequest

Responses

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

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

2.1.11.4 - 1.1

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterLoggingSetRequest

Responses

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

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

2.1.11.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterLoggingSetRequest

Responses

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

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

2.1.12 - Set Cluster Private Access Control

2.1.12.1 - 1.4

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

Description

set a private access control specific cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPrivateAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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.4"

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

2.1.12.2 - 1.3

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

Description

set a private access control specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPrivateAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.12.3 - 1.2

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

Description

set a private access control specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPrivateAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.12.4 - 1.1

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

Description

set a private access control specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPrivateAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.12.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPrivateAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.13 - Set Cluster Public Access Control

2.1.13.1 - 1.4

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

Description

set a public access control specific cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPublicAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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.4"

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

2.1.13.2 - 1.3

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

Description

set a public access control specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPublicAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.13.3 - 1.2

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

Description

set a public access control specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPublicAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.13.4 - 1.1

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

Description

set a public access control specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPublicAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.13.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPublicAccessControlSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.14 - Set Cluster Security Groups

2.1.14.1 - 1.4

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

Description

Set Cluster Security Groups

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterSecurityGroupsSetRequest

Responses

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

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.4"

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

2.1.14.2 - 1.3

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

Description

Set Cluster Security Groups

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterSecurityGroupsSetRequest

Responses

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

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

2.1.14.3 - 1.2

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

Description

Set Cluster Security Groups

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterSecurityGroupsSetRequest

Responses

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

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

2.1.14.4 - 1.1

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

Description

Set Cluster Security Groups

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterSecurityGroupsSetRequest

Responses

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

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

2.1.14.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterSecurityGroupsSetRequest

Responses

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

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

2.1.15 - Set Cluster Service Watch Logging

2.1.15.1 - 1.4

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

Description

Set Service Watch logging on the cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterServiceWatchLoggingSetRequest

Responses

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

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.4"

Request body

{
    "service_watch_logging_enabled": "true"
}

Example HTTP response

Response 200

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

2.1.15.2 - 1.3

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

Description

Set Service Watch logging on the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterServiceWatchLoggingSetRequest

Responses

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

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

2.1.15.3 - 1.2

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

Description

Set Service Watch logging on the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterServiceWatchLoggingSetRequest

Responses

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

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

2.1.15.4 - 1.1

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

Description

Set Service Watch logging on the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterServiceWatchLoggingSetRequest

Responses

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

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

2.1.16 - Set Cluster Upgrade

2.1.16.1 - 1.4

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterUpgradeSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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.4"

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

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

2.1.16.2 - 1.3

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterUpgradeSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.16.3 - 1.2

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterUpgradeSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.16.4 - 1.1

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterUpgradeSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.16.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterUpgradeSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ClusterSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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

2.1.17 - Set Nodepool

2.1.17.1 - 1.4

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpdateRequest

Responses

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

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.4"

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

2.1.17.2 - 1.3

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpdateRequest

Responses

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

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

2.1.17.3 - 1.2

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpdateRequest

Responses

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

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

2.1.17.4 - 1.1

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpdateRequest

Responses

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

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

2.1.17.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpdateRequest

Responses

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

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

2.1.18 - Set Nodepool Labels

2.1.18.1 - 1.4

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolLabelsSetRequest

Responses

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

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.4"

Request body

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

Example HTTP response

Response 200

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

2.1.18.2 - 1.3

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolLabelsSetRequest

Responses

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

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

2.1.18.3 - 1.2

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolLabelsSetRequest

Responses

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

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

2.1.18.4 - 1.1

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolLabelsSetRequest

Responses

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

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

2.1.18.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolLabelsSetRequest

Responses

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

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

2.1.19 - Set Nodepool Linked Resources

2.1.19.1 - 1.4

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

Description

set nodepool linked resources

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolLinkedResourcesSetRequest

Responses

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

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.4"

Request body

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

Example HTTP response

Response 200

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

2.1.19.2 - 1.3

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

Description

set nodepool linked resources

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolLinkedResourcesSetRequest

Responses

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

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": "fs"
        }
    ]
}

Example HTTP response

Response 200

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

2.1.20 - Set Nodepool Taints

2.1.20.1 - 1.4

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolTaintsSetRequest

Responses

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

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.4"

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

2.1.20.2 - 1.3

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolTaintsSetRequest

Responses

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

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

2.1.20.3 - 1.2

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolTaintsSetRequest

Responses

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

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

2.1.20.4 - 1.1

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolTaintsSetRequest

Responses

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

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

2.1.20.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolTaintsSetRequest

Responses

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

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

2.1.21 - Set Nodepool Upgrade

2.1.21.1 - 1.4

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpgradeSetRequestV1Dot4

Responses

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

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.4"

Request body

{
    "os_version": "22.04",
    "scp_gpu_driver": ""
}

Example HTTP response

Response 200

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

2.1.21.2 - 1.3

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpgradeSetRequest

Responses

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

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

2.1.21.3 - 1.2

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpgradeSetRequest

Responses

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

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

2.1.21.4 - 1.1

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None
body	body required		NodepoolUpgradeSetRequest

Responses

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

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

2.1.21.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

Responses

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

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

2.1.22 - Show Cluster

2.1.22.1 - 1.4

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

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.4"

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

2.1.22.2 - 1.3

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

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

2.1.22.3 - 1.2

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

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

2.1.22.4 - 1.1

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

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

2.1.22.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

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

2.1.23 - Show Cluster User Kubeconfig

2.1.23.1 - 1.4

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

Description

Show user kubeconfig for the cluster

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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.4"

Example HTTP response

Response 200

2.1.23.2 - 1.3

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

Description

Show user kubeconfig for the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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

2.1.23.3 - 1.2

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

Description

Show user kubeconfig for the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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

2.1.23.4 - 1.1

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

Description

Show user kubeconfig for the cluster

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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

2.1.23.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig Type (private/public) Example : `private`	enum (private, public)	None

Responses

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

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

2.1.24 - Show Nodepool

2.1.24.1 - 1.4

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

Responses

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

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.4"

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",
            "scp_gpu_driver": ""
        },
        "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": "fs"
            }
        ],
        "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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_max_iops": "5000",
        "volume_max_throughput": "250",
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.24.2 - 1.3

get /v1/nodepools/{nodepool_id}

Description

show a nodepool v1.3

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261121

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

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/{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": "fs"
            }
        ],
        "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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.24.3 - 1.2

get /v1/nodepools/{nodepool_id}

Description

show a nodepool v1.1

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261021

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

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/{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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.24.4 - 1.1

get /v1/nodepools/{nodepool_id}

Description

show a nodepool v1.1

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260919

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

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/{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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.1.24.5 - 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.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nodepool_id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string	None

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/{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": "s1v1m2"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "s1v1m2",
            "name": "SSD_Provisioned"
        }
    }
}

2.2 - Models

2.2.1 - AsyncResponse

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
request_id required	Request ID Example : `80a599e031e749b7b260868f441e862b`	string
resource_id required	Resource ID Example : `70a599e031e749b7b260868f441e862b`	string

2.2.2 - Cluster

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
cloud_logging_enabled required	Cloud Logging Enabled Example : `true`	boolean
cluster_namespace required	Cluster Namespace Example : `sample-cluster-12345`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
kubernetes_version required	Cluster Version Example : `v1.29.8`	string
managed_security_group required	Managed Security Group	any of [ExternalResource, null]
max_node_count required	Cluster Max Node Count Example : `5`	any of [integer, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster Name Example : `sample-cluster`	string
node_count required	Cluster Node Count Example : `5`	any of [integer, null]
private_endpoint_access_control_resources required	Private Endpoint Access Control Resources	any of [array[PrivateEndpointAccessControlResource], null]
private_endpoint_url required	Private Endpoint URL Example : `https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443`	string
private_kubeconfig_download_yn required	Private Kubeconfig Downloaded Or Not (Y/N) Example : `N`	string
public_endpoint_access_control_ip required	Public Endpoint Access Control IP Example : `192.168.0.0`	any of [string, null]
public_endpoint_url required	Public Endpoint URL Example : `https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443`	any of [string, null]
public_kubeconfig_download_yn required	Public Kubeconfig Downloaded Or Not (Y/N) Example : `N`	string
security_group_list required	Connected Security Group List	array[ExternalResource]
status required	Cluster Status Example : `RUNNING`	string
subnet required	Subnet of Cluster	any of [ExternalResource, null]
volume required	Connected File Storage	any of [ExternalResource, null]
vpc required	VPC of Cluster	any of [ExternalResource, null]

2.2.3 - ClusterCreateRequest

Name	Description	Schema
cloud_logging_enabled required	Cloud Logging Enabled Example : `true`	boolean
kubernetes_version required	Cluster Version Example : `v1.29.8` Pattern : `^v[0-9]{1}\.[0-9]{1,2}\.[0-9]{1,2}$`	string
name required	Cluster Name Example : `sample-cluster` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
private_endpoint_access_control_resources optional	Private Endpoint Access Control Resources	any of [array[PrivateEndpointAccessControlResource], null]
public_endpoint_access_control_ip optional	Public Endpoint Access Control IP Example : `192.168.0.0`	any of [string, null]
security_group_id_list required	Security Group ID List Example : `['bdfda539-bd2e-4a5c-9021-ec6d52d1ca79']`	array[string]
subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
tags optional	Tag list	any of [array[Tag], null]
volume_id required	Volume ID Example : `['bfdbabf2-04d9-4e8b-a205-020f8e6da438']`	string
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string

2.2.4 - ClusterCreateRequestV1Dot1

Name	Description	Schema
cloud_logging_enabled required	Cloud Logging Enabled Example : `true`	boolean
kubernetes_version required	Cluster Version Example : `v1.29.8` Pattern : `^v[0-9]{1}\.[0-9]{1,2}\.[0-9]{1,2}$`	string
name required	Cluster Name Example : `sample-cluster` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
private_endpoint_access_control_resources optional	Private Endpoint Access Control Resources	any of [array[PrivateEndpointAccessControlResource], null]
public_endpoint_access_control_ip optional	Public Endpoint Access Control IP Example : `192.168.0.0`	any of [string, null]
security_group_id_list required	Security Group ID List Example : `['bdfda539-bd2e-4a5c-9021-ec6d52d1ca79']`	array[string]
service_watch_logging_enabled required	Service Watch Logging Enabled Example : `true`	boolean
subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
tags optional	Tag list	any of [array[Tag], null]
volume_id required	Volume ID Example : `['bfdbabf2-04d9-4e8b-a205-020f8e6da438']`	string
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string

2.2.5 - ClusterListResponse

Name	Description	Schema
clusters required		array[ClusterSummary]
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

2.2.6 - ClusterLoggingSetRequest

Name	Description	Schema	Default
cloud_logging_enabled required	Cloud Logging Enabled Example : `true`	boolean

2.2.7 - ClusterOfNodepool

Name	Description	Schema	Default
id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string

2.2.8 - ClusterPrivateAccessControlSetRequest

Name	Description	Schema	Default
private_endpoint_access_control_resources required		array[PrivateEndpointAccessControlResource]

2.2.9 - ClusterPublicAccessControlSetRequest

Name	Description	Schema	Default
public_endpoint_access_control_ip required	Public Endpoint Access Control IP Example : `192.168.0.0`	string

2.2.10 - ClusterSecurityGroupsSetRequest

Name	Description	Schema	Default
security_group_id_list required	Security Group ID List Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	array[string]

2.2.11 - ClusterServiceWatchLoggingSetRequest

Name	Description	Schema	Default
service_watch_logging_enabled required	Service Watch Logging Enabled Example : `true`	boolean

2.2.12 - ClusterSetResponse

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
request_id required	Request ID Example : `80a599e031e749b7b260868f441e862b`	string
resource_id required	Resource ID Example : `70a599e031e749b7b260868f441e862b`	string

2.2.13 - ClusterShowResponse

Name	Description	Schema	Default
cluster required		Cluster

2.2.14 - ClusterShowResponseV1Dot1

Name	Description	Schema	Default
cluster required		ClusterV1Dot1

2.2.15 - ClusterSummary

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
created_at required	Created At Example : `2025-03-31T00:23:17Z`	string (date-time)
id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string
kubernetes_version required	Cluster Version Example : `v1.29.8`	string
modified_at required	Modified At Example : `2025-06-31T00:23:17Z`	string (date-time)
name required	Cluster Name Example : `sample-cluster`	string
node_count required	Cluster Node Count Example : `5`	any of [integer, null]
status required	Cluster Status Example : `RUNNING`	string
subnet_id required	Cluster Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]

2.2.16 - ClusterUpgradeSetRequest

Name	Description	Schema	Default
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string

2.2.17 - ClusterV1Dot1

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
cloud_logging_enabled required	Cloud Logging Enabled Example : `true`	boolean
cluster_namespace required	Cluster Namespace Example : `sample-cluster-12345`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
kubernetes_version required	Cluster Version Example : `v1.29.8`	string
managed_security_group required	Managed Security Group	any of [ExternalResource, null]
max_node_count required	Cluster Max Node Count Example : `5`	any of [integer, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster Name Example : `sample-cluster`	string
node_count required	Cluster Node Count Example : `5`	any of [integer, null]
private_endpoint_access_control_resources required	Private Endpoint Access Control Resources	any of [array[PrivateEndpointAccessControlResource], null]
private_endpoint_url required	Private Endpoint URL Example : `https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443`	string
private_kubeconfig_download_yn required	Private Kubeconfig Downloaded Or Not (Y/N) Example : `N`	string
public_endpoint_access_control_ip required	Public Endpoint Access Control IP Example : `192.168.0.0`	any of [string, null]
public_endpoint_url required	Public Endpoint URL Example : `https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443`	any of [string, null]
public_kubeconfig_download_yn required	Public Kubeconfig Downloaded Or Not (Y/N) Example : `N`	string
security_group_list required	Connected Security Group List	array[ExternalResource]
service_watch_logging_enabled required	Service Watch Logging Enabled Example : `true`	boolean
status required	Cluster Status Example : `RUNNING`	string
subnet required	Subnet of Cluster	any of [ExternalResource, null]
volume required	Connected File Storage	any of [ExternalResource, null]
vpc required	VPC of Cluster	any of [ExternalResource, null]

2.2.18 - ExternalResource

Name	Description	Schema	Default
id required	External Resource ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string
name required	External Resource name Example : `sample-name`	string

2.2.19 - Image

Name	Description	Schema
custom_image_name required	Custom Image Name Example : `custom-image`	any of [string, null]
os required	Image OS Example : `ubuntu`	string
os_version required	Image OS Version Example : `22.04`	string

2.2.20 - ImageV1Dot4

Name	Description	Schema
custom_image_name required	Custom Image Name Example : `custom-image`	any of [string, null]
os required	Image OS Example : `ubuntu`	string
os_version required	Image OS Version Example : `22.04`	string
scp_gpu_driver optional	GPU Driver Version Example :	any of [string, null]

2.2.21 - Keypair

Name	Description	Schema	Default
name required	Keypair Name Example : `test_keypair`	string

2.2.22 - KubernetesVersionListResponse

Name	Description	Schema	Default
kubernetes_versions required		array[KubernetesVersionSummary]

2.2.23 - KubernetesVersionSummary

Name	Description	Schema
description required	Kubernetes Version Example : `v1.29.8`	any of [string, null]
end_dt required	SCP Kubernetes Version End of Support Date Example : `2025-06-31T00:00:00Z`	string (date-time)
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string

2.2.24 - LinkedResource

Name	Description	Schema
id required	Linked Resource ID Example : `res-12345678`	string
name required	Linked Resource Name Example : `my-resource`	string
type required	Linked Resource Type (fs/obs) Example : `fs`	string

2.2.25 - NodeInNodepool

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
name required	Node Name Example : `ske-aug-rhel-0805-1-84d799f767-8dr2p`	string
status required	Node Status Example : `RUNNING`	string

2.2.26 - NodeListInNodepoolResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nodes required	Node List In Node Pool	any of [array[NodeInNodepool], null]

2.2.27 - Nodepool

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
auto_recovery_enabled required	Is Auto Recovery Example : `true`	boolean
auto_scale_enabled required	Is Auto Scale Example : `true`	boolean
cluster required	Cluster	ClusterOfNodepool
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
current_node_count required	Current Node Count Example : `1`	integer
desired_node_count required	Desired Node Count Example : `2`	integer
id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	Image	Image
keypair required	Keypair Name	Keypair
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
max_node_count required	Max Node Count Example : `5`	integer
min_node_count required	Min Node Count Example : `1`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Nodepool Name Example : `sample-nodepool`	string
server_type required	Server Type	ServerType
status required	Node Pool Status Example : `Running`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_size required	Volume Size Example : `104`	integer
volume_type required	Volume Type	VolumeType

2.2.28 - NodepoolAdvancedSettings

Name	Description	Schema
allowed_unsafe_sysctls optional	Allowed Unsafe sysctls Example : `kernel.msg*,net.ipv4.route.min_pmtu`	string
container_log_max_files required	Max Number Of Container Log Files Example : `5` Minimum : `2` Maximum : `10`	integer
container_log_max_size required	Max Size Of Container Log (MB) Example : `10` Minimum : `10` Maximum : `100`	integer
image_gc_high_threshold required	Image GC High Threshold Percent Example : `85` Minimum : `10` Maximum : `85`	integer
image_gc_low_threshold required	Image GC Low Threshold Percent Example : `80` Minimum : `10` Maximum : `85`	integer
max_pods required	Max Pods Per Node Example : `110` Minimum : `10` Maximum : `250`	integer
pod_max_pids required	Pod Max PID Limit Example : `4096` Minimum : `1024` Maximum : `4194304`	integer

2.2.29 - NodepoolCreateRequest

Name	Description	Schema
cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string
custom_image_id optional	Custom Image ID Example : `10a599e031e749b7b260868f441e862b`	any of [string, null]
desired_node_count optional	Desired node count (is_auto_scale = false) Example : `2`	any of [integer, null]
image_os required	Image OS Example : `ubuntu`	string
image_os_version required	Image OS Version Example : `22.04`	string
is_auto_recovery required	Is Auto Recovery Example : `true`	boolean
is_auto_scale required	Is Auto Scale Example : `true`	boolean
keypair_name required	Keypair Name Example : `test_keypair`	string
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
max_node_count optional	Maximum node count (is_auto_scale = true) Example : `5`	any of [integer, null]
min_node_count optional	Minimum node count (is_auto_scale = true) Example : `1`	any of [integer, null]
name required	Nodepool Name Example : `sample-nodepool` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `20`	string
server_type_id required	Server Type ID Example : `s1v1m2`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_size required	Volume Size Example : `104`	integer
volume_type_name required	Volume Type Name Example : `SSD_Provisioned`	string

2.2.30 - NodepoolCreateRequestV1Dot1

Name	Description	Schema
advanced_settings optional	Advanced Settings	any of [NodepoolAdvancedSettings, null]
cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string
custom_image_id optional	Custom Image ID Example : `10a599e031e749b7b260868f441e862b`	any of [string, null]
desired_node_count optional	Desired node count (is_auto_scale = false) Example : `2`	any of [integer, null]
image_os required	Image OS Example : `ubuntu`	string
image_os_version required	Image OS Version Example : `22.04`	string
is_auto_recovery required	Is Auto Recovery Example : `true`	boolean
is_auto_scale required	Is Auto Scale Example : `true`	boolean
keypair_name required	Keypair Name Example : `test_keypair`	string
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
max_node_count optional	Maximum node count (is_auto_scale = true) Example : `5`	any of [integer, null]
min_node_count optional	Minimum node count (is_auto_scale = true) Example : `1`	any of [integer, null]
name required	Nodepool Name Example : `sample-nodepool` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `20`	string
server_group_id optional	Server Group ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type_id required	Server Type ID Example : `s1v1m2`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_size required	Volume Size Example : `104`	integer
volume_type_name required	Volume Type Name Example : `SSD_Provisioned`	string

2.2.31 - NodepoolCreateRequestV1Dot3

Name	Description	Schema
advanced_settings optional	Advanced Settings	any of [NodepoolAdvancedSettings, null]
cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string
custom_image_id optional	Custom Image ID Example : `10a599e031e749b7b260868f441e862b`	any of [string, null]
desired_node_count optional	Desired node count (is_auto_scale = false) Example : `2`	any of [integer, null]
image_os required	Image OS Example : `ubuntu`	string
image_os_version required	Image OS Version Example : `22.04`	string
is_auto_recovery required	Is Auto Recovery Example : `true`	boolean
is_auto_scale required	Is Auto Scale Example : `true`	boolean
keypair_name required	Keypair Name Example : `test_keypair`	string
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
linked_resources optional	List of linked resources associated with the nodepool	any of [array[LinkedResource], null]
max_node_count optional	Maximum node count (is_auto_scale = true) Example : `5`	any of [integer, null]
min_node_count optional	Minimum node count (is_auto_scale = true) Example : `1`	any of [integer, null]
name required	Nodepool Name Example : `sample-nodepool` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `20`	string
server_group_id optional	Server Group ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type_id required	Server Type ID Example : `s1v1m2`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_size required	Volume Size Example : `104`	integer
volume_type_name required	Volume Type Name Example : `SSD_Provisioned`	string

2.2.32 - NodepoolCreateRequestV1Dot4

Name	Description	Schema
advanced_settings optional	Advanced Settings	any of [NodepoolAdvancedSettings, null]
cluster_id required	Cluster ID Example : `70a599e031e749b7b260868f441e862b`	string
custom_image_id optional	Custom Image ID Example : `10a599e031e749b7b260868f441e862b`	any of [string, null]
desired_node_count optional	Desired node count (is_auto_scale = false) Example : `2`	any of [integer, null]
image_os required	Image OS Example : `ubuntu`	string
image_os_version required	Image OS Version Example : `22.04`	string
is_auto_recovery required	Is Auto Recovery Example : `true`	boolean
is_auto_scale required	Is Auto Scale Example : `true`	boolean
keypair_name required	Keypair Name Example : `test_keypair`	string
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
linked_resources optional	List of linked resources associated with the nodepool	any of [array[LinkedResource], null]
max_node_count optional	Maximum node count (is_auto_scale = true) Example : `5`	any of [integer, null]
min_node_count optional	Minimum node count (is_auto_scale = true) Example : `1`	any of [integer, null]
name required	Nodepool Name Example : `sample-nodepool` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `20`	string
scp_gpu_driver optional	GPU Driver Version Example :	any of [string, null]
server_group_id optional	Server Group ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type_id required	Server Type ID Example : `s1v1m2`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_max_iops optional	Volume Max Iops Example : `5000`	any of [integer, null]
volume_max_throughput optional	Volume Max Throughput Example : `250`	any of [integer, null]
volume_size required	Volume Size Example : `104`	integer
volume_type_name required	Volume Type Name Example : `SSD_Provisioned`	string

2.2.33 - NodepoolImage

Name	Description	Schema
end_of_support optional	Whether this is an EOS (End of Service) image Example : `False`	boolean
id required	Image ID Example : `10a599e031e749b7b260868f441e862b`	string
kubernetes_version optional	Kubernetes Version Example : `v1.29.8`	any of [string, null]
name required	Image name Example : `ubuntu-22.04-k8s-v1.29.8`	string
os required	Image OS Example : `ubuntu`	string
os_version required	Image OS Version Example : `22.04`	string
scp_image_type optional	SCP image type (k8s, custom) Example : `k8s`	any of [string, null]
scp_original_image_type optional	scp original image type (k8s, k8s_gpu) Example : `k8s`	any of [string, null]
volume optional	Volume information Example : `{'size': 100}`	any of [object, null]

2.2.34 - NodepoolImageListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nodepool_images required	List of Nodepool images	array[NodepoolImage]

2.2.35 - NodepoolImageListResponseV1Dot4

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nodepool_images required	List of Nodepool images	array[NodepoolImageV1Dot4]

2.2.36 - NodepoolImageV1Dot4

Name	Description	Schema
end_of_support optional	Whether this is an EOS (End of Service) image Example : `False`	boolean
id required	Image ID Example : `10a599e031e749b7b260868f441e862b`	string
kubernetes_version optional	Kubernetes Version Example : `v1.29.8`	any of [string, null]
name required	Image name Example : `ubuntu-22.04-k8s-v1.29.8`	string
os required	Image OS Example : `ubuntu`	string
os_version required	Image OS Version Example : `22.04`	string
scp_gpu_driver optional	GPU Driver Version Example : `ND_570.195.03`	any of [string, null]
scp_image_type optional	SCP image type (k8s, custom) Example : `k8s`	any of [string, null]
scp_original_image_type optional	scp original image type (k8s, k8s_gpu) Example : `k8s`	any of [string, null]
scp_supported_class_types optional	List of supported class types for GPU SKE image Example : `['GPU-A100-1', 'GPU-H100-2', 'GPU-B300-3']`	array[object]
volume optional	Volume information Example : `{'size': 100}`	any of [object, null]

2.2.37 - NodepoolLabel

Name	Description	Schema	Default
key required	Label Key Example : `example.com/my-app` Pattern : `^([a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)/)?([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9]$`	string
value optional	Label Value Example : `bar` Pattern : `^(([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9])?$` Maximum length* : `63`	string

2.2.38 - NodepoolLabelsSetRequest

Name	Description	Schema	Default
labels required		array[NodepoolLabel]

2.2.39 - NodepoolLinkedResourcesSetRequest

Name	Description	Schema	Default
linked_resources required	List of linked resources associated with the nodepool	any of [array[LinkedResource], null]

2.2.40 - NodepoolListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nodepools required	Node Pool List	array[NodepoolSummary]

2.2.41 - NodepoolListResponseV1Dot4

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nodepools required	Node Pool List	array[NodepoolSummaryV1Dot4]

2.2.42 - NodepoolShowResponse

Name	Description	Schema	Default
nodepool required		Nodepool

2.2.43 - NodepoolShowResponseV1Dot1

Name	Description	Schema	Default
nodepool required		NodepoolV1Dot1

2.2.44 - NodepoolShowResponseV1Dot3

Name	Description	Schema	Default
nodepool required		NodepoolV1Dot3

2.2.45 - NodepoolShowResponseV1Dot4

Name	Description	Schema	Default
nodepool required		NodepoolV1Dot4

2.2.46 - NodepoolSummary

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
auto_recovery_enabled required	Is Auto Recovery Example :	boolean
auto_scale_enabled required	Is Auto Scale Example :	boolean
current_node_count required	Current Node Count Example : `1`	integer
desired_node_count required	Desired Node Count Example : `2`	integer
id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	Image	Image
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
name required	Nodepool Name Example : `sample-nodepool`	string
server_type required	Server Type	ServerType
status required	Node Pool Status Example : `Running`	string
volume_type required	Volume Type	VolumeTypeSummary

2.2.47 - NodepoolSummaryV1Dot4

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
auto_recovery_enabled required	Is Auto Recovery Example :	boolean
auto_scale_enabled required	Is Auto Scale Example :	boolean
current_node_count required	Current Node Count Example : `1`	integer
desired_node_count required	Desired Node Count Example : `2`	integer
id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	Image	ImageV1Dot4
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
name required	Nodepool Name Example : `sample-nodepool`	string
server_type required	Server Type	ServerType
status required	Node Pool Status Example : `Running`	string
volume_type required	Volume Type	VolumeTypeSummary

2.2.48 - NodepoolTaint

Name	Description	Schema
effect required	Taint Effect Example : `NoSchedule`	enum (NoSchedule, NoExecute, PreferNoSchedule)
key required	Taint Key Example : `example.com/my-app` Pattern : `^([a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)/)?([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9]$`	string
value optional	Taint Value Example : `bar` Pattern : `^(([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9])?$` Maximum length* : `63`	string

2.2.49 - NodepoolTaintsSetRequest

Name	Description	Schema	Default
taints required		array[NodepoolTaint]

2.2.50 - NodepoolUpdateRequest

Name	Description	Schema
desired_node_count optional	Desired Node Count Example : `2`	any of [integer, null]
is_auto_recovery optional	Is Auto Recovery Example : `true`	any of [boolean, null]
is_auto_scale optional	Is Auto Scale Example : `true`	any of [boolean, null]
max_node_count optional	Max Node Count Example : `5`	any of [integer, null]
min_node_count optional	Min Node Count Example : `1`	any of [integer, null]

2.2.51 - NodepoolUpgradeSetRequest

Name	Description	Schema	Default
os_version required	Image OS Version Example : `22.04`	string

2.2.52 - NodepoolUpgradeSetRequestV1Dot4

Name	Description	Schema	Default
os_version required	Image OS Version Example : `22.04`	string
scp_gpu_driver optional	GPU Driver Version Example :	any of [string, null]

2.2.53 - NodepoolV1Dot1

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
advanced_settings optional	Advanced Settings	any of [NodepoolAdvancedSettings, null]
auto_recovery_enabled required	Is Auto Recovery Example : `true`	boolean
auto_scale_enabled required	Is Auto Scale Example : `true`	boolean
cluster required	Cluster	ClusterOfNodepool
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
current_node_count required	Current Node Count Example : `1`	integer
desired_node_count required	Desired Node Count Example : `2`	integer
id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	Image	Image
keypair required	Keypair Name	Keypair
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
max_node_count required	Max Node Count Example : `5`	integer
min_node_count required	Min Node Count Example : `1`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Nodepool Name Example : `sample-nodepool`	string
server_group_id optional	Server Group ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type required	Server Type	ServerType
status required	Node Pool Status Example : `Running`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_size required	Volume Size Example : `104`	integer
volume_type required	Volume Type	VolumeType

2.2.54 - NodepoolV1Dot3

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
advanced_settings optional	Advanced Settings	any of [NodepoolAdvancedSettings, null]
auto_recovery_enabled required	Is Auto Recovery Example : `true`	boolean
auto_scale_enabled required	Is Auto Scale Example : `true`	boolean
cluster required	Cluster	ClusterOfNodepool
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
current_node_count required	Current Node Count Example : `1`	integer
desired_node_count required	Desired Node Count Example : `2`	integer
id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	Image	Image
keypair required	Keypair Name	Keypair
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
linked_resources optional	List of linked resources associated with the nodepool	any of [array[LinkedResource], null]
max_node_count required	Max Node Count Example : `5`	integer
min_node_count required	Min Node Count Example : `1`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Nodepool Name Example : `sample-nodepool`	string
server_group_id optional	Server Group ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type required	Server Type	ServerType
status required	Node Pool Status Example : `Running`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_size required	Volume Size Example : `104`	integer
volume_type required	Volume Type	VolumeType

2.2.55 - NodepoolV1Dot4

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
advanced_settings optional	Advanced Settings	any of [NodepoolAdvancedSettings, null]
auto_recovery_enabled required	Is Auto Recovery Example : `true`	boolean
auto_scale_enabled required	Is Auto Scale Example : `true`	boolean
cluster required	Cluster	ClusterOfNodepool
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
current_node_count required	Current Node Count Example : `1`	integer
desired_node_count required	Desired Node Count Example : `2`	integer
id required	Nodepool ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	Image	ImageV1Dot4
keypair required	Keypair Name	Keypair
kubernetes_version required	Kubernetes Version Example : `v1.29.8`	string
labels optional	Labels	any of [array[NodepoolLabel], null]
linked_resources optional	List of linked resources associated with the nodepool	any of [array[LinkedResource], null]
max_node_count required	Max Node Count Example : `5`	integer
min_node_count required	Min Node Count Example : `1`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Nodepool Name Example : `sample-nodepool`	string
server_group_id optional	Server Group ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type required	Server Type	ServerType
status required	Node Pool Status Example : `Running`	string
taints optional	Taints	any of [array[NodepoolTaint], null]
volume_max_iops optional	Volume Max Iops Example : `5000`	any of [integer, null]
volume_max_throughput optional	Volume Max Throughput Example : `250`	any of [integer, null]
volume_size required	Volume Size Example : `104`	integer
volume_type required	Volume Type	VolumeType

2.2.56 - PrivateEndpointAccessControlResource

Name	Description	Schema
id required	Private Endpoint Access Control Resource ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string
name required	Private Endpoint Access Control Resource Name Example : `sample-name`	string
type required	Private Endpoint Access Control Resource Type Example : `vm`	string

2.2.57 - ServerType

Name	Description	Schema	Default
description required	Server Type Description Example : `Standard`	string
id required	Server Type ID Example : `s1v1m2`	string

2.2.58 - Tag

Name	Description	Schema	Default
key required	Tag Key Example : `Key`	string
value required	Tag Value Example : `Value`	string

2.2.59 - VolumeType

Name	Description	Schema
encrypt required	Volume Type Encrypt Example : `true`	boolean
id required	Volume Type ID Example : `s1v1m2`	string
name required	Volume Type Name Example : `SSD_Provisioned`	string

2.2.60 - VolumeTypeSummary

Name	Description	Schema	Default
id required	Volume Type ID Example : `10a599e031e749b7b260868f441e862b`	string
name required	Volume Type Name Example : `SSD_Provisioned`	string