curl --request POST \
--url https://api.korve.dev/v1/orgs/{orgId}/projects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"region": "<string>",
"gitRepo": "<string>",
"gitRef": "<string>"
}
'import requests
url = "https://api.korve.dev/v1/orgs/{orgId}/projects"
payload = {
"name": "<string>",
"slug": "<string>",
"region": "<string>",
"gitRepo": "<string>",
"gitRef": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
region: '<string>',
gitRepo: '<string>',
gitRef: '<string>'
})
};
fetch('https://api.korve.dev/v1/orgs/{orgId}/projects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.korve.dev/v1/orgs/{orgId}/projects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'region' => '<string>',
'gitRepo' => '<string>',
'gitRef' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.korve.dev/v1/orgs/{orgId}/projects"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"region\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"gitRef\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.korve.dev/v1/orgs/{orgId}/projects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"region\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"gitRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"region\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"gitRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"runtimeClass": "scale-to-zero",
"region": "<string>",
"gitRepo": "<string>",
"gitRef": "<string>",
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}Create
Create a project and provision its runtime.
curl --request POST \
--url https://api.korve.dev/v1/orgs/{orgId}/projects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"region": "<string>",
"gitRepo": "<string>",
"gitRef": "<string>"
}
'import requests
url = "https://api.korve.dev/v1/orgs/{orgId}/projects"
payload = {
"name": "<string>",
"slug": "<string>",
"region": "<string>",
"gitRepo": "<string>",
"gitRef": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
region: '<string>',
gitRepo: '<string>',
gitRef: '<string>'
})
};
fetch('https://api.korve.dev/v1/orgs/{orgId}/projects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.korve.dev/v1/orgs/{orgId}/projects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'region' => '<string>',
'gitRepo' => '<string>',
'gitRef' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.korve.dev/v1/orgs/{orgId}/projects"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"region\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"gitRef\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.korve.dev/v1/orgs/{orgId}/projects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"region\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"gitRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"region\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"gitRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"runtimeClass": "scale-to-zero",
"region": "<string>",
"gitRepo": "<string>",
"gitRef": "<string>",
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The organization's id (UUID) or slug — either form is accepted.
Body
Managed subdomain label — globally unique.
^[a-z][a-z0-9-]{1,61}$scale-to-zero, always-on Compute region id for always-on apps (see regions.list); defaults to the platform default region. Scale-to-zero apps run on the global edge and must not pick a region.
Repository to connect as "owner/repo" — enables push-to-deploy and pull-request previews.
^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$Production branch for push-to-deploy. Defaults to main.
Response
Project created.
^[a-z][a-z0-9-]{1,61}$scale-to-zero, always-on Where the app runs: a compute region id for always-on apps, "global" for scale-to-zero apps (they run on the global edge). Always-on projects can change regions with projects.update; the catalog lives at regions.list.
Connected repository as "owner/repo" — pushes and pull requests there drive deploys and previews; null when no repository is connected.
Production branch — pushes to it deploy automatically.
Public URL on the managed domain ("https://.korve.app").