Skip to content
Starlight OpenAPI

Create a new Item

POST
/vaults/{vaultUuid}/items

Authorizations

Parameters

Path Parameters

vaultUuid
required
string
/^[\da-z]{26}$/

The UUID of the Vault to create an Item in

Request Body

object
category
required
string
Allowed values: 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
createdAt
string format: date-time
favorite
boolean
id
string
/^[\da-z]{26}$/
lastEditedBy
string
state
string
Allowed values: ARCHIVED DELETED
tags
Array<string>
title
string
updatedAt
string format: date-time
urls
Array<object>
object
href
required
string format: url
label
string
primary
boolean
[
  {
    "href": "https://example.com",
    "primary": true
  },
  {
    "href": "https://example.org"
  }
]
vault
required
object
id
required
string
/^[\da-z]{26}$/
version
integer
fields
Array<object>
object
entropy

For fields with a purpose of PASSWORD this is the entropy of the value

number
generate

If value is not present then a new value should be generated for this field

boolean
id
required
string
label
string
purpose

Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.

string
Allowed values: "" USERNAME PASSWORD NOTES
recipe

The recipe is used in conjunction with the “generate” property to set the character set used to generate a new secure value

object
characterSets
Array<string>
<= 3 unique items
Allowed values: LETTERS DIGITS SYMBOLS
excludeCharacters

List of all characters that should be excluded from generated passwords.

string
abc1
length

Length of the generated value

integer
default: 32 >= 1 <= 64
section
object
id
string
type
required
string
default: STRING
Allowed values: STRING EMAIL CONCEALED URL TOTP DATE MONTH_YEAR MENU
value
string
files
Array<object>
object
content

Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and inline_files is set to true.

string format: byte
content_path

Path of the Connect API that can be used to download the contents of this file.

string
id

ID of the file

string
name

Name of the file

string
section

For files that are in a section, this field describes the section.

object
id
string
size

Size in bytes of the file

integer
{
  "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo=",
  "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
  "id": "6r65pjq33banznomn7q22sj44e",
  "name": "foo.txt",
  "size": 35
}
sections
Array<object>
object
id
string
label
string

Responses

200

OK

object
category
required
string
Allowed values: 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
createdAt
string format: date-time
favorite
boolean
id
string
/^[\da-z]{26}$/
lastEditedBy
string
state
string
Allowed values: ARCHIVED DELETED
tags
Array<string>
title
string
updatedAt
string format: date-time
urls
Array<object>
object
href
required
string format: url
label
string
primary
boolean
[
  {
    "href": "https://example.com",
    "primary": true
  },
  {
    "href": "https://example.org"
  }
]
vault
required
object
id
required
string
/^[\da-z]{26}$/
version
integer
fields
Array<object>
object
entropy

For fields with a purpose of PASSWORD this is the entropy of the value

number
generate

If value is not present then a new value should be generated for this field

boolean
id
required
string
label
string
purpose

Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.

string
Allowed values: "" USERNAME PASSWORD NOTES
recipe

The recipe is used in conjunction with the “generate” property to set the character set used to generate a new secure value

object
characterSets
Array<string>
<= 3 unique items
Allowed values: LETTERS DIGITS SYMBOLS
excludeCharacters

List of all characters that should be excluded from generated passwords.

string
abc1
length

Length of the generated value

integer
default: 32 >= 1 <= 64
section
object
id
string
type
required
string
default: STRING
Allowed values: STRING EMAIL CONCEALED URL TOTP DATE MONTH_YEAR MENU
value
string
files
Array<object>
object
content

Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and inline_files is set to true.

string format: byte
content_path

Path of the Connect API that can be used to download the contents of this file.

string
id

ID of the file

string
name

Name of the file

string
section

For files that are in a section, this field describes the section.

object
id
string
size

Size in bytes of the file

integer
{
  "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo=",
  "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
  "id": "6r65pjq33banznomn7q22sj44e",
  "name": "foo.txt",
  "size": 35
}
sections
Array<object>
object
id
string
label
string

400

Unable to create item due to invalid input

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "Invalid item category",
  "status": 400
}

401

Invalid or missing token

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "Invalid token signature",
  "status": 401
}

403

Unauthorized access

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "vault {vaultUuid} is not in scope",
  "status": 403
}

404

Item not found

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Examples

Vault not found

{
  "message": "vault {vaultUuid} not found",
  "status": 404
}