Open Context Protocol is live! 🚀 Read the launch post

listBaremetals

List Bare Metal Instances

Details

  • Method: GET
  • Path: /bare-metals
  • Operation ID: list-baremetals

Parameters

{
  "per_page": {
    "description": "Number of items requested per page. Default is 100 and Max is 500.\n",
    "required": false,
    "location": "query",
    "type": "integer"
  },
  "cursor": {
    "description": "Cursor for paging. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination).",
    "required": false,
    "location": "query",
    "type": "string"
  }
}

Response Schema

{
  "type": "object",
  "properties": {
    "bare_metals": {
      "type": "array",
      "items": {
        "title": "baremetal",
        "type": "object",
        "x-tags": [
          "baremetal"
        ],
        "description": "Bare Metal information.",
        "x-examples": {
          "bare metal": {
            "id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60",
            "os": "CentOS 8 x64",
            "ram": "32768 MB",
            "disk": "2x 240GB SSD",
            "main_ip": "192.0.2.123",
            "cpu_count": 4,
            "region": "ewr",
            "default_password": "example-password",
            "date_created": "2020-10-10T01:56:20+00:00",
            "status": "active",
            "netmask_v4": "255.255.254.0",
            "gateway_v4": "192.0.2.123",
            "plan": "vbm-4c-32gb",
            "v6_network": "2001:0db8:1000::",
            "v6_main_ip": "2001:0db8:1000::100",
            "v6_network_size": 64,
            "label": "Example Bare Metal",
            "mac_address": 2199756823533,
            "os_id": 215,
            "app_id": 0,
            "image_id": "",
            "tags": [
              "a tag",
              "another"
            ]
          }
        },
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique ID for the Bare Metal instance."
          },
          "os": {
            "type": "string",
            "description": "The [Operating System name](#operation/list-os)."
          },
          "ram": {
            "type": "string",
            "description": "Text description of the instances' RAM."
          },
          "disk": {
            "type": "string",
            "description": "Text description of the instances' disk configuration."
          },
          "main_ip": {
            "type": "string",
            "description": "The main IPv4 address."
          },
          "cpu_count": {
            "type": "integer",
            "description": "Number of CPUs."
          },
          "region": {
            "type": "string",
            "description": "The [Region id](#operation/list-regions) where the instance is located."
          },
          "default_password": {
            "type": "string",
            "description": "The default password assigned at deployment."
          },
          "date_created": {
            "type": "string",
            "description": "The date this instance was created."
          },
          "status": {
            "type": "string",
            "description": "The current status.\n\n* active\n* pending\n* suspended"
          },
          "netmask_v4": {
            "type": "string",
            "description": "The IPv4 netmask in dot-decimal notation."
          },
          "gateway_v4": {
            "type": "string",
            "description": "The IPv4 gateway address."
          },
          "plan": {
            "type": "string",
            "description": "The [Bare Metal Plan id](#operation/list-metal-plans) used by this instance."
          },
          "label": {
            "type": "string",
            "description": "The user-supplied label for this instance."
          },
          "tag": {
            "type": "string",
            "description": "Use `tags` instead. The user-supplied tag for this instance.",
            "deprecated": true
          },
          "os_id": {
            "type": "integer",
            "description": "The [Operating System id](#operation/list-os)."
          },
          "app_id": {
            "type": "integer",
            "description": "The [Application id](#operation/list-applications)."
          },
          "image_id": {
            "type": "string",
            "description": "The [Application image_id](#operation/list-applications)."
          },
          "v6_network": {
            "type": "string",
            "description": "The IPv6 network size in bits."
          },
          "v6_main_ip": {
            "type": "string",
            "description": "The main IPv6 network address."
          },
          "v6_network_size": {
            "type": "integer",
            "description": "The IPv6 subnet."
          },
          "mac_address": {
            "type": "integer",
            "description": "The MAC address for a Bare Metal server"
          },
          "tags": {
            "type": "array",
            "description": "Tags to apply to the instance",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "meta": {
      "title": "meta",
      "type": "object",
      "x-examples": {
        "meta response": {
          "meta": {
            "total": 31,
            "links": {
              "next": "WxYzExampleNext",
              "prev": ""
            }
          }
        }
      },
      "description": "The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.",
      "properties": {
        "total": {
          "type": "integer",
          "description": "Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set."
        },
        "links": {
          "type": "object",
          "description": "Cursor values for pagination.",
          "properties": {
            "next": {
              "type": "string",
              "description": "Cursor value for the next page."
            },
            "prev": {
              "type": "string",
              "description": "Cursor value for the previous page."
            }
          }
        }
      }
    }
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('vultr')

# Call this tool
result = await agent.call_tool('listBaremetals', {
    # Add required parameters here
})