Create a vault for the Secrets Manager

Post

/api/v1/secretmanager/vault

This operation should be called only by administrator and only once per tenant.

Security

HTTP

Type bearer

Body parameters

{
  "name": "my-vault",
  "description": "Production secrets vault",
  "rotationTime": 90,
  "encryptionAlgorithm": "AES",
  "defaultNotificationMediumId": "01d4b73e-46b3-4347-842d-6b556dc7f9b2",
  "keyRotationScheduleTime": "2026-09-22T04:00:00Z",
  "staticExpiryReminderFrequency": "Daily",
  "staticExpiryReminderTime": "2026-09-22T04:00:00Z",
  "dynamicRotationScheduleTime": "2026-09-22T04:30:00Z",
  "dynamicRotationIntervalHours": 24,
  "verificationScheduleTime": "2026-09-22T05:00:00Z",
  "verificationIntervalHours": 24,
  "recipients": {
    "userIds": [
      "g1bfrv2idml7sxfb5q70"
    ],
    "tags": [],
    "channelIds": null
  }
}

Expand All

object

string

name

string

Min length1

Max length30

Pattern^[a-zA-Z0-9-_\s]{1,30}$

description

string

Min length0

Max length255

lastRotation

string

nextRotation

string

status

string

encryptionAlgorithm

string

metadata

object

property*

string additionalProperties

Valid values[ "Allow", "Deny", "Pending", "Timeout", "Rejected", "ApprovalRequired" ]

defaultNotificationMediumId

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

maxSecretRotationInterval

integer (int32)

rotationTime

integer (int32)

keyRotationScheduleTime

string

Time of day (HH:mm, 24-hour) at which the daily vault key rotation task runs. Must be at least 30 minutes apart from dynamicRotationScheduleTime (SM-0174). Invalid format returns SM-0178. Defaults to 04:00 if not provided.

Default"04:00"

Example02:00

staticExpiryReminderFrequency

string

Frequency for sending static secret expiry reminders. Allowed values: Daily, Weekly, Off (SM-0175). Defaults to Daily if not provided.

Valid values[ "Daily", "Weekly", "Off" ]

Default"Daily"

ExampleWeekly

staticExpiryReminderTime

string

Time of day (HH:mm, 24-hour) at which expiry reminder notifications are sent. Invalid format returns SM-0178. Defaults to 04:00 if not provided.

Default"04:00"

Example09:00

staticExpiryReminderDay

integer (int32)

Day of week for weekly expiry reminders (1=Monday, 7=Sunday). Required when staticExpiryReminderFrequency is Weekly (SM-0176).

Minimum1

Maximum7

Example1

dynamicRotationScheduleTime

string

Start time (HH:mm, 24-hour) for the bulk dynamic secret rotation task. Must be at least 30 minutes apart from keyRotationScheduleTime (SM-0174). Invalid format returns SM-0178. Defaults to 04:30 if not provided.

Default"04:30"

Example03:00

dynamicRotationIntervalHours

integer (int32)

How often (in hours) to run the bulk dynamic secret rotation task. Allowed values: 4, 8, 12, 24 (SM-0177). Defaults to 24 if not provided.

Valid values[ 4, 8, 12, 24 ]

Default24

Example24

verificationScheduleTime

string

Start time (HH:mm, 24-hour) for the secret verification task. Verification runs on its own independent schedule, decoupled from rotation; whether an individual secret is actually verified is a per-secret setting, not vault-level. Invalid format returns SM-0178. Defaults to 05:00 if not provided (30 minutes after the default dynamicRotationScheduleTime; verification then runs independently thereafter).

Default"05:00"

Example05:00

verificationIntervalHours

integer (int32)

How often (in hours) to run the secret verification task. Allowed values: 4, 8, 12, 24 (SM-0181). Defaults to 24 if not provided.

Valid values[ 4, 8, 12, 24 ]

Default24

Example24

Responses

201

successful operation

object

400

Bad request. Returned for the following violations:

SM-0174 — keyRotationScheduleTime and dynamicRotationScheduleTime are less than 30 minutes apart. Both fields are validated against their resolved values; omitted fields are replaced by their defaults (04:00 and 04:30) before the check runs.
SM-0175 — staticExpiryReminderFrequency is not one of Daily, Weekly, or Off.
SM-0176 — staticExpiryReminderDay is missing or not in range 1–7 when staticExpiryReminderFrequency is Weekly.
SM-0177 — dynamicRotationIntervalHours is not one of 4, 8, 12, or 24.
SM-0178 — keyRotationScheduleTime, staticExpiryReminderTime, or dynamicRotationScheduleTime is not in HH:mm format. Message: Invalid schedule time format. Expected HH:mm (e.g. 14:30).
SM-0181 — verificationIntervalHours is not one of 4, 8, 12, or 24.

Was this article helpful?