Create function
curl --request POST \
--url https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"autoscaling": {
"max_instances": 2,
"min_instances": 1
},
"code_text": "def main():\n return 'Hello World'",
"flavor": "64m-64MB",
"main_method": "handler",
"name": "function-name",
"runtime": "python3.7.12",
"timeout": 5,
"dependencies": "numpy==1.21.0\npandas==1.3.0",
"description": "This is a sample function.",
"enable_api_key": true,
"envs": {
"ENV_VAR": "value"
}
}
EOFimport requests
url = "https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions"
payload = {
"autoscaling": {
"max_instances": 2,
"min_instances": 1
},
"code_text": "def main():
return 'Hello World'",
"flavor": "64m-64MB",
"main_method": "handler",
"name": "function-name",
"runtime": "python3.7.12",
"timeout": 5,
"dependencies": "numpy==1.21.0
pandas==1.3.0",
"description": "This is a sample function.",
"enable_api_key": True,
"envs": { "ENV_VAR": "value" }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
autoscaling: {max_instances: 2, min_instances: 1},
code_text: 'def main():\n return \'Hello World\'',
flavor: '64m-64MB',
main_method: 'handler',
name: 'function-name',
runtime: 'python3.7.12',
timeout: 5,
dependencies: 'numpy==1.21.0\npandas==1.3.0',
description: 'This is a sample function.',
enable_api_key: true,
envs: {ENV_VAR: 'value'}
})
};
fetch('https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions', 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.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions",
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([
'autoscaling' => [
'max_instances' => 2,
'min_instances' => 1
],
'code_text' => 'def main():
return \'Hello World\'',
'flavor' => '64m-64MB',
'main_method' => 'handler',
'name' => 'function-name',
'runtime' => 'python3.7.12',
'timeout' => 5,
'dependencies' => 'numpy==1.21.0
pandas==1.3.0',
'description' => 'This is a sample function.',
'enable_api_key' => true,
'envs' => [
'ENV_VAR' => 'value'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions"
payload := strings.NewReader("{\n \"autoscaling\": {\n \"max_instances\": 2,\n \"min_instances\": 1\n },\n \"code_text\": \"def main():\\n return 'Hello World'\",\n \"flavor\": \"64m-64MB\",\n \"main_method\": \"handler\",\n \"name\": \"function-name\",\n \"runtime\": \"python3.7.12\",\n \"timeout\": 5,\n \"dependencies\": \"numpy==1.21.0\\npandas==1.3.0\",\n \"description\": \"This is a sample function.\",\n \"enable_api_key\": true,\n \"envs\": {\n \"ENV_VAR\": \"value\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"autoscaling\": {\n \"max_instances\": 2,\n \"min_instances\": 1\n },\n \"code_text\": \"def main():\\n return 'Hello World'\",\n \"flavor\": \"64m-64MB\",\n \"main_method\": \"handler\",\n \"name\": \"function-name\",\n \"runtime\": \"python3.7.12\",\n \"timeout\": 5,\n \"dependencies\": \"numpy==1.21.0\\npandas==1.3.0\",\n \"description\": \"This is a sample function.\",\n \"enable_api_key\": true,\n \"envs\": {\n \"ENV_VAR\": \"value\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoscaling\": {\n \"max_instances\": 2,\n \"min_instances\": 1\n },\n \"code_text\": \"def main():\\n return 'Hello World'\",\n \"flavor\": \"64m-64MB\",\n \"main_method\": \"handler\",\n \"name\": \"function-name\",\n \"runtime\": \"python3.7.12\",\n \"timeout\": 5,\n \"dependencies\": \"numpy==1.21.0\\npandas==1.3.0\",\n \"description\": \"This is a sample function.\",\n \"enable_api_key\": true,\n \"envs\": {\n \"ENV_VAR\": \"value\"\n }\n}"
response = http.request(request)
puts response.read_body{
"tasks": [
"d478ae29-dedc-4869-82f0-96104425f565"
]
}Function as a Service
Create function
Create a new serverless function in the specified namespace. The function can be configured with code, dependencies, and runtime settings.
POST
/
cloud
/
v1
/
faas
/
namespaces
/
{project_id}
/
{region_id}
/
{namespace_name}
/
functions
Create function
curl --request POST \
--url https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"autoscaling": {
"max_instances": 2,
"min_instances": 1
},
"code_text": "def main():\n return 'Hello World'",
"flavor": "64m-64MB",
"main_method": "handler",
"name": "function-name",
"runtime": "python3.7.12",
"timeout": 5,
"dependencies": "numpy==1.21.0\npandas==1.3.0",
"description": "This is a sample function.",
"enable_api_key": true,
"envs": {
"ENV_VAR": "value"
}
}
EOFimport requests
url = "https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions"
payload = {
"autoscaling": {
"max_instances": 2,
"min_instances": 1
},
"code_text": "def main():
return 'Hello World'",
"flavor": "64m-64MB",
"main_method": "handler",
"name": "function-name",
"runtime": "python3.7.12",
"timeout": 5,
"dependencies": "numpy==1.21.0
pandas==1.3.0",
"description": "This is a sample function.",
"enable_api_key": True,
"envs": { "ENV_VAR": "value" }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
autoscaling: {max_instances: 2, min_instances: 1},
code_text: 'def main():\n return \'Hello World\'',
flavor: '64m-64MB',
main_method: 'handler',
name: 'function-name',
runtime: 'python3.7.12',
timeout: 5,
dependencies: 'numpy==1.21.0\npandas==1.3.0',
description: 'This is a sample function.',
enable_api_key: true,
envs: {ENV_VAR: 'value'}
})
};
fetch('https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions', 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.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions",
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([
'autoscaling' => [
'max_instances' => 2,
'min_instances' => 1
],
'code_text' => 'def main():
return \'Hello World\'',
'flavor' => '64m-64MB',
'main_method' => 'handler',
'name' => 'function-name',
'runtime' => 'python3.7.12',
'timeout' => 5,
'dependencies' => 'numpy==1.21.0
pandas==1.3.0',
'description' => 'This is a sample function.',
'enable_api_key' => true,
'envs' => [
'ENV_VAR' => 'value'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions"
payload := strings.NewReader("{\n \"autoscaling\": {\n \"max_instances\": 2,\n \"min_instances\": 1\n },\n \"code_text\": \"def main():\\n return 'Hello World'\",\n \"flavor\": \"64m-64MB\",\n \"main_method\": \"handler\",\n \"name\": \"function-name\",\n \"runtime\": \"python3.7.12\",\n \"timeout\": 5,\n \"dependencies\": \"numpy==1.21.0\\npandas==1.3.0\",\n \"description\": \"This is a sample function.\",\n \"enable_api_key\": true,\n \"envs\": {\n \"ENV_VAR\": \"value\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"autoscaling\": {\n \"max_instances\": 2,\n \"min_instances\": 1\n },\n \"code_text\": \"def main():\\n return 'Hello World'\",\n \"flavor\": \"64m-64MB\",\n \"main_method\": \"handler\",\n \"name\": \"function-name\",\n \"runtime\": \"python3.7.12\",\n \"timeout\": 5,\n \"dependencies\": \"numpy==1.21.0\\npandas==1.3.0\",\n \"description\": \"This is a sample function.\",\n \"enable_api_key\": true,\n \"envs\": {\n \"ENV_VAR\": \"value\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoscaling\": {\n \"max_instances\": 2,\n \"min_instances\": 1\n },\n \"code_text\": \"def main():\\n return 'Hello World'\",\n \"flavor\": \"64m-64MB\",\n \"main_method\": \"handler\",\n \"name\": \"function-name\",\n \"runtime\": \"python3.7.12\",\n \"timeout\": 5,\n \"dependencies\": \"numpy==1.21.0\\npandas==1.3.0\",\n \"description\": \"This is a sample function.\",\n \"enable_api_key\": true,\n \"envs\": {\n \"ENV_VAR\": \"value\"\n }\n}"
response = http.request(request)
puts response.read_body{
"tasks": [
"d478ae29-dedc-4869-82f0-96104425f565"
]
}Authorizations
API key for authentication. Make sure to include the word apikey, followed by a single space and then your token.
Example: apikey 1234_abcdef
Path Parameters
Project ID
Example:
1
Region ID
Example:
1
Namespace name
Pattern:
^[a-z][-a-z0-9]{0,24}[a-z0-9]$Example:
"namespace-name"
Body
application/json
Autoscaling configuration for the function. Keys must be 'min_instances' or 'max_instances', and values must be integers between 0 and 50.
Show child attributes
Show child attributes
Example:
{ "max_instances": 2, "min_instances": 1 }
Function code text.
Required string length:
1 - 100000Example:
"def main():\n return 'Hello World'"
The name of the flavor associated with the function.
Example:
"64m-64MB"
The main startup method name.
Required string length:
1 - 100Example:
"handler"
Function name.
Pattern:
^[a-z][-a-z0-9]{0,24}[a-z0-9]$Example:
"function-name"
Function runtime.
Example:
"python3.7.12"
Function timeout in seconds.
Required range:
0 <= x <= 180Example:
5
Dependencies for the function to install.
Maximum string length:
100000Example:
"numpy==1.21.0\npandas==1.3.0"
Description of the function.
Maximum string length:
255Example:
"This is a sample function."
Enable or disable API key authentication. Enable api key is temporarily disabled. As a result, using Functions with authorization is currently not supported.
Example:
true
Environment variables for the function. Keys must match a specific regex pattern and be 1-255 characters long, and values must be 0-255 characters long.
Show child attributes
Show child attributes
Example:
{ "ENV_VAR": "value" }
Response
200 - application/json
OK
List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:
GET /v1/tasks/{task_id}- Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.
Example:
["d478ae29-dedc-4869-82f0-96104425f565"]
Was this page helpful?