Inference
Marketplace
Get third party plugins list.
GET /api/v1/plugins. Orchestrator API reference.
Get third party plugins list.
curl --request GET \
--url https://{apiHost}/api/v1/plugins \
--header 'Authorization: Bearer <token>'import requests
url = "https://{apiHost}/api/v1/plugins"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{apiHost}/api/v1/plugins', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"pluginListSummary": {
"description": "<string>",
"total": 123,
"values": {}
},
"list": [
{
"name": "splunk-integration",
"title": ""
}
],
"next": {
"pageToken": "<string>",
"orderBy": [
"<string>"
],
"pageNum": 123,
"pageSize": 123,
"totalPages": 123
},
"cfgList": [
{
"name": "<string>",
"title": "<string>",
"integrationType": "PLUGIN_INTEGRATION_TYPE_UNSPECIFIED",
"pluginType": "PLUGIN_TYPE_UNSPECIFIED",
"id": "<string>",
"description": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"objectId": "<string>",
"status": "PLUGIN_STATUS_UNSPECIFIED",
"revision": {
"curr": "<string>",
"createdAt": {},
"createdBy": "<string>",
"updatedAt": {},
"updatedBy": "<string>",
"prev": "<string>"
},
"statusMessage": "<string>",
"splunkConfig": {
"hecToken": "<string>",
"host": "<string>",
"port": "<string>",
"index": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"enableTLS": true,
"skipVerify": true,
"urlExtension": "<string>"
},
"httpConfig": {
"host": "<string>",
"port": "<string>",
"extension": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"enableTLS": true,
"skipVerify": true,
"httpSessionToken": "<string>",
"certFile": "<string>",
"keyFile": "<string>",
"rootCasFile": "<string>"
},
"rancherConfig": {
"orchestratorAuthenticationType": "ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED",
"orchestratorServerAddress": "<string>",
"orchestratorPort": "<string>",
"orchestratorUsername": "<string>",
"orchestratorPassword": "<string>",
"orchestratorAPIToken": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"orchestratorMaxClusterCount": 123,
"orchestratorOrder": 123
},
"vmwareVCOConfig": {
"accessCredentials": {
"orchestratorAuthenticationType": "ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED",
"orchestratorServerAddress": "<string>",
"orchestratorPort": "<string>",
"orchestratorUsername": "<string>",
"orchestratorPassword": "<string>",
"orchestratorAPIToken": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"orchestratorMaxClusterCount": 123,
"orchestratorOrder": 123
},
"VmwareVCOProfileID": 123,
"VmwareVCOLicenseID": 123
},
"vmwareTMCConfig": {
"accessCredentials": {
"orchestratorAuthenticationType": "ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED",
"orchestratorServerAddress": "<string>",
"orchestratorPort": "<string>",
"orchestratorUsername": "<string>",
"orchestratorPassword": "<string>",
"orchestratorAPIToken": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"orchestratorMaxClusterCount": 123,
"orchestratorOrder": 123
},
"useDefaultClusterGroup": true,
"useDefaultWorkspace": true,
"clusterGroupName": "<string>",
"workspaceName": "<string>",
"mgmtClusterName": "<string>"
},
"openTelemetryConfig": {
"host": "<string>",
"port": 123,
"bearerToken": "<string>",
"urlExtension": "<string>",
"enableTLS": true,
"skipVerify": true
}
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}
Authentication · API availability · Download OpenAPI
A successful response.Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.An unexpected error response.
Authorizations
Bearer token for user session
Headers
User-Agent specified id to track a request
Query Parameters
Only summary count is required.
Page Token
OrderBy helps in sorting the list response
Page Number
Defines the page size
Total number of pages to be fetched.
name pattern of matching plugin name.
Type of desired integration type
Response
A successful response.
Returned list of third parties plugins matched by filter criteria
Summary information about Third Party plugin list records.
Show child attributes
Show child attributes
Details of Third Party list records.
Show child attributes
Show child attributes
Returned record page.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get third party plugins list.
curl --request GET \
--url https://{apiHost}/api/v1/plugins \
--header 'Authorization: Bearer <token>'import requests
url = "https://{apiHost}/api/v1/plugins"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{apiHost}/api/v1/plugins', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"pluginListSummary": {
"description": "<string>",
"total": 123,
"values": {}
},
"list": [
{
"name": "splunk-integration",
"title": ""
}
],
"next": {
"pageToken": "<string>",
"orderBy": [
"<string>"
],
"pageNum": 123,
"pageSize": 123,
"totalPages": 123
},
"cfgList": [
{
"name": "<string>",
"title": "<string>",
"integrationType": "PLUGIN_INTEGRATION_TYPE_UNSPECIFIED",
"pluginType": "PLUGIN_TYPE_UNSPECIFIED",
"id": "<string>",
"description": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"objectId": "<string>",
"status": "PLUGIN_STATUS_UNSPECIFIED",
"revision": {
"curr": "<string>",
"createdAt": {},
"createdBy": "<string>",
"updatedAt": {},
"updatedBy": "<string>",
"prev": "<string>"
},
"statusMessage": "<string>",
"splunkConfig": {
"hecToken": "<string>",
"host": "<string>",
"port": "<string>",
"index": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"enableTLS": true,
"skipVerify": true,
"urlExtension": "<string>"
},
"httpConfig": {
"host": "<string>",
"port": "<string>",
"extension": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"enableTLS": true,
"skipVerify": true,
"httpSessionToken": "<string>",
"certFile": "<string>",
"keyFile": "<string>",
"rootCasFile": "<string>"
},
"rancherConfig": {
"orchestratorAuthenticationType": "ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED",
"orchestratorServerAddress": "<string>",
"orchestratorPort": "<string>",
"orchestratorUsername": "<string>",
"orchestratorPassword": "<string>",
"orchestratorAPIToken": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"orchestratorMaxClusterCount": 123,
"orchestratorOrder": 123
},
"vmwareVCOConfig": {
"accessCredentials": {
"orchestratorAuthenticationType": "ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED",
"orchestratorServerAddress": "<string>",
"orchestratorPort": "<string>",
"orchestratorUsername": "<string>",
"orchestratorPassword": "<string>",
"orchestratorAPIToken": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"orchestratorMaxClusterCount": 123,
"orchestratorOrder": 123
},
"VmwareVCOProfileID": 123,
"VmwareVCOLicenseID": 123
},
"vmwareTMCConfig": {
"accessCredentials": {
"orchestratorAuthenticationType": "ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED",
"orchestratorServerAddress": "<string>",
"orchestratorPort": "<string>",
"orchestratorUsername": "<string>",
"orchestratorPassword": "<string>",
"orchestratorAPIToken": "<string>",
"encryptedSecrets": {},
"cryptoKey": "<string>",
"orchestratorMaxClusterCount": 123,
"orchestratorOrder": 123
},
"useDefaultClusterGroup": true,
"useDefaultWorkspace": true,
"clusterGroupName": "<string>",
"workspaceName": "<string>",
"mgmtClusterName": "<string>"
},
"openTelemetryConfig": {
"host": "<string>",
"port": 123,
"bearerToken": "<string>",
"urlExtension": "<string>",
"enableTLS": true,
"skipVerify": true
}
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"operationType": "OPS_TYPE_UNSPECIFIED",
"operationStatus": "OPS_STATUS_UNSPECIFIED",
"objectKind": "<string>",
"objectId": "<string>",
"objectName": "<string>",
"objectRevision": "<string>",
"objectType": "OBJECT_TYPE_UNSPECIFIED",
"operationTime": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"user": "<string>",
"httpStatusCode": 123,
"httpStatusMsg": "<string>",
"jobId": "<string>",
"error": [
{
"ec": "zMsgErrorNone",
"location": "<string>",
"details": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}