Juicebox Environment Information API

This endpoint provides information about the environment of the currently running Juicebox. It requires the user to be logged in and to either be a super user or a client admin.

Get information about the running Juicebox environment

GET /api/v1/jb/env/

Get information about this Juicebox environment

Example Request:

GET /api/v1/jb/env/
Accept: application/json
Authorization: Token 7297b3ebb0e7f7baf5f54d39908dda99f5ea8665

Example Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/json

{
   "environment": "dev",
   "upload_bucket_name": "my_bucket"
}
Response JSON Object:
 
  • environment (string) – the environment juicebox is running in
  • upload_bucket_name (string) – the name of the s3 bucket where uploads will be stored for this client
Request Headers:
 
  • Accept – the response content type depends on Accept header
  • Authorization – contains the token to be used for authentication
Response Headers:
 
Status Codes: