Get function
curl --request GET \
--url https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name} \
--header 'Authorization: <api-key>'import requests
url = "https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}', 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/{function_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"autoscaling": {
"max_instances": 2,
"min_instances": 1
},
"build_message": "Building",
"build_status": "Building",
"code_text": "def main():\n return 'Hello World'",
"created_at": "2023-08-22T11:21:00Z",
"dependencies": "numpy==1.21.0\npandas==1.3.0",
"deploy_status": {
"deployed": 1
},
"description": "This is a sample function.",
"endpoint": "https://example.com/function-name",
"flavor": "64m-64MB",
"id": "c8a920ad-b5a4-47d5-b8b9-0e6c35cd800f",
"main_method": "run",
"name": "function-name",
"runtime": "python3.7.12",
"status": "Running",
"timeout": 5,
"enable_api_key": true,
"envs": {
"ENV_VAR": "value"
}
}Function as a Service
Get function
Retrieve detailed information about a specific function. Includes function code, configuration, and deployment status.
GET
/
cloud
/
v1
/
faas
/
namespaces
/
{project_id}
/
{region_id}
/
{namespace_name}
/
functions
/
{function_name}
Get function
curl --request GET \
--url https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name} \
--header 'Authorization: <api-key>'import requests
url = "https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}', 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/{function_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"autoscaling": {
"max_instances": 2,
"min_instances": 1
},
"build_message": "Building",
"build_status": "Building",
"code_text": "def main():\n return 'Hello World'",
"created_at": "2023-08-22T11:21:00Z",
"dependencies": "numpy==1.21.0\npandas==1.3.0",
"deploy_status": {
"deployed": 1
},
"description": "This is a sample function.",
"endpoint": "https://example.com/function-name",
"flavor": "64m-64MB",
"id": "c8a920ad-b5a4-47d5-b8b9-0e6c35cd800f",
"main_method": "run",
"name": "function-name",
"runtime": "python3.7.12",
"status": "Running",
"timeout": 5,
"enable_api_key": true,
"envs": {
"ENV_VAR": "value"
}
}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"
Function name
Pattern:
^[a-z][-a-z0-9]{0,24}[a-z0-9]$Example:
"function-name"
Response
200 - application/json
OK
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 build message.
Example:
"Building"
Function build status.
Example:
"Building"
Function code text.
Required string length:
1 - 100000Example:
"def main():\n return 'Hello World'"
Function creation date.
Example:
"2023-08-22T11:21:00Z"
Dependencies for the function to install.
Maximum string length:
100000Example:
"numpy==1.21.0\npandas==1.3.0"
Function deploy status.
Show child attributes
Show child attributes
Example:
{ "deployed": 1 }
Description of the function.
Maximum string length:
255Example:
"This is a sample function."
Function endpoint.
Example:
"https://example.com/function-name"
The name of the flavor associated with the function.
Example:
"64m-64MB"
Function ID.
Example:
"c8a920ad-b5a4-47d5-b8b9-0e6c35cd800f"
The main startup method name.
Required string length:
1 - 100Example:
"run"
Function name.
Pattern:
^[a-z][-a-z0-9]{0,24}[a-z0-9]$Example:
"function-name"
Function runtime.
Example:
"python3.7.12"
Function status.
Example:
"Running"
Function timeout in seconds.
Required range:
0 <= x <= 180Example:
5
Enable or disable API key authentication.
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" }
Was this page helpful?