LogoLogo
ProductsCommunityGitHubShare Feedback
Storage Kit
Storage Kit
  • WHAT IS THE STORAGE KIT?
    • Introduction
    • Architecture
      • System Architecture
      • Functional Architecture
        • L1 | Data Encryption
        • L2 | Data Sharing, Versioning & Search
        • L3 | HL Server-Side Functions
      • Dependencies
  • Getting started
    • Quick Start
    • CLI | Command Line Interface
    • REST APIs
      • Server
      • Client
      • Service
    • Dependency (JVM)
    • Configurations
    • Build
      • Docker Build
      • Local Build
  • Concepts
    • Basic Concepts
      • Sessions
      • Client Set-up
      • Client Document Upload
      • Service Access
    • Advanced Concepts
      • Searchable Symmetric Encryption (SEE)
      • ZCap-LD (Authorization)
        • (Theory) Authorization Capabilities
        • ZCaps - Caveats Extension
  • Usage / Examples
    • Client CLI Examples
    • Client code examples
    • Simple service example
  • Community
    • Discord
    • Twitter
    • Newsletter
    • GitHub Discussions
  • DEVELOPER RELATIONS
    • Contribute
    • Roadmap
    • Share Feedback
    • Contact
  • Product Editions
    • Open Source | Always Free
    • Enterprise | Self-Managed
    • Cloud Platform | Managed
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Getting started
  2. REST APIs

Server

Method
Route
Description

GET

/api-routes

Shows a simple routing table

GET

/api-documentation

Contains the OpenAPI documentation/definition

GET

/swagger

Shows a Swagger API interface

GET

/redoc

Shows a ReDoc API interface

POST

/edvs

Create a EDV

POST

/edvs/{edv-id}/docs

Create a document in an EDV

POST

/edvs/{edv-id}/docs/search

Perform an encrypted search

GET

/edvs/{edv-id}/docs/{doc-id}

Retrieve a specific document

PATCH

/edvs/{edv-id}/docs/{doc-id}

Update a specific document

DELETE

/edvs/{edv-id}/docs/{doc-id}

Delete a specific document

GET

/capabilities

Displays the capabilities of a server

GET

/configuration

Displays the configuration of a server

WEBSOCKET

/edvs/{edv-id}/notifications

Interact with the notification API

PreviousREST APIsNextClient

Last updated 3 years ago

Was this helpful?