vaults.getVaultItem

GET

/v1/vaults/{vaultId}/items/{itemId}

const url = 'https://example.com/v1/vaults/example/items/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/vaults/example/items/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

vaultId

required

string

>= 1 characters <= 128 characters

itemId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

required

string

>= 1 characters <= 128 characters

vault

required

string

>= 1 characters <= 128 characters

name

required

string

description

required

string

source

required

Any of:

object

_tag

required

string

Allowed values: Builtin

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
null

string

>= 1 characters <= 256 characters

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

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

400

VaultInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: VaultInvalid

message

required

string

Example

{
  "_tag": "VaultInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

VaultNotFound | VaultItemNotFound | SecretProviderNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: VaultNotFound

required

string

Example

{
  "_tag": "VaultNotFound"
}

409

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

application/json

Any of:

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

SecretProviderFailed

application/json

object

_tag

required

string

Allowed values: SecretProviderFailed

message

required

string

Example

{
  "_tag": "SecretProviderFailed"
}

503

VaultsUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}