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
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTCreate a new integration
        • DELDelete an integration
        • GETGet integration
        • GETList all integrations
        • POSTPost an access token with an authorization code
        • PUTUpdate an integration
        • PUTUpdate the properties of an integration
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceIntegrations

Get integration

GET
http://localhost:3000/integrations/:name
GET
/integrations/:name
$curl http://localhost:3000/integrations/ \
>     -u "<username>:<password>"
1{
2  "metadata": {
3    "isActive": true,
4    "activeSync": true
5  },
6  "data": {
7    "type": null,
8    "properties": {}
9  }
10}
Returns the integration in Itential Platform.
Was this page helpful?
Previous

List all integrations

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

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

Response

Contains the data of a single integration.
metadataobject
dataobject
All of the properties required for a service.

Errors

500
Internal Server Error