Give Feedback

dots.v2.images.byImage_id().get()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Copy page as Markdown View page as Markdown

Usage

client.v2.images.byImage_id(image_id).get(requestConfiguration?: RequestConfiguration<object>): Promise<undefined | WithImage_GetResponse>

Description

To retrieve information about an image, send a GET request to /v2/images/{image_id}.

Parameters

image_id integer or string required: A unique number (id) or string (slug) used to identify and reference a
specific image.

Public images can be identified by image id or slug.

Private images *must* be identified by image id.

Request Sample

Show Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.images
    .byImage_id(1).get();

Response Example

Show Response Example

{
  "image": {
    "id": 6918990,
    "name": "14.04 x64",
    "distribution": "Ubuntu",
    "slug": "ubuntu-16-04-x64",
    "public": true,
    "regions": [
      "nyc1",
      "ams1",
      "sfo1",
      "nyc2",
      "ams2",
      "sgp1",
      "lon1",
      "nyc3",
      "ams3",
      "nyc3"
    ],
    "created_at": "2014-10-17T20:24:33Z",
    "min_disk_size": 20,
    "size_gigabytes": 2.34,
    "description": "",
    "tags": [],
    "status": "available",
    "error_message": ""
  }
}

More Information

See /v2/images/{image_id} in the API reference for additional detail on responses, headers, parameters, and more.