Skip to main content
POST
/
vaults
/
{vaultUuid}
/
items
Create a new Item
curl --request POST \
  --url http://localhost:8080/v1/vaults/{vaultUuid}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vault": {
    "id": "<string>"
  },
  "category": "LOGIN",
  "id": "<string>",
  "title": "<string>",
  "urls": [
    {
      "primary": true,
      "href": "https://example.com"
    },
    {
      "href": "https://example.org"
    }
  ],
  "favorite": false,
  "tags": [
    "<string>"
  ],
  "version": 123,
  "sections": [
    {
      "id": "<string>",
      "label": "<string>"
    }
  ],
  "fields": [
    {
      "id": "<string>",
      "type": "STRING",
      "section": {
        "id": "<string>"
      },
      "purpose": "",
      "label": "<string>",
      "value": "<string>",
      "generate": false,
      "recipe": {
        "length": 32,
        "characterSets": [
          "LETTERS"
        ],
        "excludeCharacters": "abc1"
      }
    }
  ],
  "files": [
    {
      "id": "6r65pjq33banznomn7q22sj44e",
      "name": "foo.txt",
      "size": 35,
      "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
      "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo="
    }
  ]
}
'
{
  "vault": {
    "id": "<string>"
  },
  "category": "LOGIN",
  "id": "<string>",
  "title": "<string>",
  "urls": [
    {
      "primary": true,
      "href": "https://example.com"
    },
    {
      "href": "https://example.org"
    }
  ],
  "favorite": false,
  "tags": [
    "<string>"
  ],
  "version": 123,
  "state": "ARCHIVED",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastEditedBy": "<string>",
  "sections": [
    {
      "id": "<string>",
      "label": "<string>"
    }
  ],
  "fields": [
    {
      "id": "<string>",
      "type": "STRING",
      "section": {
        "id": "<string>"
      },
      "purpose": "",
      "label": "<string>",
      "value": "<string>",
      "generate": false,
      "recipe": {
        "length": 32,
        "characterSets": [
          "LETTERS"
        ],
        "excludeCharacters": "abc1"
      },
      "entropy": 123
    }
  ],
  "files": [
    {
      "id": "6r65pjq33banznomn7q22sj44e",
      "name": "foo.txt",
      "size": 35,
      "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
      "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo="
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vaultUuid
string
required

The UUID of the Vault to create an Item in

Pattern: ^[\da-z]{26}$

Body

application/json
​
vault
object
required
​
category
enum<string>
required
Available options:
LOGIN,
PASSWORD,
API_CREDENTIAL,
SERVER,
DATABASE,
CREDIT_CARD,
MEMBERSHIP,
PASSPORT,
SOFTWARE_LICENSE,
OUTDOOR_LICENSE,
SECURE_NOTE,
WIRELESS_ROUTER,
BANK_ACCOUNT,
DRIVER_LICENSE,
IDENTITY,
REWARD_PROGRAM,
DOCUMENT,
EMAIL_ACCOUNT,
SOCIAL_SECURITY_NUMBER,
MEDICAL_RECORD,
SSH_KEY,
CUSTOM
​
id
string
Pattern: ^[\da-z]{26}$
​
title
string
​
urls
object[]
Example:
[
  {
    "primary": true,
    "href": "https://example.com"
  },
  { "href": "https://example.org" }
]
​
favorite
boolean
default:false
​
tags
string[]
​
version
integer
​
sections
object[]
​
fields
object[]
​
files
object[]

Response

OK

​
vault
object
required
​
category
enum<string>
required
Available options:
LOGIN,
PASSWORD,
API_CREDENTIAL,
SERVER,
DATABASE,
CREDIT_CARD,
MEMBERSHIP,
PASSPORT,
SOFTWARE_LICENSE,
OUTDOOR_LICENSE,
SECURE_NOTE,
WIRELESS_ROUTER,
BANK_ACCOUNT,
DRIVER_LICENSE,
IDENTITY,
REWARD_PROGRAM,
DOCUMENT,
EMAIL_ACCOUNT,
SOCIAL_SECURITY_NUMBER,
MEDICAL_RECORD,
SSH_KEY,
CUSTOM
​
id
string
Pattern: ^[\da-z]{26}$
​
title
string
​
urls
object[]
Example:
[
  {
    "primary": true,
    "href": "https://example.com"
  },
  { "href": "https://example.org" }
]
​
favorite
boolean
default:false
​
tags
string[]
​
version
integer
​
state
enum<string>
Available options:
ARCHIVED,
DELETED
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
lastEditedBy
string
​
sections
object[]
​
fields
object[]
​
files
object[]