Skip to main content
POST
/
texml
/
secrets
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.texml.secrets({ name: 'My Secret Name', value: 'My Secret Value' });

console.log(response.data);
import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.texml.secrets(
    name="My Secret Name",
    value="My Secret Value",
)
print(response.data)
package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Texml.Secrets(context.TODO(), telnyx.TexmlSecretsParams{
		Name:  "My Secret Name",
		Value: "My Secret Value",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.texml.TexmlSecretsParams;
import com.telnyx.sdk.models.texml.TexmlSecretsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        TexmlSecretsParams params = TexmlSecretsParams.builder()
            .name("My Secret Name")
            .value("My Secret Value")
            .build();
        TexmlSecretsResponse response = client.texml().secrets(params);
    }
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.texml.secrets(name: "My Secret Name", value: "My Secret Value")

puts(response)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->texml->secrets(
    name: 'My Secret Name', value: 'My Secret Value'
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}
telnyx texml secrets \
  --api-key 'My API Key' \
  --name 'My Secret Name' \
  --value 'My Secret Value'
curl --request POST \
  --url https://api.telnyx.com/v2/texml/secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Secret Name",
  "value": "My Secret Value"
}
'
{
  "data": {
    "name": "My Secret Name",
    "value": "REDACTED"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create TeXML secret request object

​
name
string
required

Name used as a reference for the secret, if the name already exists within the account its value will be replaced

Example:

"My Secret Name"

​
value
string
required

Secret value which will be used when rendering the TeXML template

Example:

"My Secret Value"

Response

Successful response upon creating a TeXML secret.

​
data
Create TeXML Secret result · object
Example:
{
  "name": "My Secret Name",
  "value": "REDACTED"
}