curl --request POST \
--url https://api.example.com/v1/deploy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'function_name=<string>' \
--form port=8080 \
--form memory=1Gi \
--form 'source_archive=<string>' \
--form 'source_object=<string>' \
--form session_affinity=false \
--form use_http2=false \
--form timeout=600 \
--form cpu=1 \
--form concurrency=80 \
--form max_instances=0 \
--form 'volumes=<string>' \
--form schedule= \
--form timezone= \
--form source_archive.0='@example-file'import requests
url = "https://api.example.com/v1/deploy"
files = { "source_archive.0": ("example-file", open("example-file", "rb")) }
payload = {
"function_name": "<string>",
"port": "8080",
"memory": "1Gi",
"source_archive": "<string>",
"source_object": "<string>",
"session_affinity": "false",
"use_http2": "false",
"timeout": "600",
"cpu": "1",
"concurrency": "80",
"max_instances": "0",
"volumes": "<string>",
"schedule": "",
"timezone": ""
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('function_name', '<string>');
form.append('port', '8080');
form.append('memory', '1Gi');
form.append('source_archive', '<string>');
form.append('source_object', '<string>');
form.append('session_affinity', 'false');
form.append('use_http2', 'false');
form.append('timeout', '600');
form.append('cpu', '1');
form.append('concurrency', '80');
form.append('max_instances', '0');
form.append('volumes', '<string>');
form.append('schedule', '');
form.append('timezone', '');
form.append('source_archive.0', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.example.com/v1/deploy', 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.example.com/v1/deploy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.example.com/v1/deploy"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/v1/deploy")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/deploy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Deploy
Deploy a service. Returns NDJSON stream with progress updates.
Post the source as source_archive, the tar.gz, up to 100 MiB. Ship
large files via volumes (cycls volume put), not the source archive.
timeout is how long a single request to the deployed service may run
raise it for long compute, up to Cloud Run’s 3600s ceiling. cpu is raised
automatically if memory requires more than you asked for.
concurrency is how many requests one instance serves at once. Leave it high
for I/O-bound apps; set it to 1 for compute, so each call gets its own instance.
max_instances caps how many instances the service may scale to. 0 (default)
leaves scaling to the platform.
volumes maps mount paths to volumes (JSON), e.g. {"/data": "shared"} or
{"/data": {"name": "shared", "read_only": true, "sub_path": "v1"}}.
Required, {} declares no storage; the deploy is a complete declaration.
Unknown volumes are created (announced in the stream).
schedule fires the deployed function on a cron: {"cron": "0 3 * * *", "timezone": "Asia/Riyadh"}. Empty or omitted removes any schedule, the
same complete-declaration rule.
Events: BUILDING → DEPLOYING → DONE (or ERROR)
curl --request POST \
--url https://api.example.com/v1/deploy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'function_name=<string>' \
--form port=8080 \
--form memory=1Gi \
--form 'source_archive=<string>' \
--form 'source_object=<string>' \
--form session_affinity=false \
--form use_http2=false \
--form timeout=600 \
--form cpu=1 \
--form concurrency=80 \
--form max_instances=0 \
--form 'volumes=<string>' \
--form schedule= \
--form timezone= \
--form source_archive.0='@example-file'import requests
url = "https://api.example.com/v1/deploy"
files = { "source_archive.0": ("example-file", open("example-file", "rb")) }
payload = {
"function_name": "<string>",
"port": "8080",
"memory": "1Gi",
"source_archive": "<string>",
"source_object": "<string>",
"session_affinity": "false",
"use_http2": "false",
"timeout": "600",
"cpu": "1",
"concurrency": "80",
"max_instances": "0",
"volumes": "<string>",
"schedule": "",
"timezone": ""
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('function_name', '<string>');
form.append('port', '8080');
form.append('memory', '1Gi');
form.append('source_archive', '<string>');
form.append('source_object', '<string>');
form.append('session_affinity', 'false');
form.append('use_http2', 'false');
form.append('timeout', '600');
form.append('cpu', '1');
form.append('concurrency', '80');
form.append('max_instances', '0');
form.append('volumes', '<string>');
form.append('schedule', '');
form.append('timezone', '');
form.append('source_archive.0', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.example.com/v1/deploy', 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.example.com/v1/deploy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.example.com/v1/deploy"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/v1/deploy")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/deploy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"function_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"port\"\r\n\r\n8080\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"memory\"\r\n\r\n1Gi\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_object\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_affinity\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"use_http2\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timeout\"\r\n\r\n600\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cpu\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"concurrency\"\r\n\r\n80\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_instances\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"volumes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schedule\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source_archive.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
1 <= x <= 36001 <= x <= 10000 <= x <= 1000Response
NDJSON stream of deployment progress