Delete virtual machine

APIs

Cloud

Moves an existing virtual machine to the trash

DELETE

https://api.katapult.io/core/v1/virtual_machines/virtual_machine

Details

Success status

200 OK

Required scopes

virtual_machines

Possible errors

Code	Error	When it happens
400	`missing_api_token`	No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer
403	`unauthorized_network_for_api_token`	Network is not allowed to access the API with this API token
403	`invalid_api_token`	The API token provided was not valid (it may not exist or have expired)
403	`token_owner_suspended`	The user that owns the API token has been suspended
403	`invalid_capabilities_token`	The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)
403	`scope_not_granted`	The scope required for this endpoint has not been granted to the authenticating identity
403	`virtual_machine_suspended`	A virtual machine was found from the arguments provided but it is suspended
403	`permission_denied`	The authenticated identity is not permitted to perform this action
404	`virtual_machine_not_found`	No virtual machine was found matching any of the criteria provided in the arguments
406	`object_in_trash`	The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.
429	`rate_limit_reached`	You have reached the rate limit for this type of request
503	`service_unavailable`	The service is currently unavailable, please try again later

Arguments

virtual_machine object body

All 'virtual_machine[]' params are mutually exclusive, only one can be provided.
- id string
- fqdn string

Response

trash_object object
- id string
- keep_until integer
- purge_after integer
  
  When the item becomes eligible for automatic purging under the current retention setting: the later of keep_until and the time it was trashed plus the retention period. Actual removal may be up to an hour later.
- object_id string
- object_type string
virtual_machine object
- id string
- name string
- hostname string
- fqdn string
- description string
- created_at integer
- initial_root_password string
  
  Only returned for 24 hours after the boot disk's installation.
- state string
  
  Allowed values: stoppedfailedstartedstartingallocatedallocatingresettingmigratingstoppingshutting_downtransferringorphaned
- suspended boolean
- suspended_at integer
- zone object
  - id string
  - name string
  - permalink string
  - data_center object
    
    id string
    
    name string
    
    permalink string
    
    country object
    
    id string
    
    name string
    
    iso_code2 string
    
    iso_code3 string
    
    time_zone string
    
    eu boolean
- organization object
  - id string
  - uuid string
  - name string
  - sub_domain string
  - infrastructure_domain string
  - created_at integer
  - activated_at integer
  - suspended boolean
  - managed boolean
  - billing_name string
  - address1 string
  - address2 string
  - address3 string
  - address4 string
  - postcode string
  - vat_number string
  - phone_number string
  - currency object
    
    id string
    
    name string
    
    iso_code string
    
    symbol string
  - country
  - country_state
- group
- package
- attached_iso
- memory_in_gb integer
- cpu_cores integer
- use_dedicated_cpus boolean
- gpu_type
- gpus array
  - id string
    
    Unique ID for this GPU. Not available when status is "detached".
  - status string
    
    Allowed values: attachedattachingdetacheddetachingunknown
  - pending_action
  - available boolean
    
    When pending action is "attach", this indicates if there is a GPU of the relevant type available.
  - type object
    
    id string
    
    name string
    
    manufacturer string
    
    memory_in_gb integer
    
    memory_type string
    
    permalink string
    
    data_centers array
- tags array
  - id string
  - name string
  - color string
    
    Allowed values: redpinkpurpledark_bluegreentealaqualight_blueyelloworangeorange_redbrownblackdark_graylight_graylight_brownpastel_redpastel_pinkpastel_purplepastel_dark_bluepastel_greenpastel_tealpastel_aquapastel_light_bluepastel_yellowpastel_orangepastel_orange_redpastel_brownpastel_blackpastel_dark_graypastel_light_graypastel_light_brown
  - created_at integer
- tag_names array
- ip_addresses array
  - id string
  - address string
  - reverse_dns string
  - vip boolean
  - label string
  - address_with_mask string
  - network object
    
    id string
    
    name string
    
    permalink string
    
    default boolean
    
    Indicates if this network is the default network for the data center.
    
    data_center object
    
    id string
    
    name string
    
    permalink string
    
    country object
    
    id string
    
    name string
    
    iso_code2 string
    
    iso_code3 string
    
    time_zone string
    
    eu boolean
    
    vlan integer
    
    The underlying VLAN ID given to this network. Internal use only.
  - subnet object
    
    id string
    
    address string
    
    gateway string
    
    mask integer
    
    billable boolean
    
    version integer
  - allocation_id string
  - allocation_type string
- hypervisor
- cloud_init

Example response

{
  "trash_object": {
    "id": "string",
    "keep_until": 0,
    "purge_after": 0,
    "object_id": "string",
    "object_type": "string"
  },
  "virtual_machine": {
    "id": "string",
    "name": "string",
    "hostname": "string",
    "fqdn": "string",
    "description": "string",
    "created_at": 0,
    "initial_root_password": "string",
    "state": "stopped",
    "suspended": true,
    "suspended_at": 0,
    "zone": {
      "id": "string",
      "name": "string",
      "permalink": "string",
      "data_center": {
        "id": "string",
        "name": "string",
        "permalink": "string",
        "country": {
          "id": "string",
          "name": "string",
          "iso_code2": "string",
          "iso_code3": "string",
          "time_zone": "string",
          "eu": true
        }
      }
    },
    "organization": {
      "id": "string",
      "uuid": "string",
      "name": "string",
      "sub_domain": "string",
      "infrastructure_domain": "string",
      "created_at": 0,
      "activated_at": 0,
      "suspended": true,
      "managed": true,
      "billing_name": "string",
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "address4": "string",
      "postcode": "string",
      "vat_number": "string",
      "phone_number": "string",
      "currency": {
        "id": "string",
        "name": "string",
        "iso_code": "string",
        "symbol": "string"
      },
      "country": "string",
      "country_state": "string"
    },
    "group": "string",
    "package": "string",
    "attached_iso": "string",
    "memory_in_gb": 0,
    "cpu_cores": 0,
    "use_dedicated_cpus": true,
    "gpu_type": "string",
    "gpus": [
      {
        "id": "string",
        "status": "attached",
        "pending_action": "string",
        "available": true,
        "type": {
          "id": "string",
          "name": "string",
          "manufacturer": "string",
          "memory_in_gb": 0,
          "memory_type": "string",
          "permalink": "string",
          "data_centers": []
        }
      }
    ],
    "tags": [
      {
        "id": "string",
        "name": "string",
        "color": "red",
        "created_at": 0
      }
    ],
    "tag_names": [],
    "ip_addresses": [
      {
        "id": "string",
        "address": "string",
        "reverse_dns": "string",
        "vip": true,
        "label": "string",
        "address_with_mask": "string",
        "network": {
          "id": "string",
          "name": "string",
          "permalink": "string",
          "default": true,
          "data_center": {
            "id": "string",
            "name": "string",
            "permalink": "string",
            "country": {
              "id": "string",
              "name": "string",
              "iso_code2": "string",
              "iso_code3": "string",
              "time_zone": "string",
              "eu": true
            }
          },
          "vlan": 0
        },
        "subnet": {
          "id": "string",
          "address": "string",
          "gateway": "string",
          "mask": 0,
          "billable": true,
          "version": 0
        },
        "allocation_id": "string",
        "allocation_type": "string"
      }
    ],
    "hypervisor": "string",
    "cloud_init": "string"
  }
}

Try it

Requests are real Executing sends a live DELETE request to https://api.katapult.io/core/v1 from your browser. There is no sandbox — the call hits whichever environment your token belongs to, and any change it makes is a real change.

Token

Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.

API token

Request body

Pre-filled with the endpoint's shape — declared defaults where it has them, otherwise a placeholder per type. Edit it before executing; the Arguments tab documents every field.

{ "virtual_machine": { "id": "string", "fqdn": "string" } }

Execute

Copy as curl

Response

API tokens

Address lists

Certificates

Container registry

Countries

Country states

Currencies

DNS zones

Data centers

Disk IO profiles

Disk backup policies

Disk template versions

Disk templates

Disks

File storage volumes

GPU types

IP addresses

Load balancers

Network speed profiles

Networks

Object storage

Operating systems

Organizations

SSH keys

Security groups

Tags

Tasks

Trash objects

Users

Virtual Networks

Virtual machine groups

Virtual machine network interfaces

Virtual machine packages

Virtual machines

Zones

Possible errors

Example response