Update an mTLS configuration

Renames a configuration, replaces its certificate, or both. Only the fields present in the request are changed; anything omitted is left as it is, and a request with neither field is rejected with a 400.

Replacing signedCert switches every webhook using this configuration over to the new certificate in one write, and the private key it was issued for is re-derived from the certificate. A replacement that was not issued for a private key this workspace holds is rejected with a 400.

Sending name: null removes the label.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

PATCH

webhooks_settings

mtls

{webhookMtlsId}

TypeScript

const response: Promise<FireblocksResponse<WebhookMtlsConfig>> = fireblocks.webhooksV2.updateWebhookMtlsConfig(webhooksV2ApiUpdateWebhookMtlsConfigRequest);

curl --request PATCH \
  --url https://api.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production gateway 2027",
  "signedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
}
'

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Production gateway 2027',
    signedCert: '-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----'
  })
};

fetch('https://api.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}', 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.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}",
  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([
    'name' => 'Production gateway 2027',
    'signedCert' => '-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}"

	payload := strings.NewReader("{\n  \"name\": \"Production gateway 2027\",\n  \"signedCert\": \"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Production gateway 2027\",\n  \"signedCert\": \"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\"\n}"

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

{
  "id": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "signedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "expiresAt": 1726108200000,
  "createdAt": 1694572200000,
  "updatedAt": 1726108200000,
  "name": "Production gateway 2026"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Path Parameters

webhookMtlsId

string<uuid>

required

The unique identifier of the mTLS configuration

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

Body

application/json

At least one property must be provided.

name

string | null

A new label for this mTLS configuration, or null to remove it. Letters, digits and spaces only.

Maximum string length: 255

Pattern: ^[a-zA-Z0-9 ]*$

Example:

"Production gateway 2027"

signedCert

string

A replacement signed certificate PEM. Every webhook using this configuration switches to it, and the private key it was issued for is re-derived from the certificate.

Example:

"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"

Response

The updated mTLS configuration

A signed client certificate stored for the workspace, and the id a webhook references to use it. Several webhooks may share one configuration, so replacing the certificate here switches all of them at once.

string<uuid>

required

The unique identifier of the mTLS configuration, to be set on a webhook.

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

signedCert

string

required

The signed client certificate PEM.

Example:

"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"

expiresAt

integer<int64>

required

When the certificate itself expires, in milliseconds since the epoch.

Example:

1726108200000

createdAt

integer<int64>

required

When the certificate was uploaded, in milliseconds since the epoch.

Example:

1694572200000

updatedAt

integer<int64>

required

When this configuration was last changed, in milliseconds since the epoch. Differs from createdAt once the certificate has been replaced or the configuration renamed.

Example:

1726108200000

name

string

The label given to this mTLS configuration.

Example:

"Production gateway 2026"

⌘I

TypeScript

const response: Promise<FireblocksResponse<WebhookMtlsConfig>> = fireblocks.webhooksV2.updateWebhookMtlsConfig(webhooksV2ApiUpdateWebhookMtlsConfigRequest);

curl --request PATCH \
  --url https://api.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production gateway 2027",
  "signedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
}
'

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Production gateway 2027',
    signedCert: '-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----'
  })
};

fetch('https://api.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}', 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.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}",
  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([
    'name' => 'Production gateway 2027',
    'signedCert' => '-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}"

	payload := strings.NewReader("{\n  \"name\": \"Production gateway 2027\",\n  \"signedCert\": \"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/webhooks_settings/mtls/{webhookMtlsId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Production gateway 2027\",\n  \"signedCert\": \"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\"\n}"

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

{
  "id": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "signedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "expiresAt": 1726108200000,
  "createdAt": 1694572200000,
  "updatedAt": 1726108200000,
  "name": "Production gateway 2026"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Update an mTLS configuration

Path Parameters

Body

Response