Documentation Index

Fetch the complete documentation index at: https://docs.britive.com/llms.txt

Use this file to discover all available pages before exploring further.

Britive platform release 2026.05.02 is now live in production.

Create a node/secret

Prev Next
Post
/api/v1/secretmanager/vault/{vaultId}/secrets
Security
HTTP
Type bearer
Path parameters
vaultId
stringRequired

vault Id

Examplea6ed82f6-32b5-46d8-a3a3-c36cc574abd9
Query parameters
path
stringRequired

Secret/Node parent path

Example/machine/DB
Body parameters
Expand All
object
entityType
string
Pattern\s*node\s*|\s*secret\s*
id
string
name
string
Min length1
Max length128
Pattern^[a-zA-Z0-9~`!@#$^&*\\(\)_+=\{\}|;:"?\.>\s-]{1,128}$
value
object
property*
string additionalProperties
description
string
Min length0
Max length255
staticSecretTemplateId
string
secretMode
string
Patternshared|non-shared
secretNature
string
Patternstatic|dynamic
lastRotation
string
nextRotation
string
path
string
secretType
string
rotationInterval
integer (int32)
status
string
Valid values[ "Allow", "Deny", "Pending", "Timeout", "Rejected", "ApprovalRequired" ]
metadata
object
property*
string additionalProperties
Valid values[ "Allow", "Deny", "Pending", "Timeout", "Rejected", "ApprovalRequired" ]
secondaryValue
object

Secondary credential key-value map. Required only when dualAccount is true (Dual Account secrets).

property*
string additionalProperties
dualAccount
boolean

When true the secret holds two sets of credentials (Primary in value and Secondary in secondaryValue) that alternate on each rotation cycle to ensure zero downtime.

Defaultfalse
rotationSettings
object (RotationSettingsDTO)

Rotation target and notification settings embedded in a secret

notificationMedium
Array of string

Notification medium IDs

string
recipients
object (Recipients)
userIds
Array of string
string
tags
Array of string
string
approverGroups
Array of string
string
channelIds
Array of string
string
slackAppChannels
Array of string
string
teamsAppChannels
Array of object (TeamsAppChannels)
object
team
string
channels
Array of string
string
targetData
object (RotationTargetDTO)

The target resource and account that will be updated during rotation, along with the rotation template the Broker executes

resource
string

Identifier of the target resource. Must have rotation enabled in Resource Manager.

Exampleprod-linux-server
accountDetails
object (AccountDetailsDTO)

Account on the target resource that receives the updated credential

name
string

Account name on the target resource

Examplesvc_account
value
string

Account identifier value

Examplesvc_account
rotationTemplate
object (RotationTemplateDTO)

Defines the script/logic the Broker executes to update the credential on the target resource

templateId
string

Unique identifier of the rotation template

Examplelinux-password-rotation
templateName
string

Human-readable name of the rotation template

ExampleLinux Password Rotation
templateVariables
Array of object (RotationTemplateVariableDTO)

Variables required by the rotation template. System-defined variables are populated automatically; user-defined variables must be supplied.

object

A single variable used by the rotation template

name
string

Variable name as referenced in the rotation script

ExamplesudoUser
isSystemDefined
boolean

True if populated automatically by the system; false if user-supplied

Examplefalse
values
Array of string

One or more values for this variable

Example[ "root" ]
string
filename
string
registrationStatus
string
delegationEnabled
boolean
Responses
200

successful operation

object