Open Context Protocol is live! 🚀 Read the launch post

createSnapshot

Create Snapshot

Details

  • Method: POST
  • Path: /snapshots
  • Operation ID: create-snapshot

Parameters

{
  "instance_id": {
    "description": "Create a Snapshot for this [Instance id](#operation/list-instances).",
    "required": true,
    "location": "body",
    "type": "string"
  },
  "description": {
    "description": "The user-supplied description of the Snapshot.",
    "required": false,
    "location": "body",
    "type": "string"
  }
}

Response Schema

{
  "type": "object",
  "properties": {
    "snapshot": {
      "title": "snapshot",
      "type": "object",
      "x-examples": {
        "snapshot": {
          "id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60",
          "date_created": "2020-10-10T01:56:20+00:00",
          "description": "Example Snapshot",
          "size": 42949672960,
          "status": "complete",
          "os_id": 215,
          "app_id": 0
        }
      },
      "description": "Snapshot information.",
      "x-tags": [
        "snapshot"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique ID for the Snapshot."
        },
        "date_created": {
          "type": "string",
          "description": "The date this snapshot was created."
        },
        "description": {
          "type": "string",
          "description": "The user-supplied description of the Snapshot."
        },
        "size": {
          "type": "integer",
          "description": "The snapshot size in bytes."
        },
        "status": {
          "type": "string",
          "description": "The Snapshot status.\n\n* pending\n* complete\n* deleted"
        },
        "os_id": {
          "type": "integer",
          "description": "The [Operating System id](#operation/list-os) for this Snapshot."
        },
        "app_id": {
          "type": "integer",
          "description": "The [Application id](#operation/list-applications) for this snapshot."
        }
      }
    }
  }
}

Usage

from ocp_agent import OCPAgent

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

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