Skip to content
Navigation

Enable vault

POST
https://api.sureshake.com/v2/entities/{entityId}/collections/{id}/vault

Path parameters

  • entityId
    string
    required
    format: uuid
  • id
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    object
    required
    • collectionId
      string
      required
      format: uuid
    • status
      not_vaulted
      or
      enabling
      or
      active
      or
      failed
      required
    • chainId
      integer
      or null
      required
    • chainName
      string
      or null
      required
    • tokenModuleAddress
      string
      or null
      required
    • tokenId
      string
      or null
      required
    • initializeTransactionHash
      string
      or null
      required
    • explorerUrl
      string
      or null
      required
      format: uri
    • lastError
      string
      or null
      required
    • enabledAt
      string
      or null
      required
      format: date-time
    • activatedAt
      string
      or null
      required
      format: date-time
    • passes
      object
      required
      • pending
        integer
        required
        minimum: 0
      • active
        integer
        required
        minimum: 0
      • failed
        integer
        required
        minimum: 0
      • revoking
        integer
        required
        minimum: 0
      • revoked
        integer
        required
        minimum: 0
  • meta
    optional
    object
    • timestamp
      string
      required
      format: date-time

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

403

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

409

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close