Get a third party plugin by name.

curl --request GET \
  --url https://{apiHost}/api/v1/plugins/name/{name} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/plugins/name/{name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

name

string

required

User defined name of the plugin request, unique across the enterprise. Once object is created, name can’t be changed

Response

A successful response.

The payload to configure the third party associated with a particular integration.

name

string

required

User defined name of the third party plugin request, unique across the enterprise. Once object is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

title

string

required

User defined title of the third party entity. Title can be changed at any time

Required string length: 3 - 256

Pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+$

integrationType

enum<string>

default:PLUGIN_INTEGRATION_TYPE_UNSPECIFIED

required

Type of desired integration type

Available options:

PLUGIN_INTEGRATION_TYPE_UNSPECIFIED,

PLUGIN_INTEGRATION_TYPE_DATA,

PLUGIN_INTEGRATION_TYPE_CLOUD,

PLUGIN_INTEGRATION_TYPE_STORAGE,

PLUGIN_INTEGRATION_TYPE_MONITORING,

PLUGIN_INTEGRATION_TYPE_ORCHESTRATOR

pluginType

enum<string>

default:PLUGIN_TYPE_UNSPECIFIED

required

type of actual integration

Available options:

PLUGIN_TYPE_UNSPECIFIED,

PLUGIN_TYPE_SPLUNK,

PLUGIN_TYPE_HTTP,

PLUGIN_TYPE_RANCHER,

PLUGIN_TYPE_VMWARE_VCO,

PLUGIN_TYPE_VMWARE_TMC,

PLUGIN_TYPE_OTEL

string

read-only

System defined universally unique Id of the third party plugin request

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

description

string

Detailed description of the third party entity.

Maximum string length: 256

objectType

enum<string>

default:OBJECT_TYPE_UNSPECIFIED

object type to which this third party integration is associated, can project, cluster etc.

Available options:

OBJECT_TYPE_UNSPECIFIED,

OBJECT_TYPE_USER,

OBJECT_TYPE_EDGE_NODE,

OBJECT_TYPE_EDGE_APP,

OBJECT_TYPE_IMAGE,

OBJECT_TYPE_EDGE_APP_INSTANCE,

OBJECT_TYPE_PROJECT,

OBJECT_TYPE_NETWORK,

OBJECT_TYPE_DATASTORE,

OBJECT_TYPE_SERVICE,

OBJECT_TYPE_SERVICE_INSTANCE,

OBJECT_TYPE_ENTERPRISE,

OBJECT_TYPE_ROLE,

OBJECT_TYPE_CREDENTIAL,

OBJECT_TYPE_NETWORK_INSTANCE,

OBJECT_TYPE_VOLUME_INSTANCE,

OBJECT_TYPE_REALM,

OBJECT_TYPE_AUTHPROFILE,

OBJECT_TYPE_POLICY,

OBJECT_TYPE_APP_POLICY,

OBJECT_TYPE_CLUSTER_INSTANCE,

OBJECT_TYPE_PLUGIN,

OBJECT_TYPE_DOC_POLICY,

OBJECT_TYPE_ORCHESTRATOR_CLUSTER,

OBJECT_TYPE_TAGS,

OBJECT_TYPE_EDGE_NODE_INTERFACE,

OBJECT_TYPE_DEPLOYMENT,

OBJECT_TYPE_ENTITLEMENTS,

OBJECT_TYPE_DATA_STREAM,

OBJECT_TYPE_API_USAGE,

OBJECT_TYPE_APP_INSTANCE_SNAPSHOT,

OBJECT_TYPE_PATCH_ENVELOPE,

OBJECT_TYPE_RESOURCE_USAGE_TRACK,

OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE,

OBJECT_TYPE_DEV_PASSTHROUGH,

OBJECT_TYPE_EDGE_NODE_CLUSTER,

OBJECT_TYPE_ASSET_GROUP,

OBJECT_TYPE_APP_PROFILE,

OBJECT_TYPE_PROFILE_DEPLOYMENT,

OBJECT_TYPE_ZKS_INSTANCE,

OBJECT_TYPE_CLUSTER_GROUP

objectId

string

objectId to which this third party integration is associated

status

enum<string>

default:PLUGIN_STATUS_UNSPECIFIED

status of the third party entity.

Available options:

PLUGIN_STATUS_UNSPECIFIED,

PLUGIN_STATUS_INITIALIZED,

PLUGIN_STATUS_INPROGRESS,

PLUGIN_STATUS_RUNNING,

PLUGIN_STATUS_FAILED

revision

ObjectRevision is used to store the user information. · object

system defined info

Show child attributes

statusMessage

string

Detailed status message of the third party.

Maximum string length: 256

splunkConfig

config required for configuring splunk · object

The payload to configure the splunk third party plugin.

Show child attributes

httpConfig

Http configuration required for the http plugin integration · object

The payload to configure the http third party plugin.

Show child attributes

rancherConfig

Configuration required for the cluster orchestrator integration · object

The payload to configure the third party cluster orchestrator.

Show child attributes

vmwareVCOConfig

object

Show child attributes

vmwareTMCConfig

object

Show child attributes

openTelemetryConfig

OpenTelemetry Configuration · object

The payload to configure the OpenTelemetry collector endpoint.

Show child attributes

⌘I

Get a third party plugin by name.

curl --request GET \
  --url https://{apiHost}/api/v1/plugins/name/{name} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/plugins/name/{name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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="
    }
  ]
}

API guides

API services

Get a third party plugin by name.

Authorizations

Headers

Path Parameters

Response