Knowledge Hub Management APIs - sources
UpdatedDownload OpenAPI Specification: Download
For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.
List sources
List sources with optional filtering.
Returns list of sources with pagination and optional filtering by name and status.
Each source includes its latest ingestion job summary. Results are scoped to the
caller's Boomi tenant via the token's account claim.
Required privileges: KNOWLEDGE_HUB_SOURCE_READ.
Authorizations:
query Parameters
| limit | integer (Limit) [ 1 .. 1000 ] Default: 50 Maximum results to return |
| offset | integer (Offset) >= 0 Default: 0 Pagination offset |
Name (string) or Name (null) (Name) Filter by source name | |
SourceStatus (string) or Status (null) (Status) Filter by status |
Responses
Response Schema: application/json
| total required | integer (Total) Total number of items matching filters |
| limit required | integer (Limit) Limit applied |
| offset required | integer (Offset) Offset applied |
required | Array of objects (Sources) |
Response samples
- 200
- 422
{- "limit": 20,
- "offset": 0,
- "sources": [
- {
- "created_at": "2026-01-15T10:30:00Z",
- "file_type": "json",
- "id": "30000000-0000-0000-0000-000000000001",
- "name": "HR Jira Issues",
- "source_name": "HR Jira",
- "source_schema": {
- "fields": [
- {
- "embeddable": true,
- "metadata_eligible": true,
- "name": "summary",
- "type": "string"
}
]
}, - "source_type": "jira",
- "status": "active",
- "updated_at": "2026-02-01T09:00:00Z"
}
], - "total": 1
}Create sources
Create sources (batch).
Creates one or more standalone Sources. Sources are created in 'draft' status. Connection to Knowledge Bases is established through SchemaMapping.
All-or-nothing: if any source fails validation, none are created.
Emits one Created audit event per Source in the batch — each is its own auditable entity, distinct from a single-entity create call.
An unstructured source (is_unstructured true, or a known unstructured file type)
may be created with an empty source_schema; kh-api stores the fixed worker field
list plus _content_.
Required privileges: KNOWLEDGE_HUB_SOURCE_WRITE.
Authorizations:
Request Body schema: application/jsonrequired
required | Array of objects (Sources) non-empty Array of sources to create |
Source Type (string) or Source Type (null) (Source Type) Type of source (e.g., jira, salesforce) | |
Source Name (string) or Source Name (null) (Source Name) Display name for the source | |
Source Metadata (object) or Source Metadata (null) (Source Metadata) Opaque JSON blob for source-specific metadata |
Responses
Request samples
- Payload
{- "source_name": "HR Jira",
- "source_type": "jira",
- "sources": [
- {
- "file_type": "json",
- "name": "HR Jira Issues",
- "source_schema": {
- "fields": [
- {
- "embeddable": true,
- "metadata_eligible": true,
- "name": "id",
- "type": "string"
}, - {
- "embeddable": true,
- "metadata_eligible": true,
- "name": "summary",
- "type": "string"
}
]
}
}
]
}Response samples
- 201
- 422
{- "source_ids": [
- "30000000-0000-0000-0000-000000000001"
], - "status": "ok"
}Get source
Get a source by ID.
Includes the latest ingestion job summary.
Required privileges: KNOWLEDGE_HUB_SOURCE_READ.
Authorizations:
path Parameters
| source_id required | string <uuid> (Source Id) UUID of the source |
Responses
Response Schema: application/json
| name required | string (Name) [ 1 .. 255 ] characters |
| id required | string <uuid> (Id) |
required | object (SourceSchema-Output) Schema describing source data structure. |
| status required | string (SourceStatus) Enum: "draft" "active" "disabled" "archived" Valid statuses for Source. |
| created_at required | string <date-time> (Created At) |
| updated_at required | string <date-time> (Updated At) |
Source Type (string) or Source Type (null) (Source Type) e.g., 'jira', 'salesforce' | |
Source Name (string) or Source Name (null) (Source Name) Display name | |
FileType (string) or null Supported file type for ingestion | |
Source Metadata (object) or Source Metadata (null) (Source Metadata) | |
| is_unstructured | boolean (Is Unstructured) Default: false |
LastIngestion (object) or null | |
Created By (string) or Created By (null) (Created By) | |
Updated By (string) or Updated By (null) (Updated By) |
Response samples
- 200
- 422
{- "created_at": "2026-01-15T10:30:00Z",
- "created_by": "admin@boomi.com",
- "file_type": "json",
- "id": "30000000-0000-0000-0000-000000000001",
- "last_ingestion": {
- "completed_at": "2026-02-01T08:45:00Z",
- "job_id": "01920f4a-0000-7000-8000-000000000001",
- "records_failed": 0,
- "records_processed": 120,
- "status": "success"
}, - "name": "HR Jira Issues",
- "source_name": "HR Jira",
- "source_schema": {
- "fields": [
- {
- "embeddable": true,
- "metadata_eligible": true,
- "name": "id",
- "type": "string"
}, - {
- "embeddable": true,
- "metadata_eligible": true,
- "name": "summary",
- "type": "string"
}
]
}, - "source_type": "jira",
- "status": "active",
- "updated_at": "2026-02-01T09:00:00Z",
- "updated_by": "admin@boomi.com"
}Update source
Update a source.
All fields can be updated regardless of status (except archived sources → 404). An ACTIVE source on a published (ENABLED) KB must be disabled before editing → 409. Only fields present in the request body are changed.
Required privileges: KNOWLEDGE_HUB_SOURCE_WRITE.
Authorizations:
path Parameters
| source_id required | string <uuid> (Source Id) UUID of the source |
Request Body schema: application/jsonrequired
| name | string (Name) [ 1 .. 255 ] characters |
Source Type (string) or Source Type (null) (Source Type) | |
Source Name (string) or Source Name (null) (Source Name) Display name | |
FileType (string) or null | |
Source Metadata (object) or Source Metadata (null) (Source Metadata) |
Responses
Response Schema: application/json
| status | string (Status) Default: "ok" |
Request samples
- Payload
{- "file_type": "json",
- "name": "HR Jira Issues",
- "source_name": "HR Jira"
}Response samples
- 200
- 422
{- "status": "ok"
}Delete source
Archive a source (soft delete).
Sets status to 'archived' (terminal). The associated schema mapping, if any, is disabled.
Required privileges: KNOWLEDGE_HUB_SOURCE_DELETE.
Authorizations:
path Parameters
| source_id required | string <uuid> (Source Id) UUID of the source |
Responses
Response Schema: application/json
| status | string (Status) Default: "ok" |
Response samples
- 200
- 422
{- "status": "ok"
}Update source status
Transition a source's status.
Valid transitions:
- DRAFT -> ACTIVE
- ACTIVE -> DISABLED
- DISABLED -> ACTIVE
- ARCHIVED -> (none, terminal)
To archive a source, use DELETE /sources/{source_id} instead.
Transitioning to ACTIVE requires an associated schema mapping with at least one field with query_order set; otherwise 422 is returned.
When transitioning to ACTIVE or DISABLED, the associated schema mapping status is cascaded (ACTIVE->ACTIVE, DISABLED->DISABLED).
Required privileges: KNOWLEDGE_HUB_SOURCE_WRITE.
Authorizations:
path Parameters
| source_id required | string <uuid> (Source Id) UUID of the source |
Request Body schema: application/jsonrequired
| status required | string (SourceStatus) Enum: "draft" "active" "disabled" "archived" Target status for the source |
Responses
Response Schema: application/json
| name required | string (Name) [ 1 .. 255 ] characters |
| id required | string <uuid> (Id) |
required | object (SourceSchema-Output) Schema describing source data structure. |
| status required | string (SourceStatus) Enum: "draft" "active" "disabled" "archived" Valid statuses for Source. |
| created_at required | string <date-time> (Created At) |
| updated_at required | string <date-time> (Updated At) |
Source Type (string) or Source Type (null) (Source Type) e.g., 'jira', 'salesforce' | |
Source Name (string) or Source Name (null) (Source Name) Display name | |
FileType (string) or null Supported file type for ingestion | |
Source Metadata (object) or Source Metadata (null) (Source Metadata) | |
| is_unstructured | boolean (Is Unstructured) Default: false |
LastIngestion (object) or null | |
Created By (string) or Created By (null) (Created By) | |
Updated By (string) or Updated By (null) (Updated By) |
Request samples
- Payload
{- "status": "active"
}Response samples
- 200
{- "created_at": "2026-01-15T10:30:00Z",
- "created_by": "admin@boomi.com",
- "file_type": "json",
- "id": "30000000-0000-0000-0000-000000000001",
- "last_ingestion": {
- "completed_at": "2026-02-01T08:45:00Z",
- "job_id": "01920f4a-0000-7000-8000-000000000001",
- "records_failed": 0,
- "records_processed": 120,
- "status": "success"
}, - "name": "HR Jira Issues",
- "source_name": "HR Jira",
- "source_schema": {
- "fields": [
- {
- "embeddable": true,
- "metadata_eligible": true,
- "name": "id",
- "type": "string"
}, - {
- "embeddable": true,
- "metadata_eligible": true,
- "name": "summary",
- "type": "string"
}
]
}, - "source_type": "jira",
- "status": "active",
- "updated_at": "2026-02-01T09:00:00Z",
- "updated_by": "admin@boomi.com"
}