List Kernels

List All Available Kernels for a Droplet

client.gpuDroplets.listKernels(, ?, ?): GPUDropletListKernelsResponse { meta, kernels, links }

get/v2/droplets/{droplet_id}/kernels

To retrieve a list of all kernels available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/kernels

The response will be a JSON object that has a key called kernels. This will be set to an array of kernel objects, each of which contain the standard kernel attributes.

ParametersExpand Collapse

dropletID: number

query: GPUDropletListKernelsParams { page, per_page }

page?: number

Which 'page' of paginated results to return.

minimum1

per_page?: number

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

GPUDropletListKernelsResponse { meta, kernels, links }

meta: MetaProperties { total }

Information about the response itself.

total?: number

Number of objects returned by the request.

kernels?: Array<Kernel { id, name, version } | null>

id?: number

A unique number used to identify and reference a specific kernel.

name?: string

The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question.

version?: string

A standard kernel version string representing the version, patch, and release information.

links?: PageLinks { pages }

pages?: ForwardLinks { last, next } | BackwardLinks { first, prev } | unknown

Accepts one of the following:

ForwardLinks { last, next }

last?: string

URI of the last page of the results.

next?: string

URI of the next page of the results.

BackwardLinks { first, prev }

first?: string

URI of the first page of the results.

prev?: string

URI of the previous page of the results.

unknown

List All Available Kernels for a Droplet

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const response = await client.gpuDroplets.listKernels(3164444);

console.log(response.meta);

{
  "meta": {
    "total": 1
  },
  "kernels": [
    {
      "id": 7515,
      "name": "DigitalOcean GrubLoader v0.2 (20160714)",
      "version": "2016.07.13-DigitalOcean_loader_Ubuntu"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}

Returns Examples

{
  "meta": {
    "total": 1
  },
  "kernels": [
    {
      "id": 7515,
      "name": "DigitalOcean GrubLoader v0.2 (20160714)",
      "version": "2016.07.13-DigitalOcean_loader_Ubuntu"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}