Busroot Documentation
Go to OI WebsiteRequest Access to Demo Site
  • Getting Started
    • Overview
    • Concepts and Architecture
      • Station Windows
    • Account Setup
      • Users & Authentication
    • Connecting Stations
    • Glossary
    • Releases
  • Features
    • Production Tracking
    • Asset Utilisation
    • Downtime Analysis
    • Scheduling
    • OEE Analysis
    • Energy Monitoring
    • Cycle Time Analysis
    • Lost Production Cost Analysis
    • Operator Interface
    • Shop Floor LFDs
    • Email Notifications
      • Daily Summary Email
  • Configuration
    • Plants
    • Stations
    • SKUs
    • Issue Reasons
  • Integrations
    • Real-time Station Data
    • HTTP API Reference
      • Account
      • Admin
      • Analysis Cycletime
      • ApiKey
      • Authenticate
      • Dashboard
      • Debug
      • Device
      • Energy
      • File
      • Filter
      • Health Check
      • Issue
      • Non Production Reason
      • Oee
      • OpenAPI
      • Plant
      • Production
      • Schedule
      • Shift
      • Sku
      • Sku Group
      • Station
      • Station Group
      • Station Window
      • Target
      • User
      • Models
    • PowerBI Direct Access
    • Grafana Direct Access
    • Bulk Data Export
      • CSV Download
      • S3 Sync
    • Node-RED Nodes
  • Recommended Hardware
    • Arduino Opta
      • Configuration
      • Cellular Connectivity
    • Android Tablet
    • Energy Monitors
      • 1 Phase < 100A
      • 3 Phase < 100A
      • 3 Phase < 4000A
    • Fire TV Stick
    • Diagnostic Device
  • Partner Portal
    • Overview
    • Becoming a Partner
  • Archive
    • Use Busroot
      • Live Monitoring
        • Cockpit
        • Dashboards
      • Production
        • Production Monitoring
      • OEE
        • OEE Chart
        • PT vs NPT
        • Downtime Detection
        • Utilisation Monitoring
      • Admin
        • Plants
        • Stations
        • SKU Management
        • Shift Patterns
        • Notifications
      • Production Schedules
        • Schedule CSV Upload
      • Operator Tablet
        • Interruption Tool
      • Manage Your Stations
      • Alerts and Emails
    • Workflows
      • Basic Utilisation Monitoring
      • Performance Monitoring
      • Production Progress Forecasting
      • Manual Production Progress Tracking
      • Understanding Downtime Trends
      • Understanding Production Trends
      • Daily Email Summaries
      • Adhoc Production Tracking
      • Short Interval Control
      • Wasted Energy
      • Understanding Energy Consumption Trends
      • Raw Data Access
      • Understanding OEE Trends
    • FAQs
    • CUSTOMER GUIDE TO BUSROOT
      • Requirements before and during Installation
        • Pre-Installation requirements
          • Completing the Work order form
        • What hardware will you need and do we provide it?
        • Connectivity requirements to use Busroot
        • Installation
        • Self-Installation and configuration guide
      • A user guide to getting started with your account
        • Setting up your Plant
        • Login to your account
        • Station Setup
        • SKU Setup
        • Shift Patterns
        • Notifications
      • Glossary of Busroot Menu Features and how to use them
        • Menu - Overview
        • Menu - Live Monitoring
          • Production Progress
          • Cockpit
        • Menu - Production
        • Menu - Scheduling
          • Production Schedules
          • Schedule CSV Upload
        • Menu - OEE Analysis
          • PT vs NPT
          • OEE Chart
          • Utilisation Monitoring
          • Downtime Detection
        • Menu - Energy
    • Onboarding
      • Welcome
      • Getting Started
      • Implementation
      • After the installation
      • For your IT Team
Powered by GitBook

ยฉ 2025 Output Industries Ltd

On this page
  1. Integrations
  2. HTTP API Reference

ApiKey

PreviousAnalysis CycletimeNextAuthenticate
post
Authorizations
Responses
200
200 OK
application/json
400
Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.
application/json
401
Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.
application/json
403
Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.
application/json
409
Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.
application/json
500
Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.
application/json
post
POST /api/key HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "isSuccess": true,
  "result": {
    "key": "text"
  }
}
delete
Authorizations
Path parameters
keystring ยท min: 1Required
Responses
204
204 No Content
400
Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.
application/json
401
Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.
application/json
403
Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.
application/json
409
Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.
application/json
500
Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.
application/json
delete
DELETE /api/key/{key} HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

  • POST/key
  • DELETE/key/{key}