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

Return to the regular view of this page.

Container

1: Container Registry

1.1: CLIs

1.1.1: Check Registry Name Duplication

1.1.1.1: 1.1
1.1.1.2: 1.0

1.1.2: Check Repository Name Duplication

1.1.2.1: 1.1
1.1.2.2: 1.0

1.1.3: Check Tags Vulnerability

1.1.3.1: 1.1
1.1.3.2: 1.0

1.1.4: Create Registry

1.1.4.1: 1.1
1.1.4.2: 1.0

1.1.5: Create Repository

1.1.5.1: 1.1
1.1.5.2: 1.0

1.1.6: Delete Image

1.1.6.1: 1.1
1.1.6.2: 1.0

1.1.7: Delete Registry

1.1.7.1: 1.1
1.1.7.2: 1.0

1.1.8: Delete Repository

1.1.8.1: 1.1
1.1.8.2: 1.0

1.1.9: Delete Tags

1.1.9.1: 1.1
1.1.9.2: 1.0

1.1.10: Delete Tagses

1.1.10.1: 1.1
1.1.10.2: 1.0

1.1.11: Download Manifest

1.1.11.1: 1.1
1.1.11.2: 1.0

1.1.12: List Connectable Resources

1.1.12.1: 1.1
1.1.12.2: 1.0

1.1.13: List Images

1.1.13.1: 1.1
1.1.13.2: 1.0

1.1.14: List Registries

1.1.14.1: 1.1
1.1.14.2: 1.0

1.1.15: List Repositories

1.1.15.1: 1.1
1.1.15.2: 1.0

1.1.16: List Tagses

1.1.16.1: 1.1
1.1.16.2: 1.0

1.1.17: Run Image Lifecycle Policy Preview

1.1.17.1: 1.1
1.1.17.2: 1.0

1.1.18: Show Image

1.1.18.1: 1.1
1.1.18.2: 1.0

1.1.19: Show Image Lifecycle Policy Preview

1.1.19.1: 1.1
1.1.19.2: 1.0

1.1.20: Show Registry

1.1.20.1: 1.1
1.1.20.2: 1.0

1.1.21: Show Repository

1.1.21.1: 1.1
1.1.21.2: 1.0

1.1.22: Show Tags

1.1.22.1: 1.1
1.1.22.2: 1.0

1.1.23: Show Tags Packages

1.1.23.1: 1.1
1.1.23.2: 1.0

1.1.24: Show Tags Secrets

1.1.24.1: 1.1
1.1.24.2: 1.0

1.1.25: Show Tags Vulnerabilities

1.1.25.1: 1.1
1.1.25.2: 1.0

1.1.26: Update Image Description

1.1.26.1: 1.1
1.1.26.2: 1.0

1.1.27: Update Image Lifecycle Policy

1.1.27.1: 1.1
1.1.27.2: 1.0

1.1.28: Update Image Lock Policy

1.1.28.1: 1.1
1.1.28.2: 1.0

1.1.29: Update Image Pull Policy

1.1.29.1: 1.1
1.1.29.2: 1.0

1.1.30: Update Image Scan Policy

1.1.30.1: 1.1
1.1.30.2: 1.0

1.1.31: Update Private Acl

1.1.31.1: 1.1
1.1.31.2: 1.0

1.1.32: Update Public Acl

1.1.32.1: 1.1
1.1.32.2: 1.0

1.1.33: Update Public Endpoint Enabled

1.1.33.1: 1.1
1.1.33.2: 1.0

1.1.34: Update Repository Description

1.1.34.1: 1.1
1.1.34.2: 1.0

1.1.35: Update Repository Lifecycle Policy

1.1.35.1: 1.1
1.1.35.2: 1.0

1.1.36: Update Repository Lock Policy

1.1.36.1: 1.1
1.1.36.2: 1.0

1.1.37: Update Repository Pull Policy

1.1.37.1: 1.1
1.1.37.2: 1.0

1.1.38: Update Repository Scan Policy

1.1.38.1: 1.1
1.1.38.2: 1.0

1.1.39: Update Tags Lock Policy

1.1.39.1: 1.1
1.1.39.2: 1.0

2: Kubernetes

2.1: CLIs

2.1.1: Create Cluster

2.1.1.1: 1.1
2.1.1.2: 1.0

2.1.2: Create Cluster Kubeconfig

2.1.2.1: 1.1
2.1.2.2: 1.0

2.1.3: Create Nodepool

2.1.3.1: 1.1
2.1.3.2: 1.0

2.1.4: Delete Cluster

2.1.4.1: 1.1
2.1.4.2: 1.0

2.1.5: Delete Nodepool

2.1.5.1: 1.1
2.1.5.2: 1.0

2.1.6: List Clusters

2.1.6.1: 1.1
2.1.6.2: 1.0

2.1.7: List Nodepool Nodes

2.1.7.1: 1.1
2.1.7.2: 1.0

2.1.8: List Nodepools

2.1.8.1: 1.1
2.1.8.2: 1.0

2.1.9: Set Cluster Logging

2.1.9.1: 1.1
2.1.9.2: 1.0

2.1.10: Set Cluster Private Access Control

2.1.10.1: 1.1
2.1.10.2: 1.0

2.1.11: Set Cluster Public Access Control

2.1.11.1: 1.1
2.1.11.2: 1.0

2.1.12: Set Cluster Security Groups

2.1.12.1: 1.1
2.1.12.2: 1.0

2.1.13: Set Cluster Service Watch Logging

2.1.13.1: 1.1

2.1.14: Set Cluster Upgrade

2.1.14.1: 1.1
2.1.14.2: 1.0

2.1.15: Set Nodepool

2.1.15.1: 1.1
2.1.15.2: 1.0

2.1.16: Set Nodepool Labels

2.1.16.1: 1.1
2.1.16.2: 1.0

2.1.17: Set Nodepool Taints

2.1.17.1: 1.1
2.1.17.2: 1.0

2.1.18: Set Nodepool Upgrade

2.1.18.1: 1.1
2.1.18.2: 1.0

2.1.19: Show Cluster

2.1.19.1: 1.1
2.1.19.2: 1.0

2.1.20: Show Cluster User Kubeconfig

2.1.20.1: 1.1
2.1.20.2: 1.0

2.1.21: Show Nodepool

2.1.21.1: 1.1
2.1.21.2: 1.0

1 - Container Registry

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Container Registry service and how to call CLI.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260630
1.1	CURRENT	-

1.1 - CLIs

1.1.1 - Check Registry Name Duplication

1.1.1.1 - 1.1

scpcli scr registry name-duplication show
--name <value>

Description

check registry name duplication

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Registry name	`sample`

Responses

Name	Description	Example
result	Name duplicated	True

1.1.1.2 - 1.0

scpcli scr registry name-duplication show
--name <value>

Description

check registry name duplication

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
name required	string	Registry name	`sample`

Responses

Name	Description	Example
result	Name duplicated	True

1.1.2 - Check Repository Name Duplication

1.1.2.1 - 1.1

scpcli scr repository name-duplication show
--name <value>
--registry_id <value>

Description

check repository name duplication

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Repository name	`sample`
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`

Responses

Name	Description	Example
result	Name duplicated	True

1.1.2.2 - 1.0

scpcli scr repository name-duplication show
--name <value>
--registry_id <value>

Description

check repository name duplication

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
name required	string	Repository name	`sample`
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`

Responses

Name	Description	Example
result	Name duplicated	True

1.1.3 - Check Tags Vulnerability

1.1.3.1 - 1.1

scpcli scr tags scan set
--tags_id <value>

Description

check tags vulnerability

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`

1.1.3.2 - 1.0

scpcli scr tags scan set
--tags_id <value>

Description

check tags vulnerability

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`

1.1.4 - Create Registry

1.1.4.1 - 1.1

scpcli scr registry create
--public_visible_enabled <value>
--public_acl_resources <value>
--private_acl_resources <value>
--private_acl_enabled <value>
--name <value>
[--public_acl_enabled <value>]
[--public_endpoint_enabled <value>]
[--tags <value>]

Description

create registry

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
public_visible_enabled required	boolean	Public visible enabled	`True`
public_acl_resources required	array	Public ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
private_acl_resources required	array	Private ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
private_acl_enabled required	boolean	Private ACL enabled	`True`
name required	string	Registry name	`sample`
public_acl_enabled optional	boolean	Public ACL enabled	`True`
public_endpoint_enabled optional	boolean	Public endpoint enabled	`True`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
message	Description	Carpe diem.
state	Registry state	Running

1.1.4.2 - 1.0

scpcli scr registry create
--public_visible_enabled <value>
--public_acl_resources <value>
--private_acl_resources <value>
--private_acl_enabled <value>
--name <value>
[--public_acl_enabled <value>]
[--public_endpoint_enabled <value>]
[--tags <value>]

Description

create registry

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
public_visible_enabled required	boolean	Public visible enabled	`True`
public_acl_resources required	array	Public ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
private_acl_resources required	array	Private ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
private_acl_enabled required	boolean	Private ACL enabled	`True`
name required	string	Registry name	`sample`
public_acl_enabled optional	boolean	Public ACL enabled	`True`
public_endpoint_enabled optional	boolean	Public endpoint enabled	`True`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
message	Description	Carpe diem.
state	Registry state	Running

1.1.5 - Create Repository

1.1.5.1 - 1.1

scpcli scr repository create
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
--locked <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
--registry_id <value>
--name <value>
--description <value>
[--tags <value>]
[--critical_limit <value>]
[--high_limit <value>]

Description

create repository

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
severity_limit required	string	Severity limit	`High`
secret_excepted required	boolean	Secret exception	`True`
scan_policy_enabled required	boolean	Scan policy enabled	`True`
language_excepted required	boolean	Language exception	`True`
fixed_version_excepted required	boolean	Fixed version exception	`True`
auto_scan_enabled required	boolean	Auto scan enabled	`True`
vulnerable_image_pull_prevented required	boolean	Vulnerable image pull prevented	`True`
unscanned_image_pull_prevented required	boolean	Unscanned image pull prevented	`True`
unmodified_excepted required	boolean	Unmodified exception	`True`
locked required	boolean	Locked	`True`
untagged_rule_enabled required	boolean	Untagged rule enabled	`True`
untagged_rule_duration required	integer	Untagged rule duration	`90`
outdated_rule_tag_expression required	string	Tagged rule tag expression	`*`
outdated_rule_enabled required	boolean	Tagged rule enabled	`True`
outdated_rule_duration required	integer	Tagged rule duration	`90`
lifecycle_policy_enabled required	boolean	Lifecycle policy enabled	`True`
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
name required	string	Repository name	`sample`
description required	string	Description	`Carpe diem.`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`
critical_limit optional	integer	Critical limit	`20`
high_limit optional	integer	High limit	`20`

Responses

Name	Description	Example
id	Repository ID	e5611ca6c1484df480668c5adce8b078
message	Description	Carpe diem.
state	Repository state	Active

1.1.5.2 - 1.0

scpcli scr repository create
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
--locked <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
--registry_id <value>
--name <value>
--description <value>
[--tags <value>]
[--critical_limit <value>]
[--high_limit <value>]

Description

create repository

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
severity_limit required	string	Severity limit	`High`
secret_excepted required	boolean	Secret exception	`True`
scan_policy_enabled required	boolean	Scan policy enabled	`True`
language_excepted required	boolean	Language exception	`True`
fixed_version_excepted required	boolean	Fixed version exception	`True`
auto_scan_enabled required	boolean	Auto scan enabled	`True`
vulnerable_image_pull_prevented required	boolean	Vulnerable image pull prevented	`True`
unscanned_image_pull_prevented required	boolean	Unscanned image pull prevented	`True`
unmodified_excepted required	boolean	Unmodified exception	`True`
locked required	boolean	Locked	`True`
untagged_rule_enabled required	boolean	Untagged rule enabled	`True`
untagged_rule_duration required	integer	Untagged rule duration	`90`
outdated_rule_enabled required	boolean	Tagged rule enabled	`True`
outdated_rule_duration required	integer	Tagged rule duration	`90`
lifecycle_policy_enabled required	boolean	Lifecycle policy enabled	`True`
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
name required	string	Repository name	`sample`
description required	string	Description	`Carpe diem.`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`
critical_limit optional	integer	Critical limit	`20`
high_limit optional	integer	High limit	`20`

Responses

Name	Description	Example
id	Repository ID	e5611ca6c1484df480668c5adce8b078
message	Description	Carpe diem.
state	Repository state	Active

1.1.6 - Delete Image

1.1.6.1 - 1.1

scpcli scr image delete
--image_id <value>

Description

delete image

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`

1.1.6.2 - 1.0

scpcli scr image delete
--image_id <value>

Description

delete image

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`

1.1.7 - Delete Registry

1.1.7.1 - 1.1

scpcli scr registry delete
--registry_id <value>

Description

delete registry

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`

1.1.7.2 - 1.0

scpcli scr registry delete
--registry_id <value>

Description

delete registry

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`

1.1.8 - Delete Repository

1.1.8.1 - 1.1

scpcli scr repository delete
--repository_id <value>

Description

delete repository

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`

1.1.8.2 - 1.0

scpcli scr repository delete
--repository_id <value>

Description

delete repository

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`

1.1.9 - Delete Tags

1.1.9.1 - 1.1

scpcli scr tag delete
--tags_id <value>
--tag_names <value>

Description

delete tags

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
tag_names required	array	Tag names	`[`

1.1.9.2 - 1.0

scpcli scr tag delete
--tags_id <value>
--tag_names <value>

Description

delete tags

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
tag_names required	array	Tag names	`[`

1.1.10 - Delete Tagses

1.1.10.1 - 1.1

scpcli scr tags delete
--tags_ids <value>

Description

delete tagses

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_ids required	array	Tags IDs	`[`

1.1.10.2 - 1.0

scpcli scr tags delete
--tags_ids <value>

Description

delete tagses

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_ids required	array	Tags IDs	`[`

1.1.11 - Download Manifest

1.1.11.1 - 1.1

scpcli scr tags manifest show
--tags_id <value>

Description

download manifest file

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`

Responses

Name	Description	Example

1.1.11.2 - 1.0

scpcli scr tags manifest show
--tags_id <value>

Description

download manifest file

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`

Responses

Name	Description	Example

1.1.12 - List Connectable Resources

1.1.12.1 - 1.1

scpcli scr registry connectable-resource list

Description

get connectable domains

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Responses

Name	Description	Example
id	Resource ID	558496f6c49d43459e61e191fb3c08fe
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
name	Registry name	sample
private_domain	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domain	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com
type	Resource type	container-registry

1.1.12.2 - 1.0

scpcli scr registry connectable-resource list

Description

get connectable domains

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Responses

Name	Description	Example
id	Resource ID	558496f6c49d43459e61e191fb3c08fe
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
name	Registry name	sample
private_domain	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domain	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com
type	Resource type	container-registry

1.1.13 - List Images

1.1.13.1 - 1.1

scpcli scr repository image list
--repository_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

get images

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Image name	`sample`

Responses

Name	Description	Example
id	Image ID	5b5ed4f2881a440583536fc1a8c39a28
created_at	Created at	2024-08-15T13:05:09.701645823+09:00
modified_at	Modified at	2024-08-16T16:06:09.701645823+09:00
name	Image name	sample
private_endpoint_url	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
public_endpoint_url	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
pull_count	Pull count	20
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
repository_id	Repository ID	e5611ca6c1484df480668c5adce8b078
state	Image state	Active

1.1.13.2 - 1.0

scpcli scr repository image list
--repository_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

get images

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Image name	`sample`

Responses

Name	Description	Example
id	Image ID	5b5ed4f2881a440583536fc1a8c39a28
created_at	Created at	2024-08-15T13:05:09.701645823+09:00
modified_at	Modified at	2024-08-16T16:06:09.701645823+09:00
name	Image name	sample
private_endpoint_url	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
public_endpoint_url	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
pull_count	Pull count	20
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
repository_id	Repository ID	e5611ca6c1484df480668c5adce8b078
state	Image state	Active

1.1.14 - List Registries

1.1.14.1 - 1.1

scpcli scr registry list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]

Description

get registries

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Registry name	`sample`
state optional	string	Registry state	`Running`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
bucket_name	Bucket name	4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Registry name	sample
private_domain	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domain	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabled	Public visible enabled	True
state	Registry state	Running

1.1.14.2 - 1.0

scpcli scr registry list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]

Description

get registries

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Registry name	`sample`
state optional	string	Registry state	`Running`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
bucket_name	Bucket name	4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Registry name	sample
private_domain	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domain	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabled	Public visible enabled	True
state	Registry state	Running

1.1.15 - List Repositories

1.1.15.1 - 1.1

scpcli scr registry repository list
--registry_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

get repositories

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Repository name	`sample`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Repository name	sample
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
state	Repository state	Active

1.1.15.2 - 1.0

scpcli scr registry repository list
--registry_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

get repositories

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
name optional	string	Repository name	`sample`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Repository name	sample
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
state	Repository state	Active

1.1.16 - List Tagses

1.1.16.1 - 1.1

scpcli scr image tags list
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

get tagses

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

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

Responses

Name	Description	Example
id	Tags ID	b48210c7a226460fa15b6e3e221b30b0
hash_digest	Hash digest
last_scanned_at	Last scanned at	2024-08-15T13:05:09.701645823+09:00
lock_policy	Lock Policy
modified_at	Modified at	2024-08-16T16:06:09.701645823+09:00
private_endpoint_url	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_url	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_needed	Need for retrying vulnerability inspection	True
reference_tags	List of tags in reference	[“sample”]
referenced_by	Reference necessity
scan_state	Scanning state	Scanning state
scan_summary
size	Size	10
state	Tags state	Active

1.1.16.2 - 1.0

scpcli scr image tags list
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

get tagses

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

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

Responses

Name	Description	Example
id	Tags ID	b48210c7a226460fa15b6e3e221b30b0
hash_digest	Hash digest
last_scanned_at	Last scanned at	2024-08-15T13:05:09.701645823+09:00
lock_policy	Lock Policy
modified_at	Modified at	2024-08-16T16:06:09.701645823+09:00
private_endpoint_url	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_url	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_needed	Need for retrying vulnerability inspection	True
reference_tags	List of tags in reference	[“sample”]
referenced_by	Reference necessity
scan_state	Scanning state	Scanning state
scan_summary
size	Size	10
state	Tags state	Active

1.1.17 - Run Image Lifecycle Policy Preview

1.1.17.1 - 1.1

scpcli scr image lifecycle-policy-preview run
--image_id <value>

Description

Run Image Lifecycle Policy Preview

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`

Responses

Name	Description	Example

1.1.17.2 - 1.0

scpcli scr image lifecycle-policy-preview run
--image_id <value>

Description

Run Image Lifecycle Policy Preview

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`

Responses

Name	Description	Example

1.1.18 - Show Image

1.1.18.1 - 1.1

scpcli scr image show
--image_id <value>

Description

get image

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Carpe diem.
lifecycle_policy	Lifecycle policy
lock_policy	Lock Policy
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Image name	sample
pull_count	Pull count	100
pull_policy	Pull policy
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
repository_id	Repository ID	e5611ca6c1484df480668c5adce8b078
scan_policy	Scan policy
state	Image state	Active

1.1.18.2 - 1.0

scpcli scr image show
--image_id <value>

Description

get image

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Carpe diem.
lifecycle_policy	Lifecycle policy
lock_policy	Lock Policy
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Image name	sample
pull_count	Pull count	100
pull_policy	Pull policy
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
repository_id	Repository ID	e5611ca6c1484df480668c5adce8b078
scan_policy	Scan policy
state	Image state	Active

1.1.19 - Show Image Lifecycle Policy Preview

1.1.19.1 - 1.1

scpcli scr image lifecycle-policy-preview show
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

show image lifecycle policy preview

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

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

Responses

Name	Description	Example
created_at	Created at	2024-08-15T13:05:09.701645823+09:00
hash_digest	Hash digest
reference_tags	List of tags in reference	[“sample”]
state	Tags state	Active

1.1.19.2 - 1.0

scpcli scr image lifecycle-policy-preview show
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

show image lifecycle policy preview

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

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

Responses

Name	Description	Example
id	Tags ID	b48210c7a226460fa15b6e3e221b30b0
hash_digest	Hash digest
last_scanned_at	Last scanned at	2024-08-15T13:05:09.701645823+09:00
lock_policy	Lock Policy
modified_at	Modified at	2024-08-16T16:06:09.701645823+09:00
private_endpoint_url	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_url	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_needed	Need for retrying vulnerability inspection	True
reference_tags	List of tags in reference	[“sample”]
referenced_by	Reference necessity
scan_state	Scanning state	Scanning state
scan_summary
size	Size	10
state	Tags state	Active

1.1.20 - Show Registry

1.1.20.1 - 1.1

scpcli scr registry show
--registry_id <value>

Description

get registry

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
bucket_id	Bucket ID	rpqtmqgec3174541bbf77eecf2cd3585
bucket_name	Bucket name	4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usage	Bucket Usage
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Registry name	sample
private_acl_enabled	Private ACL enabled	True
private_acl_resources	Private ACL resources
private_domain	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabled	Public ACL enabled	True
public_acl_resources	Public ACL resources
public_domain	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabled	Public endpoint enabled	True
public_visible_enabled	Public visible enabled	True
state	Registry state	Running

1.1.20.2 - 1.0

scpcli scr registry show
--registry_id <value>

Description

get registry

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
bucket_id	Bucket ID	rpqtmqgec3174541bbf77eecf2cd3585
bucket_name	Bucket name	4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usage	Bucket Usage
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Registry name	sample
private_acl_enabled	Private ACL enabled	True
private_acl_resources	Private ACL resources
private_domain	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabled	Public ACL enabled	True
public_acl_resources	Public ACL resources
public_domain	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabled	Public endpoint enabled	True
public_visible_enabled	Public visible enabled	True
state	Registry state	Running

1.1.21 - Show Repository

1.1.21.1 - 1.1

scpcli scr repository show
--repository_id <value>

Description

get repository

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Carpe diem.
lifecycle_policy	Lifecycle policy
lock_policy	Lock Policy
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Repository name	sample
private_endpoint_url	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
public_endpoint_url	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
pull_policy	Pull policy
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
scan_policy	Scan policy
state	Repository state	Active

1.1.21.2 - 1.0

scpcli scr repository show
--repository_id <value>

Description

get repository

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Carpe diem.
lifecycle_policy	Lifecycle policy
lock_policy	Lock Policy
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Repository name	sample
private_endpoint_url	Private Endpoint URL	sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
public_endpoint_url	Public Endpoint URL	sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
pull_policy	Pull policy
registry_id	Registry ID	rpqtmqgec3174541bbf77eecf2cd3585
scan_policy	Scan policy
state	Repository state	Active

1.1.22 - Show Tags

1.1.22.1 - 1.1

scpcli scr tags show
--tags_id <value>

Description

get tags

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`

Responses

Name	Description	Example
id	Tags ID	b48210c7a226460fa15b6e3e221b30b0
created_at	Created at	2024-08-15T13:05:09.701645823+09:00
hash_digest	Hash digest
image_id	Image ID	5b5ed4f2881a440583536fc1a8c39a28
lock_policy	Lock Policy
manifest	Manifest
manifest_media_type	Manifest media type
modified_at	Modified at	2024-08-16T16:06:09.701645823+09:00
reference_tags	List of tags in reference	[“sample”]
registry_id
repository_id	Repository ID	e5611ca6c1484df480668c5adce8b078
state	Tags state	Active

1.1.22.2 - 1.0

scpcli scr tags show
--tags_id <value>

Description

get tags

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`

Responses

Name	Description	Example
id	Tags ID	b48210c7a226460fa15b6e3e221b30b0
created_at	Created at	2024-08-15T13:05:09.701645823+09:00
hash_digest	Hash digest
image_id	Image ID	5b5ed4f2881a440583536fc1a8c39a28
lock_policy	Lock Policy
manifest	Manifest
manifest_media_type	Manifest media type
modified_at	Modified at	2024-08-16T16:06:09.701645823+09:00
reference_tags	List of tags in reference	[“sample”]
registry_id
repository_id	Repository ID	e5611ca6c1484df480668c5adce8b078
state	Tags state	Active

1.1.23 - Show Tags Packages

1.1.23.1 - 1.1

scpcli scr tags package show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]

Description

get tags packages

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
os_language optional	string	OS or language	`Java`
package_name optional	string	Package name	`com.example.sample`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`

Responses

Name	Description	Example
category	Category	Language
os_language	OS or language	Java
package_name	Package name	com.example.sample
scan_summary
type	Pipeline type	os-pkg(binary)
version	Pipeline version	0.7.2-r3

1.1.23.2 - 1.0

scpcli scr tags package show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]

Description

get tags packages

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
os_language optional	string	OS or language	`Java`
package_name optional	string	Package name	`com.example.sample`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`

Responses

Name	Description	Example
category	Category	Language
os_language	OS or language	Java
package_name	Package name	com.example.sample
scan_summary
type	Pipeline type	os-pkg(binary)
version	Pipeline version	0.7.2-r3

1.1.24 - Show Tags Secrets

1.1.24.1 - 1.1

scpcli scr tags secret show
--tags_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--file_name <value>]

Description

get tags secrets

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
file_name optional	string	Secret file name	`/certs/sample-key1.key`

Responses

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

1.1.24.2 - 1.0

scpcli scr tags secret show
--tags_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--file_name <value>]

Description

get tags secrets

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
file_name optional	string	Secret file name	`/certs/sample-key1.key`

Responses

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

1.1.25 - Show Tags Vulnerabilities

1.1.25.1 - 1.1

scpcli scr tags vulnerability show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
[--update_version_available <value>]
[--severity <value>]
[--category <value>]

Description

get tags vulnerabilities

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
os_language optional	string	OS or language	`Java`
package_name optional	string	Package name	`com.example.sample`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
update_version_available optional	boolean	Updated version	`True`
severity optional	array	Severity	`H`
category optional	string	Category	`Language`

Responses

Name	Description	Example
attack_complexity	Attack complexity
attack_vector	Attack vector
availability	Availability
confidentiality	Confidentiality
integrity	Integrity
privileges_required	Necessary authority
scope	Attack scope
user_interaction	Degree of user participation

1.1.25.2 - 1.0

scpcli scr tags vulnerability show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
[--update_version_available <value>]
[--severity <value>]
[--category <value>]

Description

get tags vulnerabilities

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
os_language optional	string	OS or language	`Java`
package_name optional	string	Package name	`com.example.sample`
sort optional	string	sort	`name:asc`
page optional	integer	page	`0`
size optional	integer	size	`20`
update_version_available optional	boolean	Updated version	`True`
severity optional	array	Severity	`H`
category optional	string	Category	`Language`

Responses

Name	Description	Example
attack_complexity	Attack complexity
attack_vector	Attack vector
availability	Availability
confidentiality	Confidentiality
integrity	Integrity
privileges_required	Necessary authority
scope	Attack scope
user_interaction	Degree of user participation

1.1.26 - Update Image Description

1.1.26.1 - 1.1

scpcli scr image description set
--image_id <value>
--description <value>

Description

update image description

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
description required	string	Description	`Carpe diem.`

1.1.26.2 - 1.0

scpcli scr image description set
--image_id <value>
--description <value>

Description

update image description

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
description required	string	Description	`Carpe diem.`

1.1.27 - Update Image Lifecycle Policy

1.1.27.1 - 1.1

scpcli scr image lifecycle-policy set
--image_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

update image lifecycle-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
untagged_rule_enabled required	boolean	Untagged rule enabled	`True`
untagged_rule_duration required	integer	Untagged rule duration	`90`
outdated_rule_tag_expression required	string	Tagged rule tag expression	`*`
outdated_rule_enabled required	boolean	Tagged rule enabled	`True`
outdated_rule_duration required	integer	Tagged rule duration	`90`
lifecycle_policy_enabled required	boolean	Lifecycle policy enabled	`True`

1.1.27.2 - 1.0

scpcli scr image lifecycle-policy set
--image_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

update image lifecycle-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
untagged_rule_enabled required	boolean	Untagged rule enabled	`True`
untagged_rule_duration required	integer	Untagged rule duration	`90`
outdated_rule_enabled required	boolean	Tagged rule enabled	`True`
outdated_rule_duration required	integer	Tagged rule duration	`90`
lifecycle_policy_enabled required	boolean	Lifecycle policy enabled	`True`

1.1.28 - Update Image Lock Policy

1.1.28.1 - 1.1

scpcli scr image lock-policy set
--image_id <value>
--locked <value>

Description

update image lock-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
locked required	boolean	Locked	`True`

1.1.28.2 - 1.0

scpcli scr image lock-policy set
--image_id <value>
--locked <value>

Description

update image lock-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
locked required	boolean	Locked	`True`

1.1.29 - Update Image Pull Policy

1.1.29.1 - 1.1

scpcli scr image pull-policy set
--image_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

update image pull-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
vulnerable_image_pull_prevented required	boolean	Vulnerable image pull prevented	`True`
unscanned_image_pull_prevented required	boolean	Unscanned image pull prevented	`True`
unmodified_excepted required	boolean	Unmodified exception	`True`
critical_limit optional	integer	Critical limit	`20`
high_limit optional	integer	High limit	`20`

1.1.29.2 - 1.0

scpcli scr image pull-policy set
--image_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

update image pull-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
vulnerable_image_pull_prevented required	boolean	Vulnerable image pull prevented	`True`
unscanned_image_pull_prevented required	boolean	Unscanned image pull prevented	`True`
unmodified_excepted required	boolean	Unmodified exception	`True`
critical_limit optional	integer	Critical limit	`20`
high_limit optional	integer	High limit	`20`

1.1.30 - Update Image Scan Policy

1.1.30.1 - 1.1

scpcli scr image scan-policy set
--image_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

update image scan-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
severity_limit required	string	Severity limit	`High`
secret_excepted required	boolean	Secret exception	`True`
scan_policy_enabled required	boolean	Scan policy enabled	`True`
language_excepted required	boolean	Language exception	`True`
fixed_version_excepted required	boolean	Fixed version exception	`True`
auto_scan_enabled required	boolean	Auto scan enabled	`True`

1.1.30.2 - 1.0

scpcli scr image scan-policy set
--image_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

update image scan-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`5b5ed4f2881a440583536fc1a8c39a28`
severity_limit required	string	Severity limit	`High`
secret_excepted required	boolean	Secret exception	`True`
scan_policy_enabled required	boolean	Scan policy enabled	`True`
language_excepted required	boolean	Language exception	`True`
fixed_version_excepted required	boolean	Fixed version exception	`True`
auto_scan_enabled required	boolean	Auto scan enabled	`True`

1.1.31 - Update Private Acl

1.1.31.1 - 1.1

scpcli scr registry private-acl set
--registry_id <value>
--private_acl_resources <value>
--private_acl_enabled <value>

Description

update private acl

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
private_acl_resources required	array	Private ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
private_acl_enabled required	boolean	Private ACL enabled	`True`

1.1.31.2 - 1.0

scpcli scr registry private-acl set
--registry_id <value>
--private_acl_resources <value>
--private_acl_enabled <value>

Description

update private acl

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
private_acl_resources required	array	Private ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
private_acl_enabled required	boolean	Private ACL enabled	`True`

1.1.32 - Update Public Acl

1.1.32.1 - 1.1

scpcli scr registry public-acl set
--registry_id <value>
--public_acl_resources <value>
--public_acl_enabled <value>

Description

update public acl

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
public_acl_resources required	array	Public ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
public_acl_enabled required	boolean	Public ACL enabled	`True`

1.1.32.2 - 1.0

scpcli scr registry public-acl set
--registry_id <value>
--public_acl_resources <value>
--public_acl_enabled <value>

Description

update public acl

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
public_acl_resources required	array	Public ACL resources	`'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'`
public_acl_enabled required	boolean	Public ACL enabled	`True`

1.1.33 - Update Public Endpoint Enabled

1.1.33.1 - 1.1

scpcli scr registry public-endpoint-enabled set
--registry_id <value>
--public_endpoint_enabled <value>

Description

update public endpoint enabled

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
public_endpoint_enabled required	boolean	Public endpoint enabled	`True`

1.1.33.2 - 1.0

scpcli scr registry public-endpoint-enabled set
--registry_id <value>
--public_endpoint_enabled <value>

Description

update public endpoint enabled

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
registry_id required	string	Registry ID	`rpqtmqgec3174541bbf77eecf2cd3585`
public_endpoint_enabled required	boolean	Public endpoint enabled	`True`

1.1.34 - Update Repository Description

1.1.34.1 - 1.1

scpcli scr repository description set
--repository_id <value>
--description <value>

Description

update repository description

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
description required	string	Description	`Carpe diem.`

1.1.34.2 - 1.0

scpcli scr repository description set
--repository_id <value>
--description <value>

Description

update repository description

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
description required	string	Description	`Carpe diem.`

1.1.35 - Update Repository Lifecycle Policy

1.1.35.1 - 1.1

scpcli scr repository lifecycle-policy set
--repository_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

update repository lifecycle-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
untagged_rule_enabled required	boolean	Untagged rule enabled	`True`
untagged_rule_duration required	integer	Untagged rule duration	`90`
outdated_rule_tag_expression required	string	Tagged rule tag expression	`*`
outdated_rule_enabled required	boolean	Tagged rule enabled	`True`
outdated_rule_duration required	integer	Tagged rule duration	`90`
lifecycle_policy_enabled required	boolean	Lifecycle policy enabled	`True`

1.1.35.2 - 1.0

scpcli scr repository lifecycle-policy set
--repository_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

update repository lifecycle-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
untagged_rule_enabled required	boolean	Untagged rule enabled	`True`
untagged_rule_duration required	integer	Untagged rule duration	`90`
outdated_rule_enabled required	boolean	Tagged rule enabled	`True`
outdated_rule_duration required	integer	Tagged rule duration	`90`
lifecycle_policy_enabled required	boolean	Lifecycle policy enabled	`True`

1.1.36 - Update Repository Lock Policy

1.1.36.1 - 1.1

scpcli scr repository lock-policy set
--repository_id <value>
--locked <value>

Description

update repository lock-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
locked required	boolean	Locked	`True`

1.1.36.2 - 1.0

scpcli scr repository lock-policy set
--repository_id <value>
--locked <value>

Description

update repository lock-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
locked required	boolean	Locked	`True`

1.1.37 - Update Repository Pull Policy

1.1.37.1 - 1.1

scpcli scr repository pull-policy set
--repository_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

update repository pull-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
vulnerable_image_pull_prevented required	boolean	Vulnerable image pull prevented	`True`
unscanned_image_pull_prevented required	boolean	Unscanned image pull prevented	`True`
unmodified_excepted required	boolean	Unmodified exception	`True`
critical_limit optional	integer	Critical limit	`20`
high_limit optional	integer	High limit	`20`

1.1.37.2 - 1.0

scpcli scr repository pull-policy set
--repository_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

update repository pull-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
vulnerable_image_pull_prevented required	boolean	Vulnerable image pull prevented	`True`
unscanned_image_pull_prevented required	boolean	Unscanned image pull prevented	`True`
unmodified_excepted required	boolean	Unmodified exception	`True`
critical_limit optional	integer	Critical limit	`20`
high_limit optional	integer	High limit	`20`

1.1.38 - Update Repository Scan Policy

1.1.38.1 - 1.1

scpcli scr repository scan-policy set
--repository_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

update repository scan-policy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
severity_limit required	string	Severity limit	`High`
secret_excepted required	boolean	Secret exception	`True`
scan_policy_enabled required	boolean	Scan policy enabled	`True`
language_excepted required	boolean	Language exception	`True`
fixed_version_excepted required	boolean	Fixed version exception	`True`
auto_scan_enabled required	boolean	Auto scan enabled	`True`

1.1.38.2 - 1.0

scpcli scr repository scan-policy set
--repository_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

update repository scan-policy

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
repository_id required	string	Repository ID	`e5611ca6c1484df480668c5adce8b078`
severity_limit required	string	Severity limit	`High`
secret_excepted required	boolean	Secret exception	`True`
scan_policy_enabled required	boolean	Scan policy enabled	`True`
language_excepted required	boolean	Language exception	`True`
fixed_version_excepted required	boolean	Fixed version exception	`True`
auto_scan_enabled required	boolean	Auto scan enabled	`True`

1.1.39 - Update Tags Lock Policy

1.1.39.1 - 1.1

scpcli scr tags lock-policy set
--tags_id <value>
--locked <value>

Description

update tags lock

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
locked required	boolean	Locked	`True`

1.1.39.2 - 1.0

scpcli scr tags lock-policy set
--tags_id <value>
--locked <value>

Description

update tags lock

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
tags_id required	string	Tags ID	`b48210c7a226460fa15b6e3e221b30b0`
locked required	boolean	Locked	`True`

2 - Kubernetes

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Kubernetes service and how to call CLI.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

2.1 - CLIs

2.1.1 - Create Cluster

2.1.1.1 - 1.1

scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--service_watch_logging_enabled <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]

Description

create a cluster V1.1

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`7df8abb4912e4709b1cb237daccca7a8`
volume_id required	string	Volume ID	`['bfdbabf2-04d9-4e8b-a205-020f8e6da438']`
subnet_id required	string	Subnet ID	`023c57b14f11483689338d085e061492`
service_watch_logging_enabled required	boolean	Service Watch Enabled	`true`
security_group_id_list required	array	Security Group ID List	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
name required	string	Cluster Name	`sample-cluster`
kubernetes_version required	string	Cluster Version	`v1.29.8`
cloud_logging_enabled required	boolean	Cloud Logging Enabled	`true`
private_endpoint_access_control_resources optional	array	Private Endpoint Access Control Resources	`'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'`
public_endpoint_access_control_ip optional	string	Public Endpoint Access Control IP	`192.168.0.0`
tags optional	array	Tag list	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
request_id	Request ID	80a599e031e749b7b260868f441e862b
resource_id	Resource ID	70a599e031e749b7b260868f441e862b

2.1.1.2 - 1.0

scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]

Description

create a cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`7df8abb4912e4709b1cb237daccca7a8`
volume_id required	string	Volume ID	`['bfdbabf2-04d9-4e8b-a205-020f8e6da438']`
subnet_id required	string	Subnet ID	`023c57b14f11483689338d085e061492`
security_group_id_list required	array	Security Group ID List	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
name required	string	Cluster Name	`sample-cluster`
kubernetes_version required	string	Cluster Version	`v1.29.8`
cloud_logging_enabled required	boolean	Cloud Logging Enabled	`true`
private_endpoint_access_control_resources optional	array	Private Endpoint Access Control Resources	`'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'`
public_endpoint_access_control_ip optional	string	Public Endpoint Access Control IP	`192.168.0.0`
tags optional	array	Tag list	`'{"key": "Key", "value": "Value"}'`

Responses

Name	Description	Example
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
request_id	Request ID	80a599e031e749b7b260868f441e862b
resource_id	Resource ID	70a599e031e749b7b260868f441e862b

2.1.2 - Create Cluster Kubeconfig

2.1.2.1 - 1.1

scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>

Description

Create kubeconfig file for the cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
kubeconfig_type required	****	Kubeconfig Type (private/public)	`private`

Responses

Name	Description	Example

2.1.2.2 - 1.0

scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>

Description

Create kubeconfig file for the cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
kubeconfig_type required	****	Kubeconfig Type (private/public)	`private`

Responses

Name	Description	Example

2.1.3 - Create Nodepool

2.1.3.1 - 1.1

scpcli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]

Description

create a nodepool V1.1

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
pod_max_pids required	integer	Node Pool Pod Max pids constraint	`4096`
max_pods required	integer	Node Pool max pod number	`110`
image_gc_low_threshold required	integer	Node Pool image GC low threshold percent	`80`
image_gc_high_threshold required	integer	Node Pool image GC high threshold percent	`85`
container_log_max_size required	integer	Node Pool container log max size	`10`
container_log_max_files required	integer	Node Pool container log max files	`5`
volume_type_name required	string	Volume Type Name	`SSD`
volume_size required	integer	Volume Size	`104`
server_type_id required	string	Server Type ID	`10a599e031e749b7b260868f441e862b`
name required	string	Nodepool Name	`sample-nodepool`
kubernetes_version required	string	Kubernetes Version	`v1.29.8`
keypair_name required	string	Keypair Name	`test_keypair`
is_auto_scale required	boolean	Is Auto Scale	`true`
is_auto_recovery required	boolean	Is Auto Recovery	`true`
image_os_version required	string	Image OS Version	`22.04`
image_os required	string	Image OS	`ubuntu`
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
custom_image_id optional	string	Custom Image ID	`10a599e031e749b7b260868f441e862b`
desired_node_count optional	integer	Desired node count (is_auto_scale = false)	`2`
labels optional	array	Node Pool Labels	`'{"key": "example.com/my-app", "value": "bar"}'`
max_node_count optional	integer	Maximum node count (is_auto_scale = true)	`5`
min_node_count optional	integer	Minimum node count (is_auto_scale = true)	`1`
server_group_id optional	string	Server Group ID	`2b8d33d5-4de5-40a5-a34c-7e30204133xc`
taints optional	array	Node Pool Taints	`'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'`
allowed_unsafe_sysctls optional	string	Node Pool Allowed unsafe sysctls	`kernel.msg*,net.ipv4.route.min_pmtu`

Responses

Name	Description	Example
id	Nodepool ID	bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
advanced_settings	Node Pool Advanced Settings
auto_recovery_enabled	Is Auto Recovery	true
auto_scale_enabled	Is Auto Scale	true
cluster	Cluster
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_node_count	Current Node Count	1
desired_node_count	Desired Node Count	2
image	Image
keypair	Keypair Name
kubernetes_version	Kubernetes Version	v1.29.8
labels	Node Pool Labels
max_node_count	Max Node Count	5
min_node_count	Min Node Count	1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Nodepool Name	sample-nodepool
server_group_id	Server Group ID	2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_type	Server Type
status	Node Pool Status	Running
taints	Node Pool Taints
volume_size	Volume Size	104
volume_type	Volume Type

2.1.3.2 - 1.0

scpcli ske nodepool create
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--taints <value>]

Description

create a nodepool

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_type_name required	string	Volume Type Name	`SSD`
volume_size required	integer	Volume Size	`104`
server_type_id required	string	Server Type ID	`10a599e031e749b7b260868f441e862b`
name required	string	Nodepool Name	`sample-nodepool`
kubernetes_version required	string	Kubernetes Version	`v1.29.8`
keypair_name required	string	Keypair Name	`test_keypair`
is_auto_scale required	boolean	Is Auto Scale	`true`
is_auto_recovery required	boolean	Is Auto Recovery	`true`
image_os_version required	string	Image OS Version	`22.04`
image_os required	string	Image OS	`ubuntu`
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
custom_image_id optional	string	Custom Image ID	`10a599e031e749b7b260868f441e862b`
desired_node_count optional	integer	Desired node count (is_auto_scale = false)	`2`
labels optional	array	Node Pool Labels	`'{"key": "example.com/my-app", "value": "bar"}'`
max_node_count optional	integer	Maximum node count (is_auto_scale = true)	`5`
min_node_count optional	integer	Minimum node count (is_auto_scale = true)	`1`
taints optional	array	Node Pool Taints	`'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'`

Responses

Name	Description	Example
id	Nodepool ID	bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled	Is Auto Recovery	true
auto_scale_enabled	Is Auto Scale	true
cluster	Cluster
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_node_count	Current Node Count	1
desired_node_count	Desired Node Count	2
image	Image
keypair	Keypair Name
kubernetes_version	Kubernetes Version	v1.29.8
labels	Node Pool Labels
max_node_count	Max Node Count	5
min_node_count	Min Node Count	1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Nodepool Name	sample-nodepool
server_type	Server Type
status	Node Pool Status	Running
taints	Node Pool Taints
volume_size	Volume Size	104
volume_type	Volume Type

2.1.4 - Delete Cluster

2.1.4.1 - 1.1

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`

2.1.4.2 - 1.0

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`

2.1.5 - Delete Nodepool

2.1.5.1 - 1.1

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`

2.1.5.2 - 1.0

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`

2.1.6 - List Clusters

2.1.6.1 - 1.1

scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]

Description

get clusters list

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Cluster Name	`sample-cluster`
status optional	array	Cluster Status	`R`
kubernetes_version optional	array	Cluster Version	`v`
subnet_id optional	string	Cluster Subnet ID	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
id	Cluster ID	70a599e031e749b7b260868f441e862b
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
created_at	Created At	2025-03-31T00:23:17Z
kubernetes_version	Cluster Version	v1.29.8
modified_at	Modified At	2025-03-31T00:23:17Z
name	Cluster Name	sample-cluster
node_count	Cluster Node Count	5
status	Cluster Status	RUNNING
subnet_id	Cluster Subnet ID	023c57b14f11483689338d085e061492

2.1.6.2 - 1.0

scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]

Description

get clusters list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Cluster Name	`sample-cluster`
status optional	array	Cluster Status	`R`
kubernetes_version optional	array	Cluster Version	`v`
subnet_id optional	string	Cluster Subnet ID	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
id	Cluster ID	70a599e031e749b7b260868f441e862b
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
created_at	Created At	2025-03-31T00:23:17Z
kubernetes_version	Cluster Version	v1.29.8
modified_at	Modified At	2025-03-31T00:23:17Z
name	Cluster Name	sample-cluster
node_count	Cluster Node Count	5
status	Cluster Status	RUNNING
subnet_id	Cluster Subnet ID	023c57b14f11483689338d085e061492

2.1.7 - List Nodepool Nodes

2.1.7.1 - 1.1

scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]

Description

Get nodepool node list

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
node_name optional	string	Node Name	`ske-aug-rhel-0805-1-84d799f767-8dr2p`

Responses

Name	Description	Example
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
kubernetes_version	Kubernetes Version	v1.29.8
name	Node Name	ske-aug-rhel-0805-1-84d799f767-8dr2p
status	Node Status	RUNNING

2.1.7.2 - 1.0

scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]

Description

Get nodepool node list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
node_name optional	string	Node Name	`ske-aug-rhel-0805-1-84d799f767-8dr2p`

Responses

Name	Description	Example
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
kubernetes_version	Kubernetes Version	v1.29.8
name	Node Name	ske-aug-rhel-0805-1-84d799f767-8dr2p
status	Node Status	RUNNING

2.1.8 - List Nodepools

2.1.8.1 - 1.1

scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]

Description

get nodepools list

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
nodepool_name optional	string	Nodepool Name	`sample-nodepool`

Responses

Name	Description	Example
id	Nodepool ID	bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled	Is Auto Recovery
auto_scale_enabled	Is Auto Scale
current_node_count	Current Node Count	1
desired_node_count	Desired Node Count	2
image	Image
kubernetes_version	Kubernetes Version	v1.29.8
name	Nodepool Name	sample-nodepool
server_type	Server Type
status	Node Pool Status	Running
volume_type	Volume Type

2.1.8.2 - 1.0

scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]

Description

get nodepools list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
nodepool_name optional	string	Nodepool Name	`sample-nodepool`

Responses

Name	Description	Example
id	Nodepool ID	bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled	Is Auto Recovery
auto_scale_enabled	Is Auto Scale
current_node_count	Current Node Count	1
desired_node_count	Desired Node Count	2
image	Image
kubernetes_version	Kubernetes Version	v1.29.8
name	Nodepool Name	sample-nodepool
server_type	Server Type
status	Node Pool Status	Running
volume_type	Volume Type

2.1.9 - Set Cluster Logging

2.1.9.1 - 1.1

scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>

Description

Set logging on the cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
cloud_logging_enabled required	boolean	Cloud Logging Enabled	`true`

2.1.9.2 - 1.0

scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>

Description

Set logging on the cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
cloud_logging_enabled required	boolean	Cloud Logging Enabled	`true`

2.1.10 - Set Cluster Private Access Control

2.1.10.1 - 1.1

scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>

Description

set a private access control specific cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
private_endpoint_access_control_resources required	array		`'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'`

2.1.10.2 - 1.0

scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>

Description

set a private access control specific cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
private_endpoint_access_control_resources required	array		`'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'`

2.1.11 - Set Cluster Public Access Control

2.1.11.1 - 1.1

scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>

Description

set a public access control specific cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
public_endpoint_access_control_ip required	string	Public Endpoint Access Control IP	`192.168.0.0`

2.1.11.2 - 1.0

scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>

Description

set a public access control specific cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
public_endpoint_access_control_ip required	string	Public Endpoint Access Control IP	`192.168.0.0`

2.1.12 - Set Cluster Security Groups

2.1.12.1 - 1.1

scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>

Description

Set Cluster Security Groups

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
security_group_id_list required	array	Security Group ID List	`b`

2.1.12.2 - 1.0

scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>

Description

Set Cluster Security Groups

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
security_group_id_list required	array	Security Group ID List	`b`

2.1.13 - Set Cluster Service Watch Logging

2.1.13.1 - 1.1

scpcli ske cluster service watch logging set
--cluster_id <value>
--service_watch_logging_enabled <value>

Description

Set Service Watch logging on the cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
service_watch_logging_enabled required	boolean	Service Watch Enabled	`true`

2.1.14 - Set Cluster Upgrade

2.1.14.1 - 1.1

scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>

Description

upgrade a specific cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
kubernetes_version required	string	Kubernetes Version	`v1.29.8`

2.1.14.2 - 1.0

scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>

Description

upgrade a specific cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
kubernetes_version required	string	Kubernetes Version	`v1.29.8`

2.1.15 - Set Nodepool

2.1.15.1 - 1.1

scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]

Description

set a nodepool

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
desired_node_count optional	integer	Desired Node Count	`2`
is_auto_recovery optional	boolean	Is Auto Recovery	`true`
is_auto_scale optional	boolean	Is Auto Scale	`true`
max_node_count optional	integer	Max Node Count	`5`
min_node_count optional	integer	Min Node Count	`1`

2.1.15.2 - 1.0

scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]

Description

set a nodepool

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
desired_node_count optional	integer	Desired Node Count	`2`
is_auto_recovery optional	boolean	Is Auto Recovery	`true`
is_auto_scale optional	boolean	Is Auto Scale	`true`
max_node_count optional	integer	Max Node Count	`5`
min_node_count optional	integer	Min Node Count	`1`

2.1.16 - Set Nodepool Labels

2.1.16.1 - 1.1

scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>

Description

set nodepool labels

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
labels required	array		`'{"key": "example.com/my-app", "value": "bar"}'`

2.1.16.2 - 1.0

scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>

Description

set nodepool labels

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
labels required	array		`'{"key": "example.com/my-app", "value": "bar"}'`

2.1.17 - Set Nodepool Taints

2.1.17.1 - 1.1

scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>

Description

set nodepool taints

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
taints required	array		`'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'`

2.1.17.2 - 1.0

scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>

Description

set nodepool taints

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
taints required	array		`'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'`

2.1.18 - Set Nodepool Upgrade

2.1.18.1 - 1.1

scpcli ske nodepool upgrade set
--nodepool_id <value>
--os_version <value>

Description

upgrade a nodepool

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`
os_version required	string	Image OS Version	`22.04`

2.1.18.2 - 1.0

scpcli ske nodepool upgrade set
--nodepool_id <value>

Description

upgrade a nodepool

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`

2.1.19 - Show Cluster

2.1.19.1 - 1.1

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabled	Cloud Logging Enabled	true
cluster_namespace	Cluster Namespace	sample-cluster-12345
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_version	Cluster Version	v1.29.8
managed_security_group	Managed Security Group
max_node_count	Cluster Max Node Count	5
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster Name	sample-cluster
node_count	Cluster Node Count	5
private_endpoint_access_control_resources	Private Endpoint Access Control Resources
private_endpoint_url	Private Kubeconfig Download Yn	N
private_kubeconfig_download_yn	Private Endpoint URL	https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
public_endpoint_access_control_ip	Public Endpoint Access Control IP	192.168.0.0
public_endpoint_url	Public Endpoint URL	https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_yn	Public Kubeconfig Download Yn	N
security_group_list	Connected Security Group List
service_watch_logging_enabled	Service Watch Enabled	true
status	Cluster Status	RUNNING
subnet	Subnet of Cluster
volume	Connected File Storage
vpc	VPC of Cluster

2.1.19.2 - 1.0

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabled	Cloud Logging Enabled	true
cluster_namespace	Cluster Namespace	sample-cluster-12345
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_version	Cluster Version	v1.29.8
managed_security_group	Managed Security Group
max_node_count	Cluster Max Node Count	5
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster Name	sample-cluster
node_count	Cluster Node Count	5
private_endpoint_access_control_resources	Private Endpoint Access Control Resources
private_endpoint_url	Private Kubeconfig Download Yn	N
private_kubeconfig_download_yn	Private Endpoint URL	https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
public_endpoint_access_control_ip	Public Endpoint Access Control IP	192.168.0.0
public_endpoint_url	Public Endpoint URL	https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_yn	Public Kubeconfig Download Yn	N
security_group_list	Connected Security Group List
status	Cluster Status	RUNNING
subnet	Subnet of Cluster
volume	Connected File Storage
vpc	VPC of Cluster

2.1.20 - Show Cluster User Kubeconfig

2.1.20.1 - 1.1

scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>

Description

Show user kubeconfig for the cluster

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
kubeconfig_type required	****	Kubeconfig Type (private/public)	`private`

Responses

Name	Description	Example

2.1.20.2 - 1.0

scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>

Description

Show user kubeconfig for the cluster

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`70a599e031e749b7b260868f441e862b`
kubeconfig_type required	****	Kubeconfig Type (private/public)	`private`

Responses

Name	Description	Example

2.1.21 - Show Nodepool

2.1.21.1 - 1.1

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`

Responses

Name	Description	Example
id	Nodepool ID	bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
advanced_settings	Node Pool Advanced Settings
auto_recovery_enabled	Is Auto Recovery	true
auto_scale_enabled	Is Auto Scale	true
cluster	Cluster
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_node_count	Current Node Count	1
desired_node_count	Desired Node Count	2
image	Image
keypair	Keypair Name
kubernetes_version	Kubernetes Version	v1.29.8
labels	Node Pool Labels
max_node_count	Max Node Count	5
min_node_count	Min Node Count	1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Nodepool Name	sample-nodepool
server_group_id	Server Group ID	2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_type	Server Type
status	Node Pool Status	Running
taints	Node Pool Taints
volume_size	Volume Size	104
volume_type	Volume Type

2.1.21.2 - 1.0

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nodepool_id required	string	Nodepool ID	`bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`

Responses

Name	Description	Example
id	Nodepool ID	bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_id	Account ID	617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled	Is Auto Recovery	true
auto_scale_enabled	Is Auto Scale	true
cluster	Cluster
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_node_count	Current Node Count	1
desired_node_count	Desired Node Count	2
image	Image
keypair	Keypair Name
kubernetes_version	Kubernetes Version	v1.29.8
labels	Node Pool Labels
max_node_count	Max Node Count	5
min_node_count	Min Node Count	1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Nodepool Name	sample-nodepool
server_type	Server Type
status	Node Pool Status	Running
taints	Node Pool Taints
volume_size	Volume Size	104
volume_type	Volume Type