LogoFreestyle
API Reference/Git

Get dev server configuration

Get the dev server configuration for a repository and branch.

GET
/git/v1/repo/{repo_id}/dev-server-configuration

Path Parameters

repo_idRequiredstring

Repository ID

Format: "uuid"

Query Parameters

branchRequiredstring

Git branch name

Response Body

200

Dev server configuration

devCommandstring | null
installCommandstring | null
timeoutinteger | null
Format: "int32"
envVarsobject | null
portsarray | null
presetstring
systemdobject
usersarray | null
groupsarray | null
additionalFilesobject | null
webTerminalboolean | null
webVscodeboolean | null
additionalRepositoriesarray | null
curl -X GET "https://api.freestyle.sh/git/v1/repo/497f6eca-6276-4993-bfeb-53cbbbba6f08/dev-server-configuration?branch=%3Cstring%3E"

Dev server configuration

{
  "devCommand": "npm run dev",
  "installCommand": "npm install",
  "timeout": 30,
  "envVars": {
    "RESEND_API_KEY": "re_123456789"
  },
  "ports": [
    {
      "externalPort": 443,
      "targetPort": 3000
    }
  ],
  "preset": {},
  "systemd": {},
  "users": [
    {
      "name": "string",
      "uid": 0,
      "gecos": "string",
      "groups": [
        "string"
      ],
      "home": "string",
      "shell": "string",
      "system": false
    }
  ],
  "groups": [
    {
      "name": "string",
      "gid": 0,
      "system": false
    }
  ],
  "additionalFiles": {
    "property1": {
      "content": "string",
      "encoding": "string"
    },
    "property2": {
      "content": "string",
      "encoding": "string"
    }
  },
  "webTerminal": true,
  "webVscode": true,
  "additionalRepositories": [
    {
      "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
      "path": "string"
    }
  ]
}

Freestyle AI

Documentation assistant

Experimental: AI responses may not always be accurate—please verify important details with the official documentation.

How can I help?

Ask me about Freestyle while you browse the docs.