vaults.createVaultItem

POST

/v1/vaults/{vaultId}/items

curl --request POST \
  --url https://example.com/v1/vaults/example/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "source": { "_tag": "Builtin" }, "fields": [ "example" ], "values": { "additionalProperty": "example" }, "exits": [ { "_tag": "App", "connection": "example", "tool": "example" } ] }'

Adds an item. For an item of a secret provider, the caller must be able to use the provider, and OpenBot reads the item once to check that its fields are there.

Authorizations

• token
• session

Parameters

Path Parameters

vaultId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

name

required

string

description

string

<= 500 characters

source

required

Any of:

object

object

_tag

required

string

Allowed values: Builtin

object

object

_tag

required

string

Allowed values: OnePassword

provider

required

string

>= 1 characters <= 128 characters

vault

required

string

>= 1 characters <= 128 characters

item

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: Bitwarden

provider

required

string

>= 1 characters <= 128 characters

item

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: HashiCorp

provider

required

string

>= 1 characters <= 128 characters

path

required

string

>= 1 characters <= 512 characters

fields

Array<string>

>= 1 items <= 32 items

values

object

key

additional properties

string

>= 1 characters <= 4096 characters

exits

required

Array

<= 32 items

Any of:

object

object

_tag

required

string

Allowed values: App

connection

required

string

>= 1 characters <= 128 characters

tool

required

Any of:

string

string

>= 1 characters <= 256 characters

null

null

Responses

201

Success

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

vault

required

string

>= 1 characters <= 128 characters

name

required

string

description

required

string

source

required

Any of:

object

object

_tag

required

string

Allowed values: Builtin

object

object

_tag

required

string

Allowed values: OnePassword

provider

required

string

>= 1 characters <= 128 characters

vault

required

string

>= 1 characters <= 128 characters

item

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: Bitwarden

provider

required

string

>= 1 characters <= 128 characters

item

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: HashiCorp

provider

required

string

>= 1 characters <= 128 characters

path

required

string

>= 1 characters <= 512 characters

fields

required

Array<string>

exits

required

Array

Any of:

object

object

_tag

required

string

Allowed values: App

connection

required

string

>= 1 characters <= 128 characters

tool

required

Any of:

string

string

>= 1 characters <= 256 characters

null

null

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "source": {
    "_tag": "Builtin"
  },
  "exits": [
    {
      "_tag": "App"
    }
  ]
}

400

VaultInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: VaultInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "VaultInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

VaultNotFound | VaultItemNotFound | SecretProviderNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: VaultNotFound

id

required

string

object

object

_tag

required

string

Allowed values: VaultItemNotFound

id

required

string

object

object

_tag

required

string

Allowed values: SecretProviderNotFound

id

required

string

Example

{
  "_tag": "VaultNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: SecretProviderInUse

id

required

string

object

object

_tag

required

string

Allowed values: VaultConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

SecretProviderFailed

Media typeapplication/json

object

_tag

required

string

Allowed values: SecretProviderFailed

message

required

string

Example

{
  "_tag": "SecretProviderFailed"
}

503

VaultsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: VaultsUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}