Update API key
curl --request PATCH \
--url https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"functions": [
{
"name": "function-name",
"namespace": "namespace-name"
}
],
"description": "key-description",
"expire": "2023-08-22T11:21:00Z"
}
'import requests
url = "https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name}"
payload = {
"functions": [
{
"name": "function-name",
"namespace": "namespace-name"
}
],
"description": "key-description",
"expire": "2023-08-22T11:21:00Z"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
functions: [{name: 'function-name', namespace: 'namespace-name'}],
description: 'key-description',
expire: '2023-08-22T11:21:00Z'
})
};
fetch('https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_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/keys/{project_id}/{region_id}/{key_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'functions' => [
[
'name' => 'function-name',
'namespace' => 'namespace-name'
]
],
'description' => 'key-description',
'expire' => '2023-08-22T11:21:00Z'
]),
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/keys/{project_id}/{region_id}/{key_name}"
payload := strings.NewReader("{\n \"functions\": [\n {\n \"name\": \"function-name\",\n \"namespace\": \"namespace-name\"\n }\n ],\n \"description\": \"key-description\",\n \"expire\": \"2023-08-22T11:21:00Z\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"functions\": [\n {\n \"name\": \"function-name\",\n \"namespace\": \"namespace-name\"\n }\n ],\n \"description\": \"key-description\",\n \"expire\": \"2023-08-22T11:21:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"functions\": [\n {\n \"name\": \"function-name\",\n \"namespace\": \"namespace-name\"\n }\n ],\n \"description\": \"key-description\",\n \"expire\": \"2023-08-22T11:21:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-08-22T11:21:00Z",
"functions": [
{
"name": "function-name",
"namespace": "namespace-name"
}
],
"name": "key-name",
"status": "Expired",
"description": "key-description",
"expire": "2023-08-22T11:21:00Z"
}Function as a Service
Update API key
Update the configuration of an existing API key. Only specified fields will be modified.
PATCH
/
cloud
/
v1
/
faas
/
keys
/
{project_id}
/
{region_id}
/
{key_name}
Update API key
curl --request PATCH \
--url https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"functions": [
{
"name": "function-name",
"namespace": "namespace-name"
}
],
"description": "key-description",
"expire": "2023-08-22T11:21:00Z"
}
'import requests
url = "https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name}"
payload = {
"functions": [
{
"name": "function-name",
"namespace": "namespace-name"
}
],
"description": "key-description",
"expire": "2023-08-22T11:21:00Z"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
functions: [{name: 'function-name', namespace: 'namespace-name'}],
description: 'key-description',
expire: '2023-08-22T11:21:00Z'
})
};
fetch('https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_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/keys/{project_id}/{region_id}/{key_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'functions' => [
[
'name' => 'function-name',
'namespace' => 'namespace-name'
]
],
'description' => 'key-description',
'expire' => '2023-08-22T11:21:00Z'
]),
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/keys/{project_id}/{region_id}/{key_name}"
payload := strings.NewReader("{\n \"functions\": [\n {\n \"name\": \"function-name\",\n \"namespace\": \"namespace-name\"\n }\n ],\n \"description\": \"key-description\",\n \"expire\": \"2023-08-22T11:21:00Z\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"functions\": [\n {\n \"name\": \"function-name\",\n \"namespace\": \"namespace-name\"\n }\n ],\n \"description\": \"key-description\",\n \"expire\": \"2023-08-22T11:21:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/faas/keys/{project_id}/{region_id}/{key_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"functions\": [\n {\n \"name\": \"function-name\",\n \"namespace\": \"namespace-name\"\n }\n ],\n \"description\": \"key-description\",\n \"expire\": \"2023-08-22T11:21:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-08-22T11:21:00Z",
"functions": [
{
"name": "function-name",
"namespace": "namespace-name"
}
],
"name": "key-name",
"status": "Expired",
"description": "key-description",
"expire": "2023-08-22T11:21:00Z"
}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
Key name
Pattern:
^[a-z][-a-z0-9]{0,24}[a-z0-9]$Example:
"key-name"
Body
application/json
Response
200 - application/json
OK
Key starts to work
Example:
"2023-08-22T11:21:00Z"
List of functions using key
Show child attributes
Show child attributes
Key name
Pattern:
^[a-z][-a-z0-9]{0,24}[a-z0-9]$Example:
"key-name"
Key status
Example:
"Expired"
Optional key description
Example:
"key-description"
Key expires at
Example:
"2023-08-22T11:21:00Z"
Was this page helpful?
⌘I