For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.v2.security.scans.byScan_id(scan_id).get(requestConfiguration?: RequestConfiguration<WithScan_ItemRequestBuilderGetQueryParameters>): Promise<undefined | WithScan_GetResponse>

Description

To get a CSPM scan by ID, send a GET request to /v2/security/scans/{scan_id}.

Parameters

Path Parameters

scan_id string required

Example: 497dcba3-ecbf-4587-a2dd-5eb0665e6880

The scan UUID.

Query Parameters

severity string optional

The finding severity level to include.

One of: LOW, MEDIUM, HIGH, CRITICAL

perPage integer optional

Example: 2

Number of items returned per page

Default: 20

Min: 1

Max: 200

page integer optional

Example: 1

Which 'page' of paginated results to return.

Default: 1

Min: 1

type string optional

Example: CSPM

The finding type to include.

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.security.scans
    .byScan_id("497dcba3-ecbf-4587-a2dd-5eb0665e6880").get();

Response Example

{
  "scan": {
    "id": "760e09ef-dc84-11e8-981e-3cfdfeaae000",
    "status": "COMPLETED",
    "created_at": "2025-12-04T00:00:00Z",
    "findings": []
  }
}

More Information

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