Functions

Delete function secret

Permanently delete a secret from this function. The secret will be removed from the runtime environment and will no longer be available as an environment variable.

Requirements:

Function must be in ‘deployed’ status (422 if not)
Secret must exist (404 if not found)

After deletion:

Secret is immediately removed from function runtime environment
Function can no longer access the secret value
Any function invocations referencing the deleted secret will fail

This operation cannot be undone. Make sure the secret is no longer needed before deletion. If the function code still references the deleted secret, invocations may fail with undefined variable errors.

DELETE

functions

{function_id}

secrets

{secret_name}

Delete function secret

curl --request DELETE \
  --url https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}"

headers = {"X-API-Key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_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.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Function must be deployed to manage secrets"
}

{
  "error": "Failed to delete secret from Cloudflare"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

function_id

string<uuid>

required

Function identifier

secret_name

string

required

Secret name (uppercase alphanumeric with underscores)

Pattern: ^[A-Z0-9_]+$

Response

Secret deleted successfully (no content returned)

Delete function secret

curl --request DELETE \
  --url https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}"

headers = {"X-API-Key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_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.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/platform/v1/functions/{function_id}/secrets/{secret_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Function must be deployed to manage secrets"
}

{
  "error": "Failed to delete secret from Cloudflare"
}

Overview

WhatsApp API

Platform API

Workflows API

Kapso Agent API

Delete function secret

Authorizations

Path Parameters

Response