dots.v2.projects.byProject_id().get()

Generated on 13 Nov 2026 from DoTs version v1.24.0

Usage

client.v2.projects.byProject_id(project_id).get(requestConfiguration?: RequestConfiguration<object>): Promise<undefined | WithProject_GetResponse>

Description

To get a project, send a GET request to /v2/projects/{project_id}.

Parameters

project_id string required

Example: 4de7ac8b-495b-4884-9a69-1050c6793cd6

A unique identifier for a project.

Min: 1

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.projects
    .byProject_id("4de7ac8b-495b-4884-9a69-1050c6793cd6").get();

Response Example

Show Response Example
{
  "project": {
    "id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679",
    "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7",
    "owner_id": 258992,
    "name": "my-web-api",
    "description": "My website API",
    "purpose": "Service or API",
    "environment": "Production",
    "created_at": "2018-09-27T20:10:35Z",
    "updated_at": "2018-09-27T20:10:35Z",
    "is_default": false
  }
}

More Information

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

We can't find any results for your search.

Try using different keywords or simplifying your search terms.