Multibox box manager API

Please start a discussion or contact us if you have question, feedback or suggestions.
Multibox box manager API uses Aidbox JSON RPC API.
Multibox API is accessible on the box manager URL. Please use an external REST client to access your Multibox server.
RPC methods available
multibox/fhir-versions
List FHIR versions supported by the server. One of these values must be used in multibox/create-box.
multibox/create-box
Create a new box for the current user.
Parameters
Response
Errors
id (required): id of the box to create. Must match /[a-z][a-z0-9]{4,}/
fhirVersion (required): FHIR version. Value must be from the multibox/versions response.
description: description of the box to create.
env: object with environment variables in lower-kebab-case (not in UPPER_SNAKE_CASE).
description - box description 
meta - meta info about the box resource 
fhirVersion 
box-url 
access-url - link to get admin access 
participant- collection of user resources 
resourceType 
env - object with environment variables in lower-kebab-case (not in UPPER_SNAKE_CASE) 
access-token 
id
message - "Can not create box"
message - "Box already exists"
message - FHIR OperationOutcome
multibox/list-boxes
List boxes available for the current user.
Parameters
Response
Error
Expects no parameters
Collection of objects with the following structure:
id - box id
cluster 
fhirVersion - fhir version
message - "No user session"
multibox/get-box
Get box information.
Parameters
Response
Error
id (required): id of the box
description - box description 
meta - meta info about the box resource 
fhirVersion 
box-url 
access-url - link to get admin access 
participant- collection of user resources 
resourceType 
env - object with environment variables in lower-kebab-case (not in UPPER_SNAKE_CASE) 
access-token 
id
message- "You do not have access to this box"
message - "No box with id - "
message - "No user session"
multibox/delete-box
This operation will drop the box database. Can not be undone!
Delete a box
Parameters
Response
Error
id (required): id of the box
description - box description 
meta - meta info about the box resource 
fhirVersion 
box-url 
access-url - link to get admin access 
participant- collection of user resources 
resourceType 
env - object with environment variables in lower-kebab-case (not in UPPER_SNAKE_CASE) 
access-token 
id
message - "Only owner can delete box."
message - "Cannot delete box: \n <details>"
message - FHIR OperationOutcome
multibox/drop-box-caches
Drop cache in every box
Parameters
Response
expects no parameters.
String: "ok".