Answers when the API is up.

GET

/api/health

const url = 'https://app.jadwigo.pl/api/health';
const options = {method: 'GET'};

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

curl --request GET \
  --url https://app.jadwigo.pl/api/health

Responses

200

OK.

application/json

object

status

required

string

Allowed value: ok

Example

{
  "status": "ok"
}

4XX

An error: {error: {type, message}}. The type names the cause, and answers with one status:

400: BadRequest, ServerFieldSupplied
401: NotSignedIn, Unauthorized
404: NotFound
409: AccountMissing, AttemptClaimed, AttemptPreview, AssignmentClosed, AttemptFinished, AttemptNotFinished, AttemptPaused, QuestionNotOpen, TryOutOfOrder, AnswerConflict, EventIdMismatch, WriteOnce
429: AnswerLimit
502: BankUnavailable

application/json

object

error

required

object

type

required

string

Allowed values: BadRequest ServerFieldSupplied NotSignedIn NotFound AccountMissing AttemptClaimed AttemptPreview AssignmentClosed AttemptFinished AttemptNotFinished AttemptPaused QuestionNotOpen TryOutOfOrder AnswerConflict EventIdMismatch WriteOnce AnswerLimit Unauthorized BankUnavailable

message

required

string

Example

{
  "error": {
    "type": "BadRequest"
  }
}

5XX

An error: {error: {type, message}}. The type names the cause, and answers with one status:

400: BadRequest, ServerFieldSupplied
401: NotSignedIn, Unauthorized
404: NotFound
409: AccountMissing, AttemptClaimed, AttemptPreview, AssignmentClosed, AttemptFinished, AttemptNotFinished, AttemptPaused, QuestionNotOpen, TryOutOfOrder, AnswerConflict, EventIdMismatch, WriteOnce
429: AnswerLimit
502: BankUnavailable

application/json

object

error

required

object

type

required

string

message

required

string

Example

{
  "error": {
    "type": "BadRequest"
  }
}