TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Transaction Management
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Plot Uploading and Analysis Requests
    • Commercial network management
    • Transaction Management
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
      • Analyses
      • Business invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  1. Using the TradeAware API
  2. API reference

Health

PreviousSubmit a TransactionNextVersion

Last updated 7 months ago

Check system health.

Checks whether the system's components are up and running.

get

/health

Authorizations
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.tradeaware.live-eo.com/health' \
  --header 'Authorization: Bearer JWT'
200
503
{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

The Health Check is successful