API Reference

Users

Dotfiles

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

GetDotfilesConfiguration

client.users.dotfiles.get(DotfileGetParams { empty } body, RequestOptionsoptions?): DotfileGetResponse { dotfilesConfiguration }

POST/gitpod.v1.UserService/GetDotfilesConfiguration

Gets the dotfiles for a user.

Use this method to:

• Retrieve user dotfiles

Examples

• Get dotfiles:

  Retrieves the dotfiles for the current user.

  {}

ParametersExpand Collapse

body: DotfileGetParams { empty }

empty?: boolean

ReturnsExpand Collapse

DotfileGetResponse { dotfilesConfiguration }

dotfilesConfiguration: DotfilesConfiguration { repository }

repository?: string

The URL of a dotfiles repository.

formaturi

GetDotfilesConfiguration

TypeScript

HTTP

TypeScript

Python

Go

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const dotfile = await client.users.dotfiles.get();

console.log(dotfile.dotfilesConfiguration);

200 example

{
  "dotfilesConfiguration": {
    "repository": "https://example.com"
  }
}

Returns Examples

200 example

{
  "dotfilesConfiguration": {
    "repository": "https://example.com"
  }
}