json vRealize-的OpenAPI
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了json vRealize-的OpenAPI相关的知识，希望对你有一定的参考价值。
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "vRealize Operations 6",
"description": "TODO: Add Description"
},
"host": "example.com",
"basePath": "/suite-api/api",
"schemes": [
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/api/auth/token/acquire": {
"post": {
"description": "TODO: Add Description",
"summary": "RUN FIRST - Get vR Ops Auth Token",
"tags": [
"Authenticate - RUN FIRST"
],
"operationId": "ApiAuthTokenAcquirePost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Run first get vr ops auth tokenrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/api/auth/token/acquire",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
},
"body": "{\"username\":\"{{user}}\",\"authSource\":\"local\",\"password\":\"{{pass}}\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "RUN FIRST - Get vR Ops Auth Token",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/alerts/query": {
"post": {
"description": "TODO: Add Description",
"summary": "Query Alerts",
"tags": [
"Full Alert Info"
],
"operationId": "ApiAlertsQueryPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/QueryAlertsrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/api/alerts/query",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
},
"body": "{\"resource-query\":{\"resourceKind\":[\"virtualmachine\"]},\"activeOnly\":\"True\",\"alertCriticality\":[\"CRITICAL\",\"IMMEDIATE\",\"WARNING\",\"INFORMATION\"],\"alertImpact\":[\"risk\"]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Query Alerts",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/alerts/7c2a4f9a-fd04-4300-b85c-cda555782e86": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Alert",
"tags": [
"Full Alert Info"
],
"operationId": "ApiAlerts7c2a4f9aFd044300B85cCda555782e86Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/api/alerts/7c2a4f9a-fd04-4300-b85c-cda555782e86",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Alert",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/alertdefinitions/{alertDefinitionId}": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Alert Definition",
"tags": [
"Full Alert Info"
],
"operationId": "ApiAlertdefinitionsByAlertDefinitionIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "alertDefinitionId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/symptoms": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Impacted Resource Symptoms",
"tags": [
"Full Alert Info"
],
"operationId": "SymptomsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "resourceId",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/symptoms?resourceId={{resourceId}}",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Impacted Resource Symptoms",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/alerts/contributingsymptoms": {
"get": {
"description": "Added in vROps 6.7",
"summary": "Get Alert Contributing Symptoms",
"tags": [
"Full Alert Info"
],
"operationId": "AlertsContributingsymptomsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/alerts/contributingsymptoms?id=3a4851be-bcc3-4872-a4ea-8bb926f48850",
"headers": {
"Accept": "application/json",
"Content-Type": "applicaiton/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Alert Contributing Symptoms",
"x-testDescription": "Added in vROps 6.7"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/resources": {
"get": {
"description": "Test script will extract resource IDs from the response and load into the env as \"resourceIds\"\nYou can then use this within the body of a request",
"summary": "Get Resources by Query and Save to var",
"tags": [
"Resources"
],
"operationId": "ResourcesGet5",
"produces": [
"application/json"
],
"parameters": [
{
"name": "resourceKind",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/resources?resourceKind=virtualmachine",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Resources by Query and Save to var",
"x-testDescription": "Test script will extract resource IDs from the response and load into the env as \"resourceIds\"\nYou can then use this within the body of a request"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/internal/agent/upgrade": {
"post": {
"description": "TODO: Add Description",
"summary": "Update EP Ops Agent",
"tags": [
"Agent Management"
],
"operationId": "InternalAgentUpgradePost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-vRealizeOps-API-use-unsupported",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateEpOpsAgentrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/internal/agent/upgrade",
"headers": {
"Accept": "application/json",
"X-vRealizeOps-API-use-unsupported": "true",
"Content-Type": "application/json"
},
"body": "{\"agentId\":\"1451538219583-2983685990625162095-598612646798980120\",\"fileLocation\":\"bundles/6.2.1\",\"agentBundleFile\":\"agent-x86-64-win-6.2.1.zip\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update EP Ops Agent",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/adapterkinds/EP Ops Adapter/resourcekinds/EP Ops Agent/resources": {
"get": {
"description": "Need agent ID (token)",
"summary": "Get Agent Status on Upgrade",
"tags": [
"Agent Management"
],
"operationId": "AdapterkindsEPOpsAdapterResourcekindsEPOpsAgentResourcesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "identifiers[agentID]",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/adapterkinds/EP Ops Adapter/resourcekinds/EP Ops Agent/resources?identifiers[agentID]=1432528639235-6190445699790943031-2415937788285910890",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Agent Status on Upgrade",
"x-testDescription": "Need agent ID (token)"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/{agentResourceId}/relationships": {
"get": {
"description": "TODO: Add Description",
"summary": "Get OS Resource ID and Save",
"tags": [
"Monitors"
],
"operationId": "ApiResourcesRelationshipsByAgentResourceIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "agentResourceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/adapters/{adapterInstanceId}": {
"post": {
"description": "TODO: Add Description",
"summary": "Create an EPOPS Unix MultiProcess Monitor Resource",
"tags": [
"Monitors"
],
"operationId": "ApiResourcesAdaptersByAdapterInstanceIdPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAnEpopsUnixMultiprocessMonitorResourcerequest"
}
},
{
"name": "adapterInstanceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/{osResourceId}/relationships/children": {
"post": {
"description": "This operation adds a child resource to a resource. \n\nAPI documentation states that POST is additive while PUT is destructive (i.e. overwites existing relationships).\n\nJSON body includes an array of child objects to add. \n\nThe call does not provide a lot of detail for failure, but it seems\nthat if you have an invalid UUID for a child or the child is already related\nthen it will fail with 400.\n\n204 is a successful call.",
"summary": "Add Child Resource to a Resource",
"tags": [
"Monitors"
],
"operationId": "ApiResourcesRelationshipsChildrenByOsResourceIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddChildResourceToAResourcerequest"
}
},
{
"name": "osResourceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/{epopsMonitorResourceId}/monitoringstate/start": {
"put": {
"description": "TODO: Add Description",
"summary": "Start Monitoring a Resource",
"tags": [
"Monitors"
],
"operationId": "ApiResourcesMonitoringstateStartByEpopsMonitorResourceIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "epopsMonitorResourceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/internal/resources/groups": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Custom Groups",
"tags": [
"Internal API Calls"
],
"operationId": "InternalResourcesGroupsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-vRealizeOps-API-use-unsupported",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/internal/resources/groups",
"headers": {
"X-vRealizeOps-API-use-unsupported": "true",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Custom Groups",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "TODO: Add Description",
"summary": "Create Custom Group",
"tags": [
"Internal API Calls"
],
"operationId": "InternalResourcesGroupsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-vRealizeOps-API-use-unsupported",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateCustomGrouprequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/internal/resources/groups",
"headers": {
"X-vRealizeOps-API-use-unsupported": "true",
"Accept": "application/json",
"Content-Type": "application/json"
},
"body": "{\"resourceKey\":{\"name\":\"test group 100\",\"adapterKindKey\":\"Container\",\"resourceKindKey\":\"Function\",\"resourceIdentifiers\":[]},\"membershipDefinition\":{\"includedResources\":[],\"excludedResources\":[],\"rules\":[{\"resourceKindKey\":{\"resourceKind\":\"VirtualMachine\",\"adapterKind\":\"VMWARE\"},\"attributeRules\":[],\"resourceNameRules\":[{\"name\":\"lnx\",\"compareOperator\":\"CONTAINS\"}],\"relationshipRules\":[],\"others\":[],\"otherAttributes\":{}}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create Custom Group",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/reportdefinitions": {
"get": {
"description": "Gets all - to get a single report ID, just add /<report def id>\n",
"summary": "Get Report Definitions",
"tags": [
"Reports"
],
"operationId": "ApiReportdefinitionsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/api/reportdefinitions",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Report Definitions",
"x-testDescription": "Gets all - to get a single report ID, just add /<report def id>\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/reports": {
"get": {
"description": "You can check status of report runs this way.\nTo get a specific generated report add /<report id> \n",
"summary": "Get Generated Reports",
"tags": [
"Reports"
],
"operationId": "ApiReportsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/api/reports",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Generated Reports",
"x-testDescription": "You can check status of report runs this way.\nTo get a specific generated report add /<report id> \n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "You will need to update several items in the body such as:\n - ID of resource you wish to run this report on\n - ID of the report you wish to run\n - Traversal Spec for the report (you can get this from the API query\n\"Get Report Definitions\", the travesal spec must match the resource type.\n",
"summary": "Generate a report",
"tags": [
"Reports"
],
"operationId": "ApiReportsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/GenerateAReportrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/api/reports",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
},
"body": "{\"resourceId\":\"24f55311-3d86-41fd-9c73-1c4c0e0dcbb6\",\"reportDefinitionId\":\"97d19754-0ad3-4de1-b35b-d8ad5d07be24\",\"traversalSpec\":{\"name\":\"vSphere Hosts and Clusters\",\"description\":\"Enables view of resources imported from vCenter like Clusters, Hosts, VMs and ResourcePools\",\"rootAdapterKindKey\":\"VMWARE\",\"rootResourceKindKey\":\"vSphere World\",\"adapterInstanceAssociation\":false},\"others\":[],\"otherAttributes\":{},\"id\":null}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Generate a report",
"x-testDescription": "You will need to update several items in the body such as:\n - ID of resource you wish to run this report on\n - ID of the report you wish to run\n - Traversal Spec for the report (you can get this from the API query\n\"Get Report Definitions\", the travesal spec must match the resource type.\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/be9097f7-0c8c-4a33-a855-faafb6f03a1d/download": {
"get": {
"description": "TODO: Add Description",
"summary": "Download Report",
"tags": [
"Reports"
],
"operationId": "ReportsBe9097f70c8c4a33A855Faafb6f03a1dDownloadGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "format",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/be9097f7-0c8c-4a33-a855-faafb6f03a1d/download?format=CSV",
"headers": {
"Content-Type": "application/json",
"Accept": "application/pdf"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Download Report",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/adapterkinds": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Adapter Types (Kinds)",
"tags": [
"Manage Adapters"
],
"operationId": "ApiAdapterkindsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/api/adapterkinds",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Adapter Types (Kinds)",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/adapters": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Adapter Instances",
"tags": [
"Manage Adapters"
],
"operationId": "ApiAdaptersGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/api/adapters",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Adapter Instances",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Be sure to check values in the JSON body for credentials.\nAlso note you will need to start the adapter using \"Star an adapter instance\" \nafter creation using the UUID from the response.\n\nIf you aren't using a CA, the certificate will have to be added via the UI\nI do not know of a way to do this via the REST API",
"summary": "Create a Python Adapter Instance",
"tags": [
"Manage Adapters"
],
"operationId": "ApiAdaptersPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAPythonAdapterInstancerequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/adapters": {
"get": {
"description": "TODO: Add Description",
"summary": "Get An Adapter Instance(s) of Type (Kind)",
"tags": [
"Manage Adapters"
],
"operationId": "AdaptersGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "adapterKindKey",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/adapters?adapterKindKey=VMWARE",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get An Adapter Instance(s) of Type (Kind)",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/adapters/617d20fd-536a-4bea-9f5e-4c01dd845ddc/monitoringstate/start": {
"put": {
"description": "Replace the UUID with the ID of the adapter instance you want to start\nThis can be retrieved using Get Adapter Instances",
"summary": "Start an adapter instance",
"tags": [
"Manage Adapters"
],
"operationId": "ApiAdapters617d20fd536a4bea9f5e4c01dd845ddcMonitoringstateStartPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/api/adapters/617d20fd-536a-4bea-9f5e-4c01dd845ddc/monitoringstate/start",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Start an adapter instance",
"x-testDescription": "Replace the UUID with the ID of the adapter instance you want to start\nThis can be retrieved using Get Adapter Instances"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/query": {
"post": {
"description": "TODO: Add Description",
"summary": "Get Resources",
"tags": [
"Resources"
],
"operationId": "ApiResourcesQueryPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/GetResourcesrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/api/resources/query",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
},
"body": "{\"resourceIds\":[\"daee892f-6938-45dd-9ee9-e6669b5150a5\",\"4541356a-2d54-411c-b276-312552f92c52\",\"4a0d7bfa-e095-45f4-b158-6a0090e4684a\",\"59773bb2-960d-48b9-a3a4-ca3de52a2ade\",\"fe5d227e-fba3-4d5f-97ad-8c6f7c02534a\",\"37045610-a3f2-4489-8bdd-4c223a243552\",\"3ad8fed7-0aa1-4aee-a79b-f01cd62e96cf\",\"a7e59f4f-d59c-4593-b9bd-1a8dfd4b5587\",\"273e71a2-5b0e-4fae-903b-e0a7b26608e2\",\"7ded588f-637c-48a6-a4e4-cbfc6b6d5713\"]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Resources",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/{resourceId}/properties": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Properties of a Resource",
"tags": [
"Resources"
],
"operationId": "ApiResourcesPropertiesByResourceIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "TODO: Add Description",
"summary": "Add or Update Properties of a Resource",
"tags": [
"Resources"
],
"operationId": "ApiResourcesPropertiesByResourceIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddOrUpdatePropertiesOfAResourcerequest"
}
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/{resourceId}/statkeys": {
"get": {
"description": "Grabs CPU statKeys for a VM resource using the {{resourceId}} env var.\nPopulates two env vars:\ncpuStatKeys for GET stats for small requests (1 to ~10 VMs)\ncpuStatKeysJSON for POST stats for large requests (use in conjunction with {{resourceIds}}",
"summary": "Get StatKeys for Resource and Load var",
"tags": [
"Resources"
],
"operationId": "ApiResourcesStatkeysByResourceIdGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/resources/7a3a3bfc-1664-4e1d-bfe1-0e42db1d3c0e/stats": {
"get": {
"description": "I have not tested but you may be able to use the \"resourceIds\" input paramter to specify multiple resources (of the same kind, obviously). The example here shows a daily avg for 30 days. Timestamps are milli from epoch.",
"summary": "Get Stats from Resource (Not query)",
"tags": [
"Resources"
],
"operationId": "Resources7a3a3bfc16644e1dBfe10e42db1d3c0eStatsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "begin",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "end",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "intervalQuantifier",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "intervalType",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "rollUpType",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "statKey",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/resources/7a3a3bfc-1664-4e1d-bfe1-0e42db1d3c0e/stats?begin={{epochPrev24}}&end={{epoch}}&intervalQuantifier=1&intervalType=DAYS&rollUpType=AVG&statKey=mem|host_usage",
"headers": {
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Stats from Resource (Not query)",
"x-testDescription": "I have not tested but you may be able to use the \"resourceIds\" input paramter to specify multiple resources (of the same kind, obviously). The example here shows a daily avg for 30 days. Timestamps are milli from epoch."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/resources/stats/topn": {
"get": {
"description": "TODO: Add Description",
"summary": "Get TopN Stats",
"tags": [
"Resources"
],
"operationId": "ResourcesStatsTopnGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "begin",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "intervalType",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "intervalQuantifier",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "rollUpType",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "statKey",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/resources/stats/topn?begin={{epoch}}&intervalType=Hours&intervalQuantifier=24&rollUpType=AVG&statKey=",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get TopN Stats",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/resources/{resourceId}/stats": {
"post": {
"description": "TODO: Add Description",
"summary": "Add or Update Stats of a Resource",
"tags": [
"Resources"
],
"operationId": "ApiResourcesStatsByResourceIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/symptoms/query": {
"post": {
"description": "TODO: Add Description",
"summary": "Query Symptoms",
"tags": [
"Resources"
],
"operationId": "ApiSymptomsQueryPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/QuerySymptomsrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/auth/sources": {
"get": {
"description": "TODO: Add Description",
"summary": "Get Auth Sources",
"tags": [
"Users and Authentication"
],
"operationId": "ApiAuthSourcesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/api/auth/sources"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Auth Sources",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/api/auth/users": {
"post": {
"description": "TODO: Add Description",
"summary": "Create Local User",
"tags": [
"Users and Authentication"
],
"operationId": "ApiAuthUsersPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateLocalUserrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/api/auth/users",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"username\":\"frank\",\"firstName\":\"Frank\",\"lastName\":\"Barnes\",\"password\":\"VMware1!\",\"enabled\":\"true\",\"role-permissions\":[{\"roleName\":\"GeneralUser-1\",\"allowAllObjects\":true}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create Local User",
"x-testDescription": "TODO: Add Description"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/auth/users": {
"get": {
"description": "May also include query such as id, roleName and username",
"summary": "Get Users",
"tags": [
"Users and Authentication"
],
"operationId": "AuthUsersGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "username",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/auth/users?username=frank",
"headers": {
"Accept": "application/json",
"Content-Type": "applicaiton/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get Users",
"x-testDescription": "May also include query such as id, roleName and username"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"Run first get vr ops auth tokenrequest": {
"title": "RUN FIRST - Get vR Ops Auth TokenRequest",
"example": {
"username": "{{user}}",
"authSource": "local",
"password": "{{pass}}"
},
"type": "object",
"properties": {
"username": {
"description": "",
"example": "{{user}}",
"type": "string"
},
"authSource": {
"description": "",
"example": "local",
"type": "string"
},
"password": {
"description": "",
"example": "{{pass}}",
"type": "string"
}
},
"required": [
"username",
"authSource",
"password"
]
},
"QueryAlertsrequest": {
"title": "Query AlertsRequest",
"example": {
"resource-query": {
"resourceKind": [
"virtualmachine"
]
},
"activeOnly": "True",
"alertCriticality": [
"CRITICAL",
"IMMEDIATE",
"WARNING",
"INFORMATION"
],
"alertImpact": [
"risk"
]
},
"type": "object",
"properties": {
"resource-query": {
"$ref": "#/definitions/ResourceQuery"
},
"activeOnly": {
"description": "",
"example": "True",
"type": "string"
},
"alertCriticality": {
"description": "",
"example": [
"CRITICAL",
"IMMEDIATE",
"WARNING",
"INFORMATION"
],
"type": "array",
"items": {
"type": "string"
}
},
"alertImpact": {
"description": "",
"example": [
"risk"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"resource-query",
"activeOnly",
"alertCriticality",
"alertImpact"
]
},
"ResourceQuery": {
"title": "ResourceQuery",
"example": {
"resourceKind": [
"virtualmachine"
]
},
"type": "object",
"properties": {
"resourceKind": {
"description": "",
"example": [
"virtualmachine"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"resourceKind"
]
},
"UpdateEpOpsAgentrequest": {
"title": "Update EP Ops AgentRequest",
"example": {
"agentId": "1451538219583-2983685990625162095-598612646798980120",
"fileLocation": "bundles/6.2.1",
"agentBundleFile": "agent-x86-64-win-6.2.1.zip"
},
"type": "object",
"properties": {
"agentId": {
"description": "",
"example": "1451538219583-2983685990625162095-598612646798980120",
"type": "string"
},
"fileLocation": {
"description": "",
"example": "bundles/6.2.1",
"type": "string"
},
"agentBundleFile": {
"description": "",
"example": "agent-x86-64-win-6.2.1.zip",
"type": "string"
}
},
"required": [
"agentId",
"fileLocation",
"agentBundleFile"
]
},
"CreateAnEpopsIcmpMonitorResourcerequest": {
"title": "Create an EPOPS ICMP Monitor ResourceRequest",
"example": {
"description": "",
"creationTime": null,
"resourceKey": {
"name": "vc-east-icmp",
"adapterKindKey": "EP Ops Adapter",
"resourceKindKey": "ICMP Check",
"resourceIdentifiers": [
{
"identifierType": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "{{agentID}}"
},
{
"identifierType": {
"name": "discoveryMode",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "MANUAL"
},
{
"identifierType": {
"name": "hostname",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "msbu-vc-east.mgmt.local"
},
{
"identifierType": {
"name": "monitoredResourceID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "vc-west"
},
{
"identifierType": {
"name": "Override_agent_configuration_data",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "0"
},
{
"identifierType": {
"name": "parentID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "|{{agentID}}"
},
{
"identifierType": {
"name": "sotimeout",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "10"
}
]
}
},
"type": "object",
"properties": {
"description": {
"description": "",
"type": "string"
},
"creationTime": {
"description": "",
"type": "string"
},
"resourceKey": {
"$ref": "#/definitions/ResourceKey"
}
},
"required": [
"description",
"creationTime",
"resourceKey"
]
},
"ResourceKey": {
"title": "ResourceKey",
"example": {
"name": "vc-east-icmp",
"adapterKindKey": "EP Ops Adapter",
"resourceKindKey": "ICMP Check",
"resourceIdentifiers": [
{
"identifierType": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "{{agentID}}"
},
{
"identifierType": {
"name": "discoveryMode",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "MANUAL"
},
{
"identifierType": {
"name": "hostname",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "msbu-vc-east.mgmt.local"
},
{
"identifierType": {
"name": "monitoredResourceID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "vc-west"
},
{
"identifierType": {
"name": "Override_agent_configuration_data",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "0"
},
{
"identifierType": {
"name": "parentID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "|{{agentID}}"
},
{
"identifierType": {
"name": "sotimeout",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "10"
}
]
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "vc-east-icmp",
"type": "string"
},
"adapterKindKey": {
"description": "",
"example": "EP Ops Adapter",
"type": "string"
},
"resourceKindKey": {
"description": "",
"example": "ICMP Check",
"type": "string"
},
"resourceIdentifiers": {
"description": "",
"example": [
{
"identifierType": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "{{agentID}}"
},
{
"identifierType": {
"name": "discoveryMode",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "MANUAL"
},
{
"identifierType": {
"name": "hostname",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "msbu-vc-east.mgmt.local"
},
{
"identifierType": {
"name": "monitoredResourceID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "vc-west"
},
{
"identifierType": {
"name": "Override_agent_configuration_data",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "0"
},
{
"identifierType": {
"name": "parentID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "|{{agentID}}"
},
{
"identifierType": {
"name": "sotimeout",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "10"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ResourceIdentifier"
}
}
},
"required": [
"name",
"adapterKindKey",
"resourceKindKey",
"resourceIdentifiers"
]
},
"ResourceIdentifier": {
"title": "ResourceIdentifier",
"example": {
"identifierType": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "{{agentID}}"
},
"type": "object",
"properties": {
"identifierType": {
"$ref": "#/definitions/IdentifierType"
},
"value": {
"description": "",
"example": "{{agentID}}",
"type": "string"
}
},
"required": [
"identifierType",
"value"
]
},
"IdentifierType": {
"title": "IdentifierType",
"example": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "agentID",
"type": "string"
},
"dataType": {
"description": "",
"example": "STRING",
"type": "string"
},
"isPartOfUniqueness": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"name",
"dataType",
"isPartOfUniqueness"
]
},
"CreateAnEpopsIcmpMonitorResource": {
"title": "Create an EPOPS ICMP Monitor Resource",
"example": {
"description": "",
"resourceKey": {
"name": "vc-west",
"adapterKindKey": "EP Ops Adapter",
"resourceKindKey": "ICMP Check",
"resourceIdentifiers": [
{
"identifierType": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "1477442044192-8820317972786024825-462474138079878128"
},
{
"identifierType": {
"name": "discoveryMode",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "MANUAL"
},
{
"identifierType": {
"name": "hostname",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "msbu-vc-west.mgmt.local"
},
{
"identifierType": {
"name": "monitoredResourceID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "vc-west ICMP Monitor"
},
{
"identifierType": {
"name": "Override_agent_configuration_data",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "0"
},
{
"identifierType": {
"name": "parentID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "|1477442044192-8820317972786024825-462474138079878128"
},
{
"identifierType": {
"name": "sotimeout",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "10"
}
]
},
"resourceStatusStates": [],
"dtEnabled": true,
"badges": [],
"relatedResources": [],
"links": [
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1",
"rel": "SELF",
"name": "linkToSelf"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/relationships",
"rel": "RELATED",
"name": "relationsOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/properties",
"rel": "RELATED",
"name": "propertiesOfResource"
},
{
"href": "/suite-api/api/alerts?resourceId=27eef2d8-84c6-4296-981b-8e97778c78f1",
"rel": "RELATED",
"name": "alertsOfResource"
},
{
"href": "/suite-api/api/symptoms?resourceId=27eef2d8-84c6-4296-981b-8e97778c78f1",
"rel": "RELATED",
"name": "symptomsOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/statkeys",
"rel": "RELATED",
"name": "statKeysOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/stats/latest",
"rel": "RELATED",
"name": "latestStatsOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/properties",
"rel": "RELATED",
"name": "latestPropertiesOfResource"
},
{
"href": "/suite-api/api/credentials/",
"rel": "RELATED",
"name": "credentialsOfResource"
}
],
"identifier": "27eef2d8-84c6-4296-981b-8e97778c78f1"
},
"type": "object",
"properties": {
"description": {
"description": "",
"type": "string"
},
"resourceKey": {
"$ref": "#/definitions/ResourceKey"
},
"resourceStatusStates": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"dtEnabled": {
"description": "",
"example": true,
"type": "boolean"
},
"badges": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"relatedResources": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"description": "",
"example": [
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1",
"rel": "SELF",
"name": "linkToSelf"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/relationships",
"rel": "RELATED",
"name": "relationsOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/properties",
"rel": "RELATED",
"name": "propertiesOfResource"
},
{
"href": "/suite-api/api/alerts?resourceId=27eef2d8-84c6-4296-981b-8e97778c78f1",
"rel": "RELATED",
"name": "alertsOfResource"
},
{
"href": "/suite-api/api/symptoms?resourceId=27eef2d8-84c6-4296-981b-8e97778c78f1",
"rel": "RELATED",
"name": "symptomsOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/statkeys",
"rel": "RELATED",
"name": "statKeysOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/stats/latest",
"rel": "RELATED",
"name": "latestStatsOfResource"
},
{
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1/properties",
"rel": "RELATED",
"name": "latestPropertiesOfResource"
},
{
"href": "/suite-api/api/credentials/",
"rel": "RELATED",
"name": "credentialsOfResource"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Link"
}
},
"identifier": {
"description": "",
"example": "27eef2d8-84c6-4296-981b-8e97778c78f1",
"type": "string"
}
},
"required": [
"description",
"resourceKey",
"resourceStatusStates",
"dtEnabled",
"badges",
"relatedResources",
"links",
"identifier"
]
},
"Link": {
"title": "Link",
"example": {
"href": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1",
"rel": "SELF",
"name": "linkToSelf"
},
"type": "object",
"properties": {
"href": {
"description": "",
"example": "/suite-api/api/resources/27eef2d8-84c6-4296-981b-8e97778c78f1",
"type": "string"
},
"rel": {
"description": "",
"example": "SELF",
"type": "string"
},
"name": {
"description": "",
"example": "linkToSelf",
"type": "string"
}
},
"required": [
"href",
"rel",
"name"
]
},
"CreateAnEpopsWindowsServiceMonitorResourcerequest": {
"title": "Create an EPOPS Windows Service Monitor ResourceRequest",
"example": {
"description": "Windows Time Service Monitor",
"creationTime": null,
"resourceKey": {
"name": "Windows Time Service",
"adapterKindKey": "EP Ops Adapter",
"resourceKindKey": "Windows Service",
"resourceIdentifiers": [
{
"identifierType": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "{{agentID}}"
},
{
"identifierType": {
"name": "discoveryMode",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "MANUAL"
},
{
"identifierType": {
"name": "monitoredResourceID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "Windows Time Service"
},
{
"identifierType": {
"name": "Override_agent_configuration_data",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "0"
},
{
"identifierType": {
"name": "parentID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "|{{agentID}}"
},
{
"identifierType": {
"name": "service_name",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "W32Time"
}
]
},
"identifier": null
},
"type": "object",
"properties": {
"description": {
"description": "",
"example": "Windows Time Service Monitor",
"type": "string"
},
"creationTime": {
"description": "",
"type": "string"
},
"resourceKey": {
"$ref": "#/definitions/ResourceKey"
},
"identifier": {
"description": "",
"type": "string"
}
},
"required": [
"description",
"creationTime",
"resourceKey",
"identifier"
]
},
"CreateAnEpopsUnixMultiprocessMonitorResourcerequest": {
"title": "Create an EPOPS Unix MultiProcess Monitor ResourceRequest",
"example": {
"description": "VMTools",
"creationTime": null,
"resourceKey": {
"name": "vmtoolsd",
"adapterKindKey": "EP Ops Adapter",
"resourceKindKey": "MultiProcess",
"resourceIdentifiers": [
{
"identifierType": {
"name": "agentID",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "{{agentID}}"
},
{
"identifierType": {
"name": "discoveryMode",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "MANUAL"
},
{
"identifierType": {
"name": "monitoredResourceID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "VMtools"
},
{
"identifierType": {
"name": "Override_agent_configuration_data",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "0"
},
{
"identifierType": {
"name": "parentID",
"dataType": "STRING",
"isPartOfUniqueness": true
},
"value": "|{{agentID}}"
},
{
"identifierType": {
"name": "process.query",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"value": "State.Name.eq=vmtoolsd"
}
]
},
"identifier": null
},
"type": "object",
"properties": {
"description": {
"description": "",
"example": "VMTools",
"type": "string"
},
"creationTime": {
"description": "",
"type": "string"
},
"resourceKey": {
"$ref": "#/definitions/ResourceKey"
},
"identifier": {
"description": "",
"type": "string"
}
},
"required": [
"description",
"creationTime",
"resourceKey",
"identifier"
]
},
"AddChildResourceToAResourcerequest": {
"title": "Add Child Resource to a ResourceRequest",
"example": {
"uuids": [
"{{epopsMonitorResourceId}}"
]
},
"type": "object",
"properties": {
"uuids": {
"description": "",
"example": [
"{{epopsMonitorResourceId}}"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"uuids"
]
},
"CreateCustomGrouprequest": {
"title": "Create Custom GroupRequest",
"example": {
"resourceKey": {
"name": "test group 100",
"adapterKindKey": "Container",
"resourceKindKey": "Function",
"resourceIdentifiers": []
},
"membershipDefinition": {
"includedResources": [],
"excludedResources": [],
"rules": [
{
"resourceKindKey": {
"resourceKind": "VirtualMachine",
"adapterKind": "VMWARE"
},
"attributeRules": [],
"resourceNameRules": [
{
"name": "lnx",
"compareOperator": "CONTAINS"
}
],
"relationshipRules": [],
"others": [],
"otherAttributes": {}
}
]
}
},
"type": "object",
"properties": {
"resourceKey": {
"$ref": "#/definitions/ResourceKey23"
},
"membershipDefinition": {
"$ref": "#/definitions/MembershipDefinition"
}
},
"required": [
"resourceKey",
"membershipDefinition"
]
},
"ResourceKey23": {
"title": "ResourceKey23",
"example": {
"name": "test group 100",
"adapterKindKey": "Container",
"resourceKindKey": "Function",
"resourceIdentifiers": []
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "test group 100",
"type": "string"
},
"adapterKindKey": {
"description": "",
"example": "Container",
"type": "string"
},
"resourceKindKey": {
"description": "",
"example": "Function",
"type": "string"
},
"resourceIdentifiers": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"adapterKindKey",
"resourceKindKey",
"resourceIdentifiers"
]
},
"MembershipDefinition": {
"title": "MembershipDefinition",
"example": {
"includedResources": [],
"excludedResources": [],
"rules": [
{
"resourceKindKey": {
"resourceKind": "VirtualMachine",
"adapterKind": "VMWARE"
},
"attributeRules": [],
"resourceNameRules": [
{
"name": "lnx",
"compareOperator": "CONTAINS"
}
],
"relationshipRules": [],
"others": [],
"otherAttributes": {}
}
]
},
"type": "object",
"properties": {
"includedResources": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"excludedResources": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"rules": {
"description": "",
"example": [
{
"resourceKindKey": {
"resourceKind": "VirtualMachine",
"adapterKind": "VMWARE"
},
"attributeRules": [],
"resourceNameRules": [
{
"name": "lnx",
"compareOperator": "CONTAINS"
}
],
"relationshipRules": [],
"others": [],
"otherAttributes": {}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Rule"
}
}
},
"required": [
"includedResources",
"excludedResources",
"rules"
]
},
"Rule": {
"title": "Rule",
"example": {
"resourceKindKey": {
"resourceKind": "VirtualMachine",
"adapterKind": "VMWARE"
},
"attributeRules": [],
"resourceNameRules": [
{
"name": "lnx",
"compareOperator": "CONTAINS"
}
],
"relationshipRules": [],
"others": [],
"otherAttributes": {}
},
"type": "object",
"properties": {
"resourceKindKey": {
"$ref": "#/definitions/ResourceKindKey"
},
"attributeRules": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"resourceNameRules": {
"description": "",
"example": [
{
"name": "lnx",
"compareOperator": "CONTAINS"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ResourceNameRule"
}
},
"relationshipRules": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"resourceKindKey",
"attributeRules",
"resourceNameRules",
"relationshipRules",
"others",
"otherAttributes"
]
},
"ResourceKindKey": {
"title": "ResourceKindKey",
"example": {
"resourceKind": "VirtualMachine",
"adapterKind": "VMWARE"
},
"type": "object",
"properties": {
"resourceKind": {
"description": "",
"example": "VirtualMachine",
"type": "string"
},
"adapterKind": {
"description": "",
"example": "VMWARE",
"type": "string"
}
},
"required": [
"resourceKind",
"adapterKind"
]
},
"ResourceNameRule": {
"title": "ResourceNameRule",
"example": {
"name": "lnx",
"compareOperator": "CONTAINS"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "lnx",
"type": "string"
},
"compareOperator": {
"description": "",
"example": "CONTAINS",
"type": "string"
}
},
"required": [
"name",
"compareOperator"
]
},
"GenerateAReportrequest": {
"title": "Generate a reportRequest",
"example": {
"resourceId": "24f55311-3d86-41fd-9c73-1c4c0e0dcbb6",
"reportDefinitionId": "97d19754-0ad3-4de1-b35b-d8ad5d07be24",
"traversalSpec": {
"name": "vSphere Hosts and Clusters",
"description": "Enables view of resources imported from vCenter like Clusters, Hosts, VMs and ResourcePools",
"rootAdapterKindKey": "VMWARE",
"rootResourceKindKey": "vSphere World",
"adapterInstanceAssociation": false
},
"others": [],
"otherAttributes": {},
"id": null
},
"type": "object",
"properties": {
"resourceId": {
"description": "",
"example": "24f55311-3d86-41fd-9c73-1c4c0e0dcbb6",
"type": "string"
},
"reportDefinitionId": {
"description": "",
"example": "97d19754-0ad3-4de1-b35b-d8ad5d07be24",
"type": "string"
},
"traversalSpec": {
"$ref": "#/definitions/TraversalSpec"
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
},
"id": {
"description": "",
"type": "string"
}
},
"required": [
"resourceId",
"reportDefinitionId",
"traversalSpec",
"others",
"otherAttributes",
"id"
]
},
"TraversalSpec": {
"title": "TraversalSpec",
"example": {
"name": "vSphere Hosts and Clusters",
"description": "Enables view of resources imported from vCenter like Clusters, Hosts, VMs and ResourcePools",
"rootAdapterKindKey": "VMWARE",
"rootResourceKindKey": "vSphere World",
"adapterInstanceAssociation": false
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "vSphere Hosts and Clusters",
"type": "string"
},
"description": {
"description": "",
"example": "Enables view of resources imported from vCenter like Clusters, Hosts, VMs and ResourcePools",
"type": "string"
},
"rootAdapterKindKey": {
"description": "",
"example": "VMWARE",
"type": "string"
},
"rootResourceKindKey": {
"description": "",
"example": "vSphere World",
"type": "string"
},
"adapterInstanceAssociation": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"name",
"description",
"rootAdapterKindKey",
"rootResourceKindKey",
"adapterInstanceAssociation"
]
},
"CreateAVcenterAdapterInstancerequest": {
"title": "Create a vCenter Adapter InstanceRequest",
"type": "object",
"properties": {
"name": {
"description": "",
"example": "VC Adapter Instance",
"type": "string"
},
"description": {
"description": "",
"example": "A vCenter Adapter Instance",
"type": "string"
},
"collectorId": {
"description": "",
"example": "1",
"type": "string"
},
"adapterKindKey": {
"description": "",
"example": "VMWARE",
"type": "string"
},
"resourceIdentifiers": {
"description": "",
"example": [
{
"name": "AUTODISCOVERY",
"value": "true"
},
{
"name": "PROCESSCHANGEEVENTS",
"value": "true"
},
{
"name": "VCURL",
"value": "https://vc-vapp.mylab.dias/sdk"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ResourceIdentifier31"
}
},
"credential": {
"$ref": "#/definitions/Credential"
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"name",
"description",
"collectorId",
"adapterKindKey",
"resourceIdentifiers",
"credential",
"others",
"otherAttributes"
]
},
"ResourceIdentifier31": {
"title": "ResourceIdentifier31",
"example": {
"name": "AUTODISCOVERY",
"value": "true"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "AUTODISCOVERY",
"type": "string"
},
"value": {
"description": "",
"example": "true",
"type": "string"
}
},
"required": [
"name",
"value"
]
},
"Credential": {
"title": "Credential",
"example": {
"id": null,
"name": "New Principal Credential",
"adapterKindKey": "VMWARE",
"credentialKindKey": "PRINCIPALCREDENTIAL",
"fields": [
{
"name": "USER",
"value": "administrator@mylab.dias"
},
{
"name": "PASSWORD",
"value": "VMware1!"
}
],
"others": [],
"otherAttributes": {}
},
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"example": "New Principal Credential",
"type": "string"
},
"adapterKindKey": {
"description": "",
"example": "VMWARE",
"type": "string"
},
"credentialKindKey": {
"description": "",
"example": "PRINCIPALCREDENTIAL",
"type": "string"
},
"fields": {
"description": "",
"example": [
{
"name": "USER",
"value": "administrator@mylab.dias"
},
{
"name": "PASSWORD",
"value": "VMware1!"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Field"
}
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"id",
"name",
"adapterKindKey",
"credentialKindKey",
"fields",
"others",
"otherAttributes"
]
},
"Field": {
"title": "Field",
"example": {
"name": "USER",
"value": "administrator@mylab.dias"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "USER",
"type": "string"
},
"value": {
"description": "",
"example": "administrator@mylab.dias",
"type": "string"
}
},
"required": [
"name",
"value"
]
},
"CreateAPythonAdapterInstancerequest": {
"title": "Create a Python Adapter InstanceRequest",
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Python Adapter Instance",
"type": "string"
},
"description": {
"description": "",
"example": "A Python Adapter Instance",
"type": "string"
},
"collectorId": {
"description": "",
"example": "1",
"type": "string"
},
"adapterKindKey": {
"description": "",
"example": "PythonRemediationVcenterAdapter",
"type": "string"
},
"resourceIdentifiers": {
"description": "",
"example": [
{
"name": "AUTODISCOVERY",
"value": "true"
},
{
"name": "PROCESSCHANGEEVENTS",
"value": "true"
},
{
"name": "VCURL",
"value": "https://vc-vapp.mylab.dias"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ResourceIdentifier31"
}
},
"credential": {
"$ref": "#/definitions/Credential"
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"name",
"description",
"collectorId",
"adapterKindKey",
"resourceIdentifiers",
"credential",
"others",
"otherAttributes"
]
},
"GetResourcesrequest": {
"title": "Get ResourcesRequest",
"example": {
"resourceIds": [
"daee892f-6938-45dd-9ee9-e6669b5150a5",
"4541356a-2d54-411c-b276-312552f92c52",
"4a0d7bfa-e095-45f4-b158-6a0090e4684a",
"59773bb2-960d-48b9-a3a4-ca3de52a2ade",
"fe5d227e-fba3-4d5f-97ad-8c6f7c02534a",
"37045610-a3f2-4489-8bdd-4c223a243552",
"3ad8fed7-0aa1-4aee-a79b-f01cd62e96cf",
"a7e59f4f-d59c-4593-b9bd-1a8dfd4b5587",
"273e71a2-5b0e-4fae-903b-e0a7b26608e2",
"7ded588f-637c-48a6-a4e4-cbfc6b6d5713"
]
},
"type": "object",
"properties": {
"resourceIds": {
"description": "",
"example": [
"daee892f-6938-45dd-9ee9-e6669b5150a5",
"4541356a-2d54-411c-b276-312552f92c52",
"4a0d7bfa-e095-45f4-b158-6a0090e4684a",
"59773bb2-960d-48b9-a3a4-ca3de52a2ade",
"fe5d227e-fba3-4d5f-97ad-8c6f7c02534a",
"37045610-a3f2-4489-8bdd-4c223a243552",
"3ad8fed7-0aa1-4aee-a79b-f01cd62e96cf",
"a7e59f4f-d59c-4593-b9bd-1a8dfd4b5587",
"273e71a2-5b0e-4fae-903b-e0a7b26608e2",
"7ded588f-637c-48a6-a4e4-cbfc6b6d5713"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"resourceIds"
]
},
"AddOrUpdatePropertiesOfAResourcerequest": {
"title": "Add or Update Properties of a ResourceRequest",
"example": {
"property-content": [
{
"statKey": "apiInjected|random",
"timestamps": [
1477432000
],
"values": [
0
],
"others": [],
"otherAttributes": {}
}
]
},
"type": "object",
"properties": {
"property-content": {
"description": "",
"example": [
{
"statKey": "apiInjected|random",
"timestamps": [
1477432000
],
"values": [
0
],
"others": [],
"otherAttributes": {}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/PropertyContent"
}
}
},
"required": [
"property-content"
]
},
"PropertyContent": {
"title": "PropertyContent",
"example": {
"statKey": "apiInjected|random",
"timestamps": [
1477432000
],
"values": [
0
],
"others": [],
"otherAttributes": {}
},
"type": "object",
"properties": {
"statKey": {
"description": "",
"example": "apiInjected|random",
"type": "string"
},
"timestamps": {
"description": "",
"example": [
1477432000
],
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"values": {
"description": "",
"example": [
0
],
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"statKey",
"timestamps",
"values",
"others",
"otherAttributes"
]
},
"QuerySymptomsrequest": {
"title": "Query SymptomsRequest",
"type": "object",
"properties": {
"compositeOperator": {
"description": "",
"example": "AND",
"type": "string"
},
"symptomId": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"resource-query": {
"$ref": "#/definitions/ResourceQuery42"
},
"includeChildrenResources": {
"description": "",
"example": false,
"type": "boolean"
},
"activeOnly": {
"description": "",
"example": true,
"type": "boolean"
},
"alarmType": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"alarmCriticality": {
"description": "",
"example": [
"CRITICAL",
"IMMEDIATE",
"WARNING",
"INFORMATION"
],
"type": "array",
"items": {
"type": "string"
}
},
"symptomDefinitionId": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"statKey": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"compositeOperator",
"symptomId",
"resource-query",
"includeChildrenResources",
"activeOnly",
"alarmType",
"alarmCriticality",
"symptomDefinitionId",
"statKey",
"others",
"otherAttributes"
]
},
"ResourceQuery42": {
"title": "ResourceQuery42",
"example": {
"name": null,
"regex": null,
"adapterKind": null,
"resourceKind": null,
"collectorName": null,
"collectorId": null,
"maintenanceScheduleId": null,
"adapterInstanceId": null,
"recentlyAdded": null,
"resourceState": null,
"resourceStatus": null,
"resourceHealth": null,
"parentId": null,
"credentialId": null,
"resourceId": [
"5748438c-41d5-4397-a59b-efe973674653"
],
"propertyName": null,
"propertyValue": null,
"statKey": null,
"statKeyLowerBound": null,
"statKeyUpperBound": null,
"statKeyInclusive": true,
"others": [],
"otherAttributes": {}
},
"type": "object",
"properties": {
"name": {
"description": "",
"type": "string"
},
"regex": {
"description": "",
"type": "string"
},
"adapterKind": {
"description": "",
"type": "string"
},
"resourceKind": {
"description": "",
"type": "string"
},
"collectorName": {
"description": "",
"type": "string"
},
"collectorId": {
"description": "",
"type": "string"
},
"maintenanceScheduleId": {
"description": "",
"type": "string"
},
"adapterInstanceId": {
"description": "",
"type": "string"
},
"recentlyAdded": {
"description": "",
"type": "string"
},
"resourceState": {
"description": "",
"type": "string"
},
"resourceStatus": {
"description": "",
"type": "string"
},
"resourceHealth": {
"description": "",
"type": "string"
},
"parentId": {
"description": "",
"type": "string"
},
"credentialId": {
"description": "",
"type": "string"
},
"resourceId": {
"description": "",
"example": [
"5748438c-41d5-4397-a59b-efe973674653"
],
"type": "array",
"items": {
"type": "string"
}
},
"propertyName": {
"description": "",
"type": "string"
},
"propertyValue": {
"description": "",
"type": "string"
},
"statKey": {
"description": "",
"type": "string"
},
"statKeyLowerBound": {
"description": "",
"type": "string"
},
"statKeyUpperBound": {
"description": "",
"type": "string"
},
"statKeyInclusive": {
"description": "",
"example": true,
"type": "boolean"
},
"others": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"otherAttributes": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"name",
"regex",
"adapterKind",
"resourceKind",
"collectorName",
"collectorId",
"maintenanceScheduleId",
"adapterInstanceId",
"recentlyAdded",
"resourceState",
"resourceStatus",
"resourceHealth",
"parentId",
"credentialId",
"resourceId",
"propertyName",
"propertyValue",
"statKey",
"statKeyLowerBound",
"statKeyUpperBound",
"statKeyInclusive",
"others",
"otherAttributes"
]
},
"CreateLocalUserrequest": {
"title": "Create Local UserRequest",
"example": {
"username": "frank",
"firstName": "Frank",
"lastName": "Barnes",
"password": "VMware1!",
"enabled": "true",
"role-permissions": [
{
"roleName": "GeneralUser-1",
"allowAllObjects": true
}
]
},
"type": "object",
"properties": {
"username": {
"description": "",
"example": "frank",
"type": "string"
},
"firstName": {
"description": "",
"example": "Frank",
"type": "string"
},
"lastName": {
"description": "",
"example": "Barnes",
"type": "string"
},
"password": {
"description": "",
"example": "VMware1!",
"type": "string"
},
"enabled": {
"description": "",
"example": "true",
"type": "string"
},
"role-permissions": {
"description": "",
"example": [
{
"roleName": "GeneralUser-1",
"allowAllObjects": true
}
],
"type": "array",
"items": {
"$ref": "#/definitions/RolePermission"
}
}
},
"required": [
"username",
"firstName",
"lastName",
"password",
"enabled",
"role-permissions"
]
},
"RolePermission": {
"title": "RolePermission",
"example": {
"roleName": "GeneralUser-1",
"allowAllObjects": true
},
"type": "object",
"properties": {
"roleName": {
"description": "",
"example": "GeneralUser-1",
"type": "string"
},
"allowAllObjects": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"roleName",
"allowAllObjects"
]
}
}
}以上是关于json vRealize-的OpenAPI的主要内容，如果未能解决你的问题，请参考以下文章