Create a new project

POSThttps://api.ridgeline.run/v11/projectsOpenAPI spec

Creates a project with the provided configuration. Only the project name is required; everything else overrides a default.

Parameters

teamIdstringquery

The team identifier to perform the request on behalf of.

slugstringquery

The team slug to perform the request on behalf of.

Request body

namestringrequired

The project name. Lowercase, up to 100 characters.

frameworkstring

The framework preset, or null for other.

nextjs | astro | sveltekit | remix | vite

buildCommandstring

Overrides the detected build command.

rootDirectorystring

The folder inside the repository that holds the app.

environmentVariablesobject[]

Variables to create with the project.

Show child parameters

keystring

valuestring

targetstring

production | preview | development

{
  "name": "string",
  "framework": "nextjs",
  "buildCommand": "string",
  "rootDirectory": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "string",
      "target": "production"
    }
  ]
}

Code samples

TypeScript

const res = await fetch('https://api.ridgeline.run/v11/projects?teamId=&slug=', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name":"string","framework":"nextjs","buildCommand":"string","rootDirectory":"string","environmentVariables":[{"key":"string","value":"string","target":"production"}]}),
});
const data = await res.json();

cURL

curl -X POST "https://api.ridgeline.run/v11/projects?teamId=&slug=" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","framework":"nextjs","buildCommand":"string","rootDirectory":"string","environmentVariables":[{"key":"string","value":"string","target":"production"}]}'

Python

import requests

res = requests.request(
    "POST",
    "https://api.ridgeline.run/v11/projects?teamId=&slug=",
    headers={
    "Content-Type": "application/json",
    },
    json={"name": "string", "framework": "nextjs", "buildCommand": "string", "rootDirectory": "string", "environmentVariables": [{"key": "string", "value": "string", "target": "production"}]},
)
data = res.json()

Responses

200 OK

Example

{
  "id": "prj_8f3k2",
  "name": "my-app",
  "framework": "nextjs",
  "createdAt": 1760000000000
}

Schema

idstring

namestring

frameworkstring

createdAtinteger

400 One of the provided values is invalid.

403 You do not have permission to access this resource.

{ "name": "string", "framework": "nextjs", "buildCommand": "string", "rootDirectory": "string", "environmentVariables": [ { "key": "string", "value": "string", "target": "production" } ] }

const res = await fetch('https://api.ridgeline.run/v11/projects?teamId=&slug=', { method: 'POST', headers: { 'Content-Type': 'application/json', }, body: JSON.stringify({"name":"string","framework":"nextjs","buildCommand":"string","rootDirectory":"string","environmentVariables":[{"key":"string","value":"string","target":"production"}]}), }); const data = await res.json();

curl -X POST "https://api.ridgeline.run/v11/projects?teamId=&slug=" \ -H "Content-Type: application/json" \ -d '{"name":"string","framework":"nextjs","buildCommand":"string","rootDirectory":"string","environmentVariables":[{"key":"string","value":"string","target":"production"}]}'

import requests res = requests.request( "POST", "https://api.ridgeline.run/v11/projects?teamId=&slug=", headers={ "Content-Type": "application/json", }, json={"name": "string", "framework": "nextjs", "buildCommand": "string", "rootDirectory": "string", "environmentVariables": [{"key": "string", "value": "string", "target": "production"}]}, ) data = res.json()