이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Container

1: Container Registry

1.1: APIs

1.1.1: Check Registry Name Duplication

1.1.1.1: 1.1
1.1.1.2: 1.0

1.1.2: Check Repository Name Duplication

1.1.2.1: 1.1
1.1.2.2: 1.0

1.1.3: Check Tags Vulnerability

1.1.3.1: 1.1
1.1.3.2: 1.0

1.1.4: Create Registry

1.1.4.1: 1.1
1.1.4.2: 1.0

1.1.5: Create Repository

1.1.5.1: 1.1
1.1.5.2: 1.0

1.1.6: Delete Image

1.1.6.1: 1.1
1.1.6.2: 1.0

1.1.7: Delete Registry

1.1.7.1: 1.1
1.1.7.2: 1.0

1.1.8: Delete Repository

1.1.8.1: 1.1
1.1.8.2: 1.0

1.1.9: Delete Tags

1.1.9.1: 1.1
1.1.9.2: 1.0

1.1.10: Delete Tagses

1.1.10.1: 1.1
1.1.10.2: 1.0

1.1.11: Download Manifest

1.1.11.1: 1.1
1.1.11.2: 1.0

1.1.12: List Connectable Resources

1.1.12.1: 1.1
1.1.12.2: 1.0

1.1.13: List Images

1.1.13.1: 1.1
1.1.13.2: 1.0

1.1.14: List Registries

1.1.14.1: 1.1
1.1.14.2: 1.0

1.1.15: List Repositories

1.1.15.1: 1.1
1.1.15.2: 1.0

1.1.16: List Tagses

1.1.16.1: 1.1
1.1.16.2: 1.0

1.1.17: Run Image Lifecycle Policy Preview

1.1.17.1: 1.1
1.1.17.2: 1.0

1.1.18: Show Image

1.1.18.1: 1.1
1.1.18.2: 1.0

1.1.19: Show Image Lifecycle Policy Preview

1.1.19.1: 1.1
1.1.19.2: 1.0

1.1.20: Show Registry

1.1.20.1: 1.1
1.1.20.2: 1.0

1.1.21: Show Repository

1.1.21.1: 1.1
1.1.21.2: 1.0

1.1.22: Show Tags

1.1.22.1: 1.1
1.1.22.2: 1.0

1.1.23: Show Tags Packages

1.1.23.1: 1.1
1.1.23.2: 1.0

1.1.24: Show Tags Secrets

1.1.24.1: 1.1
1.1.24.2: 1.0

1.1.25: Show Tags Vulnerabilities

1.1.25.1: 1.1
1.1.25.2: 1.0

1.1.26: Update Image Description

1.1.26.1: 1.1
1.1.26.2: 1.0

1.1.27: Update Image Lifecycle Policy

1.1.27.1: 1.1
1.1.27.2: 1.0

1.1.28: Update Image Lock Policy

1.1.28.1: 1.1
1.1.28.2: 1.0

1.1.29: Update Image Pull Policy

1.1.29.1: 1.1
1.1.29.2: 1.0

1.1.30: Update Image Scan Policy

1.1.30.1: 1.1
1.1.30.2: 1.0

1.1.31: Update Private Acl

1.1.31.1: 1.1
1.1.31.2: 1.0

1.1.32: Update Public Acl

1.1.32.1: 1.1
1.1.32.2: 1.0

1.1.33: Update Public Endpoint Enabled

1.1.33.1: 1.1
1.1.33.2: 1.0

1.1.34: Update Repository Description

1.1.34.1: 1.1
1.1.34.2: 1.0

1.1.35: Update Repository Lifecycle Policy

1.1.35.1: 1.1
1.1.35.2: 1.0

1.1.36: Update Repository Lock Policy

1.1.36.1: 1.1
1.1.36.2: 1.0

1.1.37: Update Repository Pull Policy

1.1.37.1: 1.1
1.1.37.2: 1.0

1.1.38: Update Repository Scan Policy

1.1.38.1: 1.1
1.1.38.2: 1.0

1.1.39: Update Tags Lock Policy

1.1.39.1: 1.1
1.1.39.2: 1.0

1.2: Models

1.2.1: CheckDuplicationResponse
1.2.2: ConnectableResource
1.2.3: ConnectableResourceListResponse
1.2.4: ContainerRegistry
1.2.5: ContainerRegistryCreateRequest
1.2.6: ContainerRegistryCreateResponse
1.2.7: ContainerRegistryForList
1.2.8: ContainerRegistryListResponse
1.2.9: ContainerRegistryShowResponse
1.2.10: Cve
1.2.11: Image
1.2.12: ImageForList
1.2.13: ImageListResponse
1.2.14: ImageSetRequest
1.2.15: ImageShowResponse
1.2.16: ImageShowResponseV1_1
1.2.17: ImageV1_1
1.2.18: LifecyclePolicy
1.2.19: LifecyclePolicyPreview
1.2.20: LifecyclePolicyPreviewResponseV1_1
1.2.21: LifecyclePolicySetRequest
1.2.22: LifecyclePolicySetRequestV1_1
1.2.23: LifecyclePolicyV1_1
1.2.24: LockPolicy
1.2.25: LockPolicySetRequest
1.2.26: PackageListResponse
1.2.27: PackageReport
1.2.28: PrivateAclSetRequest
1.2.29: PublicAclSetRequest
1.2.30: PublicEndpointEnabledSetRequest
1.2.31: PullPolicy
1.2.32: PullPolicySetRequest
1.2.33: Repository
1.2.34: RepositoryCreateRequest
1.2.35: RepositoryCreateRequestV1_1
1.2.36: RepositoryCreateResponse
1.2.37: RepositoryForList
1.2.38: RepositoryListResponse
1.2.39: RepositorySetRequest
1.2.40: RepositoryShowResponse
1.2.41: RepositoryShowResponseV1_1
1.2.42: RepositoryV1_1
1.2.43: Resource
1.2.44: ScanPolicy
1.2.45: ScanPolicySetRequest
1.2.46: ScanSummary
1.2.47: SecretListResponse
1.2.48: SecretReport
1.2.49: SecretSummary
1.2.50: Tag
1.2.51: TagDeleteRequest
1.2.52: Tags
1.2.53: TagsDeleteRequest
1.2.54: TagsForList
1.2.55: TagsListResponse
1.2.56: TagsShowResponse
1.2.57: VectorInfo
1.2.58: VectorInfos
1.2.59: Vectors
1.2.60: VulnerabilityListResponse
1.2.61: VulnerabilityReport

2: Kubernetes

2.1: APIs

2.1.1: Create Cluster

2.1.1.1: 1.1
2.1.1.2: 1.0

2.1.2: Create Cluster Kubeconfig

2.1.2.1: 1.1
2.1.2.2: 1.0

2.1.3: Create Nodepool

2.1.3.1: 1.1
2.1.3.2: 1.0

2.1.4: Delete Cluster

2.1.4.1: 1.1
2.1.4.2: 1.0

2.1.5: Delete Nodepool

2.1.5.1: 1.1
2.1.5.2: 1.0

2.1.6: List Clusters

2.1.6.1: 1.1
2.1.6.2: 1.0

2.1.7: List Kubernetes Versions

2.1.7.1: 1.1
2.1.7.2: 1.0

2.1.8: List Nodepool Nodes

2.1.8.1: 1.1
2.1.8.2: 1.0

2.1.9: List Nodepools

2.1.9.1: 1.1
2.1.9.2: 1.0

2.1.10: Set Cluster Logging

2.1.10.1: 1.1
2.1.10.2: 1.0

2.1.11: Set Cluster Private Access Control

2.1.11.1: 1.1
2.1.11.2: 1.0

2.1.12: Set Cluster Public Access Control

2.1.12.1: 1.1
2.1.12.2: 1.0

2.1.13: Set Cluster Security Groups

2.1.13.1: 1.1
2.1.13.2: 1.0

2.1.14: Set Cluster Service Watch Logging

2.1.14.1: 1.1

2.1.15: Set Cluster Upgrade

2.1.15.1: 1.1
2.1.15.2: 1.0

2.1.16: Set Nodepool

2.1.16.1: 1.1
2.1.16.2: 1.0

2.1.17: Set Nodepool Labels

2.1.17.1: 1.1
2.1.17.2: 1.0

2.1.18: Set Nodepool Taints

2.1.18.1: 1.1
2.1.18.2: 1.0

2.1.19: Set Nodepool Upgrade

2.1.19.1: 1.1
2.1.19.2: 1.0

2.1.20: Show Cluster

2.1.20.1: 1.1
2.1.20.2: 1.0

2.1.21: Show Cluster User Kubeconfig

2.1.21.1: 1.1
2.1.21.2: 1.0

2.1.22: Show Nodepool

2.1.22.1: 1.1
2.1.22.2: 1.0

2.2: Models

2.2.1: AsyncResponse
2.2.2: Cluster
2.2.3: ClusterCreateRequest
2.2.4: ClusterCreateRequestV1Dot1
2.2.5: ClusterListResponse
2.2.6: ClusterLoggingSetRequest
2.2.7: ClusterOfNodepool
2.2.8: ClusterPrivateAccessControlSetRequest
2.2.9: ClusterPublicAccessControlSetRequest
2.2.10: ClusterSecurityGroupsSetRequest
2.2.11: ClusterServiceWatchLoggingSetRequest
2.2.12: ClusterSetResponse
2.2.13: ClusterShowResponse
2.2.14: ClusterShowResponseV1Dot1
2.2.15: ClusterSummary
2.2.16: ClusterUpgradeSetRequest
2.2.17: ClusterV1Dot1
2.2.18: ExternalResource
2.2.19: Image
2.2.20: Keypair
2.2.21: KubernetesVersionListResponse
2.2.22: KubernetesVersionSummary
2.2.23: NodeInNodepool
2.2.24: NodeListInNodepoolResponse
2.2.25: Nodepool
2.2.26: NodepoolAdvancedSettings
2.2.27: NodepoolCreateRequest
2.2.28: NodepoolCreateRequestV1Dot1
2.2.29: NodepoolLabel
2.2.30: NodepoolLabelsSetRequest
2.2.31: NodepoolListResponse
2.2.32: NodepoolShowResponse
2.2.33: NodepoolShowResponseV1Dot1
2.2.34: NodepoolSummary
2.2.35: NodepoolTaint
2.2.36: NodepoolTaintsSetRequest
2.2.37: NodepoolUpdateRequest
2.2.38: NodepoolUpgradeSetRequest
2.2.39: NodepoolV1Dot1
2.2.40: PrivateEndpointAccessControlResource
2.2.41: ServerType
2.2.42: Tag
2.2.43: VolumeType
2.2.44: VolumeTypeSummary

1 - Container Registry

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Container Registry 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260630
1.1	CURRENT	-

OpenAPI URL

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

Environment and Region List

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

1.1 - APIs

1.1.1 - Check Registry Name Duplication

1.1.1.1 - 1.1

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

Description

Registry명 중복 여부

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.1.2 - 1.0

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

Description

Registry명 중복 여부

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.2 - Check Repository Name Duplication

1.1.2.1 - 1.1

get /v1/repositories/check-duplication/name

Description

Registry명 중복 여부

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.2.2 - 1.0

get /v1/repositories/check-duplication/name

Description

Registry명 중복 여부

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.3 - Check Tags Vulnerability

1.1.3.1 - 1.1

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

Description

취약점 검사 수행

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

1.1.3.2 - 1.0

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

Description

취약점 검사 수행

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

1.1.4 - Create Registry

1.1.4.1 - 1.1

post /v1/container-registries

Description

Registry 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ContainerRegistryCreateRequest

Responses

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

Example HTTP request

Request path

/v1/container-registries

Request header

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

Request body

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

Example HTTP response

Response 201

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

1.1.4.2 - 1.0

post /v1/container-registries

Description

Registry 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		ContainerRegistryCreateRequest

Responses

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

Example HTTP request

Request path

/v1/container-registries

Request header

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

Request body

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

Example HTTP response

Response 201

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

1.1.5 - Create Repository

1.1.5.1 - 1.1

post /v1/repositories

Description

Repository 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		RepositoryCreateRequestV1_1

Responses

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

Example HTTP request

Request path

/v1/repositories

Request header

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

Request body

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

Example HTTP response

Response 201

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

1.1.5.2 - 1.0

post /v1/repositories

Description

Repository 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		RepositoryCreateRequest

Responses

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

Example HTTP request

Request path

/v1/repositories

Request header

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

Request body

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

Example HTTP response

Response 201

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

1.1.6 - Delete Image

1.1.6.1 - 1.1

delete /v1/images/{image_id}

Description

Image 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}

Request header

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

Example HTTP response

Response 202

1.1.6.2 - 1.0

delete /v1/images/{image_id}

Description

Image 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}

Request header

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

Example HTTP response

Response 202

1.1.7 - Delete Registry

1.1.7.1 - 1.1

delete /v1/container-registries/{registry_id}

Description

Registry 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}

Request header

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

Example HTTP response

Response 202

1.1.7.2 - 1.0

delete /v1/container-registries/{registry_id}

Description

Registry 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}

Request header

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

Example HTTP response

Response 202

1.1.8 - Delete Repository

1.1.8.1 - 1.1

delete /v1/repositories/{repository_id}

Description

Repository 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}

Request header

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

Example HTTP response

Response 202

1.1.8.2 - 1.0

delete /v1/repositories/{repository_id}

Description

Repository 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}

Request header

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

Example HTTP response

Response 202

1.1.9 - Delete Tags

1.1.9.1 - 1.1

delete /v1/tagses/{tags_id}

Description

Tags 복수 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}

Request header

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

Request body

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

Example HTTP response

Response 204

1.1.9.2 - 1.0

delete /v1/tagses/{tags_id}

Description

Tags 복수 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}

Request header

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

Request body

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

Example HTTP response

Response 204

1.1.10 - Delete Tagses

1.1.10.1 - 1.1

delete /v1/tagses

Description

Tags 복수 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		TagsDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/tagses

Request header

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

Request body

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

Example HTTP response

Response 202

1.1.10.2 - 1.0

delete /v1/tagses

Description

Tags 복수 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		TagsDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/tagses

Request header

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

Request body

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

Example HTTP response

Response 202

1.1.11 - Download Manifest

1.1.11.1 - 1.1

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

Description

매니페스트 파일 다운로드

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

1.1.11.2 - 1.0

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

Description

매니페스트 파일 다운로드

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

1.1.12 - List Connectable Resources

1.1.12.1 - 1.1

get /v1/container-registries/connectable-resources

Description

get connectable domains

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Responses

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

Example HTTP request

Request path

/v1/container-registries/connectable-resources

Request header

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

Example HTTP response

Response 200

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

1.1.12.2 - 1.0

get /v1/container-registries/connectable-resources

Description

get connectable domains

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Responses

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

Example HTTP request

Request path

/v1/container-registries/connectable-resources

Request header

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

Example HTTP response

Response 200

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

1.1.13 - List Images

1.1.13.1 - 1.1

get /v1/repositories/{repository_id}/images

Description

Image 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/images

Request header

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

Example HTTP response

Response 200

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

1.1.13.2 - 1.0

get /v1/repositories/{repository_id}/images

Description

Image 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/images

Request header

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

Example HTTP response

Response 200

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

1.1.14 - List Registries

1.1.14.1 - 1.1

get /v1/container-registries

Description

Registry 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/container-registries

Request header

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

Example HTTP response

Response 200

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

1.1.14.2 - 1.0

get /v1/container-registries

Description

Registry 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/container-registries

Request header

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

Example HTTP response

Response 200

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

1.1.15 - List Repositories

1.1.15.1 - 1.1

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

Description

Repository 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

1.1.15.2 - 1.0

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

Description

Repository 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

1.1.16 - List Tagses

1.1.16.1 - 1.1

get /v1/images/{image_id}/tagses

Description

Tags 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	이미지 ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	참조 중인 tags 목록 Example : `["sample"]`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/tagses

Request header

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

Example HTTP response

Response 200

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

1.1.16.2 - 1.0

get /v1/images/{image_id}/tagses

Description

Tags 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	이미지 ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	참조 중인 tags 목록 Example : `["sample"]`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/tagses

Request header

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

Example HTTP response

Response 200

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

1.1.17 - Run Image Lifecycle Policy Preview

1.1.17.1 - 1.1

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

Description

Lifecycle 정책 Preview 실행

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

1.1.17.2 - 1.0

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

Description

Lifecycle 정책 Preview 실행

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

1.1.18 - Show Image

1.1.18.1 - 1.1

get /v1/images/{image_id}

Description

Image 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}

Request header

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

Example HTTP response

Response 200

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

1.1.18.2 - 1.0

get /v1/images/{image_id}

Description

Image 상세 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}

Request header

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

Example HTTP response

Response 200

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

1.1.19 - Show Image Lifecycle Policy Preview

1.1.19.1 - 1.1

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

Description

Lifecycle 정책 Preview 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	image_id required	이미지 ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	참조 중인 tags 목록 Example : `["sample"]`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

1.1.19.2 - 1.0

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

Description

Lifecycle 정책 Preview 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	image_id required	이미지 ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	reference_tags optional	참조 중인 tags 목록 Example : `["sample"]`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

1.1.20 - Show Registry

1.1.20.1 - 1.1

get /v1/container-registries/{registry_id}

Description

Registry 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}

Request header

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

Example HTTP response

Response 200

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

1.1.20.2 - 1.0

get /v1/container-registries/{registry_id}

Description

Registry 상세 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/container-registries/{registry_id}

Request header

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

Example HTTP response

Response 200

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

1.1.21 - Show Repository

1.1.21.1 - 1.1

get /v1/repositories/{repository_id}

Description

Repository 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}

Request header

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

Example HTTP response

Response 200

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

1.1.21.2 - 1.0

get /v1/repositories/{repository_id}

Description

Repository 상세 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}

Request header

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

Example HTTP response

Response 200

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

1.1.22 - Show Tags

1.1.22.1 - 1.1

get /v1/tagses/{tags_id}

Description

Tags 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}

Request header

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

Example HTTP response

Response 200

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

1.1.22.2 - 1.0

get /v1/tagses/{tags_id}

Description

Tags 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}

Request header

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

Example HTTP response

Response 200

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

1.1.23 - Show Tags Packages

1.1.23.1 - 1.1

get /v1/tagses/{tags_id}/packages

Description

Package 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS 이름 또는 언어 이름 Example : `Java`	any of [string, null]	None
query	package_name optional	패키지명 Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/packages

Request header

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

Example HTTP response

Response 200

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

1.1.23.2 - 1.0

get /v1/tagses/{tags_id}/packages

Description

Package 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS 이름 또는 언어 이름 Example : `Java`	any of [string, null]	None
query	package_name optional	패키지명 Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/packages

Request header

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

Example HTTP response

Response 200

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

1.1.24 - Show Tags Secrets

1.1.24.1 - 1.1

get /v1/tagses/{tags_id}/secrets

Description

Secret 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/secrets

Request header

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

Example HTTP response

Response 200

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

1.1.24.2 - 1.0

get /v1/tagses/{tags_id}/secrets

Description

Secret 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/secrets

Request header

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

Example HTTP response

Response 200

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

1.1.25 - Show Tags Vulnerabilities

1.1.25.1 - 1.1

get /v1/tagses/{tags_id}/vulnerabilities

Description

취약점 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS 이름 또는 언어 이름 Example : `Java`	any of [string, null]	None
query	package_name optional	패키지명 Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	update_version_available optional	수정 버전 Example : `True`	any of [boolean, null]	None
query	severity optional	심각도 Example : `High`	any of [array[string], string, null]	None
query	category optional	카테고리 Example : `Language`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/vulnerabilities

Request header

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

Example HTTP response

Response 200

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

1.1.25.2 - 1.0

get /v1/tagses/{tags_id}/vulnerabilities

Description

취약점 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	tags_id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string	None
query	os_language optional	OS 이름 또는 언어 이름 Example : `Java`	any of [string, null]	None
query	package_name optional	패키지명 Example : `com.example.sample`	any of [string, null]	None
query	sort optional	sort Example : `name:asc`	any of [string, null]	None
query	page optional	page Example : `0`	any of [integer, null]	None
query	size optional	size Example : `20`	any of [integer, null]	None
query	update_version_available optional	수정 버전 Example : `True`	any of [boolean, null]	None
query	severity optional	심각도 Example : `High`	any of [array[string], string, null]	None
query	category optional	카테고리 Example : `Language`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/tagses/{tags_id}/vulnerabilities

Request header

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

Example HTTP response

Response 200

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

1.1.26 - Update Image Description

1.1.26.1 - 1.1

put /v1/images/{image_id}/description

Description

Image 설명 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.26.2 - 1.0

put /v1/images/{image_id}/description

Description

Image 설명 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/images/{image_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.27 - Update Image Lifecycle Policy

1.1.27.1 - 1.1

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

Description

Lifecycle 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.27.2 - 1.0

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

Description

Lifecycle 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.28 - Update Image Lock Policy

1.1.28.1 - 1.1

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

Description

Lock 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.28.2 - 1.0

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

Description

Lock 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.29 - Update Image Pull Policy

1.1.29.1 - 1.1

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

Description

Pull 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.29.2 - 1.0

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

Description

Pull 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.30 - Update Image Scan Policy

1.1.30.1 - 1.1

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

Description

Scan 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.30.2 - 1.0

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

Description

Scan 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.31 - Update Private Acl

1.1.31.1 - 1.1

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

Description

Private 접근 제어 설정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.31.2 - 1.0

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

Description

Private 접근 제어 설정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.32 - Update Public Acl

1.1.32.1 - 1.1

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

Description

Public 접근 제어 설정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.32.2 - 1.0

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

Description

Public 접근 제어 설정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.33 - Update Public Endpoint Enabled

1.1.33.1 - 1.1

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

Description

Public Endpoint 활성화

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

{
    "public_endpoint_enabled": true
}

Example HTTP response

Response 200

1.1.33.2 - 1.0

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

Description

Public Endpoint 활성화

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

{
    "public_endpoint_enabled": true
}

Example HTTP response

Response 200

1.1.34 - Update Repository Description

1.1.34.1 - 1.1

put /v1/repositories/{repository_id}/description

Description

Repository 설명 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.34.2 - 1.0

put /v1/repositories/{repository_id}/description

Description

Repository 설명 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/repositories/{repository_id}/description

Request header

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

Request body

{
    "description": "Carpe diem."
}

Example HTTP response

Response 200

1.1.35 - Update Repository Lifecycle Policy

1.1.35.1 - 1.1

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

Description

Lifecycle 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.35.2 - 1.0

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

Description

Lifecycle 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.36 - Update Repository Lock Policy

1.1.36.1 - 1.1

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

Description

Lock 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.36.2 - 1.0

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

Description

Lock 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.37 - Update Repository Pull Policy

1.1.37.1 - 1.1

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

Description

Pull 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.37.2 - 1.0

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

Description

Pull 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.38 - Update Repository Scan Policy

1.1.38.1 - 1.1

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

Description

Scan 정책 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.38.2 - 1.0

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

Description

Scan 정책 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.39 - Update Tags Lock Policy

1.1.39.1 - 1.1

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

Description

태그 잠금 갱신

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.1.39.2 - 1.0

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

Description

태그 잠금 갱신

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260630

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

1.2 - Models

1.2.1 - CheckDuplicationResponse

Name	Description	Schema	Default
result required	이름 중복 여부 Example : `True`	boolean

1.2.2 - ConnectableResource

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

1.2.3 - ConnectableResourceListResponse

Name	Description	Schema	Default
count required	Pull 횟수 Example : `20`	integer
resources required	내용	array[ConnectableResource]

1.2.4 - ContainerRegistry

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
bucket_id required	Bucket ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
bucket_name required	Bucket명 Example : `4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup`	string
bucket_usage required	Bucket 사용량 Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Registry명 Example : `sample`	string
private_acl_enabled required	Private 접근 제어 활성화 Example : `True`	boolean
private_acl_resources required	Private 접근 허용 리소스 리스트	array[Resource]
private_domain required	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com`	string
public_acl_enabled optional	Public 접근 제어 활성화 Example : `True`	any of [boolean, null]
public_acl_resources required	Public 접근 허용 리소스 리스트	array[Resource]
public_domain optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com`	any of [string, null]
public_endpoint_enabled optional	Public Endpoint 활성화 Example : `True`	any of [boolean, null]
public_visible_enabled required	가시성 Public 선택 여부 Example : `True`	boolean
state required	Registry 상태 Example : `Running`	string

1.2.5 - ContainerRegistryCreateRequest

Name	Description	Schema
name required	Registry명 Example : `sample` Pattern : `^[a-z][a-z0-9]$` Minimum length* : `3` Maximum length : `25`	string
private_acl_enabled required	Private 접근 제어 활성화 Example : `True`	boolean
private_acl_resources required	Private 접근 허용 리소스 리스트	array[Resource]
public_acl_enabled optional	Public 접근 제어 활성화 Example : `True`	any of [boolean, null]
public_acl_resources required	Public 접근 허용 리소스 리스트	array[Resource]
public_endpoint_enabled optional	Public Endpoint 활성화 Example : `True`	any of [boolean, null]
public_visible_enabled required	가시성 Public 선택 여부 Example : `True`	boolean
tags optional	태그 목록	any of [array[Tag], null]

1.2.6 - ContainerRegistryCreateResponse

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

1.2.7 - ContainerRegistryForList

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
bucket_name required	Bucket명 Example : `4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Registry명 Example : `sample`	string
private_domain optional	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com`	any of [string, null]
public_domain optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com`	any of [string, null]
public_visible_enabled required	가시성 Public 선택 여부 Example : `True`	boolean
state required	Registry 상태 Example : `Running`	string

1.2.8 - ContainerRegistryListResponse

Name	Description	Schema	Default
count required	Pull 횟수 Example : `20`	integer
registries required	내용	array[ContainerRegistryForList]

1.2.9 - ContainerRegistryShowResponse

Name	Description	Schema	Default
registry required		ContainerRegistry

1.2.10 - Cve

Name	Description	Schema
category required	카테고리 Example : `Language`	string
current_version required	현재 버전 Example : `2.9.9.1`	string
cve_code required	Cve code Example : `CVE-2019-1454`	string
description required	설명 Example : `A Polymorphic Typing issue was discovered in FasterXML.`	string
links required	페이지 링크 URL Example : `https://nvd.nist.gov/vuln/detail/CVE-2019-1454`	string
os_language optional	OS 이름 또는 언어 이름 Example : `Java`	any of [string, null]
package_name optional	패키지명 Example : `com.example.sample`	any of [string, null]
severity required	심각도 Example : `High`	string
update_version required	수정 버전 Example : `2.9.10, 2.8.11.5, 2.6.7.3`	string
vectors required		Vectors

1.2.11 - Image

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example : `Carpe diem.`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lifecycle_policy optional	Lifecycle 정책	any of [LifecyclePolicy, null]
lock_policy optional	Lock 정책	any of [LockPolicy, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	이미지명 Example : `sample`	string
pull_count required	Pull 횟수 Example : `100`	integer
pull_policy optional	Pull 정책	any of [PullPolicy, null]
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
scan_policy optional	Scan 정책	any of [ScanPolicy, null]
state required	이미지 상태 Example : `Active`	string

1.2.12 - ImageForList

Name	Description	Schema
created_at required	생성일시 Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
id required	이미지 ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string
modified_at required	수정일시 Example : `2024-08-16T16:06:09.701645823+09:00`	string (date-time)
name required	이미지명 Example : `sample`	string
private_endpoint_url optional	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817`	any of [string, null]
public_endpoint_url optional	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817`	any of [string, null]
pull_count required	Pull 횟수 Example : `20`	integer
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
state required	이미지 상태 Example : `Active`	string

1.2.13 - ImageListResponse

Name	Description	Schema	Default
count required	Pull 횟수 Example : `20`	integer
images required	내용	array[ImageForList]

1.2.14 - ImageSetRequest

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

1.2.15 - ImageShowResponse

Name	Description	Schema	Default
image required		Image

1.2.16 - ImageShowResponseV1_1

Name	Description	Schema	Default
image required		ImageV1_1

1.2.17 - ImageV1_1

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example : `Carpe diem.`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lifecycle_policy optional	Lifecycle 정책	any of [LifecyclePolicyV1_1, null]
lock_policy optional	Lock 정책	any of [LockPolicy, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	이미지명 Example : `sample`	string
pull_count required	Pull 횟수 Example : `100`	integer
pull_policy optional	Pull 정책	any of [PullPolicy, null]
registry_id required	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
scan_policy optional	Scan 정책	any of [ScanPolicy, null]
state required	이미지 상태 Example : `Active`	string

1.2.18 - LifecyclePolicy

Name	Description	Schema
lifecycle_policy_enabled required	Lifecycle 정책 활성화 Example : `True`	boolean
outdated_rule_duration required	Tagged rule duration Example : `90` Maximum : `999`	integer
outdated_rule_enabled required	Tagged rule enabled Example : `True`	boolean
untagged_rule_duration required	Untagged Image 자동 삭제 기한 Example : `90` Maximum : `999`	integer
untagged_rule_enabled required	Untagged Image 자동 삭제 활성화 Example : `True`	boolean

1.2.19 - LifecyclePolicyPreview

Name	Description	Schema
created_at required	생성일시 Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
hash_digest required	Hash digest Example :	string
reference_tags required	참조 중인 tags 목록 Example : `["sample"]`	array[string]
state required	태그 상태 Example : `Active`	string

1.2.20 - LifecyclePolicyPreviewResponseV1_1

Name	Description	Schema
count required	Pull 횟수 Example : `20`	any of [integer, null]
outdated_rule_duration required	Tagged rule duration Example : `10`	any of [integer, null]
outdated_rule_enabled required	Tagged rule enabled Example : `True`	any of [boolean, null]
outdated_rule_tag_expression required	Tagged rule tag expression Example : `*`	any of [string, null]
preview_run_at optional	Lifecycle 정책 Preview 수행일시 Example : `2024-08-15T13:05:09.701645823+09:00`	any of [string (date-time), null]
preview_run_state required	Lifecycle 정책 Preview 수행상태 Example : `Active`	string
previews required	내용	any of [array[LifecyclePolicyPreview], null]
untagged_rule_duration required	Untagged Image 자동 삭제 기한 Example : `10`	any of [integer, null]
untagged_rule_enabled required	Untagged Image 자동 삭제 활성화 Example : `True`	any of [boolean, null]

1.2.21 - LifecyclePolicySetRequest

Name	Description	Schema	Default
lifecycle_policy required		LifecyclePolicy

1.2.22 - LifecyclePolicySetRequestV1_1

Name	Description	Schema	Default
lifecycle_policy required		LifecyclePolicyV1_1

1.2.23 - LifecyclePolicyV1_1

Name	Description	Schema
lifecycle_policy_enabled required	Lifecycle 정책 활성화 Example : `True`	boolean
outdated_rule_duration required	Tagged rule duration Example : `90` Maximum : `999`	integer
outdated_rule_enabled required	Tagged rule enabled Example : `True`	boolean
outdated_rule_tag_expression required	Tagged rule tag expression Example : `` Pattern* : `^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,130}$` Minimum length : `1` Maximum length : `130`	string
untagged_rule_duration required	Untagged Image 자동 삭제 기한 Example : `90` Maximum : `999`	integer
untagged_rule_enabled required	Untagged Image 자동 삭제 활성화 Example : `True`	boolean

1.2.24 - LockPolicy

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

1.2.25 - LockPolicySetRequest

Name	Description	Schema	Default
lock_policy required		LockPolicy

1.2.26 - PackageListResponse

Name	Description	Schema
filtered_count required	검색 결과 갯수 Example : `30`	integer
last_scanned_at required	마지막 스캔 일시 Example : `2024-08-15T13:05:09.701645823+09:00`	string
package_reports required	내용	array[PackageReport]
package_reports_count required	Pull 횟수 Example : `30`	integer
release_version required	OS 배포 버전 Example : `alpine:3.14.10`	string
scan_summary required		ScanSummary

1.2.27 - PackageReport

Name	Description	Schema
category required	카테고리 Example : `Language`	string
os_language optional	OS 이름 또는 언어 이름 Example : `Java`	any of [string, null]
package_name optional	패키지명 Example : `com.example.sample`	any of [string, null]
scan_summary required		ScanSummary
type required	Pipeline 유형 Example : `os-pkg(binary)`	string
version required	OS 배포 버전 Example : `0.7.2-r3`	string

1.2.28 - PrivateAclSetRequest

Name	Description	Schema	Default
private_acl_enabled required	Private 접근 제어 활성화 Example : `True`	boolean
private_acl_resources required	Private 접근 허용 리소스 리스트	array[Resource]

1.2.29 - PublicAclSetRequest

Name	Description	Schema	Default
public_acl_enabled required	Public 접근 제어 활성화 Example : `True`	boolean
public_acl_resources required	Public 접근 허용 리소스 리스트	array[Resource]

1.2.30 - PublicEndpointEnabledSetRequest

Name	Description	Schema	Default
public_endpoint_enabled required	Public Endpoint 활성화 Example : `True`	boolean

1.2.31 - PullPolicy

Name	Description	Schema
critical_limit optional	Critical 심각도 Example : `20`	any of [integer, null]
high_limit optional	High 심각도 Example : `20`	any of [integer, null]
unmodified_excepted required	수정 버전이 없는 취약점 제외 여부 Example : `True`	boolean
unscanned_image_pull_prevented required	스캔 되지 않은 이미지 Pull 제한 여부 Example : `True`	boolean
vulnerable_image_pull_prevented required	취약점이 있는 이미지 Pull 제한 여부 Example : `True`	boolean

1.2.32 - PullPolicySetRequest

Name	Description	Schema	Default
pull_policy required		PullPolicy

1.2.33 - Repository

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

1.2.34 - RepositoryCreateRequest

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

1.2.35 - RepositoryCreateRequestV1_1

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

1.2.36 - RepositoryCreateResponse

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

1.2.37 - RepositoryForList

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Repository명 Example : `sample`	string
registry_id optional	Registry ID Example : `rpqtmqgec3174541bbf77eecf2cd3585`	string
state required	Repository 상태 Example : `Active`	string

1.2.38 - RepositoryListResponse

Name	Description	Schema	Default
count required	Pull 횟수 Example : `20`	integer
repositories required		array[RepositoryForList]

1.2.39 - RepositorySetRequest

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

1.2.40 - RepositoryShowResponse

Name	Description	Schema	Default
repository required		Repository

1.2.41 - RepositoryShowResponseV1_1

Name	Description	Schema	Default
repository required		RepositoryV1_1

1.2.42 - RepositoryV1_1

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

1.2.43 - Resource

Name	Description	Schema
resource_id optional	자원 ID Example : `558496f6c49d43459e61e191fb3c08fe`	any of [string, null]
resource_ips optional	자원 IP 목록 Example : `[]`	any of [array[string], null]
resource_name optional	자원명 Example : `sample`	any of [string, null]
resource_type optional	자원 타입 Example : `virtualServer`	any of [string, null]

1.2.44 - ScanPolicy

Name	Description	Schema
auto_scan_enabled required	이미지 자동 스캔 여부 Example : `True`	boolean
fixed_version_excepted required	Fixed version 제외 여부 Example : `True`	boolean
language_excepted required	Language 제외 여부 Example : `True`	boolean
scan_policy_enabled required	스캔 제외 정책 여부 Example : `True`	boolean
secret_excepted required	Secret 제외 여부 Example : `True`	boolean
severity_limit required	취약점 레벨 Example : `High`	string

1.2.45 - ScanPolicySetRequest

Name	Description	Schema	Default
scan_policy required		ScanPolicy

1.2.46 - ScanSummary

Name	Description	Schema
critical required	Critical 취약점 수 Example : `10`	integer
high required	High 취약점 수 Example : `10`	integer
low required	Low 취약점 수 Example : `10`	integer
medium required	Medium 취약점 수 Example : `10`	integer
negligible required	Negligible 취약점 수 Example : `10`	integer
total_vulnerability required	Low 취약점 수 Example : `60`	integer
unknown required	Low 취약점 수 Example : `10`	integer

1.2.47 - SecretListResponse

Name	Description	Schema
filtered_count required	검색 결과 갯수 Example : `30`	integer
last_scanned_at required	마지막 스캔 일시 Example : `2024-08-16T16:06:09.701645823+09:00`	string
release_version required	OS 배포 버전 Example : `alpine:3.14.10`	string
secret_reports required	내용	array[SecretReport]
secret_summary required		SecretSummary

1.2.48 - SecretReport

Name	Description	Schema
category required	카테고리 Example : `Language`	string
file_name required	시크릿 파일명 Example : `/certs/sample-key1.key`	string
match required	시크릿 매치 Example : `-----BEGIN SAMPLE KEY-----*********************...`	string
rule_id required	시크릿 룰 ID Example : `private-key`	string
severity required	심각도 Example : `High`	string
start_line required	시크릿 시작점 Example : `1`	integer
target required	대상 Example : `/certs/sample-key1.key`	string
title required	시크릿 제목 Example : `Asymmetric Private Key`	string
vulnerability_class required	시크릿 취약점 클래스 Example : `secret`	string

1.2.49 - SecretSummary

Name	Description	Schema
critical required	Critical 취약점 수 Example : `10`	integer
high required	High 취약점 수 Example : `10`	integer
low required	Low 취약점 수 Example : `10`	integer
medium required	Medium 취약점 수 Example : `10`	integer
total_secret required	Pull 횟수 Example : `50`	integer
unknown required	Low 취약점 수 Example : `10`	integer

1.2.50 - Tag

Name	Description	Schema	Default
key required	태그키 Example :	string
value required	태그값 Example :	any of [string, null]

1.2.51 - TagDeleteRequest

Name	Description	Schema	Default
tag_names required	태그명 Example : `["sample"]`	array[string]

1.2.52 - Tags

Name	Description	Schema
created_at required	생성일시 Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
hash_digest required	Hash digest Example :	string
id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string
image_id required	이미지 ID Example : `5b5ed4f2881a440583536fc1a8c39a28`	string
lock_policy optional	Lock 정책	any of [LockPolicy, null]
manifest required	매니페스트 Example :	string
manifest_media_type required	Manifest 미디어 타입 Example :	string
modified_at required	수정일시 Example : `2024-08-16T16:06:09.701645823+09:00`	string (date-time)
reference_tags required	참조 중인 tags 목록 Example : `["sample"]`	array[string]
registry_id optional	Example :	string
repository_id required	Repository ID Example : `e5611ca6c1484df480668c5adce8b078`	string
state required	태그 상태 Example : `Active`	string

1.2.53 - TagsDeleteRequest

Name	Description	Schema	Default
tags_ids required	태그 ID 목록 Example : `["b48210c7a226460fa15b6e3e221b30b0"]`	array[string]

1.2.54 - TagsForList

Name	Description	Schema
hash_digest required	Hash digest Example :	string
id required	Tags ID Example : `b48210c7a226460fa15b6e3e221b30b0`	string
last_scanned_at required	마지막 스캔 일시 Example : `2024-08-15T13:05:09.701645823+09:00`	string (date-time)
lock_policy optional	Lock 정책	any of [LockPolicy, null]
modified_at required	수정일시 Example : `2024-08-16T16:06:09.701645823+09:00`	string (date-time)
private_endpoint_url required	Private Endpoint URL Example : `sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd`	string
public_endpoint_url required	Public Endpoint URL Example : `sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234...abcd`	string
re_scan_needed required	취약점 점검 재시도 필요 여부 Example : `True`	boolean
reference_tags required	참조 중인 tags 목록 Example : `["sample"]`	array[string]
referenced_by required	참조 여부 Example :	string
scan_state required	스캔 상태 Example : `Scanning state`	string
scan_summary required		ScanSummary
size required	크기 Example : `10`	integer
state required	태그 상태 Example : `Active`	string

1.2.55 - TagsListResponse

Name	Description	Schema	Default
count required	Pull 횟수 Example : `10`	integer
tagses required	Pull 횟수	array[TagsForList]

1.2.56 - TagsShowResponse

Name	Description	Schema	Default
tags required		Tags

1.2.57 - VectorInfo

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

1.2.58 - VectorInfos

Name	Description	Schema
attack_complexity required	공격 복잡성	array[VectorInfo]
attack_vector required	공격 벡터	array[VectorInfo]
availability required	가용성	array[VectorInfo]
confidentiality required	기밀성	array[VectorInfo]
integrity required	무결성	array[VectorInfo]
privileges_required required	필요한 권한	array[VectorInfo]
scope required	공격 범위	array[VectorInfo]
user_interaction required	사용자 참여 정도	array[VectorInfo]

1.2.59 - Vectors

Name	Description	Schema
attack_complexity required	공격 복잡성 Example : `High`	string
attack_vector required	공격 벡터 Example : `NETWORK`	string
availability required	가용성 Example : `High`	string
base_severity required	기본 심각도 Example :	string
confidentiality required	기밀성 Example : `High`	string
cvss required	취약점 등급 시스템 Example : `9.8`	object
integrity required	무결성 Example : `High`	string
privileges_required required	필요한 권한 Example : `Low`	string
scope required	공격 범위 Example :	string
user_interaction required	사용자 참여 정도 Example : `Low`	string

1.2.60 - VulnerabilityListResponse

Name	Description	Schema
filtered_count required	검색 결과 갯수 Example : `30`	integer
vector_info required		VectorInfos
vulnerability_report required	내용	VulnerabilityReport

1.2.61 - VulnerabilityReport

Name	Description	Schema
cves required		array[Cve]
last_scanned_at required	마지막 스캔 일시 Example : `2024-08-16T16:06:09.701645823+09:00`	string
release_version required	OS 배포 버전 Example : `alpine:3.14.10`	string
scan_summary required		ScanSummary

2 - Kubernetes

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 KUBERNETES 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

OpenAPI URL

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

Environment and Region List

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

2.1 - APIs

2.1.1 - Create Cluster

2.1.1.1 - 1.1

post /v1/clusters

Description

create a cluster V1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ClusterCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/clusters

Request header

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

Request body

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

Example HTTP response

Response 202

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

2.1.1.2 - 1.0

post /v1/clusters

Description

create a cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		ClusterCreateRequest

Responses

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

Example HTTP request

Request path

/v1/clusters

Request header

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

Request body

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

Example HTTP response

Response 202

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

2.1.2 - Create Cluster Kubeconfig

2.1.2.1 - 1.1

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig 타입 (private/public) Example : `private`	enum (private, public)	None

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

2.1.2.2 - 1.0

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig 타입 (private/public) Example : `private`	enum (private, public)	None

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

2.1.3 - Create Nodepool

2.1.3.1 - 1.1

post /v1/nodepools

Description

create a nodepool V1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		NodepoolCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/nodepools

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.3.2 - 1.0

post /v1/nodepools

Description

create a nodepool

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		NodepoolCreateRequest

Responses

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

Example HTTP request

Request path

/v1/nodepools

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.4 - Delete Cluster

2.1.4.1 - 1.1

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

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

Example HTTP response

Response 202

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

2.1.4.2 - 1.0

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

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

Example HTTP response

Response 202

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

2.1.5 - Delete Nodepool

2.1.5.1 - 1.1

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

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

Example HTTP response

Response 202

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

2.1.5.2 - 1.0

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

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

Example HTTP response

Response 202

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

2.1.6 - List Clusters

2.1.6.1 - 1.1

get /v1/clusters

Description

get clusters list

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	클러스터 이름 Example : `sample-cluster`	any of [string, null]	None
query	status optional	클러스터 상태 Example : `RUNNING`	any of [array[string], string, null]	None
query	kubernetes_version optional	클러스터 버전 Example : `v1.29.8`	any of [array[string], string, null]	None
query	subnet_id optional	클러스터 Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/clusters

Request header

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

Example HTTP response

Response 200

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

2.1.6.2 - 1.0

get /v1/clusters

Description

get clusters list

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	클러스터 이름 Example : `sample-cluster`	any of [string, null]	None
query	status optional	클러스터 상태 Example : `RUNNING`	any of [array[string], string, null]	None
query	kubernetes_version optional	클러스터 버전 Example : `v1.29.8`	any of [array[string], string, null]	None
query	subnet_id optional	클러스터 Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/clusters

Request header

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

Example HTTP response

Response 200

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

2.1.7 - List Kubernetes Versions

2.1.7.1 - 1.1

get /v1/kubernetes-versions

Description

get kubernetes versions list

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Responses

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

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

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

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

2.1.7.2 - 1.0

get /v1/kubernetes-versions

Description

get kubernetes versions list

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Responses

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

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

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

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

2.1.8 - List Nodepool Nodes

2.1.8.1 - 1.1

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

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

Example HTTP response

Response 200

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

2.1.8.2 - 1.0

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

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

Example HTTP response

Response 200

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

2.1.9 - List Nodepools

2.1.9.1 - 1.1

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	nodepool_name optional	노드풀 이름 Example : `sample-nodepool`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

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

Example HTTP response

Response 200

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

2.1.9.2 - 1.0

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	nodepool_name optional	노드풀 이름 Example : `sample-nodepool`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

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

Example HTTP response

Response 200

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

2.1.10 - Set Cluster Logging

2.1.10.1 - 1.1

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterLoggingSetRequest

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

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

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

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

2.1.10.2 - 1.0

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterLoggingSetRequest

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

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

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

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

2.1.11 - Set Cluster Private Access Control

2.1.11.1 - 1.1

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

Description

set a private access control specific cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPrivateAccessControlSetRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

2.1.11.2 - 1.0

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

Description

set a private access control specific cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPrivateAccessControlSetRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

2.1.12 - Set Cluster Public Access Control

2.1.12.1 - 1.1

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

Description

set a public access control specific cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPublicAccessControlSetRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

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

2.1.12.2 - 1.0

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

Description

set a public access control specific cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterPublicAccessControlSetRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

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

2.1.13 - Set Cluster Security Groups

2.1.13.1 - 1.1

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

Description

Set Cluster Security Groups

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterSecurityGroupsSetRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.13.2 - 1.0

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

Description

Set Cluster Security Groups

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterSecurityGroupsSetRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.14 - Set Cluster Service Watch Logging

2.1.14.1 - 1.1

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

Description

Set Service Watch logging on the cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterServiceWatchLoggingSetRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

{
    "service_watch_logging_enabled": "true"
}

Example HTTP response

Response 200

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

2.1.15 - Set Cluster Upgrade

2.1.15.1 - 1.1

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterUpgradeSetRequest

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

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

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

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

2.1.15.2 - 1.0

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
body	body required		ClusterUpgradeSetRequest

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

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

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

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

2.1.16 - Set Nodepool

2.1.16.1 - 1.1

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.16.2 - 1.0

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.17 - Set Nodepool Labels

2.1.17.1 - 1.1

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.17.2 - 1.0

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.18 - Set Nodepool Taints

2.1.18.1 - 1.1

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.18.2 - 1.0

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

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

Request body

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

Example HTTP response

Response 200

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

2.1.19 - Set Nodepool Upgrade

2.1.19.1 - 1.1

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

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

Request body

{
    "os_version": "22.04"
}

Example HTTP response

Response 200

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

2.1.19.2 - 1.0

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

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

Example HTTP response

Response 200

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

2.1.20 - Show Cluster

2.1.20.1 - 1.1

get /v1/clusters/{cluster_id}

Description

show a cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

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

Example HTTP response

Response 200

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

2.1.20.2 - 1.0

get /v1/clusters/{cluster_id}

Description

show a cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None

Responses

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

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

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

Example HTTP response

Response 200

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

2.1.21 - Show Cluster User Kubeconfig

2.1.21.1 - 1.1

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

Description

Show user kubeconfig for the cluster

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig 타입 (private/public) Example : `private`	enum (private, public)	None

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

2.1.21.2 - 1.0

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

Description

Show user kubeconfig for the cluster

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string	None
query	kubeconfig_type required	Kubeconfig 타입 (private/public) Example : `private`	enum (private, public)	None

Responses

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

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

2.1.22 - Show Nodepool

2.1.22.1 - 1.1

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

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

Example HTTP response

Response 200

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

2.1.22.2 - 1.0

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

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

Example HTTP response

Response 200

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

2.2 - Models

2.2.1 - AsyncResponse

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
request_id required	요청 ID Example : `80a599e031e749b7b260868f441e862b`	string
resource_id required	자원 ID Example : `70a599e031e749b7b260868f441e862b`	string

2.2.2 - Cluster

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
cloud_logging_enabled required	클라우드 로깅 사용 여부 Example : `true`	boolean
cluster_namespace required	클러스터 네임스페이스 Example : `sample-cluster-12345`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
kubernetes_version required	클러스터 버전 Example : `v1.29.8`	string
managed_security_group required	Managed Security Group	any of [ExternalResource, null]
max_node_count required	클러스터 최대 노드 수 Example : `5`	any of [integer, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	클러스터 이름 Example : `sample-cluster`	string
node_count required	클러스터 노드 수 Example : `5`	any of [integer, null]
private_endpoint_access_control_resources required	Private Endpoint 접근 제어 리소스 목록	any of [array[PrivateEndpointAccessControlResource], null]
private_endpoint_url required	Private Kubeconfig Download Yn Example : `N`	string
private_kubeconfig_download_yn required	Cluster의 Private Endpoint URL Example : `https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443`	string
public_endpoint_access_control_ip required	Public Endpoint 접근 제어 IP Example : `192.168.0.0`	any of [string, null]
public_endpoint_url required	Public Endpoint 접근 제어 IP Example : `https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443`	any of [string, null]
public_kubeconfig_download_yn required	Public Kubeconfig Download Yn Example : `N`	string
security_group_list required	연결된 Security Group	array[ExternalResource]
status required	클러스터 상태 Example : `RUNNING`	string
subnet required	Cluster가 사용하는 Subnet	any of [ExternalResource, null]
volume required	연결된 File Storage	any of [ExternalResource, null]
vpc required	Cluster가 사용하는 VPC	any of [ExternalResource, null]

2.2.3 - ClusterCreateRequest

Name	Description	Schema
cloud_logging_enabled required	클라우드 로깅 사용 여부 Example : `true`	boolean
kubernetes_version required	클러스터 버전 Example : `v1.29.8` Pattern : `^v[0-9]{1}\.[0-9]{1,2}\.[0-9]{1,2}$`	string
name required	클러스터 이름 Example : `sample-cluster` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
private_endpoint_access_control_resources optional	Private Endpoint 접근 제어 리소스 목록	any of [array[PrivateEndpointAccessControlResource], null]
public_endpoint_access_control_ip optional	Public Endpoint 접근 제어 IP Example : `192.168.0.0`	any of [string, null]
security_group_id_list required	Security group ID 목록 Example : `['bdfda539-bd2e-4a5c-9021-ec6d52d1ca79']`	array[string]
subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
tags optional	태그 목록	any of [array[Tag], null]
volume_id required	볼륨 ID Example : `['bfdbabf2-04d9-4e8b-a205-020f8e6da438']`	string
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string

2.2.4 - ClusterCreateRequestV1Dot1

Name	Description	Schema
cloud_logging_enabled required	클라우드 로깅 사용 여부 Example : `true`	boolean
kubernetes_version required	클러스터 버전 Example : `v1.29.8` Pattern : `^v[0-9]{1}\.[0-9]{1,2}\.[0-9]{1,2}$`	string
name required	클러스터 이름 Example : `sample-cluster` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
private_endpoint_access_control_resources optional	Private Endpoint 접근 제어 리소스 목록	any of [array[PrivateEndpointAccessControlResource], null]
public_endpoint_access_control_ip optional	Public Endpoint 접근 제어 IP Example : `192.168.0.0`	any of [string, null]
security_group_id_list required	Security group ID 목록 Example : `['bdfda539-bd2e-4a5c-9021-ec6d52d1ca79']`	array[string]
service_watch_logging_enabled required	Service Watch 사용 여부 Example : `true`	boolean
subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
tags optional	태그 목록	any of [array[Tag], null]
volume_id required	볼륨 ID Example : `['bfdbabf2-04d9-4e8b-a205-020f8e6da438']`	string
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string

2.2.5 - ClusterListResponse

Name	Description	Schema
clusters required		array[ClusterSummary]
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

2.2.6 - ClusterLoggingSetRequest

Name	Description	Schema	Default
cloud_logging_enabled required	클라우드 로깅 사용 여부 Example : `true`	boolean

2.2.7 - ClusterOfNodepool

Name	Description	Schema	Default
id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string

2.2.8 - ClusterPrivateAccessControlSetRequest

Name	Description	Schema	Default
private_endpoint_access_control_resources required		array[PrivateEndpointAccessControlResource]

2.2.9 - ClusterPublicAccessControlSetRequest

Name	Description	Schema	Default
public_endpoint_access_control_ip required	Public Endpoint 접근 제어 IP Example : `192.168.0.0`	string

2.2.10 - ClusterSecurityGroupsSetRequest

Name	Description	Schema	Default
security_group_id_list required	Security group ID 목록 Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	array[string]

2.2.11 - ClusterServiceWatchLoggingSetRequest

Name	Description	Schema	Default
service_watch_logging_enabled required	Service Watch 사용 여부 Example : `true`	boolean

2.2.12 - ClusterSetResponse

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
request_id required	요청 ID Example : `80a599e031e749b7b260868f441e862b`	string
resource_id required	자원 ID Example : `70a599e031e749b7b260868f441e862b`	string

2.2.13 - ClusterShowResponse

Name	Description	Schema	Default
cluster required		Cluster

2.2.14 - ClusterShowResponseV1Dot1

Name	Description	Schema	Default
cluster required		ClusterV1Dot1

2.2.15 - ClusterSummary

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
created_at required	생성 시간 Example : `2025-03-31T00:23:17Z`	string (date-time)
id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string
kubernetes_version required	클러스터 버전 Example : `v1.29.8`	string
modified_at required	수정 시간 Example : `2025-03-31T00:23:17Z`	string (date-time)
name required	클러스터 이름 Example : `sample-cluster`	string
node_count required	클러스터 노드 수 Example : `5`	any of [integer, null]
status required	클러스터 상태 Example : `RUNNING`	string
subnet_id required	클러스터 Subnet ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]

2.2.16 - ClusterUpgradeSetRequest

Name	Description	Schema	Default
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string

2.2.17 - ClusterV1Dot1

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
cloud_logging_enabled required	클라우드 로깅 사용 여부 Example : `true`	boolean
cluster_namespace required	클러스터 네임스페이스 Example : `sample-cluster-12345`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
kubernetes_version required	클러스터 버전 Example : `v1.29.8`	string
managed_security_group required	Managed Security Group	any of [ExternalResource, null]
max_node_count required	클러스터 최대 노드 수 Example : `5`	any of [integer, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	클러스터 이름 Example : `sample-cluster`	string
node_count required	클러스터 노드 수 Example : `5`	any of [integer, null]
private_endpoint_access_control_resources required	Private Endpoint 접근 제어 리소스 목록	any of [array[PrivateEndpointAccessControlResource], null]
private_endpoint_url required	Private Kubeconfig Download Yn Example : `N`	string
private_kubeconfig_download_yn required	Cluster의 Private Endpoint URL Example : `https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443`	string
public_endpoint_access_control_ip required	Public Endpoint 접근 제어 IP Example : `192.168.0.0`	any of [string, null]
public_endpoint_url required	Public Endpoint 접근 제어 IP Example : `https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443`	any of [string, null]
public_kubeconfig_download_yn required	Public Kubeconfig Download Yn Example : `N`	string
security_group_list required	연결된 Security Group	array[ExternalResource]
service_watch_logging_enabled required	Service Watch 사용 여부 Example : `true`	boolean
status required	클러스터 상태 Example : `RUNNING`	string
subnet required	Cluster가 사용하는 Subnet	any of [ExternalResource, null]
volume required	연결된 File Storage	any of [ExternalResource, null]
vpc required	Cluster가 사용하는 VPC	any of [ExternalResource, null]

2.2.18 - ExternalResource

Name	Description	Schema	Default
id required	외부 자원 ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string
name required	외부 자원 이름 Example : `sample-name`	string

2.2.19 - Image

Name	Description	Schema
custom_image_name required	커스텀 이미지 이름 Example : `custom-image`	any of [string, null]
os required	이미지 OS Example : `ubuntu`	string
os_version required	이미지 OS 버전 Example : `22.04`	string

2.2.20 - Keypair

Name	Description	Schema	Default
name required	키페어 이름 Example : `test_keypair`	string

2.2.21 - KubernetesVersionListResponse

Name	Description	Schema	Default
kubernetes_versions required		array[KubernetesVersionSummary]

2.2.22 - KubernetesVersionSummary

Name	Description	Schema	Default
description required	쿠버네티스 버전 Example : `v1.29.8`	any of [string, null]
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string

2.2.23 - NodeInNodepool

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string
name required	노드 이름 Example : `ske-aug-rhel-0805-1-84d799f767-8dr2p`	string
status required	노드풀 상태 Example : `RUNNING`	string

2.2.24 - NodeListInNodepoolResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nodes required	노드 풀의 노드 목록	any of [array[NodeInNodepool], null]

2.2.25 - Nodepool

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
auto_recovery_enabled required	자동 복구 사용 여부 Example : `true`	boolean
auto_scale_enabled required	자동 확장 사용 여부 Example : `true`	boolean
cluster required	클러스터	ClusterOfNodepool
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
current_node_count required	현재 노드 수 Example : `1`	integer
desired_node_count required	요청 노드 수 Example : `2`	integer
id required	노드풀 ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	이미지	Image
keypair required	키페어 이름	Keypair
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string
labels optional	노드풀 레이블 목록	any of [array[NodepoolLabel], null]
max_node_count required	최대 노드 수 Example : `5`	integer
min_node_count required	최소 노드 수 Example : `1`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	노드풀 이름 Example : `sample-nodepool`	string
server_type required	서버 타입	ServerType
status required	노드풀 상태 Example : `Running`	string
taints optional	노드풀 테인트 목록	any of [array[NodepoolTaint], null]
volume_size required	볼륨 크기 Example : `104`	integer
volume_type required	볼륨 타입	VolumeType

2.2.26 - NodepoolAdvancedSettings

Name	Description	Schema
allowed_unsafe_sysctls optional	unsafe sysctl 허용 Example : `kernel.msg*,net.ipv4.route.min_pmtu`	string
container_log_max_files required	컨테이너 로그 최대 파일 수 Example : `5` Minimum : `2` Maximum : `10`	integer
container_log_max_size required	컨테이너 로그 최대 사이즈 MB Example : `10` Minimum : `10` Maximum : `100`	integer
image_gc_high_threshold required	이미지 GC 상한 퍼센트 Example : `85` Minimum : `10` Maximum : `85`	integer
image_gc_low_threshold required	이미지 GC 하한 퍼센트 Example : `80` Minimum : `10` Maximum : `85`	integer
max_pods required	노드당 최대 파드 수 Example : `110` Minimum : `10` Maximum : `250`	integer
pod_max_pids required	파드 최대 PID 수 Example : `4096` Minimum : `1024` Maximum : `4194304`	integer

2.2.27 - NodepoolCreateRequest

Name	Description	Schema
cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string
custom_image_id optional	커스텀 이미지 ID Example : `10a599e031e749b7b260868f441e862b`	any of [string, null]
desired_node_count optional	요청 노드 수 (is_auto_scale = false 일 때 설정) Example : `2`	any of [integer, null]
image_os required	이미지 OS Example : `ubuntu`	string
image_os_version required	이미지 OS 버전 Example : `22.04`	string
is_auto_recovery required	자동 복구 사용 여부 Example : `true`	boolean
is_auto_scale required	자동 확장 사용 여부 Example : `true`	boolean
keypair_name required	키페어 이름 Example : `test_keypair`	string
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string
labels optional	노드풀 레이블 목록	any of [array[NodepoolLabel], null]
max_node_count optional	최대 노드 수 (is_auto_scale = true 일 때 설정) Example : `5`	any of [integer, null]
min_node_count optional	최소 노드 수 (is_auto_scale = true 일 때 설정) Example : `1`	any of [integer, null]
name required	노드풀 이름 Example : `sample-nodepool` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `20`	string
server_type_id required	서버 타입 ID Example : `10a599e031e749b7b260868f441e862b`	string
taints optional	노드풀 테인트 목록	any of [array[NodepoolTaint], null]
volume_size required	볼륨 크기 Example : `104`	integer
volume_type_name required	볼륨 타입 이름 Example : `SSD`	string

2.2.28 - NodepoolCreateRequestV1Dot1

Name	Description	Schema
advanced_settings optional	노드풀 고급 설정	any of [NodepoolAdvancedSettings, null]
cluster_id required	클러스터 ID Example : `70a599e031e749b7b260868f441e862b`	string
custom_image_id optional	커스텀 이미지 ID Example : `10a599e031e749b7b260868f441e862b`	any of [string, null]
desired_node_count optional	요청 노드 수 (is_auto_scale = false 일 때 설정) Example : `2`	any of [integer, null]
image_os required	이미지 OS Example : `ubuntu`	string
image_os_version required	이미지 OS 버전 Example : `22.04`	string
is_auto_recovery required	자동 복구 사용 여부 Example : `true`	boolean
is_auto_scale required	자동 확장 사용 여부 Example : `true`	boolean
keypair_name required	키페어 이름 Example : `test_keypair`	string
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string
labels optional	노드풀 레이블 목록	any of [array[NodepoolLabel], null]
max_node_count optional	최대 노드 수 (is_auto_scale = true 일 때 설정) Example : `5`	any of [integer, null]
min_node_count optional	최소 노드 수 (is_auto_scale = true 일 때 설정) Example : `1`	any of [integer, null]
name required	노드풀 이름 Example : `sample-nodepool` Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `20`	string
server_group_id optional	서버 그룹 ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type_id required	서버 타입 ID Example : `10a599e031e749b7b260868f441e862b`	string
taints optional	노드풀 테인트 목록	any of [array[NodepoolTaint], null]
volume_size required	볼륨 크기 Example : `104`	integer
volume_type_name required	볼륨 타입 이름 Example : `SSD`	string

2.2.29 - NodepoolLabel

Name	Description	Schema	Default
key required	노드풀 레이블 키 Example : `example.com/my-app` Pattern : `^([a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)/)?([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9]$`	string
value optional	노드풀 레이블 값 Example : `bar` Pattern : `^(([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9])?$` Maximum length* : `63`	string

2.2.30 - NodepoolLabelsSetRequest

Name	Description	Schema	Default
labels required		array[NodepoolLabel]

2.2.31 - NodepoolListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nodepools required	노드풀 목록	array[NodepoolSummary]

2.2.32 - NodepoolShowResponse

Name	Description	Schema	Default
nodepool required		Nodepool

2.2.33 - NodepoolShowResponseV1Dot1

Name	Description	Schema	Default
nodepool required		NodepoolV1Dot1

2.2.34 - NodepoolSummary

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
auto_recovery_enabled required	자동 복구 사용 여부 Example :	boolean
auto_scale_enabled required	자동 확장 사용 여부 Example :	boolean
current_node_count required	현재 노드 수 Example : `1`	integer
desired_node_count required	요청 노드 수 Example : `2`	integer
id required	노드풀 ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	이미지	Image
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string
name required	노드풀 이름 Example : `sample-nodepool`	string
server_type required	서버 타입	ServerType
status required	노드풀 상태 Example : `Running`	string
volume_type required	볼륨 타입	VolumeTypeSummary

2.2.35 - NodepoolTaint

Name	Description	Schema
effect required	노드풀 테인트 효과 Example : `NoSchedule`	enum (NoSchedule, NoExecute, PreferNoSchedule)
key required	노드풀 테인트 키 Example : `example.com/my-app` Pattern : `^([a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)/)?([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9]$`	string
value optional	노드풀 테인트 값 Example : `bar` Pattern : `^(([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9])?$` Maximum length* : `63`	string

2.2.36 - NodepoolTaintsSetRequest

Name	Description	Schema	Default
taints required		array[NodepoolTaint]

2.2.37 - NodepoolUpdateRequest

Name	Description	Schema
desired_node_count optional	요청 노드 수 Example : `2`	any of [integer, null]
is_auto_recovery optional	자동 복구 사용 여부 Example : `true`	any of [boolean, null]
is_auto_scale optional	자동 확장 사용 여부 Example : `true`	any of [boolean, null]
max_node_count optional	최대 노드 수 Example : `5`	any of [integer, null]
min_node_count optional	최소 노드 수 Example : `1`	any of [integer, null]

2.2.38 - NodepoolUpgradeSetRequest

Name	Description	Schema	Default
os_version required	이미지 OS 버전 Example : `22.04`	string

2.2.39 - NodepoolV1Dot1

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
advanced_settings optional	노드풀 고급 설정	any of [NodepoolAdvancedSettings, null]
auto_recovery_enabled required	자동 복구 사용 여부 Example : `true`	boolean
auto_scale_enabled required	자동 확장 사용 여부 Example : `true`	boolean
cluster required	클러스터	ClusterOfNodepool
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
current_node_count required	현재 노드 수 Example : `1`	integer
desired_node_count required	요청 노드 수 Example : `2`	integer
id required	노드풀 ID Example : `bdfda539-bd2e-4a5c-9021-ec6d52d1ca79`	string
image required	이미지	Image
keypair required	키페어 이름	Keypair
kubernetes_version required	쿠버네티스 버전 Example : `v1.29.8`	string
labels optional	노드풀 레이블 목록	any of [array[NodepoolLabel], null]
max_node_count required	최대 노드 수 Example : `5`	integer
min_node_count required	최소 노드 수 Example : `1`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	노드풀 이름 Example : `sample-nodepool`	string
server_group_id optional	서버 그룹 ID Example : `2b8d33d5-4de5-40a5-a34c-7e30204133xc`	any of [string, null]
server_type required	서버 타입	ServerType
status required	노드풀 상태 Example : `Running`	string
taints optional	노드풀 테인트 목록	any of [array[NodepoolTaint], null]
volume_size required	볼륨 크기 Example : `104`	integer
volume_type required	볼륨 타입	VolumeType

2.2.40 - PrivateEndpointAccessControlResource

Name	Description	Schema
id required	Private Endpoint 접근 제어 리소스 ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string
name required	Private Endpoint 접근 제어 리소스 이름 Example : `sample-name`	string
type required	Private Endpoint 접근 제어 리소스 타입 Example : `vm`	string

2.2.41 - ServerType

Name	Description	Schema	Default
description required	서버 타입 설명 Example : `Standard`	string
id required	서버 타입 ID Example : `10a599e031e749b7b260868f441e862b`	string

2.2.42 - Tag

Name	Description	Schema	Default
key required	태그 키 Example : `Key`	string
value required	태그 값 Example : `Value`	string

2.2.43 - VolumeType

Name	Description	Schema
encrypt required	볼륨 타입 암호화 Example : `true`	boolean
id required	볼륨 타입 ID Example : `10a599e031e749b7b260868f441e862b`	string
name required	볼륨 타입 이름 Example : `SSD`	string

2.2.44 - VolumeTypeSummary

Name	Description	Schema	Default
id required	볼륨 타입 ID Example : `10a599e031e749b7b260868f441e862b`	string
name required	볼륨 타입 이름 Example : `SSD`	string