Slicebox API
Slicebox - safe sharing of medical images
Developer tools#openapi#collaboration
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Slicebox - safe sharing of medical images
Endpoints 118
General
- GETGET /destinations
/destinationsReturns a list of currently available destinations. Possible destinations are box - sending data to a remote box, and scu - sending data a receiving SCP. - GETGET /sources
/sourcesReturns a list of currently available data sources. Possible source types are user - data imported by an API call by a user, box - data received from a remote… - GETGET /system/health
/system/healthNo-op route for checking whether the service is alive or not - POSTPOST /system/stop
/system/stopstop and shut down slicebox
Import
- GETGET /import/sessions
/import/sessions?startindex=0&count=20Returns a list of available import sessions. - POSTPOST /import/sessions
/import/sessionscreate a new import sessions - GETGET /import/sessions/{id}
/import/sessions/:idReturns the import sessions with the supplied ID - DELETEDELETE /import/sessions/{id}
/import/sessions/:iddeletes the import session with the supplied ID - GETGET /import/sessions/{id}/images
/import/sessions/:id/imagesget the imported images corresponding to the import session with the supplied ID - POSTPOST /import/sessions/{id}/images
/import/sessions/:id/imagesadd a DICOM dataset to the import session with the supplied ID
Meta Data
- GETGET /metadata/flatseries
/metadata/flatseries?startindex=0&count=20&orderby=string&orderascending=true&filter=string&sources=string&seriestypes=string&seriestags=stringReturns a list of flattened metadata on the patient, study and series levels - POSTPOST /metadata/flatseries/query
/metadata/flatseries/querysubmit a query for flat series - GETGET /metadata/flatseries/{id}
/metadata/flatseries/:idReturn the flat series with the supplied ID - GETGET /metadata/images
/metadata/images?startindex=0&count=20&seriesid=0Returns a list of metadata on the image level of the DICOM hierarchy - POSTPOST /metadata/images/query
/metadata/images/querysubmit a query for images - GETGET /metadata/images/{id}
/metadata/images/:idReturn the image with the supplied ID - GETGET /metadata/patients
/metadata/patients?startindex=0&count=20&orderby=string&orderascending=true&filter=string&sources=string&seriestypes=string&seriestags=stringReturns a list of metadata on the patient level of the DICOM hierarchy - POSTPOST /metadata/patients/query
/metadata/patients/querysubmit a query for patients - GETGET /metadata/patients/{id}
/metadata/patients/:idReturn the patient with the supplied ID - GETGET /metadata/patients/{id}/images
/metadata/patients/:id/images?sources=string&seriestypes=string&seriestags=stringReturns all images for the patient with the supplied patient ID - GETGET /metadata/series
/metadata/series?startindex=0&count=20&studyid=0&sources=string&seriestypes=string&seriestags=stringReturns a list of metadata on the series level of the DICOM hierarchy - POSTPOST /metadata/series/query
/metadata/series/querysubmit a query for series - GETGET /metadata/series/{id}
/metadata/series/:idReturn the series with the supplied ID - GETGET /metadata/series/{id}/seriestags
/metadata/series/:id/seriestagsget the list of series tags for the series with the supplied ID. - POSTPOST /metadata/series/{id}/seriestags
/metadata/series/:id/seriestagsadd a series tag to the series with the supplied ID - GETGET /metadata/series/{id}/seriestypes
/metadata/series/:id/seriestypesget the list of series types for the series with the supplied ID. - DELETEDELETE /metadata/series/{id}/seriestypes
/metadata/series/:id/seriestypesDelete all series types for the series with the supplied ID - GETGET /metadata/series/{id}/source
/metadata/series/:id/sourceReturn the source of the series with the supplied ID - DELETEDELETE /metadata/series/{seriesId}/seriestags/{seriesTagId}
/metadata/series/:seriesId/seriestags/:seriesTagIdDelete the series tag with the supplied series tag ID from the series with the supplied series ID - PUTPUT /metadata/series/{seriesId}/seriestypes/{seriesTypeId}
/metadata/series/:seriesId/seriestypes/:seriesTypeIdAdd the series type with the supplied series type ID to the series with the supplied series ID - DELETEDELETE /metadata/series/{seriesId}/seriestypes/{seriesTypeId}
/metadata/series/:seriesId/seriestypes/:seriesTypeIdDelete the series type with the supplied series type ID from the series with the supplied series ID - GETGET /metadata/seriestags
/metadata/seriestagsReturns a list of series tags currently currently in use. - GETGET /metadata/studies
/metadata/studies?startindex=0&count=20&patientid=0&sources=string&seriestypes=string&seriestags=stringReturns a list of metadata on the study level of the DICOM hierarchy - POSTPOST /metadata/studies/query
/metadata/studies/querysubmit a query for studies - GETGET /metadata/studies/{id}
/metadata/studies/:idReturn the study with the supplied ID - GETGET /metadata/studies/{id}/images
/metadata/studies/:id/images?sources=string&seriestypes=string&seriestags=stringReturns all images for the study with the supplied study ID - POSTPOST /seriestypes/series/query
/seriestypes/series/querysubmit a query for seriestypes for a list of series
Images
- POSTPOST /images
/imagesadd a DICOM dataset to slicebox - POSTPOST /images/delete
/images/deletebulk delete a sequence of images according to the supplied image IDs. This is the same as a sequence of DELETE requests to /images/{id} - GETGET /images/export
/images/export?id=0download the export set with the supplied export set ID as a zip archive - POSTPOST /images/export
/images/exportcreate an export set, a group of image IDs of images to export. The export set will contain the selected images. The export set is available for download 12… - POSTPOST /images/jpeg
/images/jpeg?studyid=0&description=stringadd a JPEG image to slicebox. The image data will be wrapped in a DICOM file and added as a new series belonging to the study with the supplied ID - GETGET /images/{id}
/images/:idfetch dataset corresponding to the supplied image ID - DELETEDELETE /images/{id}
/images/:idDelete the image with the supplied ID - GETGET /images/{id}/attributes
/images/:id/attributeslist all DICOM attributes of the dataset corresponding to the supplied image ID - GETGET /images/{id}/imageinformation
/images/:id/imageinformationget basic information about the pixel data of an image - PUTPUT /images/{id}/modify
/images/:id/modifymodify and/or insert image attributes according to the input tagpath-value mappings - GETGET /images/{id}/png
/images/:id/png?framenumber=1&windowmin=0&windowmax=0&imageheight=0get a PNG image representation of the image corresponding to the supplied ID
Anonymization
- POSTPOST /anonymization/anonymize
/anonymization/anonymizeanonymize the images corresponding to the supplied list of image IDs (each paired with a list of DICOM tag translation). This route corresponds to repeated… - GETGET /anonymization/keys
/anonymization/keys?startindex=0&count=20&orderby=string&orderascending=true&filter=stringget a list of anonymization keys, each specifying how vital DICOM attributes have been anonymized for a particular image - GETGET /anonymization/keys/export/csv
/anonymization/keys/export/csvexport all anonymization keys as a csv file - POSTPOST /anonymization/keys/query
/anonymization/keys/querysubmit a query for anonymization keys - GETGET /anonymization/keys/{id}
/anonymization/keys/:idget the anonymization key with the supplied ID - DELETEDELETE /anonymization/keys/{id}
/anonymization/keys/:iddelete an anonymization key that is no longer of interest - GETGET /anonymization/keys/{id}/keyvalues
/anonymization/keys/:id/keyvaluesget pointers to the images corresponding to the anonymization key with the supplied ID - GETGET /anonymization/options
/anonymization/optionslist all supported anonymization options defining an anonymization profile - PUTPUT /images/{id}/anonymize
/images/:id/anonymizedelete the selected image and replace it with an anonymized version - POSTPOST /images/{id}/anonymized
/images/:id/anonymizedget an anonymized version of the image with the supplied ID
Boxes
- GETGET /boxes
/boxes?startindex=0&count=20get a list of box connections - POSTPOST /boxes/connect
/boxes/connectconnect to another box using a received URL. Used to connect to a public box. - POSTPOST /boxes/createconnection
/boxes/createconnectioncreate a new box connection where the supplied entity holds the remote box name. Used by publicly available boxes. - GETGET /boxes/incoming
/boxes/incoming?startindex=0&count=20get incoming transactions (finished, currently receiving, waiting or failed) - DELETEDELETE /boxes/incoming/{id}
/boxes/incoming/:iddelete an incoming transaction. If a currently active transaction is deleted, a new transaction with the remainder of the images is created when receiving the… - GETGET /boxes/incoming/{id}/images
/boxes/incoming/:id/imagesget the received images corresponding to the incoming transaction with the supplied ID - GETGET /boxes/outgoing
/boxes/outgoing?startindex=0&count=20get outgoing transactions (finished, currently sending, waiting or failed) - DELETEDELETE /boxes/outgoing/{id}
/boxes/outgoing/:iddelete an outgoing transaction. This will stop ongoing transactions. - GETGET /boxes/outgoing/{id}/images
/boxes/outgoing/:id/imagesget the sent images corresponding to the outgoing transaction with the supplied ID - DELETEDELETE /boxes/{id}
/boxes/:idDelete the remote box with the supplied ID - POSTPOST /boxes/{id}/send
/boxes/:id/sendsend images corresponding to the supplied image ids to the remote box with the supplied ID
Transactions
- POSTPOST /transactions/{token}/image
/transactions/:token/image?transactionid=0&sequencenumber=0&totalimagecount=0add an image (dataset) as part of a transaction. This method is used when sending images using the push method to a public slicebox. - GETGET /transactions/{token}/outgoing
/transactions/:token/outgoing?transactionid=0&imageid=0fetch an image from the connected box as part of a transaction. This method is used when sending images using the poll method from a public slicebox. - POSTPOST /transactions/{token}/outgoing/done
/transactions/:token/outgoing/donesignal that the supplied outgoing transaction and image was successfully received and can be marked as sent. This method is used when sending images using the… - POSTPOST /transactions/{token}/outgoing/failed
/transactions/:token/outgoing/failedsignal that the image corresponding to the supplied outgoing transaction and image could not be read or stored properly on the receiving side, and that the… - GETGET /transactions/{token}/outgoing/poll
/transactions/:token/outgoing/pollget next outgoing transaction and image (information on the next image that the connected box wishes to send to you), if any. This method is used when sending… - GETGET /transactions/{token}/status
/transactions/:token/status?transactionid=0get the status of the remote incoming transaction with the supplied transaction ID - PUTPUT /transactions/{token}/status
/transactions/:token/status?transactionid=0update the status of the transaction with the supplied ID
SCPs
- GETGET /scps
/scps?startindex=0&count=20get a list of DICOM SCPs. Each SCP is a server for receiving DICOM images from e.g. a PACS system. - POSTPOST /scps
/scpsadd a new SCP for receiving DICOM images - DELETEDELETE /scps/{id}
/scps/:idshut down and remove the SCP corresponding to the supplied ID
SCUs
- GETGET /scus
/scus?startindex=0&count=20get a list of DICOM SCUs. Each SCU is a client for sending DICOM images to an SCP, e.g. a PACS system. - POSTPOST /scus
/scusadd a new SCU for sending DICOM images - DELETEDELETE /scus/{id}
/scus/:idremove the SCU corresponding to the supplied ID - POSTPOST /scus/{id}/send
/scus/:id/sendsend the images with the supplied image IDs to a DICOM SCP using the the SCU with the supplied scu ID
Directories
- GETGET /directorywatches
/directorywatches?startindex=0&count=20get a list of watch directories. Each watch directory and its sub-directories are watched for incoming DICOM files, which are read and imported into slicebox. - POSTPOST /directorywatches
/directorywatchesadd a new directory to watch for incoming DICOM files - DELETEDELETE /directorywatches/{id}
/directorywatches/:idstop watching and remove the directory corresponding to the supplied ID
Forwarding
- DELETEDELETE /forwarding/rule/{id}
/forwarding/rule/:idremove the forwarding rule corresponding to the supplied ID - GETGET /forwarding/rules
/forwarding/rules?startindex=0&count=20get a list of all forwarding rules. A forwarding rule specifies the automatic forwarding of images from a source (SCP, BOX, etc.) to a destimation (BOX, SCU,… - POSTPOST /forwarding/rules
/forwarding/rulesadd a new forwarding rule
Filtering
- GETGET /filtering/associations
/filtering/associations?startindex=0&count=20Get a list of source to filter associations. - POSTPOST /filtering/associations
/filtering/associationsInserts or updates a source <-> filter associations. If the specified Source already has an association this is updated, otherwise a new is inserted. - DELETEDELETE /filtering/associations/{id}
/filtering/associations/:idremove the source <-> filter association corresponding to the supplied ID - GETGET /filtering/filters
/filtering/filters?startindex=0&count=20List defined filters - POSTPOST /filtering/filters
/filtering/filtersInserts or updates a filter. If a filter with same name as supplied filter exists this filter is updated, otherwise a new filter is inserted. - DELETEDELETE /filtering/filters/{id}
/filtering/filters/:idremove the filter corresponding to the supplied ID - GETGET /filtering/filters/{id}/tagpaths
/filtering/filters/:id/tagpathsList tagpaths for the selected filter - POSTPOST /filtering/filters/{id}/tagpaths
/filtering/filters/:id/tagpathsadd a tagpath to a filter - DELETEDELETE /filtering/filters/{id}/tagpaths/{tagpathid}
/filtering/filters/:id/tagpaths/:tagpathidremove the tagpath corresponding to the supplied ID
Series Types
- GETGET /seriestypes
/seriestypes?startindex=0&count=20get a list of all added series types. By filtering search results for certain series types, it is easier for applications to ensure that they read images of… - POSTPOST /seriestypes
/seriestypesadd a new series type - GETGET /seriestypes/rules
/seriestypes/rules?seriestypeid=0get a list of rules for assigning series types to series. A rule connects to a series of attributes with values and a resulting series type. If a series has… - POSTPOST /seriestypes/rules
/seriestypes/rulesadd a new series type rule - GETGET /seriestypes/rules/updatestatus
/seriestypes/rules/updatestatusget the status of the internal process of updating series types for series following a change of series types, rules or attributes. - DELETEDELETE /seriestypes/rules/{id}
/seriestypes/rules/:idremove the series type rule corresponding to the supplied ID - GETGET /seriestypes/rules/{id}/attributes
/seriestypes/rules/:id/attributesget the list of attributes for the series type rule with the supplied ID. - POSTPOST /seriestypes/rules/{id}/attributes
/seriestypes/rules/:id/attributesadd a new series type rule attribute - DELETEDELETE /seriestypes/rules/{ruleId}/attributes/{attributeId}
/seriestypes/rules/:ruleId/attributes/:attributeIdremove the series type rule attribute corresponding to the supplied series type and attribute IDs - PUTPUT /seriestypes/{id}
/seriestypes/:idrequest an asynchronous update of all series, labelling appropriate series with the series type corresponding to the supplied ID. - DELETEDELETE /seriestypes/{id}
/seriestypes/:idremove the series type corresponding to the supplied ID
Logs
- GETGET /log
/log?startindex=0&count=20&subject=string&type=stringget a list of slicebox log messages - DELETEDELETE /log
/logdelete all log messages - DELETEDELETE /log/{id}
/log/:idDelete the log entry with the supplied ID
Users
- GETGET /users
/users?startindex=0&count=20Returns all users of slicebox - POSTPOST /users
/usersCreates a new user. Dupicates are accepted but not added. - GETGET /users/current
/users/currentobtain information on the currently logged in user as specified by the supplied session cookie, IP address and user agent. - POSTPOST /users/login
/users/loginObtain a session cookie that can be used to authenticate future API calls from the present IP address and with the present user agent. - POSTPOST /users/logout
/users/logoutLogout the current user by responding with a delete cookie header removing the session cookie for this user. - DELETEDELETE /users/{id}
/users/:iddeletes a single user based on the ID supplied
API details
- Base URL
http://slicebox.local/api- Authentication
- None declared in the description
- Operations
- 118 operations on 95 pathsGET 54POST 37DELETE 22PUT 5
- Main resources
- Meta Data 27Images 13Boxes 11Series Types 11Anonymization 10Filtering 9Transactions 7Import 6Users 6General 4
- Response formats
application/jsonapplication/octet-stream- Description format
- Swagger 2.0, API version
2.0 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Slicebox API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Slicebox API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “GET /destinations” (GET /destinations), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Slicebox API?
Slicebox - safe sharing of medical images It is listed under Developer tools and has 118 endpoints.
Who publishes the Slicebox API?
It is listed from Slicebox's public API description (an OpenAPI document), not published by Slicebox on Swastik Codes. Anyone who controls its domain can claim the profile by adding a DNS TXT record.
What is the base URL of the Slicebox API?
Requests go to http://slicebox.local/api. Endpoint paths are added to this base URL.
How do I authenticate with the Slicebox API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Slicebox API have?
118 operations on 95 paths (54 GET, 37 POST, 22 DELETE, 5 PUT). The largest groups are Meta Data, Images, Boxes, Series Types.
Is forking the Slicebox API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.