post
https://example.com/beyondtrust/api/public/v3/secrets-safe/folders//upload
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-datawith 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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…