For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Open source Support FAQs Docs Home

Documentation API reference Release notes

Documentation API reference Release notes

Introduction
- Overview
- Authentication
Guides
Reference

Open source Support FAQs Docs Home

Reference Schema

Get the integration schema

GET

http://localhost:3000/schema/integrations/:name

GET

/schema/integrations/:name

$ curl http://localhost:3000/schema/integrations/name \
>      -u "<username>:<password>"

1 {
2   "schema": {
3     "type": null,
4     "properties": {}
5   },
6   "decorators": [
7     {
8       "type": "encryption",
9       "pointer": "/redisProps/password"
10     }
11   ]
12 }

Returns the integration schema.

Was this page helpful?

Get the profile schema

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

namestringRequired

The name for the selected integration.

Response

Contains the schema for an integration.

schemaobject

All of the properties required for a service.

decoratorslist of objects

Errors

500

Internal Server Error