zVault API

Deletes existing master key.

post

Deletes existing master key, propagating changes to Zauth.

Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
200
OK
post
POST /delete/:client_id HTTP/1.1
Host: 
Accept: */*

No content

Generate new split key.

post

Generates new split key using previously stored or generated master key, propagating changes to zauth.

Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
201
Created
post
POST /key/:client_id HTTP/1.1
Host: 
Accept: */*

No content

Retrieves split keys for the given master key.

get
Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
200
OK
get
GET /keys/:client_id HTTP/1.1
Host: 
Accept: */*

No content

Retrieves restrictions for the given split key.

get
Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

X-Peer-Public-KeyanyRequired

Peer public key of the split key, which restrictions should be updated

Responses
200
OK
get
GET /restrictions HTTP/1.1
Host: 
Accept: */*

No content

Update restrictions for the existing split key.

put

Updates restrictions for existing split key, propagating changes to Zauth.

Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

X-Peer-Public-KeyanyRequired

Peer public key of the split key, which restrictions should be updated

Responses
200
OK
put
PUT /restrictions/:client_id HTTP/1.1
Host: 
Accept: */*

No content

Revoke existing split key.

post

Revokes existing split key, propagating changes to Zauth.

Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Body
stringOptional
Responses
200
OK
post
POST /revoke/:client_id HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 6

"'text'"
No content

Share existing split key to the givens user.

post

Shares previously created split key to the given user.

Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
200
OK
post
POST /share HTTP/1.1
Host: 
Accept: */*

No content

Store 0box wallet private key.

post

Stores external 0box generated wallet private key as master key used to generate new split keys.

Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
201
Created
post
POST /store HTTP/1.1
Host: 
Accept: */*

No content

Generate new wallet.

post

Generates new wallet used as master key to generate new split keys.

Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
201
Created
post
POST /wallet HTTP/1.1
Host: 
Accept: */*

No content

Retrieves split wallets for the given master key.

get
Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
200
OK
get
GET /wallets HTTP/1.1
Host: 
Accept: */*

No content

Retrieves shared split keys shared with the given user.

get
Header parameters
X-Jwt-TokenanyRequired

0box generated JWT token

Responses
200
OK
get
GET /wallets/shared HTTP/1.1
Host: 
Accept: */*

No content
PreviousAI APIsNextCLIs

Last updated