Get Plugin Api
Get scripting API for a plugin
Returns supported VCF Operations Orchestrator scripting API for a plugin.
Request
URI
GET
https://{api_host}/server-configuration/api/plugins/{plugin}/{version}/{build}
COPY
Path Parameters
string
plugin
Required
plugin
string
version
Required
version
integer
build
Required
build
Query Parameters
string
scope
Optional
scope
string
filter
Optional
filter
boolean
isStrict
Optional
isStrict
Responses
200
The request is successful.
Returns
SdkModuleTypeDetails
of type(s)
application/json
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"version": "string",
"build": 0,
"objects": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"attributes": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"readonly": false
}
],
"constructors": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"parameters": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
],
"static": false
}
],
"methods": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"parameters": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
],
"static": false
}
],
"members": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
],
"events": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string"
}
],
"namespace": false
}
],
"enums": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"values": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string"
}
]
}
],
"types": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"scriptObject": "string",
"props": [
"string"
],
"events": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"minValue": "string",
"maxValue": "string",
"numberFormat": "string",
"unit": "string",
"props": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
]
}
]
}
]
}
string
description
Optional
description
string
icon
Optional
icon
string
name
Optional
name
string
externalUrl
Optional
externalUrl
string
state
Optional
state
Possible values are :
release,
alpha,
beta,
deprecated,
string
version
Optional
version
integer As int64
As int64
build
Optional
build
array of
object
objects
Optional
objects
array of
object
enums
Optional
enums
array of
object
types
Optional
types
401
User is not authenticated.
Returns
SdkModuleTypeDetails
of type(s)
application/json
"SdkModuleTypeDetails Object"
string
description
Optional
description
string
icon
Optional
icon
string
name
Optional
name
string
externalUrl
Optional
externalUrl
string
state
Optional
state
Possible values are :
release,
alpha,
beta,
deprecated,
string
version
Optional
version
integer As int64
As int64
build
Optional
build
array of
object
objects
Optional
objects
array of
object
enums
Optional
enums
array of
object
types
Optional
types
403
User is not authorized.
Returns
SdkModuleTypeDetails
of type(s)
application/json
"SdkModuleTypeDetails Object"
string
description
Optional
description
string
icon
Optional
icon
string
name
Optional
name
string
externalUrl
Optional
externalUrl
string
state
Optional
state
Possible values are :
release,
alpha,
beta,
deprecated,
string
version
Optional
version
integer As int64
As int64
build
Optional
build
array of
object
objects
Optional
objects
array of
object
enums
Optional
enums
array of
object
types
Optional
types
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/server-configuration/api/plugins/{plugin}/{version}/{build}
On This Page
Server Configuration Service Operations
GET
Get Server Configuration
POST
Import Server Configuration
GET
Get O1 1n Types
GET
Get Settings
GET
Get O1 1n Polyglot Runtimes
GET
Get Scripting Api
GET
Get Plugin Api
GET
Get Category Details