KEkernel
Vaults

Get a vault item, its currently available operations, and optionally expanded live data

Changed on

The response advertises operations that are valid in the item's current state and live data that can be requested through expand. Read each operation's description before using it. Expanded data is fetched from the provider and is not persisted in the vault item. Requesting an unavailable expansion returns 409 instead of a partial item. Pending credential items return a collection action. Kernel-hosted active collection links are renewed atomically on expiry for ready or pending items without changing the item version. Invoke collect to open a form for a ready item without clearing values. Sensitive credential values are never returned.

get/vaults/{id_or_name}/items/{key}

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/vaults/{id_or_name}/items/{key}
  • Auth
    HTTP bearer

Query parameters

waitinteger

Hold for up to this many seconds while the item is pending authorization, approval, or credential collection. Return the current item when ready or when the wait elapses. This does not wait for edits to an already-ready credential; poll GET without wait and compare version to observe changes after collect. Managed auth credentials are created ready, so wait returns immediately.

expandVaultItemExpansionType[]

Live fields advertised by available_expansions to include in expanded.

Response

Vault item

OR
OR
OR
OR

Changes

  • 324a13ba3570Revision changes
    • info

      the ///////// response's property pattern was changed from ^[A-Za-z]{3}$ to ^[Uu][Ss][Dd]$ for the status

  • 8e5483977604Revision changes
    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • info

      added shop_pay discriminator mapping keys to the //// response property for the response status

    • info

      added shop_pay discriminator mapping keys to the //// response property for the response status

    • info

      added shop_pay discriminator mapping keys to the //// response property for the response status

    • info

      added shop_pay discriminator mapping keys to the //// response property for the response status

    • info

      added shop_pay_oauth discriminator mapping keys to the //// response property for the response status

    • info

      added shop_pay_oauth discriminator mapping keys to the //// response property for the response status

    • info

      added shop_pay_oauth discriminator mapping keys to the //// response property for the response status