DocumentationAPI ReferenceRelease Notes
API Reference

Create file secret

Creates a file secret in the folder with the given ID.

Required Permission(s)

Any of the following:

  • Secrets Safe (Read)
  • Workforce Passwords (Read)

Request Body Details

  • Max file size is 5 MB. Size must be greater than 0 MB
  • Expects multipart/form-data with:
    • secretmetadata: JSON object with the following properties:
      • Title (string, required, length: 1-256)
      • Description (string, length: 1-256)
      • FileName (string, length: 1-256)
      • Owners: Array of JSON objects with the following properties:
        • UserId OR GroupId (int, required, range: 1-2147483647)
      • Notes (string, length: 1-4000)
    • file (file content)
  • When adding the file, the form field name must be "secretmetadata". If the name of the form is anything else, the following error occurs: The multipart Request is missing parts: key:'form-data'=True, key:'secretmetadata'=False
  • Request body contents:
    • Content-Type: application/octet-stream
    • Content Part One - name: form-data, type: binary
    • Content Part Two - name: secretmetadata, type: string

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

ID of the target folder

Query Params
string
Defaults to 3.0

API version for response format

Body Params
string
length between 0 and 256

Filename of the file secret

string
required
length between 0 and 256

Title of the secret

string
length between 0 and 256

Additional information relevant to the secret

int32
1 to 2147483647
deprecated
int32
1 to 2147483647
deprecated
string
deprecated
Owners
array of objects

List of owners of the secret

Owners
string
length between 0 and 4000

Notes relevant to the secret

Urls
array of objects

List of URLs relevant to the secret

Urls
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
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.