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

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

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

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260630

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringRegistry namesample

Responses

NameDescriptionExample
resultName duplicatedTrue

1.1.1.2 - 1.0

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

Description

check registry name duplication

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringRegistry namesample

Responses

NameDescriptionExample
resultName duplicatedTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringRepository namesample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
resultName duplicatedTrue

1.1.2.2 - 1.0

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

Description

check repository name duplication

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringRepository namesample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
resultName duplicatedTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

1.1.3.2 - 1.0

scpcli scr tags scan set
--tags_id <value>

Description

check tags vulnerability

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
public_visible_enabled
required
booleanPublic visible enabledTrue
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue
name
required
stringRegistry namesample
public_acl_enabled
optional
booleanPublic ACL enabledTrue
public_endpoint_enabled
optional
booleanPublic endpoint enabledTrue
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
messageDescriptionCarpe diem.
stateRegistry stateRunning

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
public_visible_enabled
required
booleanPublic visible enabledTrue
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue
name
required
stringRegistry namesample
public_acl_enabled
optional
booleanPublic ACL enabledTrue
public_endpoint_enabled
optional
booleanPublic endpoint enabledTrue
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
messageDescriptionCarpe diem.
stateRegistry stateRunning

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
locked
required
booleanLockedTrue
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_tag_expression
required
stringTagged rule tag expression*
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
name
required
stringRepository namesample
description
required
stringDescriptionCarpe diem.
tags
optional
arrayTag List'{"key": "", "value": ""}'
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

Responses

NameDescriptionExample
idRepository IDe5611ca6c1484df480668c5adce8b078
messageDescriptionCarpe diem.
stateRepository stateActive

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
locked
required
booleanLockedTrue
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
name
required
stringRepository namesample
description
required
stringDescriptionCarpe diem.
tags
optional
arrayTag List'{"key": "", "value": ""}'
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

Responses

NameDescriptionExample
idRepository IDe5611ca6c1484df480668c5adce8b078
messageDescriptionCarpe diem.
stateRepository stateActive

1.1.6 - Delete Image

1.1.6.1 - 1.1

scpcli scr image delete
--image_id <value>

Description

delete image

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

1.1.6.2 - 1.0

scpcli scr image delete
--image_id <value>

Description

delete image

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

1.1.7 - Delete Registry

1.1.7.1 - 1.1

scpcli scr registry delete
--registry_id <value>

Description

delete registry

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

1.1.7.2 - 1.0

scpcli scr registry delete
--registry_id <value>

Description

delete registry

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

1.1.8 - Delete Repository

1.1.8.1 - 1.1

scpcli scr repository delete
--repository_id <value>

Description

delete repository

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

1.1.8.2 - 1.0

scpcli scr repository delete
--repository_id <value>

Description

delete repository

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
tag_names
required
arrayTag names[

1.1.9.2 - 1.0

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

Description

delete tags

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
tag_names
required
arrayTag 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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_ids
required
arrayTags IDs[

1.1.10.2 - 1.0

scpcli scr tags delete
--tags_ids <value>

Description

delete tagses

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_ids
required
arrayTags 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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample

1.1.11.2 - 1.0

scpcli scr tags manifest show
--tags_id <value>

Description

download manifest file

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample

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)

VersionNot Before
1.1-

Responses

NameDescriptionExample
idResource ID558496f6c49d43459e61e191fb3c08fe
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
typeResource typecontainer-registry

1.1.12.2 - 1.0

scpcli scr registry connectable-resource list

Description

get connectable domains

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Responses

NameDescriptionExample
idResource ID558496f6c49d43459e61e191fb3c08fe
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
typeResource typecontainer-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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringImage namesample

Responses

NameDescriptionExample
idImage ID5b5ed4f2881a440583536fc1a8c39a28
created_atCreated at2024-08-15T13:05:09.701645823+09:00
modified_atModified at2024-08-16T16:06:09.701645823+09:00
nameImage namesample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
pull_countPull count20
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateImage stateActive

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringImage namesample

Responses

NameDescriptionExample
idImage ID5b5ed4f2881a440583536fc1a8c39a28
created_atCreated at2024-08-15T13:05:09.701645823+09:00
modified_atModified at2024-08-16T16:06:09.701645823+09:00
nameImage namesample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
pull_countPull count20
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateImage stateActive

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRegistry namesample
state
optional
stringRegistry stateRunning

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRegistry namesample
state
optional
stringRegistry stateRunning

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRepository namesample

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
stateRepository stateActive

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRepository namesample

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
stateRepository stateActive

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_atLast scanned at2024-08-15T13:05:09.701645823+09:00
lock_policyLock Policy
modified_atModified at2024-08-16T16:06:09.701645823+09:00
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_neededNeed for retrying vulnerability inspectionTrue
reference_tagsList of tags in reference[“sample”]
referenced_byReference necessity
scan_stateScanning stateScanning state
scan_summary
sizeSize10
stateTags stateActive

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_atLast scanned at2024-08-15T13:05:09.701645823+09:00
lock_policyLock Policy
modified_atModified at2024-08-16T16:06:09.701645823+09:00
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_neededNeed for retrying vulnerability inspectionTrue
reference_tagsList of tags in reference[“sample”]
referenced_byReference necessity
scan_stateScanning stateScanning state
scan_summary
sizeSize10
stateTags stateActive

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample

1.1.17.2 - 1.0

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

Description

Run Image Lifecycle Policy Preview

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample

1.1.18 - Show Image

1.1.18.1 - 1.1

scpcli scr image show
--image_id <value>

Description

get image

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameImage namesample
pull_countPull count100
pull_policyPull policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
scan_policyScan policy
stateImage stateActive

1.1.18.2 - 1.0

scpcli scr image show
--image_id <value>

Description

get image

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameImage namesample
pull_countPull count100
pull_policyPull policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
scan_policyScan policy
stateImage stateActive

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
created_atCreated at2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
reference_tagsList of tags in reference[“sample”]
stateTags stateActive

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_atLast scanned at2024-08-15T13:05:09.701645823+09:00
lock_policyLock Policy
modified_atModified at2024-08-16T16:06:09.701645823+09:00
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_neededNeed for retrying vulnerability inspectionTrue
reference_tagsList of tags in reference[“sample”]
referenced_byReference necessity
scan_stateScanning stateScanning state
scan_summary
sizeSize10
stateTags stateActive

1.1.20 - Show Registry

1.1.20.1 - 1.1

scpcli scr registry show
--registry_id <value>

Description

get registry

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_idBucket IDrpqtmqgec3174541bbf77eecf2cd3585
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usageBucket Usage
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_acl_enabledPrivate ACL enabledTrue
private_acl_resourcesPrivate ACL resources
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabledPublic ACL enabledTrue
public_acl_resourcesPublic ACL resources
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabledPublic endpoint enabledTrue
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

1.1.20.2 - 1.0

scpcli scr registry show
--registry_id <value>

Description

get registry

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_idBucket IDrpqtmqgec3174541bbf77eecf2cd3585
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usageBucket Usage
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_acl_enabledPrivate ACL enabledTrue
private_acl_resourcesPrivate ACL resources
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabledPublic ACL enabledTrue
public_acl_resourcesPublic ACL resources
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabledPublic endpoint enabledTrue
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

1.1.21 - Show Repository

1.1.21.1 - 1.1

scpcli scr repository show
--repository_id <value>

Description

get repository

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
pull_policyPull policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
scan_policyScan policy
stateRepository stateActive

1.1.21.2 - 1.0

scpcli scr repository show
--repository_id <value>

Description

get repository

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
pull_policyPull policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
scan_policyScan policy
stateRepository stateActive

1.1.22 - Show Tags

1.1.22.1 - 1.1

scpcli scr tags show
--tags_id <value>

Description

get tags

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
created_atCreated at2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
image_idImage ID5b5ed4f2881a440583536fc1a8c39a28
lock_policyLock Policy
manifestManifest
manifest_media_typeManifest media type
modified_atModified at2024-08-16T16:06:09.701645823+09:00
reference_tagsList of tags in reference[“sample”]
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateTags stateActive

1.1.22.2 - 1.0

scpcli scr tags show
--tags_id <value>

Description

get tags

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
created_atCreated at2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
image_idImage ID5b5ed4f2881a440583536fc1a8c39a28
lock_policyLock Policy
manifestManifest
manifest_media_typeManifest media type
modified_atModified at2024-08-16T16:06:09.701645823+09:00
reference_tagsList of tags in reference[“sample”]
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateTags stateActive

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20

Responses

NameDescriptionExample
categoryCategoryLanguage
os_languageOS or languageJava
package_namePackage namecom.example.sample
scan_summary
typePipeline typeos-pkg(binary)
versionPipeline version0.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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20

Responses

NameDescriptionExample
categoryCategoryLanguage
os_languageOS or languageJava
package_namePackage namecom.example.sample
scan_summary
typePipeline typeos-pkg(binary)
versionPipeline version0.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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
file_name
optional
stringSecret file name/certs/sample-key1.key

Responses

NameDescriptionExample
categoryCategoryLanguage
file_nameSecret file name/certs/sample-key1.key
matchSecret match—–BEGIN SAMPLE KEY—–*********************…
rule_idRule IDprivate-key
severitySeverityHigh
start_lineSecret start line1
targetTarget/certs/sample-key1.key
titleSecret titleAsymmetric Private Key
vulnerability_classVulnerability classsecret

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
file_name
optional
stringSecret file name/certs/sample-key1.key

Responses

NameDescriptionExample
categoryCategoryLanguage
file_nameSecret file name/certs/sample-key1.key
matchSecret match—–BEGIN SAMPLE KEY—–*********************…
rule_idRule IDprivate-key
severitySeverityHigh
start_lineSecret start line1
targetTarget/certs/sample-key1.key
titleSecret titleAsymmetric Private Key
vulnerability_classVulnerability classsecret

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
update_version_available
optional
booleanUpdated versionTrue
severity
optional
arraySeverityH
category
optional
stringCategoryLanguage

Responses

NameDescriptionExample
attack_complexityAttack complexity
attack_vectorAttack vector
availabilityAvailability
confidentialityConfidentiality
integrityIntegrity
privileges_requiredNecessary authority
scopeAttack scope
user_interactionDegree 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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
update_version_available
optional
booleanUpdated versionTrue
severity
optional
arraySeverityH
category
optional
stringCategoryLanguage

Responses

NameDescriptionExample
attack_complexityAttack complexity
attack_vectorAttack vector
availabilityAvailability
confidentialityConfidentiality
integrityIntegrity
privileges_requiredNecessary authority
scopeAttack scope
user_interactionDegree 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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
description
required
stringDescriptionCarpe diem.

1.1.26.2 - 1.0

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

Description

update image description

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
description
required
stringDescriptionCarpe 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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_tag_expression
required
stringTagged rule tag expression*
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
locked
required
booleanLockedTrue

1.1.28.2 - 1.0

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

Description

update image lock-policy

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
locked
required
booleanLockedTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
public_acl_enabled
required
booleanPublic ACL enabledTrue

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
public_acl_enabled
required
booleanPublic ACL enabledTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_endpoint_enabled
required
booleanPublic endpoint enabledTrue

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_endpoint_enabled
required
booleanPublic endpoint enabledTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
description
required
stringDescriptionCarpe diem.

1.1.34.2 - 1.0

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

Description

update repository description

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
description
required
stringDescriptionCarpe 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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_tag_expression
required
stringTagged rule tag expression*
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
locked
required
booleanLockedTrue

1.1.36.2 - 1.0

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

Description

update repository lock-policy

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
locked
required
booleanLockedTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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 (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
locked
required
booleanLockedTrue

1.1.39.2 - 1.0

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

Description

update tags lock

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
locked
required
booleanLockedTrue

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

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

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20260919
1.0DEPRECATED20251231

2.1 - CLIs

2.1.1 - Create Cluster

2.1.1.1 - 1.2

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

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
volume_id
required
stringVolume ID['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
service_watch_logging_enabled
required
booleanService Watch Logging Enabledtrue
security_group_id_list
required
arraySecurity Group ID Listbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
name
required
stringCluster Namesample-cluster
kubernetes_version
required
stringCluster Versionv1.29.8
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue
private_endpoint_access_control_resources
optional
arrayPrivate Endpoint Access Control Resources'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'
public_endpoint_access_control_ip
optional
stringPublic Endpoint Access Control IP192.168.0.0
tags
optional
arrayTag list'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
request_idRequest ID80a599e031e749b7b260868f441e862b
resource_idResource ID70a599e031e749b7b260868f441e862b

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

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
volume_id
required
stringVolume ID['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
service_watch_logging_enabled
required
booleanService Watch Logging Enabledtrue
security_group_id_list
required
arraySecurity Group ID Listbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
name
required
stringCluster Namesample-cluster
kubernetes_version
required
stringCluster Versionv1.29.8
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue
private_endpoint_access_control_resources
optional
arrayPrivate Endpoint Access Control Resources'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'
public_endpoint_access_control_ip
optional
stringPublic Endpoint Access Control IP192.168.0.0
tags
optional
arrayTag list'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
request_idRequest ID80a599e031e749b7b260868f441e862b
resource_idResource ID70a599e031e749b7b260868f441e862b

2.1.1.3 - 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 V1.0

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
volume_id
required
stringVolume ID['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
security_group_id_list
required
arraySecurity Group ID Listbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
name
required
stringCluster Namesample-cluster
kubernetes_version
required
stringCluster Versionv1.29.8
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue
private_endpoint_access_control_resources
optional
arrayPrivate Endpoint Access Control Resources'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'
public_endpoint_access_control_ip
optional
stringPublic Endpoint Access Control IP192.168.0.0
tags
optional
arrayTag list'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
request_idRequest ID80a599e031e749b7b260868f441e862b
resource_idResource ID70a599e031e749b7b260868f441e862b

2.1.2 - Create Cluster Kubeconfig

2.1.2.1 - 1.2

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

Description

Create kubeconfig file for the cluster

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (private/public)private

Responses

NameDescriptionExample

2.1.2.2 - 1.1

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

Description

Create kubeconfig file for the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (private/public)private

Responses

NameDescriptionExample

2.1.2.3 - 1.0

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

Description

Create kubeconfig file for the cluster

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (private/public)private

Responses

NameDescriptionExample

2.1.3 - Create Nodepool

2.1.3.1 - 1.2

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

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integerPod Max PID Limit4096
max_pods
required
integerMax Pods Per Node110
image_gc_low_threshold
required
integerImage GC Low Threshold Percent80
image_gc_high_threshold
required
integerImage GC High Threshold Percent85
container_log_max_size
required
integerMax Size Of Container Log (MB)10
container_log_max_files
required
integerMax Number Of Container Log Files5
volume_type_name
required
stringVolume Type NameSSD
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type ID10a599e031e749b7b260868f441e862b
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
server_group_id
optional
stringServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
allowed_unsafe_sysctls
optional
stringAllowed Unsafe sysctlskernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

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

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integerPod Max PID Limit4096
max_pods
required
integerMax Pods Per Node110
image_gc_low_threshold
required
integerImage GC Low Threshold Percent80
image_gc_high_threshold
required
integerImage GC High Threshold Percent85
container_log_max_size
required
integerMax Size Of Container Log (MB)10
container_log_max_files
required
integerMax Number Of Container Log Files5
volume_type_name
required
stringVolume Type NameSSD
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type ID10a599e031e749b7b260868f441e862b
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
server_group_id
optional
stringServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
allowed_unsafe_sysctls
optional
stringAllowed Unsafe sysctlskernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

2.1.3.3 - 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 v1.0

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_type_name
required
stringVolume Type NameSSD
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type ID10a599e031e749b7b260868f441e862b
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

2.1.4 - Delete Cluster

2.1.4.1 - 1.2

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

2.1.4.2 - 1.1

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

2.1.4.3 - 1.0

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

2.1.5 - Delete Nodepool

2.1.5.1 - 1.2

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

2.1.5.2 - 1.1

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

2.1.5.3 - 1.0

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

2.1.6 - List Clusters

2.1.6.1 - 1.2

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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster Namesample-cluster
status
optional
arrayCluster StatusR
kubernetes_version
optional
arrayCluster Versionv
subnet_id
optional
stringCluster Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idCluster ID70a599e031e749b7b260868f441e862b
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-03-31T00:23:17Z
kubernetes_versionCluster Versionv1.29.8
modified_atModified At2025-03-31T00:23:17Z
nameCluster Namesample-cluster
node_countCluster Node Count5
statusCluster StatusRUNNING
subnet_idCluster Subnet ID023c57b14f11483689338d085e061492

2.1.6.2 - 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 (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster Namesample-cluster
status
optional
arrayCluster StatusR
kubernetes_version
optional
arrayCluster Versionv
subnet_id
optional
stringCluster Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idCluster ID70a599e031e749b7b260868f441e862b
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-03-31T00:23:17Z
kubernetes_versionCluster Versionv1.29.8
modified_atModified At2025-03-31T00:23:17Z
nameCluster Namesample-cluster
node_countCluster Node Count5
statusCluster StatusRUNNING
subnet_idCluster Subnet ID023c57b14f11483689338d085e061492

2.1.6.3 - 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)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster Namesample-cluster
status
optional
arrayCluster StatusR
kubernetes_version
optional
arrayCluster Versionv
subnet_id
optional
stringCluster Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idCluster ID70a599e031e749b7b260868f441e862b
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-03-31T00:23:17Z
kubernetes_versionCluster Versionv1.29.8
modified_atModified At2025-03-31T00:23:17Z
nameCluster Namesample-cluster
node_countCluster Node Count5
statusCluster StatusRUNNING
subnet_idCluster Subnet ID023c57b14f11483689338d085e061492

2.1.7 - List Nodepool Nodes

2.1.7.1 - 1.2

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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
node_name
optional
stringNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
kubernetes_versionKubernetes Versionv1.29.8
nameNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p
statusNode StatusRUNNING

2.1.7.2 - 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 (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
node_name
optional
stringNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
kubernetes_versionKubernetes Versionv1.29.8
nameNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p
statusNode StatusRUNNING

2.1.7.3 - 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)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
node_name
optional
stringNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
kubernetes_versionKubernetes Versionv1.29.8
nameNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p
statusNode StatusRUNNING

2.1.8 - List Nodepools

2.1.8.1 - 1.2

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

Description

get nodepools list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
nodepool_name
optional
stringNodepool Namesample-nodepool

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recovery
auto_scale_enabledIs Auto Scale
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
kubernetes_versionKubernetes Versionv1.29.8
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
volume_typeVolume Type

2.1.8.2 - 1.1

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

Description

get nodepools list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
nodepool_name
optional
stringNodepool Namesample-nodepool

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recovery
auto_scale_enabledIs Auto Scale
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
kubernetes_versionKubernetes Versionv1.29.8
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
volume_typeVolume Type

2.1.8.3 - 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)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
nodepool_name
optional
stringNodepool Namesample-nodepool

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recovery
auto_scale_enabledIs Auto Scale
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
kubernetes_versionKubernetes Versionv1.29.8
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
volume_typeVolume Type

2.1.9 - Set Cluster Logging

2.1.9.1 - 1.2

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

Description

Set logging on the cluster

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue

2.1.9.2 - 1.1

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

Description

Set logging on the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue

2.1.9.3 - 1.0

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

Description

Set logging on the cluster

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue

2.1.10 - Set Cluster Private Access Control

2.1.10.1 - 1.2

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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
private_endpoint_access_control_resources
required
array'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'

2.1.10.2 - 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 (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
private_endpoint_access_control_resources
required
array'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'

2.1.10.3 - 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)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
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.2

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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
public_endpoint_access_control_ip
required
stringPublic Endpoint Access Control IP192.168.0.0

2.1.11.2 - 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 (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
public_endpoint_access_control_ip
required
stringPublic Endpoint Access Control IP192.168.0.0

2.1.11.3 - 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)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
public_endpoint_access_control_ip
required
stringPublic Endpoint Access Control IP192.168.0.0

2.1.12 - Set Cluster Security Groups

2.1.12.1 - 1.2

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

Description

Set Cluster Security Groups

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
security_group_id_list
required
arraySecurity Group ID Listb

2.1.12.2 - 1.1

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

Description

Set Cluster Security Groups

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
security_group_id_list
required
arraySecurity Group ID Listb

2.1.12.3 - 1.0

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

Description

Set Cluster Security Groups

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
security_group_id_list
required
arraySecurity Group ID Listb

2.1.13 - Set Cluster Service Watch Logging

2.1.13.1 - 1.2

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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
service_watch_logging_enabled
required
booleanService Watch Logging Enabledtrue

2.1.13.2 - 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 (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
service_watch_logging_enabled
required
booleanService Watch Logging Enabledtrue

2.1.14 - Set Cluster Upgrade

2.1.14.1 - 1.2

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

Description

upgrade a specific cluster

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubernetes_version
required
stringKubernetes Versionv1.29.8

2.1.14.2 - 1.1

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

Description

upgrade a specific cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubernetes_version
required
stringKubernetes Versionv1.29.8

2.1.14.3 - 1.0

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

Description

upgrade a specific cluster

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubernetes_version
required
stringKubernetes Versionv1.29.8

2.1.15 - Set Nodepool

2.1.15.1 - 1.2

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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
desired_node_count
optional
integerDesired Node Count2
is_auto_recovery
optional
booleanIs Auto Recoverytrue
is_auto_scale
optional
booleanIs Auto Scaletrue
max_node_count
optional
integerMax Node Count5
min_node_count
optional
integerMin Node Count1

2.1.15.2 - 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 (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
desired_node_count
optional
integerDesired Node Count2
is_auto_recovery
optional
booleanIs Auto Recoverytrue
is_auto_scale
optional
booleanIs Auto Scaletrue
max_node_count
optional
integerMax Node Count5
min_node_count
optional
integerMin Node Count1

2.1.15.3 - 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)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
desired_node_count
optional
integerDesired Node Count2
is_auto_recovery
optional
booleanIs Auto Recoverytrue
is_auto_scale
optional
booleanIs Auto Scaletrue
max_node_count
optional
integerMax Node Count5
min_node_count
optional
integerMin Node Count1

2.1.16 - Set Nodepool Labels

2.1.16.1 - 1.2

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

Description

set nodepool labels

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
labels
required
array'{"key": "example.com/my-app", "value": "bar"}'

2.1.16.2 - 1.1

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

Description

set nodepool labels

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
labels
required
array'{"key": "example.com/my-app", "value": "bar"}'

2.1.16.3 - 1.0

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

Description

set nodepool labels

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-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.2

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

Description

set nodepool taints

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
taints
required
array'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

2.1.17.2 - 1.1

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

Description

set nodepool taints

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
taints
required
array'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

2.1.17.3 - 1.0

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

Description

set nodepool taints

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-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.2

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

Description

upgrade a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
os_version
required
stringImage OS Version22.04

2.1.18.2 - 1.1

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

Description

upgrade a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
os_version
required
stringImage OS Version22.04

2.1.18.3 - 1.0

scpcli ske nodepool upgrade set
--nodepool_id <value>

Description

upgrade a nodepool v1.0

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

2.1.19 - Show Cluster

2.1.19.1 - 1.2

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabledCloud Logging Enabledtrue
cluster_namespaceCluster Namespacesample-cluster-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_versionCluster Versionv1.29.8
managed_security_groupManaged Security Group
max_node_countCluster Max Node Count5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster Namesample-cluster
node_countCluster Node Count5
private_endpoint_access_control_resourcesPrivate Endpoint Access Control Resources
private_endpoint_urlPrivate Endpoint URLhttps://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
private_kubeconfig_download_ynPrivate Kubeconfig Downloaded Or Not (Y/N)N
public_endpoint_access_control_ipPublic Endpoint Access Control IP192.168.0.0
public_endpoint_urlPublic Endpoint URLhttps://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_ynPublic Kubeconfig Downloaded Or Not (Y/N)N
security_group_listConnected Security Group List
service_watch_logging_enabledService Watch Logging Enabledtrue
statusCluster StatusRUNNING
subnetSubnet of Cluster
volumeConnected File Storage
vpcVPC of Cluster

2.1.19.2 - 1.1

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabledCloud Logging Enabledtrue
cluster_namespaceCluster Namespacesample-cluster-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_versionCluster Versionv1.29.8
managed_security_groupManaged Security Group
max_node_countCluster Max Node Count5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster Namesample-cluster
node_countCluster Node Count5
private_endpoint_access_control_resourcesPrivate Endpoint Access Control Resources
private_endpoint_urlPrivate Endpoint URLhttps://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
private_kubeconfig_download_ynPrivate Kubeconfig Downloaded Or Not (Y/N)N
public_endpoint_access_control_ipPublic Endpoint Access Control IP192.168.0.0
public_endpoint_urlPublic Endpoint URLhttps://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_ynPublic Kubeconfig Downloaded Or Not (Y/N)N
security_group_listConnected Security Group List
service_watch_logging_enabledService Watch Logging Enabledtrue
statusCluster StatusRUNNING
subnetSubnet of Cluster
volumeConnected File Storage
vpcVPC of Cluster

2.1.19.3 - 1.0

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster v1.0

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabledCloud Logging Enabledtrue
cluster_namespaceCluster Namespacesample-cluster-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_versionCluster Versionv1.29.8
managed_security_groupManaged Security Group
max_node_countCluster Max Node Count5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster Namesample-cluster
node_countCluster Node Count5
private_endpoint_access_control_resourcesPrivate Endpoint Access Control Resources
private_endpoint_urlPrivate Endpoint URLhttps://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
private_kubeconfig_download_ynPrivate Kubeconfig Downloaded Or Not (Y/N)N
public_endpoint_access_control_ipPublic Endpoint Access Control IP192.168.0.0
public_endpoint_urlPublic Endpoint URLhttps://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_ynPublic Kubeconfig Downloaded Or Not (Y/N)N
security_group_listConnected Security Group List
statusCluster StatusRUNNING
subnetSubnet of Cluster
volumeConnected File Storage
vpcVPC of Cluster

2.1.20 - Show Cluster User Kubeconfig

2.1.20.1 - 1.2

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

Description

Show user kubeconfig for the cluster

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (private/public)private

Responses

NameDescriptionExample

2.1.20.2 - 1.1

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

Description

Show user kubeconfig for the cluster

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (private/public)private

Responses

NameDescriptionExample

2.1.20.3 - 1.0

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

Description

Show user kubeconfig for the cluster

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (private/public)private

Responses

NameDescriptionExample

2.1.21 - Show Nodepool

2.1.21.1 - 1.2

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

2.1.21.2 - 1.1

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

2.1.21.3 - 1.0

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool v1.0

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type