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 sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • GETGet the adapter schema
        • GETGet the application schema
        • GETGet the integration schema
        • GETGet the profile schema
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceSchema

Get the adapter schema

GET
http://localhost:3000/schema/adapters/:name
GET
/schema/adapters/:name
$curl http://localhost:3000/schema/adapters/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 adapter schema.
Was this page helpful?
Previous

Get the application schema

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

namestringRequired
The name for the selected adapter.

Response

Contains the schema for an adapter.
schemaobject
All of the properties required for a service.
decoratorslist of objects

Errors

500
Internal Server Error