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

Return to the regular view of this page.

List Baremetals

1 - 1.2

get /v1/baremetals

Description

Get Bare Metal Servers list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryserver_name
optional		Bare Metal Server name
Example : bmserver-001
any of [string, null]None
querystate
optional		Bare Metal Server state
Example : RUNNING
any of [string, null]None
queryip
optional		Bare Metal Server IP address
Example : 192.168.0.1
any of [string, null]None
queryvpc_id
optional		VPC ID
Example : e58348b1bc9148e5af86500fd4ef99ca
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKBaremetalListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone

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
}

2 - 1.1

get /v1/baremetals

Description

Get Bare Metal Servers list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryserver_name
optional		Bare Metal Server name
Example : bmserver-001
any of [string, null]None
querystate
optional		Bare Metal Server state
Example : RUNNING
any of [string, null]None
queryip
optional		Bare Metal Server IP address
Example : 192.168.0.1
any of [string, null]None
queryvpc_id
optional		VPC ID
Example : e58348b1bc9148e5af86500fd4ef99ca
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKBaremetalListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone

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
}

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.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryserver_name
optional		Bare Metal Server name
Example : bmserver-001
any of [string, null]None
querystate
optional		Bare Metal Server state
Example : RUNNING
any of [string, null]None
queryip
optional		Bare Metal Server IP address
Example : 192.168.0.1
any of [string, null]None
queryvpc_id
optional		VPC ID
Example : e58348b1bc9148e5af86500fd4ef99ca
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKBaremetalListResponse
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone

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
}