addServerImageSharingPermission

Available in VPC

Add server image sharing permissions. You can share your server image with other accounts to efficiently operate and manage servers.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Server APIs, see Server request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/addServerImageSharingPermission
?serverImageNo=***3135
&targetLoginIdList.1=test-***@naver.com
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the response status codes common to all Server APIs, see Server response status codes.

Response example

The response example is as follows:

{
    "addServerImageSharingPermissionResponse": {
        "totalRows": 1,
        "serverImageList": [
            {
                "serverImageNo": "*****3135",
                "serverImageName": "test-***",
                "serverImageType": {
                    "code": "SELF",
                    "codeName": "SELF server image"
                },
                "serverImageLifeCyclePhase": {
                    "code": "IN_SERVICE",
                    "codeName": "In Service"
                },
                "hypervisorType": {
                    "code": "KVM",
                    "codeName": "KVM"
                },
                "cpuArchitectureType": {
                    "code": "X86_64",
                    "codeName": "x86 64bit"
                },
                "osCategoryType": {
                    "code": "LINUX",
                    "codeName": "LINUX"
                },
                "osType": {
                    "code": "UBUNTU",
                    "codeName": "UBUNTU"
                },
                "serverImageStatus": {
                    "code": "CREAT",
                    "codeName": "NSI CREATED state"
                },
                "serverImageOperation": {
                    "code": "NULL",
                    "codeName": "NSI NULL OP"
                },
                "serverImageStatusName": "created",
                "shareStatus": {
                    "code": "SHARE",
                    "codeName": "NSI Share SHARE State"
                },
                "blockStorageMappingList": [
                    {
                        "order": 0,
                        "blockStorageSnapshotInstanceNo": *****4697,
                        "blockStorageSnapshotName": "test-***",
                        "blockStorageSize": 10737418240,
                        "blockStorageVolumeType": {
                            "code": "CB1",
                            "codeName": "Common BlockStorage 1"
                        },
                        "iops": 100,
                        "throughput": 104857600,
                        "isEncryptedVolume": false
                    }
                ],
                "sharedLoginIdList": [
                    "test-***@naver.com"
                ],
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
                "createDate": "2025-06-20T09:59:39+0900",
                "platformCategoryCode": "OS"
            }
        ],
        "requestId": "d4fcece2-935a-4c91-bf35-54347eb900ad",
        "returnCode": "0",
        "returnMessage": "success"
    }
}