Skip to navigation
ReferenceAdapters

Import a new adapter

Imports a new adapter in Itential Platform.

Authentication

AuthorizationBasic

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

Request

properties
namestringRequiredformat: "^[^\/]+$"Defaults to
The name of the service
typeenumRequiredDefaults to Application
If the service is an app or adapter
Allowed values:
propertiesobjectRequired
loggerPropsobjectOptional
isEncryptedbooleanOptionalDefaults to false
Whether or not this service is encrypted
modelstringOptionalformat: "^@[-_.a-z]+/.+"Defaults to
The model used by the service
migrationVersionintegerOptional>=0
descriptionstringOptional

A user-defined description of this adapter instance.

Response

The result of the adapter import process.
statusenumOptional
The status of the API request.
Allowed values:
messagestringOptional
Message containing either confirmation of the operation or the reason for the failure of the operation.
dataobjectOptional
All of the properties required for a service.

Errors

500
Internal Server Error