DocumentationAPI ReferenceRelease Notes
API Reference

Upload secrets to folder by ID

Imports a CSV secrets file into the specified folder.

Required Permission(s)

Any of the following:

  • Workforce Passwords (Read), when destination folder is a Personal Folder
  • Workforce Passwords (Read) and Secrets Safe (Read), when destination folder is in a safe

Request Body Details

  • Expects multipart/form-data with a single part named form-data containing the CSV file content.

CSV Format

  • The first row must be a header row.
  • Required columns: url, username, password, name.
  • Optional columns: description, notes, type.
    Columns may appear in any order, header matching is case-insensitive (e.g., "URL,UserName,Password,Name" works), and any additional columns in the file are ignored. Exports from third-party password managers import successfully as long as the required columns are present.
  • SecretType selection (controlled by the optional type column):
    • type=credential (case-insensitive) — Credential secret. Requires non-blank username and password.
    • type=text (case-insensitive) — Text secret. Username must be blank; the password column carries the text content (max 4096 chars).
    • type blank or column absent — inferred from username: non-blank = Credential, blank = Text.
    • Any other type value returns ImportResults.InvalidSecretType for that row.
  • Each row's status is reported individually in the response errors[] array.

Field Constraints

  • Per-field length limits (rows that exceed return a row-level error and are skipped):
    • name ≤ 256 chars (ImportResults.TitleTooLong on overflow)
    • url ≤ 2048 chars; required and validated for Credential, optional but validated when present for Text (ImportResults.URLError)
    • username ≤ 256 chars (ImportResults.UsernameExceedsMaxLength)
    • password ≤ 256 chars on Credential rows (ImportResults.PasswordExceedsMaxLength); ≤ 4096 chars on Text rows (ImportResults.TextExceedsMaxLength)
    • description ≤ 256 chars (ImportResults.DescriptionExceedsMaxLength)
    • notes ≤ 4000 chars (ImportResults.NotesExceedsMaxLength)

API Versions

  • Version 3.2 - Includes SecretValueModifiedOn in applicable response models
  • Version 3.1 - Using Owners collection
  • Version 3.0 - Using obsolete owner properties
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique GUID identifier of the target folder for bulk upload

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.