Get a plugin

1min
GET
https://{domain}/core/api/v1/plugins/{pluginId}
Path Parameters
pluginId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Responses
200
OK
GetPluginResponse
error
Error
data
PluginResponse
request
Request
400
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
401
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
404
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v1/plugins/{pluginId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/core/api/v1/plugins/{pluginId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "name": "",
    "description": "",
    "httpUrl": "",
    "httpMethod": "",
    "httpHeaders": {},
    "httpRequestBodyTemplate": [
      {
        "entity": "",
        "input": {},
        "pluginName": "",
        "outputJsonPath": {}
      }
    ],
    "requestTimeout": 20,
    "callbackTimeout": 20,
    "isActive": false,
    "responseType": "",
    "secretKey": "",
    "protocol": "",
    "maxConcurrentCalls": 0
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "name": "",
    "description": "",
    "httpUrl": "",
    "httpMethod": "",
    "httpHeaders": {},
    "httpRequestBodyTemplate": [
      {
        "entity": "",
        "input": {},
        "pluginName": "",
        "outputJsonPath": {}
      }
    ],
    "requestTimeout": 20,
    "callbackTimeout": 20,
    "isActive": false,
    "responseType": "",
    "secretKey": "",
    "protocol": "",
    "maxConcurrentCalls": 0
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 31 May 2024
Did this page help you?
Update a plugin
Create a new plugin