shadwshadw/Docs
GuidesAPIGetting Started
Dashboard
shadw REST APIOverviewErrors
  • GETGet project settings
  • POSTSet an environment variable
  • DELDelete an environment variable
  • DELDelete a project
APIs & SDKs/shadw REST API/Get project settings

Get project settings

GEThttps://api.shadw.cloud/v1/projects/{project}/settings

Read a project's settings (build config, env, domains, production branch, preview protection).

Authentication

AuthorizationbearerToken

A platform API key (hive_…, created under Settings → API Keys) or a short-lived JWT minted with POST /v1/token. An API key scopes the request to the team it was created under.

Path parameters

projectstringRequired

The project name.

ts
const response = await fetch('https://api.shadw.cloud/v1/projects/{project}/settings', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY', // hive_… (Settings → API Keys)
  },
});

const data = await response.json();
console.log(data);
Response
json
{
  "production_branch": "main",
  "build": { "framework": "", "install_command": "", "build_command": "", "output_dir": "", "root_dir": "" },
  "env": [],
  "domains": [],
  "preview_protection": true,
  "team": "personal"
}