Check the connection

GET

/api/v1/status

const url = 'http://localhost:8080/api/v1/status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/status \
  --header 'Authorization: Bearer <token>'

Authorizations

apiKey

Responses

200

The key is valid.

application/json

object

app

required

string

Allowed value: dreeve

version

required

The running Dreeve version.

string

canUpload

required

Whether this instance accepts uploads. False when IMPORT_MODE is not files, in which case every upload answers 409.

boolean

Examples

Ready to accept uploads

{
  "app": "dreeve",
  "version": "v5.2.3",
  "canUpload": true
}

Valid key, but uploads are disabled

{
  "app": "dreeve",
  "version": "v5.2.3",
  "canUpload": false
}

401

The Authorization header was missing, malformed, or did not match the configured key.

application/json

Every error uses this shape.

object

error

required

A stable, machine readable code.

string

Allowed values: invalid_token missing_file unsupported_media_type unsupported_file_type file_too_large import_mode_not_files not_found method_not_allowed bad_request forbidden internal_error

message

required

string

Examples

invalidToken

{
  "error": "invalid_token",
  "message": "A valid API token is required. Send it in the Authorization header as a Bearer token."
}

Headers

WWW-Authenticate

string