> For the complete documentation index, see [llms.txt](https://docs.fractalworks.io/joule/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api.md).

# Mangement API

## Overview

The Joule Management API offers a comprehensive set of REST endpoints for managing applications, integrations and data workflows within the Joule platform.

It allows developers to:

1. Deploy and control use cases
2. Manage data pipelines
3. Register connectors
4. Organise contextual data sources

By centralising application and integration management, the Joule Management API streamlines deployment, monitoring and maintenance for data-driven applications.

## API capabilities

### **Use case management**

The use case management endpoints enable full lifecycle control of applications deployed within Joule.

Developers can deploy new use cases, as well as pause, resume or undeploy existing ones as needed.

This feature is essential for **managing and monitoring** application workloads.

{% content-ref url="/pages/EL0K5iMvfzmqjuvV9HjK" %}
[Use case](/joule/developer-guides/api-endpoints/mangement-api/use-case.md)
{% endcontent-ref %}

### **Pipeline management**

Pipeline management endpoints allow for registration, listing, detailing and removal of stream processing pipelines.

These pipelines are fundamental for managing data flows through Joule, **enabling structured and efficient data processing** across use cases.

{% content-ref url="/pages/FwphFZppNyewjI3i94CZ" %}
[Pipelines](/joule/developer-guides/api-endpoints/mangement-api/pipelines.md)
{% endcontent-ref %}

### **Connector management**

Connector management endpoints support the registration, listing, detailing and removal of various data connectors, including both sources and sinks.

This feature enables Joule to **interact with external data systems**, making it easier to bring in data for processing or export processed data to other systems.

{% content-ref url="/pages/2e3yR6IcFxgGOn2WO73N" %}
[Data connectors](/joule/developer-guides/api-endpoints/mangement-api/data-connectors.md)
{% endcontent-ref %}

### **Context management**

The context management endpoints help register, list, detail and unregister contextual data sources, allowing for the organisation of data sources that are specific to a particular context or use case.

This ensures data is properly **segmented and accessible based** on its relevance to specific workflows.

{% content-ref url="/pages/N1V60qWJA4qAZ4odsnaK" %}
[Contextual data](/joule/developer-guides/api-endpoints/mangement-api/contextual-data.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.