Get Scripting Api
Get scripting API
Returns supported VCF Operations Orchestrator scripting API.
Request
URI
GET
https://{api_host}/server-configuration/api
COPY
Query Parameters
string
scope
Optional
scope
string
filter
Optional
filter
boolean
isStrict
Optional
isStrict
Responses
200
The request is successful.
Returns
ApiTypes
of type(s)
application/json
{
"system": {
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"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"
}
]
}
]
}
],
"plugins": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"version": "string",
"build": 0,
"detailsLink": "string"
}
]
},
"plugins": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"version": "string",
"build": 0,
"detailsLink": "string"
}
],
"scriptCategories": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"id": "string",
"detailsLink": "string"
}
]
}
object
system
Optional
system
array of
object
plugins
Optional
plugins
array of
object
scriptCategories
Optional
scriptCategories
401
User is not authenticated.
Returns
ApiTypes
of type(s)
application/json
"ApiTypes Object"
object
system
Optional
system
array of
object
plugins
Optional
plugins
array of
object
scriptCategories
Optional
scriptCategories
403
User is not authorized.
Returns
ApiTypes
of type(s)
application/json
"ApiTypes Object"
object
system
Optional
system
array of
object
plugins
Optional
plugins
array of
object
scriptCategories
Optional
scriptCategories
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/server-configuration/api