API documentation

GET /secret_items/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/secret_items/new

Build Secret with defaults.

Returns a Secret built with default attributes for previewing available fields. It is not saved.

Params

Param name	Description
key Optional Blank value allowed	Key Must be a String
value Optional Blank value allowed	The secret’s value, such as an API key or credential, stored encrypted so it can be referenced elsewhere without exposing it directly. Must be a String
description Optional Blank value allowed	Description Must be a String
change_value Optional Blank value allowed	Set to true to replace the stored value with the value given in this request; otherwise the existing value is kept. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/secret_items/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "secret_item": {
    "id": null,
    "type": "SecretItem",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "company_id": 10001,
    "key": null,
    "value": "",
    "description": null,
    "token_replacement_example": "[secret_]"
  },
  "metadata": {
    "root": "secret_item"
  }
}