Drivers & Templates
Library driver discovery and the starter templates used to create cloud-backed libraries.
GET /api/library-drivers
List the registered library drivers.
Authentication: Required
Response:
A HAL collection. Each driver carries an id, name, isLocal, and a defaultSyncInterval in minutes (null for local). Cloud drivers also expose UI hints (imageUrl, configComponent, editorComponent). The driver id values, local, onedrive, box, github, googledrive, are exactly the values a library's type accepts.
List library driversGET /api/library-drivers
The registered driver types. Cloud drivers carry their config/editor component hints and a default sync interval (minutes); local has none. The driver ids (local, onedrive, box, github, googledrive) are the values accepted by a library’s type field.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/library-drivers"
}
},
"start": 0,
"count": 5,
"total": 5,
"_embedded": {
"inf:library-driver": [
{
"_links": {
"self": {
"href": "https://informer.example.com/api/library-drivers/local"
}
},
"id": "local",
"name": "Local",
"defaultSyncInterval": null,
"isLocal": true,
"sync": {}
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/library-drivers/onedrive"
}
},
"id": "onedrive",
"name": "Microsoft OneDrive®",
"imageUrl": "/images/icons/integrations/office.svg",
"editorComponent": {
"libraryReadWriteForm": {
"type": "onedrive"
}
},
"configComponent": "onedriveConfig",
"configLabelFilter": "onedriveDetails",
"defaultSyncInterval": 1,
"isLocal": false
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/library-drivers/box"
}
},
"id": "box",
"name": "Box",
"imageUrl": "/images/icons/box.png",
"editorComponent": "clientIdSecretForm",
"configLabelFilter": "boxDetails",
"defaultSyncInterval": 1440,
"isLocal": false
},
"… 2 more items (5 total) — omitted from docs"
]
}
}
GET /api/library-drivers/{id}
Get a single driver by id.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Driver id (local, onedrive, box, github, googledrive) |
Response:
Get a single driverGET /api/library-drivers/googledrive
Look up one driver by id.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/library-drivers/googledrive"
}
},
"id": "googledrive",
"name": "Google Drive™",
"imageUrl": "/images/icons/integrations/googledrive.svg",
"configComponent": "googledriveConfig",
"editorComponent": {
"clientIdSecretForm": {
"type": "googledrive"
}
},
"defaultSyncInterval": 1440,
"isLocal": false
}
GET /api/library-templates
List the starter templates for creating cloud-backed libraries.
Authentication: Required
Response:
A collection under items. Each entry's value.library is the payload skeleton (a type plus a clientId to fill in) that you POST to /api/libraries; value.name, value.description, and value.image are display metadata.
List library-creation templatesGET /api/library-templates
Starter configurations for creating a cloud library. Each item’s value.library holds the payload skeleton (type plus a clientId to fill in) you POST to /api/libraries.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/library-templates"
}
},
"items": [
{
"detective": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001:0",
"value": {
"group": "__top",
"name": "Microsoft OneDrive®",
"description": "Create a Library from your OneDrive account.",
"image": "/images/icons/integrations/office.svg",
"editorComponent": {
"clientIdSecretForm": {
"clientId": null
}
},
"library": {
"type": "onedrive",
"clientId": null
}
}
},
{
"detective": "00000000-0000-4000-8000-000000000002",
"id": "00000000-0000-4000-8000-000000000002:0",
"value": {
"group": "__top",
"name": "Box®",
"description": "Create a Library from your Box account.",
"image": "/images/icons/box.png",
"editorComponent": {
"clientIdSecretForm": {
"clientId": null,
"type": "box"
}
},
"library": {
"clientId": null,
"type": "box"
}
}
},
{
"detective": "00000000-0000-4000-8000-000000000003",
"id": "00000000-0000-4000-8000-000000000003:0",
"value": {
"group": "__top",
"name": "GitHub Repository",
"description": "Create a Library from your GitHub repository.",
"image": "/images/icons/integrations/github-mark.svg",
"editorComponent": {
"clientIdSecretForm": {
"clientId": null,
"type": "github"
}
},
"library": {
"type": "github",
"clientId": null
}
}
},
"… 1 more items (4 total) — omitted from docs"
],
"start": 0,
"count": 4,
"total": 4
}