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
        • POSTCreate a new adapter
        • DELDelete an adapter
        • GETExport a single adapter
        • GETGet a mapping between brokers and adapters
        • GETGet adapter
        • POSTImport a new adapter
        • GETList all adapters
        • GETList changelogs
        • PUTRestart an adapter
        • PUTStart an adapter
        • PUTStop an adapter
        • PUTUpdate an adapter
        • PUTUpdate the log levels
        • PUTUpdate the properties of an adapter
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAdapters

Start an adapter

PUT
http://localhost:3000/adapters/:name/start
PUT
/adapters/:name/start
$curl -X PUT http://localhost:3000/adapters//start \
>     -u "<username>:<password>"
1{
2  "status": "OK",
3  "message": "A sample success message"
4}
Starts an adapter in Itential Platform.
Was this page helpful?
Previous

Stop an adapter

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

namestringRequiredformat: "^[^\/]+$"Defaults to
The name of the selected adapter.

Response

The result of the start process contains the status of the command.
statusenum
The status of the API request.
Allowed values:
messagestring
Message containing either confirmation of the operation or the reason for the failure of the operation.

Errors

500
Internal Server Error