Create a new deployment
POST
https://api.ridgeline.run /v13/deployments Creates a deployment from files or a Git reference.
Parameters
teamIdstringqueryThe team identifier to perform the request on behalf of.
slugstringqueryThe team slug to perform the request on behalf of.
Request body application/json
namestringrequiredThe project to deploy to.
targetstringWhere the deployment is promoted.
gitSourceobjectThe Git reference to build.
{
"name": "string",
"target": "production",
"gitSource": {
"ref": "string",
"repoId": "string"
}
}Code samples
cURL
curl -X POST "https://api.ridgeline.run/v13/deployments?teamId=&slug=" \
-H "Content-Type: application/json" \
-d '{"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}'TypeScript
const res = await fetch('https://api.ridgeline.run/v13/deployments?teamId=&slug=', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://api.ridgeline.run/v13/deployments?teamId=&slug=",
headers={
"Content-Type": "application/json",
},
json={"name": "string", "target": "production", "gitSource": {"ref": "string", "repoId": "string"}},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.ridgeline.run/v13/deployments?teamId=&slug=", strings.NewReader(`{"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.ridgeline.run/v13/deployments?teamId=&slug=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.ridgeline.run/v13/deployments?teamId=&slug=')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.ridgeline.run/v13/deployments?teamId=&slug="))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"name\":\"string\",\"target\":\"production\",\"gitSource\":{\"ref\":\"string\",\"repoId\":\"string\"}}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
{
"id": "dpl_2k9x",
"url": "my-app-8f3k2.ridgeline.app",
"readyState": "QUEUED"
}400 One of the provided values is invalid.
403 You do not have permission to access this resource.
Updated
Was this page helpful?