JCB API Documentation

The JCB API provides real-time network status updates for the decentralized systems that host Joomla Component Builder (JCB) core classes. It allows developers to check the availability of these systems and ensure smooth functionality during compilation or other related tasks.

Base Endpoint

All API requests are made to the base URL:

Endpoints

1. Project Overview

Get the status of all targets within a specific project.

Endpoint:

Example:

2. Target-Specific Status

Get the network status for a specific target within a project.

Endpoint:

Example:

Error Responses

• Invalid Target:
  GET https://api.joomlacomponentbuilder.com/v1/network/community/jcb/invalid-target

  Response:

  {"error":"Target not found"}
• Invalid Project:
  GET https://api.joomlacomponentbuilder.com/v1/network/community/invalid-project/

  Response:

  {"error":"Project not found"}

Notes

• Status Codes:
  • 1 = Online
  • 0 = Offline
• Use the dataset structure to integrate with monitoring or automation scripts.
• For additional assistance, report issues at git.vdm.dev/joomla.

Examples

Retrieve All Targets in a Project

Request:

Retrieve Status for a Specific Target

Request:

Contact and Support

For questions, bug reports, or feature requests, visit our our Git system and open an issue.

Thank you for using the JCB API!