Orchestrator
Plugins
Update a plugin
1min
PUT
PATH PARAMETERS
pluginId
string
*Plugin ID
HEADER PARAMETERS
X-COREOS-TID
string
*Tenant id
X-COREOS-REQUEST-ID
string
*Unique RequestId
X-COREOS-ACCESS
string
*Access Token
X-COREOS-USERINFO
string
*user info
BODY PARAMETERS
body
PluginUpdateRequestDetails
*httpUrl
string
URL endpoint to be called when the plugin is executed.
httpMethod
string<POST | GET | PUT>
API method with which the enpoint is called
description
string
description of the plugin
httpHeaders
object
Example: [object Object]
Headers used to make the API call
httpRequestBodyTemplate
TemplateSchema[]
Template for getting plugin API request Body
dlqOnFailure
boolean
requestTimeout
number
Example: 20
Request timeout in seconds
callbackTimeout
number
Example: 20
Callback timeout in seconds
responseType
string<ASYNC | SYNC>
Type of response which API will return - it can be sync or async.
secretKey
string
Secret key for HMAC authentication.
protocol
string<HTTP | GRPC>
plugin protocol
maxConcurrentCalls
integer
Maximum concurrent calls allowed for a specific plugin API.
RESPONSES
200
OK
SuccessPluginResponse
error
Error
*Error information
request
Request
*data
object
Example: [object Object]
400
Error Occurred
PostErrorResponse
error
Error
*Error information
request
Request
*401
Error Occurred
PostErrorResponse
error
Error
*Error information
request
Request
*

Updated 03 Aug 2023
Did this page help you?