List of client bare metal servers

GET 
https://core-pl.ocplanet.cloud/backend/api/servers/

Host: https://core.ocplanet.cloud

Retrieve a list of client bare metal servers.

Request

Responses

200

application/json

Schema

Schema

count integerrequired
next nullstringrequired
previous nullstringrequired
totalCount integerrequired
pageNo integerstringrequired
objects object[]required
Array [
floating_ips object[]required
Array [
ip stringrequired
ip_attributes objectrequired
is_IP_v4 required
is_IP_v6 required
is_subnet required
primary_ip required
subnet_information objectrequired
gw required
netmask required
subnet required
type required
updated_at stringrequired
]
id integerrequired
name stringrequired
os stringrequired
primary_ip stringrequired
state objectrequired
power_status stringrequired
reinstall_run booleanrequired
tags string[]required
type stringrequired
]

Example (from schema)

{
  "count": 0,
  "totalCount": 0,
  "objects": [
    {
      "floating_ips": [
        {
          "ip": "string",
          "ip_attributes": {
            "is_IP_v4": {},
            "is_IP_v6": {},
            "is_subnet": {}
          },
          "primary_ip": {},
          "subnet_information": {
            "gw": {},
            "netmask": {},
            "subnet": {},
            "type": {}
          },
          "updated_at": "string"
        }
      ],
      "id": 0,
      "name": "string",
      "os": "string",
      "primary_ip": "string",
      "state": {
        "power_status": "string",
        "reinstall_run": true
      },
      "tags": [
        "string"
      ],
      "type": "string"
    }
  ]
}

Example

{
  "count": 1,
  "next": null,
  "previous": null,
  "objects": [
    {
      "id": 153,
      "os": "CentOS 7",
      "name": "bmserver.com",
      "tags": [
        "tag1"
      ],
      "type": "type 1",
      "state": {
        "reinstall_run": false,
        "power_status": "online"
      },
      "primary_ip": "217.147.172.253",
      "floating_ips": [
        {
          "ip": "217.147.172.253"
        }
      ],
      "storage": {
        "model": "LOGICAL VOLUME",
        "value": 572293,
        "count": 1,
        "value_type": "mib",
        "details": [
          {
            "model": "LOGICAL VOLUME",
            "size": 572293
          }
        ]
      }
    }
  ],
  "totalCount": 1,
  "pageNo": 1
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Use 'OpenAPIToken {token}' as the value

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://core-pl.ocplanet.cloud/backend/api/servers/' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://core-pl.ocplanet.cloud

Auth

apikey header authorization

ResponseClear

Click the Send API Request button above and see the response here!