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

Return to the regular view of this page.

APIs

1: Assign Baremetal Private NAT IP

1.1: 1.2
1.2: 1.1

2: Assign Baremetal Public NAT IP

2.1: 1.2
2.2: 1.1
2.3: 1.0

3: Attach Baremetal Local Subnet

3.1: 1.2
3.2: 1.1
3.3: 1.0

4: Create Baremetals

4.1: 1.2
4.2: 1.1
4.3: 1.0

5: Delete Baremetal Private NAT IP

5.1: 1.2
5.2: 1.1

6: Delete Baremetal Public NAT IP

6.1: 1.2
6.2: 1.1
6.3: 1.0

7: Delete Baremetals

7.1: 1.2
7.2: 1.1
7.3: 1.0

8: Detach Baremetal Local Subnet

8.1: 1.2
8.2: 1.1
8.3: 1.0

9: List Baremetal Images

9.1: 1.2
9.2: 1.1
9.3: 1.0

10: List Baremetal Products

10.1: 1.2
10.2: 1.1
10.3: 1.0

11: List Baremetals

11.1: 1.2
11.2: 1.1
11.3: 1.0

12: Lock Baremetal

12.1: 1.2
12.2: 1.1
12.3: 1.0

13: Show Baremetal

13.1: 1.2
13.2: 1.1
13.3: 1.0

14: Start Baremetals

14.1: 1.2
14.2: 1.1
14.3: 1.0

15: Stop Baremetals

15.1: 1.2
15.2: 1.1
15.3: 1.0

16: Unlock Baremetal

16.1: 1.2
16.2: 1.1
16.3: 1.0

1 - Assign Baremetal Private NAT IP

1.1 - 1.2

post /v1/baremetals/{baremetal_id}/private-nat-ips

Description

Assign Private NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		BaremetalServerAssignPrivateNatIpRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/private-nat-ips

Request header

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

Request body

{
    "private_nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
    "private_nat_ip_id": "03cd065d8acc4e47b11a11dc1411323e"
}

Example HTTP response

Response 202

{
    "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
    "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
    "nat_ip": "192.170.2.10",
    "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
    "state": "ACTIVE"
}

1.2 - 1.1

post /v1/baremetals/{baremetal_id}/private-nat-ips

Description

Assign Private NAT IP at Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		BaremetalServerAssignPrivateNatIpRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/private-nat-ips

Request header

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

Request body

{
    "private_nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
    "private_nat_ip_id": "03cd065d8acc4e47b11a11dc1411323e"
}

Example HTTP response

Response 202

{
    "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
    "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
    "nat_ip": "192.170.2.10",
    "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
    "state": "ACTIVE"
}

2 - Assign Baremetal Public NAT IP

2.1 - 1.2

post /v1/baremetals/{baremetal_id}/public-nat-ips

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		BaremetalServerAssignPublicNatIpRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/public-nat-ips

Request header

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

Request body

{
    "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

2.2 - 1.1

post /v1/baremetals/{baremetal_id}/public-nat-ips

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		BaremetalServerAssignPublicNatIpRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/public-nat-ips

Request header

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

Request body

{
    "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

2.3 - 1.0

post /v1/baremetals/{baremetal_id}/public-nat-ips

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		BaremetalServerAssignPublicNatIpRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/public-nat-ips

Request header

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

Request body

{
    "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

3 - Attach Baremetal Local Subnet

3.1 - 1.2

put /v1/baremetals/local-subnet/{baremetal_id}/attach

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		LocalSubnetAttachRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/local-subnet/{baremetal_id}/attach

Request header

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

Request body

{
    "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "local_subnet_ip": "192.168.0.1"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
    "is_success": true
}

3.2 - 1.1

put /v1/baremetals/local-subnet/{baremetal_id}/attach

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		LocalSubnetAttachRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/local-subnet/{baremetal_id}/attach

Request header

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

Request body

{
    "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "local_subnet_ip": "192.168.0.1"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
    "is_success": true
}

3.3 - 1.0

put /v1/baremetals/local-subnet/{baremetal_id}/attach

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		LocalSubnetAttachRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/local-subnet/{baremetal_id}/attach

Request header

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

Request body

{
    "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "local_subnet_ip": "192.168.0.1"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
    "is_success": true
}

4 - Create Baremetals

4.1 - 1.2

post /v1/baremetals

Description

Create Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalCreateRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Request body

{
    "region_id": "kr-west1",
    "lock_enabled": true,
    "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
    "init_script": "init script",
    "os_user_id": "user001",
    "os_user_password": "password",
    "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
    "subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "server_details": [
        {
            "bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
            "bare_metal_local_subnet_ip_address": "192.168.0.1",
            "bare_metal_server_name": "bmserver-001",
            "server_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "ip_address": "192.168.0.1",
            "nat_enabled": true,
            "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac",
            "local_disk_partitions": [
                {
                    "mount_point": "/mountpoint",
                    "partition_name": "partitionname",
                    "partition_size": 20,
                    "partition_type": "ext4"
                }
            ],
            "local_disk_type": "flat",
            "zone": "kr-west1-a"
        }
    ],
    "use_placement_group": false,
    "placement_group_name": "pgtest",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

4.2 - 1.1

post /v1/baremetals

Description

Create Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalCreateRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Request body

{
    "region_id": "kr-west1",
    "lock_enabled": true,
    "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
    "init_script": "init script",
    "os_user_id": "user001",
    "os_user_password": "password",
    "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
    "subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "server_details": [
        {
            "bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
            "bare_metal_local_subnet_ip_address": "192.168.0.1",
            "bare_metal_server_name": "bmserver-001",
            "server_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "ip_address": "192.168.0.1",
            "nat_enabled": true,
            "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac",
            "local_disk_partitions": [
                {
                    "mount_point": "/mountpoint",
                    "partition_name": "partitionname",
                    "partition_size": 20,
                    "partition_type": "ext4"
                }
            ],
            "local_disk_type": "flat",
            "use_hyper_threading": true
        }
    ],
    "use_placement_group": false,
    "placement_group_name": "pgtest",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

4.3 - 1.0

post /v1/baremetals

Description

Create Bare Metal Servers.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalCreateRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Request body

{
    "region_id": "kr-west1",
    "lock_enabled": true,
    "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
    "init_script": "init script",
    "os_user_id": "user001",
    "os_user_password": "password",
    "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
    "subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "server_details": [
        {
            "bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
            "bare_metal_local_subnet_ip_address": "192.168.0.1",
            "bare_metal_server_name": "bmserver-001",
            "server_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "ip_address": "192.168.0.1",
            "nat_enabled": true,
            "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac",
            "local_disk_partitions": [
                {
                    "mount_point": "/mountpoint",
                    "partition_name": "partitionname",
                    "partition_size": 20,
                    "partition_type": "ext4"
                }
            ],
            "local_disk_type": "flat",
            "use_hyper_threading": true
        }
    ],
    "use_placement_group": false,
    "placement_group_name": "pgtest",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

5 - Delete Baremetal Private NAT IP

5.1 - 1.2

delete /v1/baremetals/{baremetal_id}/private-nat-ips

Description

Delete Private NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/private-nat-ips

Request header

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

Example HTTP response

Response 202

{
    "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
    "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
    "nat_ip": "192.170.2.10",
    "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
    "state": "ACTIVE"
}

5.2 - 1.1

delete /v1/baremetals/{baremetal_id}/private-nat-ips

Description

Delete Private NAT IP Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/private-nat-ips

Request header

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

Example HTTP response

Response 202

{
    "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
    "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
    "nat_ip": "192.170.2.10",
    "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
    "state": "ACTIVE"
}

6 - Delete Baremetal Public NAT IP

6.1 - 1.2

delete /v1/baremetals/{baremetal_id}/public-nat-ips

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/public-nat-ips

Request header

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

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

6.2 - 1.1

delete /v1/baremetals/{baremetal_id}/public-nat-ips

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/public-nat-ips

Request header

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

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

6.3 - 1.0

delete /v1/baremetals/{baremetal_id}/public-nat-ips

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/public-nat-ips

Request header

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

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

7 - Delete Baremetals

7.1 - 1.2

delete /v1/baremetals

Description

Delete Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalTerminateRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Request body

{
    "baremetal_id_list": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

7.2 - 1.1

delete /v1/baremetals

Description

Delete Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalTerminateRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Request body

{
    "baremetal_id_list": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

7.3 - 1.0

delete /v1/baremetals

Description

Delete Bare Metal Servers.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalTerminateRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Request body

{
    "baremetal_id_list": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

8 - Detach Baremetal Local Subnet

8.1 - 1.2

put /v1/baremetals/local-subnet/{baremetal_id}/detach

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		LocalSubnetDetachRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/local-subnet/{baremetal_id}/detach

Request header

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

Request body

{
    "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "local_subnet_ip": "192.168.0.1"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
    "is_success": true
}

8.2 - 1.1

put /v1/baremetals/local-subnet/{baremetal_id}/detach

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		LocalSubnetDetachRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/local-subnet/{baremetal_id}/detach

Request header

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

Request body

{
    "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "local_subnet_ip": "192.168.0.1"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
    "is_success": true
}

8.3 - 1.0

put /v1/baremetals/local-subnet/{baremetal_id}/detach

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None
body	body required		LocalSubnetDetachRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/local-subnet/{baremetal_id}/detach

Request header

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

Request body

{
    "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
    "local_subnet_ip": "192.168.0.1"
}

Example HTTP response

Response 202

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
    "is_success": true
}

9 - List Baremetal Images

9.1 - 1.2

get /v1/images

Description

List Bare Metal Server Images.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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/images

Request header

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

Example HTTP response

Response 200

{
    "images": [
        {
            "id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
            "created_at": "2024-07-11 08:56:59",
            "name": "RHEL 8.8 for BM",
            "os_distro": "RHEL",
            "scp_os_version": "8.7",
            "scp_image_type": "STANDARD"
        }
    ]
}

9.2 - 1.1

get /v1/images

Description

List Bare Metal Server Images.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
query	region_id required	Region ID Example : `kr-west1`	string	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/images?region_id={region_id}

Request header

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

Example HTTP response

Response 200

{
    "images": [
        {
            "id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
            "created_at": "2024-07-11 08:56:59",
            "name": "RHEL 8.8 for BM",
            "os_distro": "RHEL",
            "scp_os_version": "8.7",
            "scp_image_type": "STANDARD"
        }
    ]
}

9.3 - 1.0

get /v1/images

Description

List Bare Metal Server Images.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	region_id required	Region ID Example : `kr-west1`	string	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/images?region_id={region_id}

Request header

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

Example HTTP response

Response 200

{
    "images": [
        {
            "id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
            "created_at": "2024-07-11 08:56:59",
            "name": "RHEL 8.8 for BM",
            "os_distro": "RHEL",
            "scp_os_version": "8.7",
            "scp_image_type": "STANDARD"
        }
    ]
}

10 - List Baremetal Products

10.1 - 1.2

get /v1/bm_products

Description

List Bare Metal Server products.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	image_id optional	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/bm_products

Request header

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

Example HTTP response

Response 200

{
    "products": [
        {
            "cpu_name": "cpu 16 vCore",
            "cpu_unit": "vCPU",
            "cpu_value": "64",
            "description": "vCPU 16 │ Memory 128G │ Disk 480G",
            "disk_unit": "GB",
            "disk_value": "480",
            "id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "memory_name": "server memory 128GB",
            "memory_unit": "GB",
            "memory_value": "128",
            "name": "s2v16m128_metal",
            "state": "AVAILABLE",
            "type": "SCALE",
            "compute_class_type_name": "StandardMetal-2",
            "compute_class_type_value": "s2_metal",
            "name_with_generation": "s2v16m128_metal",
            "created_at": "2024-05-17T00:23:17Z",
            "modified_at": "2024-05-17T00:23:17Z",
            "os_disk_gb": "480"
        }
    ]
}

10.2 - 1.1

get /v1/bm_products

Description

List Bare Metal Server products.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
query	image_id optional	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/bm_products

Request header

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

Example HTTP response

Response 200

{
    "products": [
        {
            "cpu_name": "cpu 16 vCore",
            "cpu_unit": "vCPU",
            "cpu_value": "64",
            "description": "vCPU 16 │ Memory 128G │ Disk 480G",
            "disk_unit": "GB",
            "disk_value": "480",
            "id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "memory_name": "server memory 128GB",
            "memory_unit": "GB",
            "memory_value": "128",
            "name": "s2v16m128_metal",
            "state": "AVAILABLE",
            "type": "SCALE",
            "compute_class_type_name": "StandardMetal-2",
            "compute_class_type_value": "s2_metal",
            "name_with_generation": "s2v16m128_metal",
            "created_at": "2024-05-17T00:23:17Z",
            "modified_at": "2024-05-17T00:23:17Z",
            "os_disk_gb": "480"
        }
    ]
}

10.3 - 1.0

get /v1/bm_products

Description

List Bare Metal Server products.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	image_id optional	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/bm_products

Request header

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

Example HTTP response

Response 200

{
    "products": [
        {
            "id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "attri_name": "attri name",
            "attri_value": "attri value",
            "cpu_generation": "cpu generation",
            "cpu_name": "cpu 16 vCore",
            "cpu_unit": "vCPU",
            "cpu_value": "64",
            "description": "vCPU 16 │ Memory 128G │ Disk 480G",
            "disk_name": "disk_name",
            "disk_unit": "GB",
            "disk_value": "480",
            "infiniband_name": "infiniband_name",
            "infiniband_unit": "infiniband_unit",
            "infiniband_value": "infiniband_value",
            "memory_name": "server memory 128GB",
            "memory_unit": "GB",
            "memory_value": "128",
            "name": "s2v16m128_metal",
            "socket_name": "socket_name",
            "socket_unit": "socket_unit",
            "socket_value": "socket_value",
            "state": "AVAILABLE",
            "type": "SCALE",
            "compute_class_type_name": "StandardMetal-2",
            "compute_class_type_unit": "compute_class_type_unit",
            "compute_class_type_value": "s2_metal",
            "name_with_generation": "s2v16m128_metal"
        }
    ]
}

11 - List Baremetals

11.1 - 1.2

get /v1/baremetals

Description

Get Bare Metal Servers list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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	server_name optional	Bare Metal Server name Example : `bmserver-001`	any of [string, null]	None
query	state optional	Bare Metal Server state Example : `RUNNING`	any of [string, null]	None
query	ip optional	Bare Metal Server IP address Example : `192.168.0.1`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Example HTTP response

Response 200

{
    "baremetals": [
        {
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "server_name": "bmserver-001",
            "lock_enabled": true,
            "policy_ip": "192.168.0.1",
            "product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "server_type": "s1v8m32_metal",
            "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
            "image_version": "RHEL 8.7 for BM",
            "state": "RUNNING",
            "os_type": "WINDOWS",
            "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
            "network_id": "ab313c43291e4b678f4bacffe10768ae",
            "region_id": "kr-west1",
            "placement_group_name": "pgtest",
            "zone": "kr-west1-a"
        }
    ],
    "count": 20
}

11.2 - 1.1

get /v1/baremetals

Description

Get Bare Metal Servers list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

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	server_name optional	Bare Metal Server name Example : `bmserver-001`	any of [string, null]	None
query	state optional	Bare Metal Server state Example : `RUNNING`	any of [string, null]	None
query	ip optional	Bare Metal Server IP address Example : `192.168.0.1`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Example HTTP response

Response 200

{
    "baremetals": [
        {
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "server_name": "bmserver-001",
            "lock_enabled": true,
            "policy_ip": "192.168.0.1",
            "product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "server_type": "s1v8m32_metal",
            "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
            "image_version": "RHEL 8.7 for BM",
            "state": "RUNNING",
            "os_type": "WINDOWS",
            "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
            "network_id": "ab313c43291e4b678f4bacffe10768ae",
            "region_id": "kr-west1",
            "placement_group_name": "pgtest"
        }
    ],
    "count": 20
}

11.3 - 1.0

get /v1/baremetals

Description

Get Bare Metal Servers list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	server_name optional	Bare Metal Server name Example : `bmserver-001`	any of [string, null]	None
query	state optional	Bare Metal Server state Example : `RUNNING`	any of [string, null]	None
query	ip optional	Bare Metal Server IP address Example : `192.168.0.1`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/baremetals

Request header

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

Example HTTP response

Response 200

{
    "baremetals": [
        {
            "id": "20c507a036c447cdb3b19468d8ea62ac",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
            "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
            "region_id": "kr-west1",
            "server_name": "bmserver-001",
            "lock_enabled": true,
            "root_account": "rootaccount",
            "time_zone": "Asia/Seoul",
            "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
            "network_id": "ab313c43291e4b678f4bacffe10768ae",
            "policy_ip": "192.168.0.1",
            "use_local_subnet": true,
            "local_subnet_info": [
                {
                    "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
                    "policy_local_subnet_ip": "192.168.0.1",
                    "vlan_id": 500,
                    "vni_role_name": "mgmtJ4dzQBo",
                    "interface_name": "ens8f1,bond_serv.2",
                    "state": "CREATING"
                }
            ],
            "policy_use_nat": true,
            "policy_nat": "192.168.0.1",
            "public_nat_status": "ACTIVE",
            "product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
            "server_type": "s1v8m32_metal",
            "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
            "image_version": "RHEL 8.7 for BM",
            "state": "RUNNING",
            "init_script": "init script",
            "hyper_threading_use": true,
            "os_type": "WINDOWS",
            "placement_group_name": "pgtest"
        }
    ],
    "count": 20
}

12 - Lock Baremetal

12.1 - 1.2

put /v1/baremetals/{baremetal_id}/lock

Description

Lock Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/lock

Request header

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

Example HTTP response

Response 200

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

12.2 - 1.1

put /v1/baremetals/{baremetal_id}/lock

Description

Lock Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/lock

Request header

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

Example HTTP response

Response 200

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

12.3 - 1.0

put /v1/baremetals/{baremetal_id}/lock

Description

Lock Bare Metal Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/lock

Request header

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

Example HTTP response

Response 200

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

13 - Show Baremetal

13.1 - 1.2

get /v1/baremetals/{baremetal_id}

Description

Show Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}

Request header

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

Example HTTP response

Response 200

{
    "id": "20c507a036c447cdb3b19468d8ea62ac",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "region_id": "kr-west1",
    "server_name": "bmserver-001",
    "lock_enabled": true,
    "root_account": "rootaccount",
    "time_zone": "Asia/Seoul",
    "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
    "network_id": "ab313c43291e4b678f4bacffe10768ae",
    "policy_ip": "192.168.0.1",
    "use_local_subnet": true,
    "local_subnet_info": [
        {
            "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
            "policy_local_subnet_ip": "192.168.0.1",
            "vlan_id": 500,
            "vni_role_name": "mgmtJ4dzQBo",
            "interface_name": "ens8f1,bond_serv.2",
            "state": "CREATING"
        }
    ],
    "product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
    "server_type": "s1v8m32_metal",
    "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
    "image_version": "RHEL 8.7 for BM",
    "state": "RUNNING",
    "init_script": "init script",
    "hyper_threading_use": true,
    "os_type": "WINDOWS",
    "placement_group_name": "pgtest",
    "private_nat_info": {
        "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
        "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
        "nat_ip": "192.170.2.10",
        "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
        "state": "ACTIVE"
    },
    "public_nat_info": {
        "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
        "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
        "nat_ip": "192.170.2.10",
        "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
        "state": "ACTIVE"
    },
    "zone": "kr-west1-a",
    "cpu_socket": "1",
    "total_cpu_vcore": 64,
    "cpu_core_use": true,
    "cpu_core_active": 32,
    "cpu_core_state": "SUCCESS",
    "server_model": "ThinkSystem SR650 V2",
    "cpu_unit": "vCPU"
}

13.2 - 1.1

get /v1/baremetals/{baremetal_id}

Description

Show Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}

Request header

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

Example HTTP response

Response 200

{
    "id": "20c507a036c447cdb3b19468d8ea62ac",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "region_id": "kr-west1",
    "server_name": "bmserver-001",
    "lock_enabled": true,
    "root_account": "rootaccount",
    "time_zone": "Asia/Seoul",
    "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
    "network_id": "ab313c43291e4b678f4bacffe10768ae",
    "policy_ip": "192.168.0.1",
    "use_local_subnet": true,
    "local_subnet_info": [
        {
            "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
            "policy_local_subnet_ip": "192.168.0.1",
            "vlan_id": 500,
            "vni_role_name": "mgmtJ4dzQBo",
            "interface_name": "ens8f1,bond_serv.2",
            "state": "CREATING"
        }
    ],
    "product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
    "server_type": "s1v8m32_metal",
    "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
    "image_version": "RHEL 8.7 for BM",
    "state": "RUNNING",
    "init_script": "init script",
    "hyper_threading_use": true,
    "os_type": "WINDOWS",
    "placement_group_name": "pgtest",
    "private_nat_info": {
        "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
        "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
        "nat_ip": "192.170.2.10",
        "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
        "state": "ACTIVE"
    },
    "public_nat_info": {
        "nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
        "nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
        "nat_ip": "192.170.2.10",
        "static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3",
        "state": "ACTIVE"
    }
}

13.3 - 1.0

get /v1/baremetals/{baremetal_id}

Description

Show Bare Metal Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}

Request header

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

Example HTTP response

Response 200

{
    "id": "20c507a036c447cdb3b19468d8ea62ac",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "region_id": "kr-west1",
    "server_name": "bmserver-001",
    "lock_enabled": true,
    "root_account": "rootaccount",
    "time_zone": "Asia/Seoul",
    "vpc_id": "e58348b1bc9148e5af86500fd4ef99ca",
    "network_id": "ab313c43291e4b678f4bacffe10768ae",
    "policy_ip": "192.168.0.1",
    "use_local_subnet": true,
    "local_subnet_info": [
        {
            "local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
            "policy_local_subnet_ip": "192.168.0.1",
            "vlan_id": 500,
            "vni_role_name": "mgmtJ4dzQBo",
            "interface_name": "ens8f1,bond_serv.2",
            "state": "CREATING"
        }
    ],
    "policy_use_nat": true,
    "policy_nat": "192.168.0.1",
    "public_nat_status": "ACTIVE",
    "product_type_id": "f90e8ef54cc2451b825608e9f95f7bcb",
    "server_type": "s1v8m32_metal",
    "image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
    "image_version": "RHEL 8.7 for BM",
    "state": "RUNNING",
    "init_script": "init script",
    "hyper_threading_use": true,
    "os_type": "WINDOWS",
    "placement_group_name": "pgtest"
}

14 - Start Baremetals

14.1 - 1.2

post /v1/baremetals/start

Description

Start Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalsOperationRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/start

Request header

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

Request body

{
    "bare_metal_server_ids": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

14.2 - 1.1

post /v1/baremetals/start

Description

Start Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalsOperationRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/start

Request header

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

Request body

{
    "bare_metal_server_ids": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

14.3 - 1.0

post /v1/baremetals/start

Description

Start Bare Metal Servers.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalsOperationRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/start

Request header

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

Request body

{
    "bare_metal_server_ids": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

15 - Stop Baremetals

15.1 - 1.2

post /v1/baremetals/stop

Description

Stop Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalsOperationRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/stop

Request header

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

Request body

{
    "bare_metal_server_ids": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

15.2 - 1.1

post /v1/baremetals/stop

Description

Stop Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalsOperationRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/stop

Request header

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

Request body

{
    "bare_metal_server_ids": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

15.3 - 1.0

post /v1/baremetals/stop

Description

Stop Bare Metal Servers.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		BaremetalsOperationRequest

Responses

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

Example HTTP request

Request path

/v1/baremetals/stop

Request header

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

Request body

{
    "bare_metal_server_ids": [
        "20c507a036c447cdb3b19468d8ea62ac"
    ]
}

Example HTTP response

Response 202

{
    "account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
    "request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
    "resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}

16 - Unlock Baremetal

16.1 - 1.2

put /v1/baremetals/{baremetal_id}/unlock

Description

Unlock Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/unlock

Request header

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

Example HTTP response

Response 200

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

16.2 - 1.1

put /v1/baremetals/{baremetal_id}/unlock

Description

Unlock Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/unlock

Request header

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

Example HTTP response

Response 200

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}

16.3 - 1.0

put /v1/baremetals/{baremetal_id}/unlock

Description

Unlock Bare Metal Server.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string	None

Responses

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

Example HTTP request

Request path

/v1/baremetals/{baremetal_id}/unlock

Request header

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

Example HTTP response

Response 200

{
    "baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}