vcf-automation-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@vcf-automation-mcp List all my active deployments and their current status"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
vcf-automation-mcp

MCP server for VCF Automation 9, for both VM Apps and All Apps organizations. Every REST operation the org exposes becomes one MCP tool, generated straight from the OpenAPI specs that VCF Automation serves for that org type:
VM Apps org: 698 tools across 16 services
All Apps org: 421 tools across 12 services
Both counts include 2 Event Broker subscription calls that the published specs leave out (see Event Broker subscriptions).
Sister project of vcf-orchestrator-mcp.
VM Apps and All Apps orgs
The two org types expose different API sets, so the server loads the tool catalogue that matches the org it talks to. Each server entry in your MCP client is one org: its own VCFA_ORG, its own service account and its own token chain. To work with both kinds of org, add one entry per org (see step 3).
The org type comes from, in this order:
VCFA_ORG_TYPE(vm-appsorall-apps), if setthe type
setup --org-typestored for that org in the token filevm-apps
Configs from before 1.0.0 have neither, so they keep loading the VM Apps tools exactly as before.
Related MCP server: vcf-automation-mcp-server
Services and tools
Service key | VM Apps | All Apps | API |
| 33 | – | ABX: actions, versions, secrets, action runs, flows |
| 11 | 15 | Approvals and work items |
| 5 | – | Deployment Metric (aggregator) and deployment limits |
| 40 | 33 | Blueprint / cloud templates: create, validate, version, release, provision |
| 45 | 30 | Catalog items, sources, content sharing, requests, icons, notifications (pricing on VM Apps) |
| 38 | 36 | Deployments, resources, day-2 actions, requests |
| 9 | 12 | Policies and policy types |
| 42 | 38 | Custom Forms (All Apps also: custom resource types and resource actions) |
| 11 | 11 | Content Gateway (content sources, source control) |
| 9 | 9 | Event Broker: events, topics, audit, subscriptions (list, create/update, get, delete) |
| 265 | 13 | Provisioning Service (IaaS). VM Apps: cloud accounts, zones, mappings, networks, storage, machines. All Apps: integrations, configuration properties, request tracker, certificates |
| 53 | – | Identity Service ( |
| 27 | – | Onboarding (relocation) plans, resources, deployments |
| 8 | 8 | Orchestrator Gateway: workflows and runs |
| 11 | 14 | Project Service (All Apps also: platform secrets and the RBAC auth context) |
| 91 | 202 | Org management ( |
Tool names follow <service>_<operation>, for example deployment_get_deployments, catalog_request_catalog_item_instances, iaas_create_machine, abx_post_action_runs, vro_run_workflow, provider_query_users. A service both org types share keeps the same tool names in both. Run vcf-automation-mcp --list-tools --org-type all-apps (or vm-apps) to see them all, or --list-services for the counts.
There are also two helper tools:
vcfa_connection_status: shows the host, org, org type (and where it came from), auth mode in use, token expiry and tool counts. Passtest: trueto log in now and make a test call:GET /iaas/api/abouton a VM Apps org,GET /rbac-service/api/auth-contexton an All Apps org.vcfa_describe_operation: returns the full nested request-body schema for any tool. Tool input schemas are summarised past three levels of nesting to keeptools/listsmall.
Hundreds of tools is a lot. Some MCP clients cap or slow down with that many. Use
VCFA_SERVICESto load only what you need, for exampleVCFA_SERVICES=catalog,deployment,blueprint,abx,vro.
Quick start
Login works the same way as vcf-orchestrator-mcp. A one-time setup creates a VCF Automation service account and stores its refresh token on your machine. After that the server keeps its own login alive, so no token or password goes into your MCP config.
1. Install globally
npm i -g vcf-automation-mcpThe MCP config below runs the vcf-automation-mcp command, so the global install is required. If you only run setup with npx, there's no command for the client to start and Claude Desktop shows "vcf-automation couldn't start. Its command wasn't found."
2. Run setup once
vcf-automation-mcp setup --url "https://auto.vmw.lab" --org "vmapps-org" --user "admin" --name "Lab-VCFA-MCP" --role "Service Broker Administrator,Orchestrator Administrator,Assembler Administrator" --insecureThis exact command was tested end to end against a VCF Automation 9 VM Apps org (Windows 11, Claude Desktop).
For an All Apps org, add --org-type all-apps and use that org's name and one of its local users:
vcf-automation-mcp setup --url "https://auto.vmw.lab" --org "allapps-org-01" --org-type all-apps --user "admin" --name "Lab-VCFA-AllApps-MCP" --insecureSetup stores the org type with the token, runs the API access check against the All Apps services, and prints a config block for that org. Run setup once per org; each org's token is kept separately in the same token file.
Role names must exist in your org exactly as typed. Each name becomes a urn:vcloud:role:<name> scope. A name the org doesn't have fails registration with HTTP 500, for example:
Registering service account failed: HTTP 500 ... Unable to find the following role(s) in org <id>: [Organization Administrator].The error names only the roles it couldn't find, so drop or rename those and run setup again (the failed run creates nothing, so you can reuse the same --name). Role names vary per org: check Access Control > Roles in the tenant UI, or the role list in setup's first line (1/5 Logged in as admin@vmapps-org (..., role ...)). Leave --role out to copy the role of the user you log in with.
Setup asks for the password with a masked prompt. It uses it once to log in and never stores it. Then it:
Logs in as
user@orgat/cloudapi/1.0.0/sessions.Registers the service account at
/oauth/tenant/{org}/register.Requests device authorization.
Grants the request as you.
Exchanges the device code for an access token and a refresh token.
It saves the refresh token to ~/.vcf-automation-mcp/tokens.json (on Windows, C:\Users\<you>\.vcf-automation-mcp\tokens.json), checks which automation APIs the service account's role can reach, and prints the MCP config to paste.
Option | Meaning |
| VCF Automation URL |
| Organization name, from the tenant URL |
| Local org user, typed without |
| Service account display name (under Access Control > Service Accounts) |
| Comma-separated role names. Default: the role of the user you log in with |
| Skips the prompt (the password then ends up in your shell history) |
|
|
| Uses a service account created in the UI instead; you approve the access request there. Use this for SSO-only orgs |
| Accepts self-signed lab certificates |
If the access check shows 403 for an API, the service account's role doesn't cover it. Give it a broader role (e.g. Organization Owner), then restart your MCP client.
3. Add it to your MCP client
Setup prints the block for the org it set up. With one VM Apps org and one All Apps org, the config has one entry each:
{
"mcpServers": {
"vcfa-vmapps-org": {
"command": "vcf-automation-mcp",
"env": {
"VCFA_HOST": "https://auto.vmw.lab",
"VCFA_AUTH_MODE": "api-token",
"VCFA_ORG": "vmapps-org",
"VCFA_INSECURE": "true",
"VCFA_SERVICES": "catalog,deployment,blueprint,project,abx,vro,eventbroker"
}
},
"vcfa-allapps-org-01": {
"command": "vcf-automation-mcp",
"env": {
"VCFA_HOST": "https://auto.vmw.lab",
"VCFA_AUTH_MODE": "api-token",
"VCFA_ORG": "allapps-org-01",
"VCFA_ORG_TYPE": "all-apps",
"VCFA_INSECURE": "true",
"VCFA_SERVICES": "catalog,deployment,blueprint,project,vro,eventbroker"
}
}
}
}An existing entry named vcf-automation keeps working; the entry name is only a label.
The config file is at ~/Library/Application Support/Claude/claude_desktop_config.json on macOS and %APPDATA%\Claude\claude_desktop_config.json on Windows. After editing it, quit Claude Desktop completely (on Windows, from the system tray) and reopen it.
Windows: if the command still isn't found after the global install, Claude Desktop isn't seeing the npm folder on its PATH. Run where vcf-automation-mcp and put the full path in command, with doubled backslashes:
"command": "C:\\Users\\<you>\\AppData\\Roaming\\npm\\vcf-automation-mcp.cmd"Without a global install, "command": "cmd" with "args": ["/c", "npx", "-y", "vcf-automation-mcp"] also works, but it's slower to start.
4. Check the connection
Ask your client to run vcfa_connection_status with test: true. A working setup shows "modeInUse": "api-token", the right orgType, the token file under your home folder, and an HTTP 200 test call (GET /iaas/api/about for VM Apps, GET /rbac-service/api/auth-context for All Apps). On VCF Automation 9 the token endpoint resolves to /tm/oauth/tenant/<org>/token. With the VCFA_SERVICES lists above, 184 of the 698 VM Apps tools and 130 of the 421 All Apps tools load.
Configuration
Variable | Default | Description |
| required | VCF Automation URL, e.g. |
|
| Organization name, e.g. |
| stored by setup, else |
|
|
|
|
| Seeds a refresh-token chain yourself instead of running setup | |
| Service account client ID, if you seed a token yourself | |
| Static access token; it expires and isn't renewed | |
| For | |
| Identity domain for | |
|
| Where rotated refresh tokens are kept |
|
| Skip TLS verification (self-signed lab certificates) |
|
| Load only GET operations; writes are also blocked at call time |
| all | Comma-separated service keys to load |
| Comma-separated service keys to skip | |
| Regex; load only tools whose name matches | |
|
|
|
|
| Responses longer than this are truncated |
|
| Per-request timeout |
Auth modes
The names and behaviour match vcf-orchestrator-mcp.
Mode | How it logs in |
| Refresh token, plus client ID when known, posted to |
|
|
|
|
| 8.x-style |
|
|
Access tokens are renewed a minute before they expire, and once more after a 401. There's no background timer: an idle server refreshes on its next call.
One token chain per machine, per server. Don't copy tokens.json between machines, and don't run two copies of this server against the same org at the same time (for example Claude Desktop and Claude Code). Whichever refreshes first invalidates the other's token, and the other gets invalid_grant; running setup again fixes it. This server keeps its own token file, separate from vcf-orchestrator-mcp's, so the two never break each other. Give each one its own service account.
Calling conventions
Path, query and header parameters are top-level arguments.
Request bodies go in
body: a JSON object, or a string for YAML/text endpoints.OData parameters drop the
$because MCP clients reject$in argument names:$topbecomestop, and likewiseskip,filter,select,orderby,count.Many automation endpoints take an optional
apiVersionquery parameter.
Event Broker subscriptions
The Event Broker spec published for VCF Automation 9 (VM Apps and All Apps orgs alike) has only two subscription operations: get one by ID, and delete. It has no way to list or create subscriptions, although the VCF Automation UI does both. The UI uses the same endpoints as Aria Automation 8.x, so this server adds them, for both org types, from a small hand-written supplement (specs/supplements/Event Broker - Subscriptions (extra).json):
Tool | Request |
|
|
|
|
A workflow subscription needs name, eventTopicId (from eventbroker_get_all_event_topics), type: "RUNNABLE", runnableType: "extensibility.vro" and runnableId (the workflow ID). For an ABX action, use runnableType: "extensibility.abx" with the action ID. Optional fields are blocking, timeout, priority, criteria, constraints.projectId and disabled.
Because these two calls aren't in Broadcom's published API, their tool descriptions say so, and a future VCF Automation release could change them.
Development
npm install
npm run generate # specs/<org type>/*.json|yaml -> data/operations-<org type>.json
npm run build
npm test # mock VCFA server + real MCP client over stdioTo refresh the specs, download each one from https://<vcfa>/tenant/<org>/api-docs of a VM Apps or an All Apps org, drop it into specs/vm-apps/ or specs/all-apps/, then run npm run generate. The per-org-type file-to-service mapping lives at the top of scripts/generate.mjs; specs/all-apps/_manifest.csv lists where each All Apps spec was downloaded from.
License
MIT
Available Tools
698 toolsabx_cancel_action_runB
Cancel an action run Cancels an action run which is currently being executed PATCH /abx/api/resources/action-runs/{id}/cancel
Inputs: id (required), body (required).
abx_create_action_versionC
Create a version for an action Creates a new version for the specified action POST /abx/api/resources/actions/{id}/versions
Inputs: id (required), body (required), projectId (required).
abx_delete_actionCDestructiveIdempotent
Delete an action Deletes an action with a specific ID DELETE /abx/api/resources/actions/{id}
Inputs: id (required), force, projectId.
abx_delete_action_runsCDestructiveIdempotent
Delete multiple action runs Deletes multiple action runs with their specific ID DELETE /abx/api/resources/action-runs
Inputs: body (required).
abx_delete_action_runs_by_idCDestructiveIdempotent
Delete an action run Deletes an action run with a specific ID DELETE /abx/api/resources/action-runs/{id}
Inputs: id (required).
abx_delete_action_secretCDestructiveIdempotent
Delete an action secret Deletes an action secret DELETE /abx/api/resources/action-secrets/{id}
Inputs: id (required).
abx_delete_action_versionCDestructiveIdempotent
Delete an action version Deletes an action version DELETE /abx/api/resources/actions/{id}/versions/{versionId}
Inputs: id (required), projectId (required), versionId (required).
abx_delete_multiple_actionsCDestructiveIdempotent
Delete multiple actions by their id and projectId Deletes actions with a specific ID and projectId DELETE /abx/api/resources/actions
Inputs: body (required).
abx_exportB
Export actions Exports the specified actions as a zip bundle POST /abx/api/resources/actions/export
Inputs: body (required).
abx_get_action_by_idCRead-onlyIdempotent
Fetch all actions by ID across all projects Retrieves all actions with a specific ID across all projects GET /abx/api/resources/actions/{id}
Inputs: id (required), allProjects (required), groupByProject (required), page, +2 more.
abx_get_action_run_by_idCRead-onlyIdempotent
Fetch an action run by its ID Retrieves an action run entity with a specific ID GET /abx/api/resources/action-runs/{id}
Inputs: id (required).
abx_get_action_runs_by_action_idCRead-onlyIdempotent
Fetch all action runs of an action Retrieves all action runs of an action GET /abx/api/resources/actions/{id}/action-runs
Inputs: id (required), page, size.
abx_get_action_secretsBRead-onlyIdempotent
Fetch all action secrets Retrieves all action secrets for given organization GET /abx/api/resources/action-secrets
Inputs: no named parameters.
abx_get_action_secrets_by_idCRead-onlyIdempotent
Fetch action secret Retrieves action secret by given id GET /abx/api/resources/action-secrets/{id}
Inputs: id (required).
abx_get_action_template_by_idBRead-onlyIdempotent
Fetch an action template by its ID Retrieves an action template entity with a specific ID GET /abx/api/resources/action-templates/{id}
Inputs: id (required).
abx_get_all_action_run_projectionsARead-onlyIdempotent
Fetch all action run projections Retrieves projections of all action runs (lightweight representation for UI) GET /abx/api/resources/action-runs
Inputs: projection (required), page, size.
abx_get_all_actionsCRead-onlyIdempotent
Fetch count of subscribable actions by ID Retrieves count of subscribable actions matching the name criteria GET /abx/api/resources/actions
Inputs: page, size, projection, nameCriteria.
abx_get_all_action_templatesCRead-onlyIdempotent
Fetch all action templates Retrieves all action templates GET /abx/api/resources/action-templates
Inputs: no named parameters.
abx_get_all_flows_using_actionCRead-onlyIdempotent
Fetch all action flows using an action Retrieves a list of all action flows which are using the specified action GET /abx/api/resources/actions/{id}/flows
Inputs: id (required), projectId.
abx_get_all_provisioning_endpointsBRead-onlyIdempotent
Proxy to fetch provisioning endpoints Retrieves provisioning endpoints for given organization GET /abx/api/provisioning/endpoints
Inputs: no named parameters.
abx_get_all_versionsCRead-onlyIdempotent
Fetch all versions of an action Retrieves all created versions for an action GET /abx/api/resources/actions/{id}/versions
Inputs: id (required), projectId (required), page, size.
abx_get_provisioning_endpoints_by_idBRead-onlyIdempotent
Proxy to fetch a provisioning endpoint by self link Retrieves provisioning endpoints for given organization GET /abx/api/provisioning/endpoints/{id}
Inputs: id (required).
abx_import_actionsC
Import an action bundle Imports an action bundle and saves all actions POST /abx/api/resources/actions/import
Inputs: body (required).
abx_patch_actions_by_idB
Patch an action Updates the state of the action based only on the supplied properties PATCH /abx/api/resources/actions/{id}
Inputs: id (required), body (required).
abx_post_action_runsA
[DEPRECATED] Create an action run Creates a new action run. This endpoint is deprecated and will be removed in a future version. Use: POST '/abx/api/resources/actions/{action-id}/action-runs' POST /abx/api/resources/action-runs
Inputs: body (required).
abx_post_actionsC
Create an action Creates a new action POST /abx/api/resources/actions
Inputs: body (required).
abx_post_actions_by_id_action_runsB
Trigger an action run Runs the specified action taking into consideration the supplied configuration POST /abx/api/resources/actions/{id}/action-runs
Inputs: id (required), body (required).
abx_post_action_secretsC
Create an action secret Creates a new action secret POST /abx/api/resources/action-secrets
Inputs: body (required).
abx_put_actions_by_idBIdempotent
Update an action Updates the action with the new supplied state PUT /abx/api/resources/actions/{id}
Inputs: id (required), body (required).
abx_put_action_secrets_by_idCIdempotent
Update an action secret Updates an existing action secret PUT /abx/api/resources/action-secrets/{id}
Inputs: id (required), body (required).
abx_release_action_versionCIdempotent
Mark an action version as released Marks an exisiting version of an action as released PUT /abx/api/resources/actions/{id}/release
Inputs: id (required), body (required), projectId (required).
abx_restore_action_versionBIdempotent
Restore the action state based on a specified version Change the current action state to the state specified in the version PUT /abx/api/resources/actions/{id}/versions/{versionId}/restore
Inputs: id (required), projectId (required), versionId (required).
abx_unrelease_action_versionCDestructiveIdempotent
Mark an action version as not released Marks an actions released version as not released DELETE /abx/api/resources/actions/{id}/release
Inputs: id (required), projectId (required).
approvals_answer_work_itemC
Answers the specified work item POST /workitem/api/workitems/{id}/answer
Inputs: id (required), body (required).
approvals_execute_action_on_approval_requestC
Approves or Rejects the approval request POST /approval/api/approvals/action
Inputs: body (required), apiVersion.
approvals_get_aboutARead-onlyIdempotent
Get about page The page contains information about the supported API versions and the latest API version. The version parameter is optional but highly recommended. If you do not specify explicitly an exact version, you will be calling the latest supported API version. Here is an example of a call which specifies the exact version you are using: GET /approval/api/approvals?apiVersion=2022-01-25 GET /approval/api/about
Inputs: apiVersion.
approvals_get_approval_requests_v3CRead-onlyIdempotent
Returns approval requests GET /approval/api/approvals
Inputs: page, size, sort, search, +4 more.
approvals_get_approval_request_v3BRead-onlyIdempotent
Returns details of the approval request GET /approval/api/approvals/{id}
Inputs: id (required), apiVersion.
approvals_get_logged_in_user_groupsCRead-onlyIdempotent
GET /approval/api/approvals/userGroups GET /approval/api/approvals/userGroups
Inputs: no named parameters.
approvals_get_work_item_by_idCRead-onlyIdempotent
Returns work item by id GET /workitem/api/workitems/{id}
Inputs: id (required), expand.
approvals_get_work_itemsCRead-onlyIdempotent
Returns work items for the logged in user GET /workitem/api/workitems
Inputs: page, size, sort, type, +3 more.
approvals_get_work_items_for_deploymentCRead-onlyIdempotent
Returns all work items for a deployment GET /workitem/api/workitems/deployment/{deploymentId}/workitems
Inputs: deploymentId (required), ids, page, size, +4 more.
approvals_get_work_items_for_deployment_requestCRead-onlyIdempotent
Returns work items for a deployment request GET /workitem/api/workitems/{deploymentId}/{requestId}
Inputs: requestId (required), deploymentId (required), ids, page, +5 more.
approvals_reject_work_itemC
Rejects the specified work item POST /workitem/api/workitems/{id}/reject
Inputs: id (required), body (required).
blueprint_cancel_blueprint_requestC
Cancel request POST /blueprint/api/blueprint-requests/{requestId}/actions/cancel
Inputs: requestId (required), apiVersion.
blueprint_create_blueprintC
Creates a blueprint POST /blueprint/api/blueprints
Inputs: body (required), apiVersion.
blueprint_create_blueprint_from_mappingB
Creates a blueprint from a Terraform blueprint configuration (obtained from /create-blueprint-mapping). POST /blueprint/api/blueprint-integrations/terraform/create-blueprint-from-mapping
Inputs: body (required), apiVersion.
blueprint_create_blueprint_mappingC
Retrieves and parses the specified Terraform configuration file(s) and returns relevant information for blueprint construction. POST /blueprint/api/blueprint-integrations/terraform/create-blueprint-mapping
Inputs: body (required), apiVersion.
blueprint_create_blueprint_requestC
Creates a blueprint request POST /blueprint/api/blueprint-requests
Inputs: body (required), apiVersion.
blueprint_create_blueprint_versionC
Creates version for the given blueprint ID POST /blueprint/api/blueprints/{blueprintId}/versions
Inputs: body (required), blueprintId (required), apiVersion.
blueprint_create_property_groupC
Creates a property group POST /properties/api/property-groups
Inputs: body (required), apiVersion.
blueprint_create_terraform_versionC
Creates a version POST /blueprint/api/blueprint-integrations/terraform/versions
Inputs: body (required), apiVersion.
blueprint_delete_blueprintADestructiveIdempotent
Deletes a blueprint DELETE /blueprint/api/blueprints/{blueprintId}
Inputs: blueprintId (required), apiVersion.
blueprint_delete_blueprint_requestCDestructiveIdempotent
Deletes request DELETE /blueprint/api/blueprint-requests/{requestId}
Inputs: requestId (required), force, apiVersion.
blueprint_delete_property_groupBDestructiveIdempotent
Deletes a property group DELETE /properties/api/property-groups/{propertyGroupId}
Inputs: propertyGroupId (required), apiVersion.
blueprint_delete_terraform_versionCDestructiveIdempotent
Deletes a terraform version DELETE /blueprint/api/blueprint-integrations/terraform/versions/{versionId}
Inputs: versionId (required), apiVersion.
blueprint_get_aboutBRead-onlyIdempotent
Returns blueprint API information The page contains information about the supported API versions and the latest API version. The version parameter is optional but highly recommended. Only assembler admin in VM Apps Org can access. If you do not specify explicitly an exact version, you will be calling the latest supported API version. Here is an example of a call which specifies the exact version you are using: GET /blueprint/api/blueprints?apiVersion=2019-09-12 GET /blueprint/api/about
Inputs: no named parameters.
blueprint_get_blueprintCRead-onlyIdempotent
Returns blueprint details GET /blueprint/api/blueprints/{blueprintId}
Inputs: blueprintId (required), select, apiVersion, revalidate.
blueprint_get_blueprint_inputs_schemaBRead-onlyIdempotent
Returns blueprint inputs schema GET /blueprint/api/blueprints/{blueprintId}/inputs-schema
Inputs: blueprintId (required), apiVersion.
blueprint_get_blueprint_requestCRead-onlyIdempotent
Returns blueprint request details GET /blueprint/api/blueprint-requests/{requestId}
Inputs: requestId (required), apiVersion.
blueprint_get_blueprint_request_executionCRead-onlyIdempotent
Returns request execution details GET /blueprint/api/blueprint-requests/{requestId}/execution
Inputs: requestId (required), expand, apiVersion.
blueprint_get_blueprint_requests_by_request_id_resources_planCRead-onlyIdempotent
Returns request resources plan GET /blueprint/api/blueprint-requests/{requestId}/resources-plan
Inputs: requestId (required), expand, apiVersion.
blueprint_get_blueprint_resources_planCRead-onlyIdempotent
Returns request plan GET /blueprint/api/blueprint-requests/{requestId}/plan
Inputs: requestId (required), expand, apiVersion.
blueprint_get_blueprint_versionCRead-onlyIdempotent
Returns versioned blueprint details GET /blueprint/api/blueprints/{blueprintId}/versions/{version}
Inputs: version (required), blueprintId (required), select.
blueprint_get_blueprint_version_inputs_schemaBRead-onlyIdempotent
Returns blueprint version inputs schema GET /blueprint/api/blueprints/{blueprintId}/versions/{version}/inputs-schema
Inputs: version (required), blueprintId (required), apiVersion.
blueprint_get_configuration_source_treeBRead-onlyIdempotent
Shows directories of the configuration source repository that correspond to Terraform configurations. GET /blueprint/api/blueprint-integrations/terraform/get-configuration-source-tree
Inputs: configurationSourceId (required), path, commitId, apiVersion.
blueprint_get_property_groupBRead-onlyIdempotent
Returns property group details GET /properties/api/property-groups/{propertyGroupId}
Inputs: propertyGroupId (required), select, apiVersion.
blueprint_get_resource_typeBRead-onlyIdempotent
Returns resource type details GET /blueprint/api/resource-types/{resourceTypeId}
Inputs: resourceTypeId (required), apiVersion.
blueprint_get_terraform_configuration_source_commit_listBRead-onlyIdempotent
Returns a paginated list of commits for a specified configuration source. GET /blueprint/api/blueprint-integrations/terraform/get-configuration-source-commits
Inputs: configurationSourceId (required), page, size, sort, +1 more.
blueprint_get_terraform_configuration_sourcesBRead-onlyIdempotent
Returns a paginated list of configuration sources configured as storage for Terraform configurations. GET /blueprint/api/blueprint-integrations/terraform/get-configuration-sources
Inputs: projects (required), page, size, sort, +2 more.
blueprint_get_terraform_versionCRead-onlyIdempotent
Returns Terraform Version details GET /blueprint/api/blueprint-integrations/terraform/versions/{versionId}
Inputs: versionId (required), apiVersion.
blueprint_list_blueprint_requestsCRead-onlyIdempotent
Lists blueprint requests GET /blueprint/api/blueprint-requests
Inputs: top, page, size, skip, +6 more.
blueprint_list_blueprintsCRead-onlyIdempotent
Lists draft blueprint GET /blueprint/api/blueprints
Inputs: top, name, page, size, +10 more.
blueprint_list_blueprint_versionsCRead-onlyIdempotent
Lists blueprint versions GET /blueprint/api/blueprints/{blueprintId}/versions
Inputs: blueprintId (required), top, page, size, +8 more.
blueprint_list_property_groupsCRead-onlyIdempotent
Lists Property Groups GET /properties/api/property-groups
Inputs: top, name, page, size, +8 more.
blueprint_list_resource_typesCRead-onlyIdempotent
Lists resource types GET /blueprint/api/resource-types
Inputs: top, name, page, size, +7 more.
blueprint_list_terraform_versionsCRead-onlyIdempotent
Lists terraform versions GET /blueprint/api/blueprint-integrations/terraform/versions
Inputs: pageable (required), top, skip, orderby, +2 more.
blueprint_release_blueprint_versionC
Release versioned blueprint to catalog POST /blueprint/api/blueprints/{blueprintId}/versions/{version}/actions/release
Inputs: version (required), blueprintId (required), apiVersion.
blueprint_restore_blueprint_versionB
Restores content of draft from versioned blueprint POST /blueprint/api/blueprints/{blueprintId}/versions/{version}/actions/restore
Inputs: version (required), blueprintId (required), apiVersion.
blueprint_un_release_blueprint_versionC
UnRelease versioned blueprint from catalog POST /blueprint/api/blueprints/{blueprintId}/versions/{version}/actions/unrelease
Inputs: version (required), blueprintId (required), apiVersion.
blueprint_update_blueprintCIdempotent
Updates a blueprint PUT /blueprint/api/blueprints/{blueprintId}
Inputs: body (required), blueprintId (required), apiVersion.
blueprint_update_property_groupCIdempotent
Updates a property group PUT /properties/api/property-groups/{propertyGroupId}
Inputs: body (required), propertyGroupId (required), apiVersion.
blueprint_update_terraform_versionC
Updates a terraform version PATCH /blueprint/api/blueprint-integrations/terraform/versions/{versionId}
Inputs: body (required), versionId (required), apiVersion.
blueprint_validate_blueprintC
Validates a blueprint POST /blueprint/api/blueprint-validation
Inputs: body (required), apiVersion.
catalog_change_metering_assignment_strategyB
Updates the pricing card assignment strategy for the Org. PATCH /price/api/private/pricing-card-assignments/strategy
Inputs: body (required).
catalog_create_metering_assignment_strategyC
Selecting the new pricing card assignment strategy,PROJECT or CLOUDZONE are possible values can be used while creating strategy. Also there can be only one strategy for a given org at a given point o… Create a new pricing card assignment strategy based on request body and validate its field according to business rules. POST /price/api/private/pricing-card-assignments/strategy
Inputs: body (required).
catalog_create_metering_policy_assignmentC
Create a new pricing card assignment Create a new pricing card policy assignment based on request body and validate its field according to business rules. Request body with ALL entityType will delete the older assignments for the given pricingCardId POST /price/api/private/pricing-card-assignments
Inputs: body (required).
catalog_create_or_updateC
Creates or updates a notification scenario branding of an organization POST /notification/api/scenario-branding
Inputs: body (required).
catalog_create_policyC
Create a new pricing card Create a new pricing card based on request body and validate its field according to business rules. POST /price/api/private/pricing-cards
Inputs: body (required).
catalog_delete_admin_sources_by_source_idCDestructiveIdempotent
Delete catalog source. Deletes the catalog source with the supplied ID. DELETE /catalog/api/admin/sources/{sourceId}
Inputs: sourceId (required).
catalog_delete_icons_by_idCDestructiveIdempotent
Delete an icon Delete an existing icon by its unique id. DELETE /icon/api/icons/{id}
Inputs: id (required).
catalog_delete_metering_policy_assignmentCDestructiveIdempotent
Delete the pricing card assignment with specified id Deletes the pricing card assignment with the specified id DELETE /price/api/private/pricing-card-assignments/{id}
Inputs: id (required).
catalog_delete_policyCDestructiveIdempotent
Delete the pricing card with specified Id Deletes the pricing card with the specified id DELETE /price/api/private/pricing-cards/{id}
Inputs: id (required).
catalog_delete_scenario_brandingBDestructiveIdempotent
Deletes a notification scenario branding DELETE /notification/api/scenario-branding
Inputs: no named parameters.
catalog_delete_scenario_configs_by_scenario_idBDestructiveIdempotent
Deletes a notification scenario configuration by scenario id of an organization DELETE /notification/api/scenario-configs/{scenarioId}
Inputs: scenarioId (required).
catalog_downloadBRead-onlyIdempotent
Download an icon Download an existing icon by its unique id. GET /icon/api/icons/{id}
Inputs: id (required).
catalog_get_admin_sources_by_source_idBRead-onlyIdempotent
Fetch a specific catalog source for the given ID. Returns the catalog source with the supplied ID. GET /catalog/api/admin/sources/{sourceId}
Inputs: sourceId (required).
catalog_get_all_metering_policy_assignmentsBRead-onlyIdempotent
Fetch all pricing card assignment for private cloud Returns a paginated list of pricing card assignments GET /price/api/private/pricing-card-assignments
Inputs: top, page, size, skip, +4 more.
catalog_get_all_scenario_configsARead-onlyIdempotent
Retrieves all notification scenario configurations of an organization GET /notification/api/scenario-configs
Inputs: page, size, sort.
catalog_get_catalog_itemCRead-onlyIdempotent
Find a catalog item with specified ID. Returns the catalog item with the specified ID. GET /catalog/api/items/{id}
Inputs: id (required), expand, expandProjects.
catalog_get_catalog_item_for_adminCRead-onlyIdempotent
Find a catalog item with specified id. Returns the catalog item with the specified id. GET /catalog/api/admin/items/{id}
Inputs: id (required), expand, includeSource.
catalog_get_catalog_itemsBRead-onlyIdempotent
Fetch a list of catalog items. Returns a paginated list of catalog items. GET /catalog/api/items
Inputs: top, page, size, skip, +7 more.
catalog_get_catalog_items_for_adminCRead-onlyIdempotent
Fetch a list of catalog items. Returns a paginated list of catalog items. GET /catalog/api/admin/items
Inputs: top, page, size, skip, +7 more.
catalog_get_metering_assignment_strategyBRead-onlyIdempotent
Fetch pricing card assignment strategy for the Org Returns a pricing card assignment strategy for the Org GET /price/api/private/pricing-card-assignments/strategy
Inputs: no named parameters.
catalog_get_metering_policy_assignmentCRead-onlyIdempotent
Fetch pricing card assignment for private cloud by id Returns a pricing card assignments by id GET /price/api/private/pricing-card-assignments/{id}
Inputs: id (required).
catalog_get_pageBRead-onlyIdempotent
Fetch catalog sources. Returns a paginated list of catalog sources. GET /catalog/api/admin/sources
Inputs: top, page, size, skip, +5 more.
catalog_get_policiesBRead-onlyIdempotent
Fetch all pricing cards for private-policy cloud Returns a paginated list of pricing cards GET /price/api/private/pricing-cards
Inputs: top, page, size, skip, +6 more.
catalog_get_policyCRead-onlyIdempotent
Find the pricing card with specified Id Returns the pricing card with the specified id GET /price/api/private/pricing-cards/{id}
Inputs: id (required).
catalog_get_scenarioCRead-onlyIdempotent
Retrieves notification scenarios GET /notification/api/scenarios/{id}
Inputs: id (required), expandBody.
catalog_get_scenario_configBRead-onlyIdempotent
Retrieves a notification scenario configuration by scenario id of an organization GET /notification/api/scenario-configs/{scenarioId}
Inputs: scenarioId (required), expandBody, defaultConfig.
catalog_get_type_by_idBRead-onlyIdempotent
Fetch catalog item type associated with the specified ID. Returns the Catalog Item Type with the specified ID. GET /catalog/api/types/{id}
Inputs: id (required).
catalog_get_typesBRead-onlyIdempotent
Find all Catalog Item Types. Returns a paginated list of all available Catalog Item Types. GET /catalog/api/types
Inputs: top, page, size, skip, +2 more.
catalog_get_upfront_price_response_for_catalog_itemBRead-onlyIdempotent
Get a response with upfront prices for a given catalog item. Returns upfront prices of a given catalog item. GET /catalog/api/items/{id}/upfront-prices/{upfrontPriceId}
Inputs: id (required), upfrontPriceId (required), project.
catalog_get_version_by_idCRead-onlyIdempotent
Fetch detailed catalog item version. Returns a detailed catalog item version. GET /catalog/api/items/{id}/versions/{versionId}
Inputs: id (required), versionId (required).
catalog_get_version_by_id_for_adminCRead-onlyIdempotent
Fetch a detailed catalog item version. Returns a detailed catalog item version. GET /catalog/api/admin/items/{id}/versions/{versionId}
Inputs: id (required), versionId (required).
catalog_get_versionsBRead-onlyIdempotent
Fetch a list of catalog items with versions. Returns a paginated list of catalog item versions. GET /catalog/api/items/{id}/versions
Inputs: id (required), page, size, sort.
catalog_get_versions_for_adminBRead-onlyIdempotent
Fetch a list of catalog items with versions. Returns a paginated list of catalog item versions. GET /catalog/api/admin/items/{id}/versions
Inputs: id (required), page, size, sort.
catalog_patch_configC
Enable or disabled a notification scenario configuration of an organization PATCH /notification/api/scenario-configs
Inputs: body (required).
catalog_patch_metering_policy_assignmentB
Updates the pricing card assignment id with the supplied id. Request body with ALL entityType will delete the older assignments for the given pricingCardId PATCH /price/api/private/pricing-card-assignments/{id}
Inputs: id (required), body (required).
catalog_postB
Create or update a catalog source. Creating or updating also imports (or re-imports) the associated catalog items. Creates a new catalog source or updates an existing catalog source based on the request body and imports catalog items from it. POST /catalog/api/admin/sources
Inputs: body (required), validationOnly.
catalog_post_scenario_configsB
Creates or updates a notification scenario configuration of an organization POST /notification/api/scenario-configs
Inputs: body (required), expandBody.
catalog_preview_notification_configC
Preview Notification Scenario Config POST /notification/api/scenario-configs/{scenarioId}/preview
Inputs: body (required), scenarioId (required).
catalog_request_catalog_item_instancesC
Create a deployment. Creates a deployment from a catalog item. POST /catalog/api/items/{id}/request
Inputs: id (required), body (required).
catalog_send_test_notificationC
Send Test Notification Scenario Config POST /notification/api/scenario-configs/{scenarioId}/test
Inputs: body (required), scenarioId (required).
catalog_submit_upfront_price_request_for_catalog_itemB
Create a request to calculate upfront price for a given catalog item. Returns upfront price response for a given catalog item. POST /catalog/api/items/{id}/upfront-prices
Inputs: id (required), body (required).
catalog_update_catalog_itemB
Set an icon or request limit to a catalog item. Updates a catalog item with specified icon id or request limit. PATCH /catalog/api/admin/items/{id}
Inputs: id (required), body (required).
catalog_update_catalog_item_versionB
Patch the catalog item version with form id. Patch the catalog item version with form id. Nullify the formId if the formId is an empty string. PATCH /catalog/api/admin/items/{id}/versions/{versionId}
Inputs: id (required), body (required), versionId (required).
catalog_update_policyCIdempotent
Update the pricing card Updates the pricing card with the specified Id PUT /price/api/private/pricing-cards/{id}
Inputs: id (required), body (required).
catalog_uploadC
Upload an icon Create an icon. POST /icon/api/icons
Inputs: body.
content_create_content_sourceB
Create a Content source Returns the new content source POST /content/api/sources
Inputs: body (required), apiVersion.
content_delete_content_sourceCDestructiveIdempotent
Delete a content source DELETE /content/api/sources/{id}
Inputs: id (required), apiVersion.
content_get_aboutCRead-onlyIdempotent
Returns content API information The page contains information about the supported API versions and the latest API version. The version parameter is optional but highly recommended. If you do not specify explicitly an exact version, you will be calling the latest supported API version. Here is an example of a call which specifies the exact version you are using: GET /content/api/sources?apiVersion=2019-01-15 GET /content/api/about
Inputs: no named parameters.
content_get_content_sourceCRead-onlyIdempotent
Get a content source GET /content/api/sources/{id}
Inputs: id (required), apiVersion.
content_get_sync_requestCRead-onlyIdempotent
Get a sync request by id GET /content/api/sourcecontrol/sync-requests/{id}
Inputs: id (required), apiVersion.
content_list_content_sourceBRead-onlyIdempotent
Get content sources Use filter parameters to narrow down the results. Request parameter should be URL encoded GET /content/api/sources/list
Inputs: page, size, sort, request, +2 more.
content_list_content_sourcesCRead-onlyIdempotent
[DEPRECATED] Get content sources. Deprecated: Use /content/api/sources/list Deprecated in favor of /content/api/sources/list due to improper usage of query parameters GET /content/api/sources
Inputs: request (required), pageable (required), page, size, +2 more.
content_schedule_syncB
Creates a sync request Request sync for a content source POST /content/api/sourcecontrol/sync-requests
Inputs: body (required), apiVersion.
content_schedule_sync_allB
Submit sync request for the projects Request sync for the sources belonging to the user's projects or specified projects POST /content/api/sourcecontrol/sync-all-requests
Inputs: body, apiVersion.
content_sync_historyCRead-onlyIdempotent
Get sync history Get history for files synced via source control sync GET /content/api/sourcecontrol/sync-history
Inputs: request (required), pageRequest (required), page, size, +1 more.
content_update_content_sourceC
Update content source PATCH /content/api/sources/{id}
Inputs: id (required), body (required), apiVersion.
deployment_action_deployment_requestA
Submit action on requests. Allowable values: cancel, dismiss. Cancel can be submitted on In-progress requests and Dismiss can be submitted on Failed requests. POST /deployment/api/requests/{requestId}
Inputs: action (required), requestId (required).
deployment_check_deployment_nameARead-onlyIdempotent
[DEPRECATED] Check if a deployment exists. Returns OK if a deployment with the supplied name exists. GET /deployment/api/deployments/names/{name}
Inputs: name (required).
deployment_check_deployment_name_existsBRead-onlyIdempotent
Check if a deployment exists. Returns OK if a deployment with the supplied name exists. GET /deployment/api/deployments/names
Inputs: name (required).
deployment_create_resourceB
Create a new resource. Returns the resource request response. POST /deployment/api/resources
Inputs: body (required).
deployment_delete_deploymentBDestructiveIdempotent
Delete a deployment. Effectively triggers a Delete Day2 operation Deletes the deployment with the supplied ID, cleans up the associated resources from the Cloud Provider. DELETE /deployment/api/deployments/{deploymentId}
Inputs: deploymentId (required), forceDelete.
deployment_delete_resourceBDestructiveIdempotent
Delete resource associated with a deployment. Effectively triggers a Delete Day2 operation. Deletes the resource with the specified ID and attempts to delete resource from the Cloud Provider. DELETE /deployment/api/deployments/{deploymentId}/resources/{resourceId}
Inputs: resourceId (required), deploymentId (required).
deployment_get_billing_metricsCRead-onlyIdempotent
Get Billing Metrics. Get billing metrics for current org. GET /deployment/api/billing-metrics
Inputs: no named parameters.
deployment_get_deployment_actionBRead-onlyIdempotent
Fetch deployment action. Returns an action for the deployment specified by its Deployment ID and Action ID. GET /deployment/api/deployments/{deploymentId}/actions/{actionId}
Inputs: actionId (required), deploymentId (required).
deployment_get_deployment_actionsARead-onlyIdempotent
Fetch deployment available actions. Returns the complete list of available actions that can be performed on a given deployment. GET /deployment/api/deployments/{deploymentId}/actions
Inputs: deploymentId (required).
deployment_get_deployment_by_idCRead-onlyIdempotent
Fetch a specific deployment. Returns the deployment with the supplied ID. GET /deployment/api/deployments/{deploymentId}
Inputs: deploymentId (required), expand, deleted, expandProject, +2 more.
deployment_get_deployment_expense_history_by_idCRead-onlyIdempotent
Fetch a specific deployment's expense history. Returns the deployment expense history with the supplied ID. GET /deployment/api/deployments/{deploymentId}/expense-history
Inputs: deploymentId (required), to, from, interval.
deployment_get_deployment_filter_by_idBRead-onlyIdempotent
Returns the Deployment filter with the supplied ID. GET /deployment/api/deployments/filters/{filterId}
Inputs: filterId (required), top, page, size, +5 more.
deployment_get_deployment_filtersCRead-onlyIdempotent
Returns the Deployment filters in context of given user. GET /deployment/api/deployments/filters
Inputs: deleted, excludeValues.
deployment_get_deployment_requestsCRead-onlyIdempotent
Fetch deployment requests. Returns the requests for the deployment. GET /deployment/api/deployments/{deploymentId}/requests
Inputs: deploymentId (required), top, page, size, +6 more.
deployment_get_deployment_resourcesBRead-onlyIdempotent
Fetch resources associated with a deployment. Returns a paginated list of resources corresponding to the deployment with the supplied ID. GET /deployment/api/deployments/{deploymentId}/resources
Inputs: deploymentId (required), top, page, size, +8 more.
deployment_get_deploymentsBRead-onlyIdempotent
Fetch all deployments. Returns a paginated list of deployments. GET /deployment/api/deployments
Inputs: ids, top, name, page, +23 more.
deployment_get_deployments_for_projectBRead-onlyIdempotent
Returns a count of deployments using the project. GET /deployment/api/projects/{projectId}/deployment-count
Inputs: projectId (required).
deployment_get_event_logsCRead-onlyIdempotent
Fetch Event logs. Returns the logs for an event. GET /deployment/api/requests/{requestId}/events/{eventId}/logs
Inputs: eventId (required), requestId (required), sinceRow.
deployment_get_event_logs_contentBRead-onlyIdempotent
Fetch Event logs content as a file. Returns the log file for an event. GET /deployment/api/requests/{requestId}/events/{eventId}/logs/download
Inputs: eventId (required), requestId (required).
deployment_get_requestCRead-onlyIdempotent
Get the Request. Returns the request with the given ID. GET /deployment/api/requests/{requestId}
Inputs: requestId (required).
deployment_get_request_eventsBRead-onlyIdempotent
Fetch Request events. Returns all the events for a request. GET /deployment/api/requests/{requestId}/events
Inputs: requestId (required), page, size, sort.
deployment_get_resource_actionCRead-onlyIdempotent
Fetch resource action. Returns an action for the resource specified by its Resource ID and Action ID. GET /deployment/api/deployments/{deploymentId}/resources/{resourceId}/actions/{actionId}
Inputs: actionId (required), resourceId (required), deploymentId (required).
deployment_get_resource_actionsBRead-onlyIdempotent
Fetch available resource actions. Returns the complete list of available actions that can be performed on a given resource. GET /deployment/api/deployments/{deploymentId}/resources/{resourceId}/actions
Inputs: resourceId (required), deploymentId (required).
deployment_get_resource_by_idBRead-onlyIdempotent
Fetch resource associated with a deployment. Returns the resource with the specified ID that is correlated with the supplied deployment. GET /deployment/api/deployments/{deploymentId}/resources/{resourceId}
Inputs: resourceId (required), deploymentId (required), expand.
deployment_get_resource_filter_by_idARead-onlyIdempotent
Returns the Resource filter with the supplied ID. GET /deployment/api/resources/filters/{filterId}
Inputs: filterId (required), top, page, size, +7 more.
deployment_get_resource_filtersCRead-onlyIdempotent
Returns the Resource filters in context of given user. GET /deployment/api/resources/filters
Inputs: resourceTypes.
deployment_get_resourcesBRead-onlyIdempotent
Fetch all resources. Returns a paginated list of resources. GET /deployment/api/resources
Inputs: top, page, size, skip, +12 more.
deployment_get_resources_by_resource_idCRead-onlyIdempotent
Fetch a specific resource. Returns the resource with the supplied ID. GET /deployment/api/resources/{resourceId}
Inputs: resourceId (required), expand.
deployment_get_resources_by_resource_id_actionsARead-onlyIdempotent
Fetch available resource actions. Returns the complete list of available actions that can be performed on a given resource. GET /deployment/api/resources/{resourceId}/actions
Inputs: resourceId (required).
deployment_get_resources_by_resource_id_actions_by_action_idBRead-onlyIdempotent
Fetch resource action. Returns an action for the resource specified by its Resource ID and Action ID. GET /deployment/api/resources/{resourceId}/actions/{actionId}
Inputs: actionId (required), resourceId (required).
deployment_get_resource_typeBRead-onlyIdempotent
Fetch a specific Resource type. Returns the Resource type with the supplied ID. GET /deployment/api/resource-types/{resourceTypeId}
Inputs: resourceTypeId (required).
deployment_get_user_eventsBRead-onlyIdempotent
Get user events for deployment. Returns paged user events for given deployment ID. User events represent: Create, Day2, Approval or vRO User Interaction GET /deployment/api/deployments/{deploymentId}/userEvents
Inputs: deploymentId (required), top, page, size, +3 more.
deployment_list_resource_requestsCRead-onlyIdempotent
Get all requests for a resource GET /deployment/api/resources/{resourceId}/requests
Inputs: resourceId (required), top, page, size, +5 more.
deployment_list_resource_typesBRead-onlyIdempotent
Fetch all Resource Types. Returns a paginated list of Resource Types. GET /deployment/api/resource-types
Inputs: ids, top, page, size, +7 more.
deployment_patch_deploymentC
Update deployment. Updates the deployment with the supplied ID. PATCH /deployment/api/deployments/{deploymentId}
Inputs: body (required), deploymentId (required).
deployment_post_resources_by_resource_id_requestsC
Resource action request. Submit a resource action request. POST /deployment/api/resources/{resourceId}/requests
Inputs: body (required), resourceId (required).
deployment_submit_deployment_action_requestC
Deployment action request. Submit a deployment action request POST /deployment/api/deployments/{deploymentId}/requests
Inputs: body (required), deploymentId (required).
deployment_submit_resource_action_requestC
Resource action request. Submit a resource action request. POST /deployment/api/deployments/{deploymentId}/resources/{resourceId}/requests
Inputs: body (required), resourceId (required), deploymentId (required).
eventbroker_delete_subscriptionBDestructiveIdempotent
Delete Subscription Delete Subscription. Only Solution users and system admin (e.g. for vRO) can manage subscriptions. DELETE /event-broker/api/subscriptions/{id}
Inputs: id (required).
eventbroker_get_all_event_topicsBRead-onlyIdempotent
Get all Event Topics Get all Event Topics with specified paging parameters. GET /event-broker/api/topics
Inputs: page, size, sort.
eventbroker_get_audit_log_filter_entry_by_idCRead-onlyIdempotent
GET /event-broker/api/audit/filters/{filterId} GET /event-broker/api/audit/filters/{filterId}
Inputs: filterId (required), page, size, sort, +1 more.
eventbroker_get_eventCRead-onlyIdempotent
Get Event by id Retrieve the details of a specified Event. GET /event-broker/api/events/{id}
Inputs: id (required).
eventbroker_get_eventsCRead-onlyIdempotent
Get Events Get Events by pages. GET /event-broker/api/events
Inputs: page, size, sort.
eventbroker_get_event_topicBRead-onlyIdempotent
Retrieves Event Topic Retrieves Event Topic by id. GET /event-broker/api/topics/{id}
Inputs: id (required).
eventbroker_get_subscriptionCRead-onlyIdempotent
Retrieves Subscription Retrieves Subscription by id. GET /event-broker/api/subscriptions/{id}
Inputs: id (required).
form_create_formC
Create form definition Create form definition. POST /form-service/api/forms
Inputs: body (required), lockForm, generateUnvalidatableExternalValuesSchema.
form_create_or_update_custom_resource_typeC
Create custom resource type. POST /form-service/api/custom/resource-types
Inputs: body (required).
form_create_or_update_resource_actionC
Create resource action. POST /form-service/api/custom/resource-actions
Inputs: body (required), generateUnvalidatableExternalValuesSchema.
form_delete_custom_resource_typeCDestructiveIdempotent
Delete custom resource type. DELETE /form-service/api/custom/resource-types/{id}
Inputs: id (required).
form_delete_formCDestructiveIdempotent
Delete form by ID Delete the form with the specified ID. DELETE /form-service/api/forms/{id}
Inputs: id (required).
form_delete_forms_delete_by_source_and_typeBDestructiveIdempotent
Delete form by source Delete the form with the specified sourceType, sourceId and formType. DELETE /form-service/api/forms/deleteBySourceAndType
Inputs: formType (required), sourceId (required), sourceType (required).
form_delete_resource_actionCDestructiveIdempotent
Delete resource action. DELETE /form-service/api/custom/resource-actions/{id}
Inputs: id (required).
form_execute_external_actionC
Execute an external action to get a value (for the UI) POST /form-service/api/forms/renderer/external-value
Inputs: body (required), sourceId, projectId.
form_execute_external_actionsC
Execute multiple external actions to get a list of values (for the UI) POST /form-service/api/forms/renderer/external-values
Inputs: body (required), sourceId, projectId.
form_fetch_customized_formB
Fetch request form or generate one for a given library schema. Fetch a request form from the database, according to the search parameters. Generate one according to the JsonSchema if there isn't a persisted form. POST /form-service/api/forms/designer/request
Inputs: body (required), formId, formType, sourceId, +1 more.
form_fetch_formC
Generate request form for a given library schema. POST /form-service/api/forms/renderer/request
Inputs: body (required), formType, sourceId, sourceType.
form_fetch_modelC
Generate request form model for a given library schema. POST /form-service/api/forms/renderer/model
Inputs: body (required), formId, formType, sourceId, +3 more.
form_generateB
[DEPRECATED] Generate schema for runnable item. Generate a ProviderSchemaImpl for the provided RunnableItem. The schema can be used to create a custom resource type. POST /form-service/api/custom/schema-generation
Inputs: body (required).
form_generate_elementsC
Generate designer elements for a given request schema. POST /form-service/api/forms/designer/elements
Inputs: body (required), sourceId, sourceType.
form_generate_elements_runnable_itemC
Generate designer elements for a given runnable item. POST /form-service/api/forms/designer/runnable-item-elements
Inputs: body (required), externalType.
form_generate_json_schemaC
Generates json schema based on the provided form layout schema POST /form-service/api/forms/designer/generate-form-json-schema
Inputs: body (required).
form_get_action_formCRead-onlyIdempotent
Get resource action's form GET /form-service/api/custom/resource-actions/{id}/form
Inputs: id (required).
form_get_action_runnable_itemCRead-onlyIdempotent
Get resource action runnable item. GET /form-service/api/custom/resource-actions/{id}/runnable-item
Inputs: id (required), includeCrResourceActions.
form_get_binding_actionBRead-onlyIdempotent
Get binding action for given action resource type and external input type. GET /form-service/api/custom/resource-actions/binding-action
Inputs: externalType (required), resourceType (required).
form_get_custom_resource_typeCRead-onlyIdempotent
Get custom resource type. GET /form-service/api/custom/resource-types/{id}
Inputs: id (required), propertiesFormat.
form_get_external_valueC
Get a list of external values. POST /form-service/api/forms/designer/external-value/sources
Inputs: body (required).
form_get_formBRead-onlyIdempotent
Get form by ID Retrieve the Form definition of a form with the specified ID. GET /form-service/api/forms/{id}
Inputs: id (required), formFormat.
form_get_form_layout_schemaC
Get form layout schema for runnable item. Get the layout schema for the provided runnable item, given that it exists on the specified endpoint POST /form-service/api/custom/schema-generation/form
Inputs: body (required).
form_get_forms_provider_by_refBRead-onlyIdempotent
Get form by providerRef Retrieve the form definition of a form with the specified provider reference. GET /form-service/api/forms/provider/{ref}
Inputs: ref (required).
form_get_forms_versionsCRead-onlyIdempotent
Get form definition versions GET /form-service/api/forms/versions
Inputs: formType (required), sourceId (required), sourceType (required), page, +2 more.
form_get_forms_versions_by_idARead-onlyIdempotent
Get form definition version by id GET /form-service/api/forms/versions/{id}
Inputs: id (required).
form_get_json_object_schemaB
Get json object schema for runnable item. Generate a ProviderSchemaImpl for the provided RunnableItem. The schema can be used to create a custom resource type. POST /form-service/api/custom/schema-generation/json
Inputs: body (required), externalType.
form_get_resource_actionCRead-onlyIdempotent
Get resource action. GET /form-service/api/custom/resource-actions/{id}
Inputs: id (required).
form_get_r_esource_action_for_custom_resourceCRead-onlyIdempotent
Get resource action for resource type. GET /form-service/api/custom/resource-types/{resourceTypeId}/resource-actions/{resourceActionId}
Inputs: resourceTypeId (required), resourceActionId (required).
form_get_resource_action_form_dataC
Returns resolved binding values based on the properties of the resource for given resource operation POST /form-service/api/custom/resource-actions/{id}/form-data
Inputs: id (required), body (required), projectId.
form_get_resource_typeARead-onlyIdempotent
[DEPRECATED] Gets resource type by id (DEPRECATED).
This endpoint is deprecated. Use /deployment/api/resource-types/{id} directly from the Catalog Service instead. Get the resource type for the provided ID in the currently authorized organization
GET /form-service/api/deployment/resource-types/{id}
Inputs: id (required).
form_list_actionsCRead-onlyIdempotent
List resource actions. GET /form-service/api/custom/resource-actions
Inputs: page, size, sort, runnableId, +1 more.
form_list_custom_resource_typesCRead-onlyIdempotent
List custom resource types. GET /form-service/api/custom/resource-types
Inputs: page, size, sort, runnableId, +2 more.
form_list_resource_typesBRead-onlyIdempotent
[DEPRECATED] List resource types (DEPRECATED).
This endpoint is deprecated. Use /deployment/api/resource-types directly from the Catalog Service instead. List all of the resource types in an organization.
GET /form-service/api/deployment/resource-types
Inputs: page, size, sort, search.
form_lookup_external_resourceCRead-onlyIdempotent
Retrieve external resource object Retrieve external resource object depending on namespace type and id GET /form-service/api/forms/renderer/external-resources
Inputs: type (required), objectId (required), namespace (required), projectId (required).
form_lookup_external_resourcesC
Retrieve external resource value Retrieve external resource value depending on provided value source type POST /form-service/api/forms/renderer/external-resources
Inputs: body (required).
form_perform_external_validationC
Perform external validations for a form (for the UI) POST /form-service/api/forms/renderer/external-validation
Inputs: body (required), sourceId, projectId.
form_post_forms_versionsC
Create form definition version POST /form-service/api/forms/versions
Inputs: body (required).
form_restoreC
Restore form definition version PATCH /form-service/api/forms/versions/{id}/restore
Inputs: id (required).
form_search_by_source_and_typeBRead-onlyIdempotent
Search form by source Search for form definition by source type, source ID and form type. GET /form-service/api/forms/fetchBySourceAndType
Inputs: formType (required), sourceId (required), sourceType (required), formFormat.
form_search_form_definitionsCRead-onlyIdempotent
Search form and form versions by term Search for form definitions and form versions with the specified term. GET /form-service/api/forms/search
Inputs: page, size, sort, term.
form_search_form_statusC
Fetch form status Retrieve statuses of forms specified by reference IDs. POST /form-service/api/forms/fetchStatus
Inputs: body (required), type.
iaas_allocate_network_ips_by_userC
allocate network IPs by user. allocate network IPs by user POST /iaas/api/network-ip-ranges/{id}/ip-addresses/allocate
Inputs: id (required), body (required), apiVersion (required).
iaas_attach_machine_diskC
Attach machine disk Attach a disk to a machine. POST /iaas/api/machines/{id}/disks
Inputs: id (required), body (required), apiVersion.
iaas_change_security_groupsB
Change security groups for a vSphere machine Change security groups for a vSphere machine network interfaces. Securing group that is part of the same deployment can be added or removed for a machine network interface. POST /iaas/api/machines/{id}/operations/change-security-groups
Inputs: id (required), body (required), apiVersion.
iaas_create_avi_lb_cloud_account_asyncB
Create an AVI Load Balancer cloud account Create an AVI Load Balancer cloud account in the current organization POST /iaas/api/cloud-accounts-avilb
Inputs: body (required), apiVersion (required).
iaas_create_aws_cloud_account_asyncC
Create a cloud account Create a cloud account in the current organization POST /iaas/api/cloud-accounts-aws
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_aws_storage_profileC
Create AWS storage class POST /iaas/api/storage-profiles-aws
Inputs: body (required), apiVersion.
iaas_create_azure_cloud_account_asyncC
Create a cloud account Create a cloud account in the current organization POST /iaas/api/cloud-accounts-azure
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_azure_storage_profileC
Create Azure storage class POST /iaas/api/storage-profiles-azure
Inputs: body (required), apiVersion.
iaas_create_block_deviceB
Create BlockDevice Following disk custom properties can be passed while creating a block device: 1. dataStore: Defines name of the datastore in which the disk has to be provisioned. 2. storagePolicy: Defines name of the storage policy in which the disk has to be provisioned. If name of the datastore is specified in the custom properties then, datastore takes precedence. 3. provisioningType: Defines the type of provisioning. For eg. thick/thin. 4. resourceGroupName: Defines the Azure resource group name where the disk needs to be provisioned. POST /iaas/api/block-devices
Inputs: body (required), apiVersion.
iaas_create_block_device_snapshotC
Create snapshot operation for Block Device Second day create snapshot operation for Block device POST /iaas/api/block-devices/{id}/operations/snapshots
Inputs: id (required), body, apiVersion.
iaas_create_cloud_account_asyncC
Create a cloud account Create a cloud account in the current organization POST /iaas/api/cloud-accounts
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_compute_gatewayC
Create a compute gateway Create a new compute gateway. POST /iaas/api/compute-gateways
Inputs: body (required), apiVersion.
iaas_create_compute_natC
Create a Compute Nat Create a new Compute Nat. POST /iaas/api/compute-nats
Inputs: body (required), apiVersion.
iaas_create_custom_nameC
Create Custom Name POST /iaas/api/naming
Inputs: body (required), apiVersion (required).
iaas_create_data_collectorB
Create Data collector Create a new Data Collector. Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release. POST /iaas/api/data-collectors
Inputs: apiVersion.
iaas_create_deploymentC
Create deployment Create a new Deployment. POST /iaas/api/deployments
Inputs: body (required), apiVersion.
iaas_create_flavor_profileC
Create flavor profile POST /iaas/api/flavor-profiles
Inputs: body (required), apiVersion, includeCores.
iaas_create_gcp_cloud_account_asyncC
Create a cloud account Create a cloud account in the current organization POST /iaas/api/cloud-accounts-gcp
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_gcp_storage_profileC
Create GCP storage profile POST /iaas/api/storage-profiles-gcp
Inputs: body (required), apiVersion.
iaas_create_image_profileA
Create image profile Create image profile. This image profile is created for the specific region. Image mapping definitions are created together with the profile. All existing image mapping definitions for the specified region will be replaced with the payload provided and if you want to keep the existing definitions, they should be added to the payload. POST /iaas/api/image-profiles
Inputs: body (required), apiVersion.
iaas_create_integration_asyncB
Create an integration Create an integration in the current organization asynchronously POST /iaas/api/integrations
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_internal_network_ip_rangeC
Create internal network IP range Creates an internal network IP range. POST /iaas/api/network-ip-ranges
Inputs: body (required), apiVersion.
iaas_create_load_balancerC
Create load balancer POST /iaas/api/load-balancers
Inputs: body (required), apiVersion.
iaas_create_machineC
Create machine POST /iaas/api/machines
Inputs: body (required), apiVersion.
iaas_create_machine_snapshotC
Create snapshot operation for machine Second day create snapshot operation for machine POST /iaas/api/machines/{id}/operations/snapshots
Inputs: id (required), body (required), apiVersion.
iaas_create_networkB
Create network Provision a new network based on the passed in constraints. The network should be destroyed after the machine is destroyed to free up resources. POST /iaas/api/networks
Inputs: body (required), apiVersion.
iaas_create_network_profileC
Create network profile POST /iaas/api/network-profiles
Inputs: body (required), apiVersion.
iaas_create_nsx_t_cloud_account_asyncC
Create a NSX Manager cloud account Create a NSX Manager cloud account in the current organization POST /iaas/api/cloud-accounts-nsx-t
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_on_demand_security_groupC
Create on-demand security group Provision a new on-demand security group POST /iaas/api/security-groups
Inputs: body (required), apiVersion.
iaas_create_projectC
Create project POST /iaas/api/projects
Inputs: body (required), apiVersion, validatePrincipals.
iaas_create_storage_profileC
Create storage profile POST /iaas/api/storage-profiles
Inputs: body (required), apiVersion.
iaas_create_tagC
Create Tag Create a new tag POST /iaas/api/tags
Inputs: body (required), apiVersion.
iaas_create_vcf_cloud_account_asyncC
Create a cloud account Create a cloud account in the current organization POST /iaas/api/cloud-accounts-vcf
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_vmc_cloud_account_asyncC
Create a cloud account Create a cloud account in the current organization POST /iaas/api/cloud-accounts-vmc
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_vsphere_cloud_account_asyncC
Create a cloud account Create a cloud account in the current organization POST /iaas/api/cloud-accounts-vsphere
Inputs: body (required), apiVersion (required), validateOnly.
iaas_create_vsphere_storage_profileC
Create vSphere storage class POST /iaas/api/storage-profiles-vsphere
Inputs: body (required), apiVersion.
iaas_create_zoneC
Create zone POST /iaas/api/zones
Inputs: body (required), apiVersion.
iaas_delete_avi_lb_account_asyncCDestructiveIdempotent
Delete an AVI Load Balancer cloud account Delete an AVI Load Balancer cloud account with a given id DELETE /iaas/api/cloud-accounts-avilb/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_aws_cloud_accountCDestructiveIdempotent
Delete an AWS cloud account Delete an AWS cloud account with a given id DELETE /iaas/api/cloud-accounts-aws/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_aws_storage_profileADestructiveIdempotent
Delete AWS storage class Delete AWS storage class with a given id DELETE /iaas/api/storage-profiles-aws/{id}
Inputs: id (required), apiVersion.
iaas_delete_azure_cloud_accountCDestructiveIdempotent
Delete an Azure Cloud Account Delete an Azure Cloud Account with a given id DELETE /iaas/api/cloud-accounts-azure/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_azure_storage_profileCDestructiveIdempotent
Delete Azure storage class Delete Azure storage class with a given id DELETE /iaas/api/storage-profiles-azure/{id}
Inputs: id (required), apiVersion.
iaas_delete_block_deviceADestructiveIdempotent
Delete a BlockDevice Delete a BlockDevice 1. A block device cannot be deleted when attached to a machine. 2. A block device with persistent property set to 'false' is deleted. 3. A block device with persistent property set to 'true' needs an additional parameter 'purge' to be set to true, for deletion. DELETE /iaas/api/block-devices/{id}
Inputs: id (required), purge, apiVersion, forceDelete.
iaas_delete_block_device_snapshotCDestructiveIdempotent
Delete snapshot operation for Block device Second day delete snapshot operation for Block device DELETE /iaas/api/block-devices/{id}/snapshots/{id1}
Inputs: id (required), id1 (required), apiVersion.
iaas_delete_cloud_accountCDestructiveIdempotent
Delete a cloud account Delete a cloud account with a given id DELETE /iaas/api/cloud-accounts/{id}
Inputs: id (required), apiVersion (required), forceDelete.
iaas_delete_cloud_account_nsx_tCDestructiveIdempotent
Delete a NSX Manager cloud account Delete a NSX Manager cloud account with a given id DELETE /iaas/api/cloud-accounts-nsx-t/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_compute_gatewayCDestructiveIdempotent
Delete a compute gateway Delete compute gateway with a given id DELETE /iaas/api/compute-gateways/{id}
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_compute_natCDestructiveIdempotent
Delete a compute nat Delete compute nat with a given id DELETE /iaas/api/compute-nats/{id}
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_configuration_propertyCDestructiveIdempotent
Delete a configuration property DELETE /iaas/api/configuration-properties/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_customnameCDestructiveIdempotent
Delete custom name Delete custom name with a given id DELETE /iaas/api/naming/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_data_collectorADestructiveIdempotent
Delete Data Collector Delete Data Collector with a given id. Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release. DELETE /iaas/api/data-collectors/{id}
Inputs: id (required), apiVersion.
iaas_delete_deploymentCDestructiveIdempotent
Delete a deployment Delete a deployment. DELETE /iaas/api/deployments/{id}
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_flavor_profileCDestructiveIdempotent
Delete flavor profile Delete flavor profile with a given id DELETE /iaas/api/flavor-profiles/{id}
Inputs: id (required), apiVersion.
iaas_delete_gcp_cloud_accountCDestructiveIdempotent
Delete an GCP cloud account Delete an GCP cloud account with a given id DELETE /iaas/api/cloud-accounts-gcp/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_gcp_storage_profileCDestructiveIdempotent
Delete GCP storage profile Delete GCP storage profile with a given id DELETE /iaas/api/storage-profiles-gcp/{id}
Inputs: id (required), apiVersion.
iaas_delete_image_profileCDestructiveIdempotent
Delete image profile Delete image profile with a given id DELETE /iaas/api/image-profiles/{id}
Inputs: id (required), apiVersion.
iaas_delete_integrationBDestructiveIdempotent
Delete an integration Delete an integration with a given id asynchronously DELETE /iaas/api/integrations/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_internal_network_ip_rangeCDestructiveIdempotent
Delete internal network IP range Delete internal network IP range with a given id DELETE /iaas/api/network-ip-ranges/{id}
Inputs: id (required), apiVersion.
iaas_delete_load_balancerCDestructiveIdempotent
Delete load balancer Delete load balancer with a given id DELETE /iaas/api/load-balancers/{id}
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_load_balancer_operationC
Delete operation for load balancer Second day delete operation for load balancer POST /iaas/api/load-balancers/{id}/operations/delete
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_machineCDestructiveIdempotent
Delete Machine Delete Machine with a given id DELETE /iaas/api/machines/{id}
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_machine_diskCDestructiveIdempotent
Delete machine disk Remove a disk from a given machine. DELETE /iaas/api/machines/{id}/disks/{diskId}
Inputs: id (required), diskId (required), apiVersion.
iaas_delete_machine_snapshotCDestructiveIdempotent
Delete snapshot operation for machine Second day delete snapshot operation for machine DELETE /iaas/api/machines/{id}/snapshots/{snapshotId}
Inputs: id (required), snapshotId (required), apiVersion.
iaas_delete_networkCDestructiveIdempotent
Delete a network Delete a network with a given id DELETE /iaas/api/networks/{id}
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_network_profileCDestructiveIdempotent
Delete network profile Delete network profile with a given id DELETE /iaas/api/network-profiles/{id}
Inputs: id (required), apiVersion.
iaas_delete_projectCDestructiveIdempotent
Delete project Delete project with a given id DELETE /iaas/api/projects/{id}
Inputs: id (required), apiVersion.
iaas_delete_requestCDestructiveIdempotent
Delete Request Delete a single Request DELETE /iaas/api/request-tracker/{id}
Inputs: id (required), apiVersion.
iaas_delete_security_groupCDestructiveIdempotent
Delete an on-demand security group Delete an on-demand security group with a given id DELETE /iaas/api/security-groups/{id}
Inputs: id (required), apiVersion, forceDelete.
iaas_delete_storage_profileCDestructiveIdempotent
Delete storage class Delete storage profile with a given id DELETE /iaas/api/storage-profiles/{id}
Inputs: id (required), apiVersion.
iaas_delete_tagCDestructiveIdempotent
Delete Tag Delete a tag by ID DELETE /iaas/api/tags/{id}
Inputs: id (required), apiVersion, ignoreUsage.
iaas_delete_vcf_cloud_accountCDestructiveIdempotent
Delete an VCF cloud account Delete an VCF cloud account with a given id DELETE /iaas/api/cloud-accounts-vcf/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_vmc_cloud_accountBDestructiveIdempotent
Delete an VMC cloud account Delete an VMC cloud account with a given id DELETE /iaas/api/cloud-accounts-vmc/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_vsphere_cloud_accountCDestructiveIdempotent
Delete a vSphere cloud account Delete a vSphere Cloud Account with a given id DELETE /iaas/api/cloud-accounts-vsphere/{id}
Inputs: id (required), apiVersion (required).
iaas_delete_vsphere_storage_profileCDestructiveIdempotent
Delete vSphere storage profile Delete vSphere storage profile with a given id DELETE /iaas/api/storage-profiles-vsphere/{id}
Inputs: id (required), apiVersion.
iaas_delete_zoneBDestructiveIdempotent
Delete a zone DELETE /iaas/api/zones/{id}
Inputs: id (required), apiVersion.
iaas_enumerate_aws_regions_asyncB
Get the available regions for specified AWS cloud account POST /iaas/api/cloud-accounts-aws/region-enumeration
Inputs: body (required), apiVersion (required).
iaas_enumerate_azure_regions_asyncB
Get the available regions for specified Azure cloud account POST /iaas/api/cloud-accounts-azure/region-enumeration
Inputs: body (required), apiVersion (required).
iaas_enumerate_gcp_regions_asyncC
Get the available regions for specified GCP cloud account POST /iaas/api/cloud-accounts-gcp/region-enumeration
Inputs: body (required), apiVersion (required).
iaas_enumerate_private_imagesC
Enumerate all private images for enabled regions of the specified cloud account POST /iaas/api/cloud-accounts/{id}/private-image-enumeration
Inputs: id (required), apiVersion.
iaas_enumerate_private_images_awsC
Enumerate all private images for enabled regions of the specified AWS account POST /iaas/api/cloud-accounts-aws/{id}/private-image-enumeration
Inputs: id (required), apiVersion.
iaas_enumerate_private_images_azureB
Enumerate all private images for enabled regions of the specified Azure account POST /iaas/api/cloud-accounts-azure/{id}/private-image-enumeration
Inputs: id (required), apiVersion.
iaas_enumerate_private_images_gcpC
Enumerate all private images for enabled regions of the specified GCP account POST /iaas/api/cloud-accounts-gcp/{id}/private-image-enumeration
Inputs: id (required), apiVersion.
iaas_enumerate_private_images_vcfB
Enumerate all private images for enabled regions of the specified VCF account POST /iaas/api/cloud-accounts-vcf/{id}/private-image-enumeration
Inputs: id (required), apiVersion.
iaas_enumerate_private_images_vmcB
Enumerate all private images for enabled regions of the specified VMC account POST /iaas/api/cloud-accounts-vmc/{id}/private-image-enumeration
Inputs: id (required), apiVersion.
iaas_enumerate_private_images_vsphereC
Enumerate all private images for enabled regions of the specified vSphere account POST /iaas/api/cloud-accounts-vsphere/{id}/private-image-enumeration
Inputs: id (required), apiVersion.
iaas_enumerate_regions_asyncC
Get the available regions for specified cloud account POST /iaas/api/cloud-accounts/region-enumeration
Inputs: body (required), apiVersion (required).
iaas_enumerate_vcf_regions_asyncC
Get the available regions for specified VCF cloud account POST /iaas/api/cloud-accounts-vcf/region-enumeration
Inputs: body (required), apiVersion (required).
iaas_enumerate_vmc_regions_asyncC
Get the available regions for specified VMC cloud account POST /iaas/api/cloud-accounts-vmc/region-enumeration
Inputs: body (required), apiVersion (required).
iaas_enumerate_vsphere_regions_asyncC
Get the available regions for specified vSphere cloud account POST /iaas/api/cloud-accounts-vsphere/region-enumeration
Inputs: body (required), apiVersion (required).
iaas_get_aboutCRead-onlyIdempotent
Get about page
The page contains information about the supported API versions and the latest API version. The version parameter is mandatory for endpoints introduced after version 2019-01-15and optional for the rest though highly recommended. If you do not specify explicitly an exact version, you will be calling the latest supported General Availability API version. Here is an example of a call which specifies the exact version you are using: GET /iaas/api/network-profiles?apiVersion=2021-07-15 Note that this version is deprecated: 2019-01-15.
GET /iaas/api/about
Inputs: no named parameters.
iaas_get_all_custom_namesCRead-onlyIdempotent
Get All Custom Names GET /iaas/api/naming
Inputs: apiVersion (required).
iaas_get_allocated_and_released_ip_addressesCRead-onlyIdempotent
Get all allocated and released addresses of an IPAM network IP range GET /iaas/api/network-ip-ranges/{id}/ip-addresses
Inputs: id (required), apiVersion (required).
iaas_get_allocated_or_released_ip_addressBRead-onlyIdempotent
Get an allocated or released address of an IPAM network IP range GET /iaas/api/network-ip-ranges/{networkIPRangeId}/ip-addresses/{ipAddressId}
Inputs: apiVersion (required), ipAddressId (required), networkIPRangeId (required).
iaas_get_avi_lb_cloud_accountBRead-onlyIdempotent
Get an AVI Load Balancer cloud account Get an AVI Load Balancer with a given id GET /iaas/api/cloud-accounts-avilb/{id}
Inputs: id (required), apiVersion.
iaas_get_avi_lb_cloud_accountsBRead-onlyIdempotent
Get AVI Load Balancer cloud accounts Get all AVI Load Balancer cloud accounts within the current organization GET /iaas/api/cloud-accounts-avilb
Inputs: top, skip, apiVersion.
iaas_get_aws_cloud_accountCRead-onlyIdempotent
Get an AWS cloud account Get an AWS cloud account with a given id GET /iaas/api/cloud-accounts-aws/{id}
Inputs: id (required), apiVersion.
iaas_get_aws_cloud_accountsBRead-onlyIdempotent
Get AWS cloud accounts Get all AWS cloud accounts within the current organization GET /iaas/api/cloud-accounts-aws
Inputs: top, skip, apiVersion.
iaas_get_aws_storage_profileBRead-onlyIdempotent
Get AWS storage class Get AWS storage class with a given id GET /iaas/api/storage-profiles-aws/{id}
Inputs: id (required), apiVersion.
iaas_get_aws_storage_profilesBRead-onlyIdempotent
Get AWS storage classes Get all AWS storage classes GET /iaas/api/storage-profiles-aws
Inputs: apiVersion.
iaas_get_azure_cloud_accountCRead-onlyIdempotent
Get an Azure Cloud Account Get an Azure Cloud Account with a given id GET /iaas/api/cloud-accounts-azure/{id}
Inputs: id (required), apiVersion.
iaas_get_azure_cloud_accountsBRead-onlyIdempotent
Get Azure cloud accounts Get all Azure cloud accounts within the current organization GET /iaas/api/cloud-accounts-azure
Inputs: top, skip, apiVersion.
iaas_get_azure_disk_encryption_setsCRead-onlyIdempotent
Get Azure disk encryption sets Get all Azure disk encryption sets GET /iaas/api/fabric-azure-disk-encryption-sets
Inputs: regionId (required), apiVersion.
iaas_get_azure_storage_profileCRead-onlyIdempotent
Get Azure storage class Get Azure storage class with a given id GET /iaas/api/storage-profiles-azure/{id}
Inputs: id (required), apiVersion.
iaas_get_azure_storage_profilesCRead-onlyIdempotent
Get Azure storage classes Get all Azure storage classes GET /iaas/api/storage-profiles-azure
Inputs: apiVersion.
iaas_get_block_deviceCRead-onlyIdempotent
Get BlockDevice Get a single BlockDevice GET /iaas/api/block-devices/{id}
Inputs: id (required), apiVersion.
iaas_get_block_devicesCRead-onlyIdempotent
Get BlockDevices Get all BlockDevices GET /iaas/api/block-devices
Inputs: top, skip, count, filter, +1 more.
iaas_get_certificate_infoCRead-onlyIdempotent
Get certificate info GET /iaas/api/certificates/{id}
Inputs: id (required), apiVersion (required).
iaas_get_cloud_accountBRead-onlyIdempotent
Get cloud account Get cloud account with a given id GET /iaas/api/cloud-accounts/{id}
Inputs: id (required), select, apiVersion.
iaas_get_cloud_accountsBRead-onlyIdempotent
Get cloud accounts Get all cloud accounts within the current organization GET /iaas/api/cloud-accounts
Inputs: top, skip, count, filter, +2 more.
iaas_get_compute_gatewayBRead-onlyIdempotent
Get a compute gateway Get compute gateway with a given id GET /iaas/api/compute-gateways/{id}
Inputs: id (required), apiVersion.
iaas_get_compute_gatewaysCRead-onlyIdempotent
Get compute gateways Get all compute gateways GET /iaas/api/compute-gateways
Inputs: apiVersion.
iaas_get_compute_natBRead-onlyIdempotent
Get a Compute Nat Get Compute Nat with a given id GET /iaas/api/compute-nats/{id}
Inputs: id (required), apiVersion.
iaas_get_compute_natsCRead-onlyIdempotent
Get Compute Nats Get all Compute Nats GET /iaas/api/compute-nats
Inputs: apiVersion.
iaas_get_computesARead-onlyIdempotent
Get computes Get zone's computes by given zone ID GET /iaas/api/zones/{id}/computes
Inputs: id (required), apiVersion.
iaas_get_configuration_propertiesCRead-onlyIdempotent
Get configuration properties Get all configuration properties GET /iaas/api/configuration-properties
Inputs: apiVersion (required).
iaas_get_configuration_propertyCRead-onlyIdempotent
Get single configuration property GET /iaas/api/configuration-properties/{id}
Inputs: id (required), apiVersion (required).
iaas_get_custom_nameCRead-onlyIdempotent
Get Custom Name by Id GET /iaas/api/naming/{id}
Inputs: id (required), apiVersion (required).
iaas_get_custom_name_by_project_idCRead-onlyIdempotent
Get Custom Names For Project Id GET /iaas/api/naming/projectId/{id}
Inputs: id (required), apiVersion (required).
iaas_get_data_collectorBRead-onlyIdempotent
Get Data Collector Get Data Collector with a given id. Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release. GET /iaas/api/data-collectors/{id}
Inputs: id (required), apiVersion.
iaas_get_data_collectorsARead-onlyIdempotent
Get Data Collectors Get all Data Collectors. Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release. GET /iaas/api/data-collectors
Inputs: disabled, apiVersion.
iaas_get_deploymentsCRead-onlyIdempotent
Get Deployments Get all deployments. GET /iaas/api/deployments
Inputs: top, skip, count, filter, +1 more.
iaas_get_disk_snapshotCRead-onlyIdempotent
Get disk snapshot Get snapshot with a given id for specific disk GET /iaas/api/block-devices/{id}/snapshots/{id1}
Inputs: id (required), id1 (required), apiVersion.
iaas_get_disk_snapshotsCRead-onlyIdempotent
Get disk snapshots information GET /iaas/api/block-devices/{id}/snapshots
Inputs: id (required), apiVersion.
iaas_get_event_logsCRead-onlyIdempotent
Get Event Logs Get all Event logs GET /iaas/api/event-logs
Inputs: top, skip, count, filter, +4 more.
iaas_get_external_ip_blockARead-onlyIdempotent
Get specific external IP block by id An external IP block is network coming from external IPAM provider that can be used to create subnetworks inside it GET /iaas/api/external-ip-blocks/{id}
Inputs: id (required), apiVersion.
iaas_get_external_ip_blocksBRead-onlyIdempotent
Get all external IP blocks An external IP block is network coming from external IPAM provider that can be used to create subnetworks inside it GET /iaas/api/external-ip-blocks
Inputs: apiVersion.
iaas_get_external_network_ip_rangeCRead-onlyIdempotent
Get external IPAM network IP range Get external IPAM network IP range with a given id GET /iaas/api/external-network-ip-ranges/{id}
Inputs: id (required), apiVersion.
iaas_get_external_network_ip_rangesCRead-onlyIdempotent
Get external IPAM network IP ranges Get all external IPAM network IP ranges GET /iaas/api/external-network-ip-ranges
Inputs: apiVersion.
iaas_get_fabric_aws_volume_typesBRead-onlyIdempotent
Get fabric AWS volume types Get all fabric AWS volume types. GET /iaas/api/fabric-aws-volume-types
Inputs: apiVersion.
iaas_get_fabric_azure_storage_accountBRead-onlyIdempotent
Get fabric Azure storage account Get fabric Azure storage account with a given id GET /iaas/api/fabric-azure-storage-accounts/{id}
Inputs: id (required), select, apiVersion.
iaas_get_fabric_azure_storage_accountsCRead-onlyIdempotent
Get fabric Azure storage accounts Get all fabric Azure storage accounts. GET /iaas/api/fabric-azure-storage-accounts
Inputs: top, skip, count, filter, +2 more.
iaas_get_fabric_computeCRead-onlyIdempotent
Get fabric compute Get fabric compute with a given id GET /iaas/api/fabric-computes/{id}
Inputs: id (required), apiVersion.
iaas_get_fabric_computesCRead-onlyIdempotent
Get fabric computes Get all fabric computes. GET /iaas/api/fabric-computes
Inputs: top, skip, count, filter, +1 more.
iaas_get_fabric_flavorsCRead-onlyIdempotent
Get fabric flavors Get all fabric flavors GET /iaas/api/fabric-flavors
Inputs: apiVersion, includeCores.
iaas_get_fabric_imageARead-onlyIdempotent
Get fabric image Get enumerated fabric image with a given id. Fabric images are enumerated images from a specific region, which could be used in image mappings. GET /iaas/api/fabric-images/{id}
Inputs: id (required), select, apiVersion.
iaas_get_fabric_imagesBRead-onlyIdempotent
Get allfabric images. Fabric images are enumerated images from a specific region, which could be used in image mappings. Get all enumerated fabric images GET /iaas/api/fabric-images
Inputs: top, skip, count, filter, +2 more.
iaas_get_fabric_networkBRead-onlyIdempotent
Get fabric network Get fabric network with a given id GET /iaas/api/fabric-networks/{id}
Inputs: id (required), select, apiVersion.
iaas_get_fabric_network_ip_rangesCRead-onlyIdempotent
Get associated fabric network IP ranges for a fabric network Get associated fabric network IP ranges for a fabric network with a given id GET /iaas/api/fabric-networks/{id}/network-ip-ranges
Inputs: id (required), top, skip, apiVersion.
iaas_get_fabric_networksCRead-onlyIdempotent
Get fabric networks Get all fabric networks. GET /iaas/api/fabric-networks
Inputs: top, skip, count, filter, +2 more.
iaas_get_fabric_network_vsphere_ip_rangesCRead-onlyIdempotent
Get associated fabric network IP ranges for a fabric vSphere network Get associated fabric network IP ranges for a fabric vSphere network with a given id GET /iaas/api/fabric-networks-vsphere/{id}/network-ip-ranges
Inputs: id (required), top, skip, apiVersion.
iaas_get_fabric_vsphere_datastoreCRead-onlyIdempotent
Get fabric vSphere datastore Get fabric vSphere datastore with a given id GET /iaas/api/fabric-vsphere-datastores/{id}
Inputs: id (required), select, apiVersion.
iaas_get_fabric_vsphere_datastoresCRead-onlyIdempotent
Get fabric vSphere datastores Get all fabric vSphere datastores. GET /iaas/api/fabric-vsphere-datastores
Inputs: top, skip, count, filter, +2 more.
iaas_get_fabric_vsphere_storage_policiesCRead-onlyIdempotent
Get fabric vSphere storage polices Get all fabric vSphere storage polices. GET /iaas/api/fabric-vsphere-storage-policies
Inputs: top, skip, count, filter, +2 more.
iaas_get_fabric_vsphere_storage_policyCRead-onlyIdempotent
Get fabric vSphere storage policy Get fabric vSphere storage policy with a given id GET /iaas/api/fabric-vsphere-storage-policies/{id}
Inputs: id (required), select, apiVersion.
iaas_get_flavor_profileCRead-onlyIdempotent
Get flavor profile Get flavor profile with a given id GET /iaas/api/flavor-profiles/{id}
Inputs: id (required), apiVersion, includeCores.
iaas_get_flavor_profilesCRead-onlyIdempotent
Get flavor profile Get all flavor profile GET /iaas/api/flavor-profiles
Inputs: apiVersion, includeCores.
iaas_get_flavorsCRead-onlyIdempotent
Get flavors Get all flavors defined in FlavorProfile GET /iaas/api/flavors
Inputs: apiVersion, includeCores.
iaas_get_foldersBRead-onlyIdempotent
Get folders Get all folders within the current organization GET /iaas/api/folders
Inputs: apiVersion (required), top, skip, count, +4 more.
iaas_get_gcp_cloud_accountCRead-onlyIdempotent
Get an GCP cloud account Get an GCP cloud account with a given id GET /iaas/api/cloud-accounts-gcp/{id}
Inputs: id (required), apiVersion.
iaas_get_gcp_cloud_accountsBRead-onlyIdempotent
Get GCP cloud accounts Get all GCP cloud accounts within the current organization GET /iaas/api/cloud-accounts-gcp
Inputs: top, skip, apiVersion.
iaas_get_gcp_storage_profileCRead-onlyIdempotent
Get GCP storage class Get GCP storage class with a given id GET /iaas/api/storage-profiles-gcp/{id}
Inputs: id (required), apiVersion.
iaas_get_gcp_storage_profilesCRead-onlyIdempotent
Get GCP storage classes Get all GCP storage classes GET /iaas/api/storage-profiles-gcp
Inputs: apiVersion.
iaas_get_image_profileCRead-onlyIdempotent
Get image profile Get image profile with a given id GET /iaas/api/image-profiles/{id}
Inputs: id (required), apiVersion.
iaas_get_image_profilesCRead-onlyIdempotent
Get image profile Get all image profiles GET /iaas/api/image-profiles
Inputs: apiVersion.
iaas_get_imagesARead-onlyIdempotent
Get images Get all images defined in ImageProfile. To get all enumerated images use Fabric Image endpoint. GET /iaas/api/images
Inputs: apiVersion.
iaas_get_integrationCRead-onlyIdempotent
Get an integration Get an integration with a given id GET /iaas/api/integrations/{id}
Inputs: id (required), apiVersion (required), select.
iaas_get_integrationsCRead-onlyIdempotent
Get integrations Get all integrations within the current organization GET /iaas/api/integrations
Inputs: apiVersion (required), top, skip, count, +2 more.
iaas_get_internal_network_ip_rangeBRead-onlyIdempotent
Get internal IPAM network IP range Get internal IPAM network IP range with a given id GET /iaas/api/network-ip-ranges/{id}
Inputs: id (required), apiVersion.
iaas_get_internal_network_ip_rangesCRead-onlyIdempotent
Get internal IPAM network IP ranges Get all internal IPAM network IP ranges GET /iaas/api/network-ip-ranges
Inputs: apiVersion.
iaas_get_load_balancerCRead-onlyIdempotent
Get load balancer Get load balancer with a given id GET /iaas/api/load-balancers/{id}
Inputs: id (required), apiVersion.
iaas_get_load_balancer_network_interfaceCRead-onlyIdempotent
Get load balancer network interface Get network interface with a given id for specific load balancer GET /iaas/api/load-balancers/{id}/network-interfaces/{id1}
Inputs: id (required), id1 (required), apiVersion.
iaas_get_load_balancersCRead-onlyIdempotent
Get load balancers Get all load balancers GET /iaas/api/load-balancers
Inputs: apiVersion.
iaas_get_machineCRead-onlyIdempotent
Get machine Get machine with a given id GET /iaas/api/machines/{id}
Inputs: id (required), select, apiVersion.
iaas_get_machine_diskBRead-onlyIdempotent
Get machine disk Get disk with a given id for specific machine GET /iaas/api/machines/{id}/disks/{diskId}
Inputs: id (required), diskId (required), apiVersion.
iaas_get_machine_disksCRead-onlyIdempotent
Get machine disks Get all machine disks GET /iaas/api/machines/{id}/disks
Inputs: id (required), apiVersion.
iaas_get_machine_network_interfaceCRead-onlyIdempotent
Get machine network interface Get network interface with a given id for specific machine GET /iaas/api/machines/{id}/network-interfaces/{networkId}
Inputs: id (required), networkId (required), apiVersion.
iaas_get_machinesCRead-onlyIdempotent
Get machines Get all machines GET /iaas/api/machines
Inputs: top, skip, count, filter, +3 more.
iaas_get_machine_snapshotARead-onlyIdempotent
Get machine snapshot Get snapshot with a given id for specific machine GET /iaas/api/machines/{id}/snapshots/{snapshotId}
Inputs: id (required), snapshotId (required), apiVersion.
iaas_get_machine_snapshotsCRead-onlyIdempotent
Get machine snapshots information GET /iaas/api/machines/{id}/snapshots
Inputs: id (required), apiVersion.
iaas_get_networkCRead-onlyIdempotent
Get network Get network with a given id GET /iaas/api/networks/{id}
Inputs: id (required), apiVersion.
iaas_get_network_domainCRead-onlyIdempotent
Get network domain Get network domain with a given id GET /iaas/api/network-domains/{id}
Inputs: id (required), apiVersion.
iaas_get_network_domainsCRead-onlyIdempotent
Get network domains Get all network domains. GET /iaas/api/network-domains
Inputs: apiVersion.
iaas_get_network_ip_ranges_resultCRead-onlyIdempotent
Get associated network IP ranges for a network Get associated network IP ranges for a network with a given id GET /iaas/api/networks/{id}/network-ip-ranges
Inputs: id (required), top, skip, apiVersion.
iaas_get_network_profileCRead-onlyIdempotent
Get network profile Get network profile with a given id GET /iaas/api/network-profiles/{id}
Inputs: id (required), apiVersion.
iaas_get_network_profilesCRead-onlyIdempotent
Get network profiles Get all network profiles GET /iaas/api/network-profiles
Inputs: top, skip, count, filter, +2 more.
iaas_get_networksCRead-onlyIdempotent
Get networks Get all networks GET /iaas/api/networks
Inputs: apiVersion.
iaas_get_nsx_t_cloud_accountBRead-onlyIdempotent
Get an NSX Manager cloud account Get an NSX Manager cloud account with a given id GET /iaas/api/cloud-accounts-nsx-t/{id}
Inputs: id (required), apiVersion.
iaas_get_nsx_t_cloud_accountsARead-onlyIdempotent
Get NSX Manager cloud accounts Get all NSX Manager cloud accounts within the current organization GET /iaas/api/cloud-accounts-nsx-t
Inputs: top, skip, apiVersion.
iaas_get_projectBRead-onlyIdempotent
Get project Get project with a given id GET /iaas/api/projects/{id}
Inputs: id (required), apiVersion.
iaas_get_project_resource_metadataCRead-onlyIdempotent
Get project resource metadata Get project resource metadata by a given project id GET /iaas/api/projects/{id}/resource-metadata
Inputs: id (required), apiVersion.
iaas_get_projectsCRead-onlyIdempotent
Get projects Get all projects GET /iaas/api/projects
Inputs: top, skip, count, filter, +2 more.
iaas_get_projects_by_id_zonesARead-onlyIdempotent
Get project zone assignments Get all zones assigned to a project by pages GET /iaas/api/projects/{id}/zones
Inputs: id (required), top, skip, count, +2 more.
iaas_get_regionCRead-onlyIdempotent
Get Region Get Region with a given id GET /iaas/api/regions/{id}
Inputs: id (required), apiVersion.
iaas_get_region_enumeration_resultCRead-onlyIdempotent
Get region enumeration response Get region enumeration response for a given id GET /iaas/api/cloud-accounts/region-enumeration/{id}
Inputs: id (required), apiVersion (required).
iaas_get_regionsCRead-onlyIdempotent
Get regions Get all regions GET /iaas/api/regions
Inputs: top, skip, apiVersion.
iaas_get_request_graphCRead-onlyIdempotent
Get Request Graph For Provisioning Request GET /iaas/api/request-graph
Inputs: flowId (required), deploymentId (required), apiVersion.
iaas_get_request_trackerCRead-onlyIdempotent
Get request tracker Get request tracker with a given id GET /iaas/api/request-tracker/{id}
Inputs: id (required), apiVersion.
iaas_get_request_trackersCRead-onlyIdempotent
Get request tracker Get all request trackers GET /iaas/api/request-tracker
Inputs: apiVersion.
iaas_get_security_groupBRead-onlyIdempotent
Get security group Get security group with a given id GET /iaas/api/security-groups/{id}
Inputs: id (required), apiVersion.
iaas_get_security_groupsCRead-onlyIdempotent
Get security groups Get all security groups GET /iaas/api/security-groups
Inputs: apiVersion.
iaas_get_single_deploymentCRead-onlyIdempotent
Get a single deployment Get a single deployment. GET /iaas/api/deployments/{id}
Inputs: id (required), apiVersion.
iaas_get_storage_profileCRead-onlyIdempotent
Get storage class Get storage class with a given id GET /iaas/api/storage-profiles/{id}
Inputs: id (required), apiVersion.
iaas_get_storage_profile_associationsBRead-onlyIdempotent
Get storage profile Associations Get all storage profile Associations with a given storage profile id GET /iaas/api/storage-profiles/{id}/storage-profile-associations
Inputs: id (required), page, size, apiVersion.
iaas_get_storage_profilesCRead-onlyIdempotent
Get storage classes Get all storage classes GET /iaas/api/storage-profiles
Inputs: apiVersion.
iaas_get_tagsCRead-onlyIdempotent
Get tags Get all tags GET /iaas/api/tags
Inputs: top, skip, count, filter, +2 more.
iaas_get_tags_usageC
Get usage of the tags Get documents of all resources that are assigned with the provided tags POST /iaas/api/tags/tags-usage
Inputs: body (required), apiVersion.
iaas_get_vcf_cloud_accountCRead-onlyIdempotent
Get an VCF cloud account Get an VCF cloud account with a given id GET /iaas/api/cloud-accounts-vcf/{id}
Inputs: id (required), apiVersion.
iaas_get_vcf_cloud_accountsBRead-onlyIdempotent
Get VCF cloud accounts Get all VCF cloud accounts within the current organization GET /iaas/api/cloud-accounts-vcf
Inputs: top, skip, apiVersion.
iaas_get_vmc_cloud_accountCRead-onlyIdempotent
Get an VMC cloud account Get an VMC cloud account with a given id GET /iaas/api/cloud-accounts-vmc/{id}
Inputs: id (required), apiVersion.
iaas_get_vmc_cloud_accountsBRead-onlyIdempotent
Get VMC cloud accounts Get all VMC cloud accounts within the current organization GET /iaas/api/cloud-accounts-vmc
Inputs: top, skip, apiVersion.
iaas_get_vsphere_cloud_accountCRead-onlyIdempotent
Get an vSphere cloud account Get an vSphere cloud account with a given id GET /iaas/api/cloud-accounts-vsphere/{id}
Inputs: id (required), apiVersion.
iaas_get_vsphere_cloud_accountsBRead-onlyIdempotent
Get vSphere cloud accounts Get all vSphere cloud accounts within the current organization GET /iaas/api/cloud-accounts-vsphere
Inputs: top, skip, apiVersion.
iaas_get_vsphere_fabric_networkCRead-onlyIdempotent
Get vSphere fabric network Get vSphere fabric network with a given id GET /iaas/api/fabric-networks-vsphere/{id}
Inputs: id (required), select, apiVersion.
iaas_get_vsphere_fabric_networksCRead-onlyIdempotent
Get vSphere fabric networks Get all vSphere fabric networks. GET /iaas/api/fabric-networks-vsphere
Inputs: top, skip, count, filter, +2 more.
iaas_get_vsphere_storage_profileBRead-onlyIdempotent
Get vSphere storage class Get vSphere storage class with a given id GET /iaas/api/storage-profiles-vsphere/{id}
Inputs: id (required), apiVersion.
iaas_get_vsphere_storage_profilesCRead-onlyIdempotent
Get vSphere storage classes Get all vSphere storage classes GET /iaas/api/storage-profiles-vsphere
Inputs: apiVersion.
iaas_get_zoneCRead-onlyIdempotent
Get zone Get zone with given id GET /iaas/api/zones/{id}
Inputs: id (required), apiVersion.
iaas_get_zonesCRead-onlyIdempotent
Get zones Get all zones GET /iaas/api/zones
Inputs: top, skip, apiVersion.
iaas_import_packageB
Import package Import IPAM package on chunks of specified size. This API implements the TUS RFC: https://github.com/tus/tus-resumable-upload-protocol/blob/main/protocol.md PATCH /iaas/api/integrations-ipam/package-import/{id}
Inputs: id (required), Tus-Resumable (required), Upload-Offset (required), body, +1 more.
iaas_import_package_http_method_overrideB
Import package Import IPAM package on chunks of specified size with additional http method override. This API implements the TUS RFC: https://github.com/tus/tus-resumable-upload-protocol/blob/main/protocol.md#x-http-method-override POST /iaas/api/integrations-ipam/package-import/{id}
Inputs: id (required), Tus-Resumable (required), Upload-Offset (required), X-HTTP-Method-Override (required), +2 more.
iaas_patch_configuration_propertyB
Update or create configuration property. PATCH /iaas/api/configuration-properties
Inputs: body (required), apiVersion (required).
iaas_patch_machine_network_interfaceA
Patch machine network interface Patch network interface with a given id for specific machine. Only name, description, IPv4 address and custom property updates are supported. The change to name and IPv4 address will not propagate to cloud endpoint for provisioned machines. PATCH /iaas/api/machines/{id}/network-interfaces/{networkId}
Inputs: id (required), body (required), networkId (required), apiVersion (required).
iaas_power_off_machineC
Power-off operation for machine Second day power-off operation for machine POST /iaas/api/machines/{id}/operations/power-off
Inputs: id (required), apiVersion.
iaas_power_on_machineC
Power-on operation for machine Second day power-on operation for machine POST /iaas/api/machines/{id}/operations/power-on
Inputs: id (required), apiVersion.
iaas_promote_diskC
Promote operation on disk Second day promote operation on disk. Applicable for vSphere Block Devices only POST /iaas/api/block-devices/{id}/operations/promote
Inputs: id (required), apiVersion.
iaas_reboot_machineC
Reboot operation for machine Second day reboot operation for machine POST /iaas/api/machines/{id}/operations/reboot
Inputs: id (required), apiVersion.
iaas_reconfigure_natC
Reconfigure operation for nat Day-2 reconfigure operation for nat POST /iaas/api/compute-nats/{id}/operations/reconfigure
Inputs: id (required), body (required), apiVersion.
iaas_reconfigure_security_groupA
Reconfigure operation for security group Day-2 reconfigure operation for new security groups provisioned by VMware Aria Automation. This is not supported for 'existing' security groups POST /iaas/api/security-groups/{id}/operations/reconfigure
Inputs: id (required), body (required), apiVersion.
iaas_release_network_ips_by_userC
release network IPs by user. release network IPs by user POST /iaas/api/network-ip-ranges/{id}/ip-addresses/release
Inputs: id (required), body (required), apiVersion.
iaas_release_unregistered_network_ipsC
release unregistered network IPs POST /iaas/api/network-ip-ranges/{id}/unregistered-ip-addresses/release
Inputs: id (required), body (required), apiVersion.
iaas_replace_storage_profileCIdempotent
Replace storage profile Replace storage profile with a given id PUT /iaas/api/storage-profiles/{id}
Inputs: id (required), body (required), apiVersion.
iaas_reserve_packageA
Reserve package This operation has two purposes: 1. Make initial request for importing package. Location of the new package is returned as a response header if body is not provided. 2. Finalize the import when all batches are sent to the server if bundleIdis provided or make the complete import if compressedBundle is provided This API implements the TUS RFC: https://github.com/tus/tus-resumable-upload-protocol/blob/main/protocol.md POST /iaas/api/integrations-ipam/package-import
Inputs: Tus-Resumable (required), Upload-Length (required), body, apiVersion.
iaas_reset_machineC
Reset operation for machine Second day reset operation for machine POST /iaas/api/machines/{id}/operations/reset
Inputs: id (required), apiVersion.
iaas_resize_block_deviceC
Resize BlockDevice Resize operation on block device. POST /iaas/api/block-devices/{id}
Inputs: id (required), capacityInGB (required), useSdrs, apiVersion.
iaas_resize_machineC
Resize operation for machine Second day resize operation for machine POST /iaas/api/machines/{id}/operations/resize
Inputs: id (required), cpuCount, coreCount, apiVersion, +3 more.
iaas_restart_machineC
Restart operation for machine Second day restart operation for machine POST /iaas/api/machines/{id}/operations/restart
Inputs: id (required), apiVersion.
iaas_retrieve_auth_tokenA
Retrieve AuthToken for local csp users
Retrieve AuthToken for local csp users. When accessing other endpoints the Bearer authentication scheme and the received token must be provided in the Authorization request header field as follows: Authorization: Bearer {token}
POST /iaas/api/login
Inputs: body (required), apiVersion.
iaas_revert_disk_snapshotC
Revert snapshot operation for Block device Second day revert snapshot operation for Block device POST /iaas/api/block-devices/{diskId}/operations/revert
Inputs: id (required), diskId (required), apiVersion.
iaas_revert_machine_snapshotC
Revert snapshot operation for machine Second day revert snapshot operation for machine POST /iaas/api/machines/{id}/operations/revert/{snapshotId}
Inputs: id (required), apiVersion (required), snapshotId (required).
iaas_run_endpoint_health_checkC
Starts cloud account health check Starts cloud account health check identified by its endpoint state POST /iaas/api/cloud-accounts/{id}/health-check
Inputs: id (required), apiVersion, periodicHealthCheckId.
iaas_scale_load_balancerC
Scale operation for load balancer Second day scale operation for load balancer POST /iaas/api/load-balancers/{id}/operations/scale
Inputs: id (required), body (required), apiVersion.
iaas_shutdown_machineC
Shut down operation for machine Second day shut down operation machine POST /iaas/api/machines/{id}/operations/shutdown
Inputs: id (required), apiVersion.
iaas_suspend_machineC
Suspend operation for machine Second day suspend operation for machine POST /iaas/api/machines/{id}/operations/suspend
Inputs: id (required), apiVersion.
iaas_unregisterC
Unregister a vSphere provisioned machine POST /iaas/api/machines/{id}/operations/unregister
Inputs: id (required), apiVersion.
iaas_update_avi_lb_cloud_account_asyncB
Update AVI Load Balancer cloud account asynchronously PATCH /iaas/api/cloud-accounts-avilb/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_aws_cloud_account_asyncC
Update AWS cloud account PATCH /iaas/api/cloud-accounts-aws/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_aws_storage_profileC
Update AWS storage class PATCH /iaas/api/storage-profiles-aws/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_azure_cloud_account_asyncC
Update Azure cloud account PATCH /iaas/api/cloud-accounts-azure/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_azure_storage_profileC
Update Azure storage class PATCH /iaas/api/storage-profiles-azure/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_cloud_account_asyncC
Update CloudAccount Update a single CloudAccount PATCH /iaas/api/cloud-accounts/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_custom_nameCIdempotent
Update custom name PUT /iaas/api/naming
Inputs: body (required), apiVersion (required).
iaas_update_external_network_ip_rangeC
Update external IPAM network IP range. Assign the external IPAM network IP range to a different network and/or change the tags of the external IPAM network IP range. PATCH /iaas/api/external-network-ip-ranges/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_fabric_computeA
Update fabric compute. Update fabric compute. Only tag updates are supported. PATCH /iaas/api/fabric-computes/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_fabric_networkA
Update fabric network. Update fabric network. Only tag updates are supported. PATCH /iaas/api/fabric-networks/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_fabric_vsphere_datastoreB
Update Fabric vSphere Datastore. Update Fabric vSphere Datastore. Only tag updates are supported. PATCH /iaas/api/fabric-vsphere-datastores/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_flavor_profileC
Update flavor profile PATCH /iaas/api/flavor-profiles/{id}
Inputs: id (required), body (required), apiVersion, includeCores.
iaas_update_gcp_cloud_account_asyncC
Update GCP cloud account PATCH /iaas/api/cloud-accounts-gcp/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_gcp_storage_profileC
Update GCP storage profile PATCH /iaas/api/storage-profiles-gcp/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_image_profileA
Update image profile Update image profile. All existing image mapping definitions for the specified region will be replaced with the payload provided and if you want to keep the existing definitions, they should be added to the payload. PATCH /iaas/api/image-profiles/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_integration_asyncC
Update an integration Update a single integration asynchronously PATCH /iaas/api/integrations/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_internal_network_ip_rangeC
Update internal network IP range. PATCH /iaas/api/network-ip-ranges/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_machineA
Update machine. Update machine. Only description, tag, custom property and bootConfig updates are supported. Please note that all existing tags, assigned to this machine, that are not implicitly added in the Patch body, will be unassigned from this machine!All other properties in the MachineSpecification body are ignored. PATCH /iaas/api/machines/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_network_profileC
Update network profile PATCH /iaas/api/network-profiles/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_nsx_t_cloud_account_asyncC
Update NSX Manager cloud account PATCH /iaas/api/cloud-accounts-nsx-t/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_projectC
Update project PATCH /iaas/api/projects/{id}
Inputs: id (required), body (required), apiVersion, validatePrincipals.
iaas_update_project_resource_metadataC
Update project resource metadata Update project resource metadata by a given project id PATCH /iaas/api/projects/{id}/resource-metadata
Inputs: id (required), body (required), apiVersion.
iaas_update_project_zone_assignmentsBIdempotent
Update all zone assignments to a project Update all zone assignments to a project asynchronously PUT /iaas/api/projects/{id}/zones
Inputs: id (required), body (required), apiVersion.
iaas_update_security_groupB
Update security group. Update security group. Only tag updates are supported. PATCH /iaas/api/security-groups/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_storage_profile_associationsC
Update storage profile associations PATCH /iaas/api/storage-profiles/{id}/storage-profile-associations
Inputs: id (required), body (required), apiVersion.
iaas_update_vcf_cloud_account_asyncC
Update VCF cloud account PATCH /iaas/api/cloud-accounts-vcf/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_vmc_cloud_account_asyncC
Update VMC cloud account PATCH /iaas/api/cloud-accounts-vmc/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_update_vsphere_cloud_account_asyncC
Update vSphere cloud account PATCH /iaas/api/cloud-accounts-vsphere/{id}
Inputs: id (required), body (required), apiVersion (required).
iaas_updatevsphere_fabric_networkC
Update vSphere fabric network. PATCH /iaas/api/fabric-networks-vsphere/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_vsphere_storage_profileC
Update vSphere storage profile PATCH /iaas/api/storage-profiles-vsphere/{id}
Inputs: id (required), body (required), apiVersion.
iaas_update_zoneC
Update zone PATCH /iaas/api/zones/{id}
Inputs: id (required), body (required), apiVersion.
identity_check_id_tokenARead-onlyIdempotent
[DEPRECATED] Check ID Token This API has no analogue in Tenant Manager Display the content of the given ID token with expanded claims if the token is valid.If the token is invalid or expired, an error will be returned.This endpoint should be used to expand the overflow claims in the ID token, if any (like the 'group_names' and 'group_ids' claim).Even though this endpoint can also be used to validate an ID token, it is expected that the client validates an ID token locally instead. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ | GET /oauth/check_id_token
Inputs: no named parameters.
identity_get_access_token_infoARead-onlyIdempotent
[DEPRECATED] Display detailed user information compiled from the user access token and the associated ID token.
Use this API instead: * /scim/v2/Users The user information includes all user related fields (which are also part of the associated user ID token). Group ids and names are included.The API diverges from the CSP API on 1) 'email_verified' field which is currently not provided by this API and 2) the 'sub' field which contains user ID only in contrast with CSP thatcontains ':'. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
GET /csp/gateway/am/api/userinfo
Inputs: no named parameters.
identity_get_access_token_pkce_flowB
[DEPRECATED] Exchanges one of the following grants: authorization_code or refresh_token for access token.
Use this API instead: * /oidc/oauth2/token This end-point exchanges one of the following grants: authorization_code, refresh_token, client_credentials for an access token. 1. Include the parameters using application/x-www-form-urlencoded format in the HTTP request body. 2. Include Basic Base64_Encode(client_id:client_secret) value in the HTTP authorization header. Organization ID parameter notes: when organization id is missing from the request the default organization will be used. 3. Upon password grant type, user default organization will be set if available. 4. Upon client_credentials…
POST /csp/gateway/am/api/auth/token
Inputs: body.
identity_get_access_token_with_authorization_requestA
[DEPRECATED] Get an access token.
Use this API instead: * /oidc/oauth2/token Exchange authorization code, refresh token or client_credentials to user access token. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
POST /csp/gateway/am/api/auth/authorize
Inputs: body.
identity_get_access_token_with_refresh_tokenA
[DEPRECATED] Exchange organization scoped API-token for user access token.
Use this API instead: * /oidc/oauth2/token **To obtain the access token please follow the steps described in the official product documentation. Using the token generated by the Identity Service API alone will not work due to a missing internal state.**DEPRECATED: Passing the refresh_token param name, need to use api_token. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
POST /csp/gateway/am/api/auth/api-tokens/authorize
Inputs: body.
identity_get_all_by_org_service_definitionsBRead-onlyIdempotent
[DEPRECATED] Get all service definitions the organization has access to. This API has no analogue in Tenant Manager ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ❌ | GET /csp/gateway/slc/api/v2/orgs/{orgId}/services
Inputs: orgId (required), locale, pageLimit, pageStart.
identity_get_all_service_definitionsBRead-onlyIdempotent
[DEPRECATED] Get all service definitions. This API has no analogue in Tenant Manager ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ | GET /csp/gateway/slc/api/definitions
Inputs: expand, orgLink.
identity_get_group_roles_on_organizationARead-onlyIdempotent
[DEPRECATED] Get Group Roles On Organization
Use this API instead: * /cloudapi/1.0.0/groups/{{groupUrn}} Get roles of a group within organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/roles
Inputs: orgId (required), groupId (required).
identity_get_keysARead-onlyIdempotent
[DEPRECATED] Defines the public keys used to verify the authenticity of the JWT token.
Use this API instead: * /oidc/oauth2/jwks Defines the public keys used to verify the authenticity of the JWT token. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
GET /csp/gateway/am/api/auth/keys
Inputs: no named parameters.
identity_get_logged_in_userARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user.
Use this API instead: * /oidc/userinfo ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user
Inputs: expand.
identity_get_logged_in_user_detailsARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user's detailed information.
Use this API instead: * /oidc/userinfo ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user/details
Inputs: no named parameters.
identity_get_logged_in_user_groups_on_orgARead-onlyIdempotent
[DEPRECATED] Get Principal User Groups Information Within the Specified Organization
Use this API instead: * /scim/v2/Users ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user/orgs/{orgId}/groups
Inputs: orgId (required).
identity_get_openid_configurationARead-onlyIdempotent
[DEPRECATED] OpenID Connect discovery endpoint
Use this API instead: * /oidc/.well-known/openid-configuration Get discovery endpoint meta data as described in https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata. OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0 protocol. It enables Clients to verify the identity of the End-User based on the authentication performed by an Authorization Server, as well as to obtain basic profile information about the End-User in an interoperable and REST-like manner. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
GET /.well-known/openid-configuration
Inputs: no named parameters.
identity_get_organization_groupsARead-onlyIdempotent
[DEPRECATED] Get Organization Groups
Use this API instead: * /cloudapi/1.0.0/groups Get groups of a specific organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/orgs/{orgId}/groups
Inputs: orgId (required), groupId, pageLimit, pageStart.
identity_get_org_rolesARead-onlyIdempotent
[DEPRECATED] Get Organization Roles
Use this API instead: * /cloudapi/1.0.0/roles Get list of organization roles. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/orgs/{orgId}/roles
Inputs: orgId (required), name, expand.
identity_get_orgs_by_org_idARead-onlyIdempotent
[DEPRECATED] Read an organization.
Use this API instead: * /cloudapi/1.0.0/orgs ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/orgs/{orgId}
Inputs: orgId (required).
identity_get_orgs_by_org_id_usersARead-onlyIdempotent
[DEPRECATED] Paginates search for user.
Use these APIs instead: * /cloudapi/1.0.0/users * /cloudapi/1.0.0/users/{{userUrn}}/preferences * /scim/v2/Groups Get response encapsulating organization users. Fetched page is according to the page start and page limit passed as optional parameters. Defaults to page size of 20 and start from the first page. Note that pageStart is 1-based index. We are currently not supporting the optional serviceDefinitionId which is to filter users having access to a service in CSP. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | &#x2…
GET /csp/gateway/am/api/orgs/{orgId}/users
Inputs: orgId (required), pageLimit, pageStart, expandProfile, +2 more.
identity_get_org_sub_orgsARead-onlyIdempotent
[DEPRECATED] Get all organization's sub-orgs.
Use this API instead: * /cloudapi/1.0.0/orgs Returns all sub organizations for the passed Org ID. The user needs to be either organization owner or a platform operator in order to get a result. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/orgs/{orgId}/sub-orgs
Inputs: orgId (required).
identity_get_paged_service_definition_orgsARead-onlyIdempotent
[DEPRECATED] Get organizations with access to specified service. This API has no analogue in Tenant Manager Currently all organizations have access to all of the service definitions. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ❌ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ✔️ | GET /csp/gateway/slc/api/v2/definitions/{serviceDefinitionId}/orgs
Inputs: serviceDefinitionId (required), pageLimit, pageStart.
identity_get_paginated_group_usersARead-onlyIdempotent
[DEPRECATED] Get users in group within organization.
Use this API instead: * /scim/v2/Users Get users in group within organization. Optionally filtered by given firstName, lastName or email with 'contains' match. Optionally filter the users by using onlyDirectUsers with true to return only direct users and not return the users from nested groups. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
Inputs: orgId (required), groupId (required), email, lastName, +4 more.
identity_get_paginated_org_users_infoARead-onlyIdempotent
[DEPRECATED] Paginates search for user.
Use these APIs instead: * /cloudapi/1.0.0/users * /cloudapi/1.0.0/users/{{userUrn}}/preferences * /scim/v2/Groups Get response encapsulating organization users. Fetched page is according to the page start and page limit passed as optional parameters. Defaults to page size of 20 and start from the first page. Note that pageStart is 1-based index. We are currently not supporting the optional serviceDefinitionId which is to filter users having access to a service in CSP. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | &#x2…
GET /csp/gateway/am/api/v2/orgs/{orgId}/users
Inputs: orgId (required), pageLimit, pageStart, expandProfile, +2 more.
identity_get_principal_user_profileARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user's profile.
Use this API instead: * /cloudapi/vcf/preferences ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user/profile
Inputs: no named parameters.
identity_get_role_by_org_id_and_role_idARead-onlyIdempotent
[DEPRECATED] Read a role.
Use this API instead: * /cloudapi/1.0.0/roles ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/orgs/{orgId}/roles/{roleId}
Inputs: orgId (required), roleId (required).
identity_get_user_default_orgARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user's organizations.
Use this API instead: * /oidc/userinfo Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user/default-org
Inputs: no named parameters.
identity_get_user_in_any_organizationBRead-onlyIdempotent
[DEPRECATED] Get the user (by user ID) belonging to the current organization.
Use this API instead: * /scim/v2/Users ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ❌ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/v2/users/{userId}
Inputs: userId (required), expandProfile.
identity_get_user_info_in_organizationARead-onlyIdempotent
[DEPRECATED] Get the user details by user ID and organization ID.
Use these APIs instead: * /scim/v2/Users * /scim/v2/Groups * /cloudapi/1.0.0/orgs Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/info
Inputs: orgId (required), userId (required).
identity_get_user_org_infoARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user's info in an organization.
Use these APIs instead: * /scim/v2/Users * /scim/v2/Groups * /cloudapi/1.0.0/orgs Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user/orgs/{orgId}/info
Inputs: orgId (required).
identity_get_user_org_rolesARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user's roles.
Use these APIs instead: * /oidc/userinfo * /cloudapi/1.0.0/roles ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user/orgs/{orgId}/roles
Inputs: orgId (required).
identity_get_user_orgsARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user's organizations.
Use this API instead: * /oidc/userinfo Currently one user can belong to exactly one organization. Result contains detailed information for the organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/v2/loggedin/user/orgs
Inputs: pageLimit, pageStart.
identity_get_user_org_service_rolesARead-onlyIdempotent
[DEPRECATED] Get the currently logged in user's service roles.
Use this API instead: * /oidc/userinfo ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/loggedin/user/orgs/{orgId}/service-roles
Inputs: orgId (required), serviceDefinitionLink.
identity_get_user_roles_in_organizationARead-onlyIdempotent
[DEPRECATED] Get the user's roles.
Use this API instead: * /scim/v2/Users/{{userUrn}} Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/users/{userId}/orgs/{orgId}/roles
Inputs: orgId (required), userId (required).
identity_get_user_roles_on_org_with_group_infoARead-onlyIdempotent
[DEPRECATED] Get user roles with groups inheritance information within the specified organization
Use these APIs instead: * /cloudapi/1.0.0/users * /scim/v2/Groups The user roles with groups inheritance information is not a CSP API call. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/users/{userId}/orgs/{orgId}/access
Inputs: orgId (required), userId (required).
identity_get_users_by_acctARead-onlyIdempotent
[DEPRECATED] Get the user belonging to the current organization.
Use this API instead: * /scim/v2/Users Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ❌ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/users/{acct}
Inputs: acct (required), expandProfile.
identity_get_users_by_acct_orgs_by_org_id_infoARead-onlyIdempotent
[DEPRECATED] Get the user details.
Use these APIs instead: * /scim/v2/Users * /scim/v2/Groups * /cloudapi/1.0.0/orgs Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/users/{acct}/orgs/{orgId}/info
Inputs: acct (required), orgId (required).
identity_get_users_by_user_id_orgs_by_org_id_rolesARead-onlyIdempotent
[DEPRECATED] Get the user's roles for a particular organization.
Use this API instead: * /scim/v2/Users Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/roles
Inputs: orgId (required), userId (required).
identity_get_users_by_user_id_orgs_by_org_id_service_rolesARead-onlyIdempotent
[DEPRECATED] Get the user's roles for a particular organization.
Use this API instead: * /cloudapi/1.0.0/users Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/service-roles
Inputs: orgId (required), userId (required), serviceDefinitionLink.
identity_get_user_service_roles_in_organizationARead-onlyIdempotent
[DEPRECATED] Get the user's service roles.
Use this API instead: * /cloudapi/1.0.0/users/{{userUrn}} Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ❌ |
GET /csp/gateway/am/api/users/{userId}/orgs/{orgId}/service-roles
Inputs: orgId (required), userId (required), serviceDefinitionLink.
identity_login_oauthB
[DEPRECATED] Get Access token.
Use this API instead: * /oidc/oauth2/token An alias of the AuthenticationController's get access token method. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
POST /csp/gateway/am/api/login/oauth
Inputs: body.
identity_patch_orgA
[DEPRECATED] Update organization details.
Use this API instead: * /cloudapi/1.0.0/orgs NOTE: At the moment we only allow for displayName change. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
PATCH /csp/gateway/am/api/orgs/{orgId}
Inputs: body (required), orgId (required).
identity_patch_org_rolesC
[DEPRECATED] Edit roles.
Use this API instead: * /cloudapi/1.0.0/users ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
PATCH /csp/gateway/am/api/orgs/{orgId}/roles
Inputs: body (required), orgId (required).
identity_patch_user_roles_in_organizationA
[DEPRECATED] Edit the user's roles.
Use this API instead: * /cloudapi/1.0.0/users/{{userUrn}} Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
PATCH /csp/gateway/am/api/users/{userId}/orgs/{orgId}/roles
Inputs: body (required), orgId (required), userId (required).
identity_patch_user_roles_on_organizationA
[DEPRECATED] (BETA) Update user roles in organization.
Use this API instead: * /cloudapi/1.0.0/users/{{userUrn}} Update service and organization roles of a user in the organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
PATCH /csp/gateway/am/api/v3/users/{userId}/orgs/{orgId}/roles
Inputs: body (required), orgId (required), userId (required).
identity_patch_user_service_roles_in_organizationA
[DEPRECATED] Edit the user's service roles.
Use this API instead: * /cloudapi/1.0.0/users/{{userUrn}} Currently one user can belong to exactly one organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
PATCH /csp/gateway/am/api/users/{userId}/orgs/{orgId}/service-roles
Inputs: body (required), orgId (required), userId (required).
identity_post_auth_logoutA
[DEPRECATED] Performs logout.
Use this API instead: * /cloudapi/1.0.0/sessions/current Performs a logout by invalidating the supplied token (if supplied) and returning an URL to navigate to. The token to invalidate is taken from the ex-identity-auth-token header. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
POST /csp/gateway/am/api/auth/logout
Inputs: The_access_token_to_be_invalidated..
identity_post_loginA
[DEPRECATED] Login.
Use this API instead: * /oauth/tenant/{{tenant name}}/token Performs login. ### Access Policy | Role | Access | | ----- | ----- | | Anonymous | ✔️ |
POST /csp/gateway/am/api/login
Inputs: body (required), access_token.
identity_remove_groups_from_organizationADestructiveIdempotent
[DEPRECATED] Remove Groups From Organization
Use this API instead: * /cloudapi/1.0.0/groups Remove groups from organization.Note: DEPRECATED: Response field failed will be deprecated. You can use the field failures instead. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
DELETE /csp/gateway/am/api/orgs/{orgId}/groups
Inputs: orgId (required), body.
identity_search_groupsARead-onlyIdempotent
[DEPRECATED] Search for a group.
Use this API instead: * /scim/v2/Groups In this case the PagedResponse.results field will contain Group object. See the Group model for reference. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/groups/search
Inputs: searchTerm (required), idpId, pageLimit, pageStart.
identity_search_org_groupsBRead-onlyIdempotent
[DEPRECATED] Find groups.
Use this API instead: * /scim/v2/Groups Performs a search for groups in the organization. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
GET /csp/gateway/am/api/orgs/{orgId}/groups-search
Inputs: orgId (required), groupSearchTerm (required).
identity_search_usersBRead-onlyIdempotent
[DEPRECATED] Search for users.
Use this API instead: * /cloudapi/1.0.0/users Search users in organization having username, firstName, lastName or email which "contains" search term e.g. search for "test" will return test@vmware.com if test@vmware.com is part of the organization. Search results limited to first 20 results. Please refine the search term for accurate results. Organization members will receive basic user information. Organization owners will additionally receive role details of the users. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | &…
GET /csp/gateway/am/api/orgs/{orgId}/users/search
Inputs: orgId (required), userSearchTerm (required), expandProfile, includeGroupIdsInRoles.
identity_search_users_in_idp_by_names_and_emailB
[DEPRECATED] Search users in idp by names and email
Use this API instead: * /scim/v2/Users Search users in the corresponding organization in idp by names and email. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
POST /csp/gateway/am/api/v2/users/search
Inputs: body (required).
identity_update_group_roles_on_organizationA
[DEPRECATED] Update Group Roles On Organization
Use this API instead: * /cloudapi/1.0.0/groups/{{groupUrn}} Update roles of a group within organization.Note: Email notification for updating group roles of group is disabled by the Identity Service. ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ❌ | | Service Account (Whitelisted Client) | ❌ |
PATCH /csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/roles
Inputs: body (required), orgId (required), groupId (required).
identity_update_user_preferencesAIdempotent
[DEPRECATED] Update the currently logged in user's locale preferences. Note that only language field will be saved.
Use this API instead: * /cloudapi/1.0.0/preferences/internal:localLanguage ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
PUT /csp/gateway/am/api/loggedin/user/profile/locale-preferences
Inputs: body (required).
identity_update_user_profileA
[DEPRECATED] Update the currently logged in user's profile attributes.
Use this API instead: * /cloudapi/1.0.0/preferences/internal:localLanguage ### Access Policy | Role | Access | | ----- | ----- | | Platform operator | ✔️ | | Organization Owner | ✔️ | | Organization Member | ✔️ | | Service Account (Whitelisted Client) | ✔️ |
PATCH /csp/gateway/am/api/loggedin/user/profile
Inputs: body (required).
metrics_get_qp_resource_detailsCRead-onlyIdempotent
Returns registered metrics GET /aggregator/api/metrics
Inputs: apiVersion.
metrics_get_resource_criteriaBRead-onlyIdempotent
Returns resource criteria for deployment limit policy. GET /deploymentlimit/api/policy/resourceCriteria/schema
Inputs: apiVersion.
metrics_get_resource_usage_metricsCRead-onlyIdempotent
Returns aggregated metrics values of the current user GET /aggregator/api/metrics/deployment/aggregate
Inputs: orgLevel, apiVersion.
metrics_get_resource_usage_metrics_by_projectCRead-onlyIdempotent
Returns aggregated metrics values of the given project GET /aggregator/api/metrics/deployment/aggregate/projects/{projectId}
Inputs: projectId (required), apiVersion.
metrics_get_resource_usage_metrics_by_userCRead-onlyIdempotent
Returns aggregated metrics values of the given user GET /aggregator/api/metrics/deployment/aggregate/users/{userId}
Inputs: userId (required), apiVersion.
onboarding_delete_blueprint_by_idCDestructiveIdempotent
Delete the selected onboarding blueprint Delete the selected onboarding blueprint in the current organization DELETE /relocation/onboarding/blueprint/{id}
Inputs: id (required).
onboarding_delete_deployment_by_idCDestructiveIdempotent
Delete the selected onboarding deployment Delete the selected onboarding deployment in the current organization DELETE /relocation/onboarding/deployment/{id}
Inputs: id (required).
onboarding_delete_plan_by_idCDestructiveIdempotent
Delete the selected onboarding plan Delete the selected onboarding plan in the current organization DELETE /relocation/onboarding/plan/{id}
Inputs: id (required).
onboarding_delete_resource_by_idCDestructiveIdempotent
Delete the selected onboarding resource Delete the selected onboarding resource in the current organization DELETE /relocation/onboarding/resource/{id}
Inputs: id (required).
onboarding_delete_wo_execute_plan_by_idCDestructiveIdempotent
Delete the selected onboarding plan execution Delete the selected onboarding plan execution in the current organization DELETE /relocation/api/wo/execute-plan/{id}
Inputs: id (required).
onboarding_get_blueprintCRead-onlyIdempotent
Query for onboarding blueprints Query for onboarding blueprints in the current organization GET /relocation/onboarding/blueprint
Inputs: limit, expand, filter, select, +1 more.
onboarding_get_blueprint_by_idCRead-onlyIdempotent
Get the selected onboarding blueprint Get the selected onboarding blueprint in the current organization GET /relocation/onboarding/blueprint/{id}
Inputs: id (required).
onboarding_get_deploymentBRead-onlyIdempotent
Query for onboarding deployments Query for onboarding deployments in the current organization GET /relocation/onboarding/deployment
Inputs: limit, expand, filter, select, +1 more.
onboarding_get_deployment_by_idCRead-onlyIdempotent
Get the selected onboarding deployment Get the selected onboarding deployment in the current organization GET /relocation/onboarding/deployment/{id}
Inputs: id (required).
onboarding_get_planCRead-onlyIdempotent
Query for onboarding plans Query for onboarding plans in the current organization GET /relocation/onboarding/plan
Inputs: limit, expand, filter, select.
onboarding_get_plan_by_idCRead-onlyIdempotent
Get the selected onboarding plan Get the selected onboarding plan in the current organization GET /relocation/onboarding/plan/{id}
Inputs: id (required).
onboarding_get_resourceCRead-onlyIdempotent
Query for onboarding resources Query for onboarding resources in the current organization GET /relocation/onboarding/resource
Inputs: limit, expand, filter, select, +1 more.
onboarding_get_resource_by_idCRead-onlyIdempotent
Get the selected onboarding resource Get the selected onboarding resource in the current organization GET /relocation/onboarding/resource/{id}
Inputs: id (required).
onboarding_get_wo_execute_planCRead-onlyIdempotent
Query for onboarding plan executions Query for onboarding plan executions in the current organization GET /relocation/api/wo/execute-plan
Inputs: limit, expand, filter, select, +1 more.
onboarding_get_wo_execute_plan_by_idCRead-onlyIdempotent
Get the selected onboarding plan execution Get the selected onboarding plan execution in the current organization GET /relocation/api/wo/execute-plan/{id}
Inputs: id (required).
onboarding_patch_blueprint_by_idC
Update the selected onboarding blueprint Update the selected onboarding blueprint in the current organization PATCH /relocation/onboarding/blueprint/{id}
Inputs: id (required), body (required).
onboarding_patch_deployment_by_idC
Update the selected onboarding deployment Update the selected onboarding deployment in the current organization PATCH /relocation/onboarding/deployment/{id}
Inputs: id (required), body (required).
onboarding_patch_plan_by_idC
Update the selected onboarding plan Update the selected onboarding plan in the current organization PATCH /relocation/onboarding/plan/{id}
Inputs: id (required), body (required).
onboarding_patch_resource_by_idC
Update the selected onboarding resource Update the selected onboarding resource in the current organization PATCH /relocation/onboarding/resource/{id}
Inputs: id (required), body (required).
onboarding_post_blueprintB
Create an onboarding blueprint Create an onboarding blueprint in the current organization POST /relocation/onboarding/blueprint
Inputs: body (required).
onboarding_post_deploymentC
Create an onboarding deployment Create an onboarding deployment in the current organization POST /relocation/onboarding/deployment
Inputs: body (required).
onboarding_post_planC
Create an onboarding plan Create an onboarding plan in the current organization POST /relocation/onboarding/plan
Inputs: body (required).
onboarding_post_resourceB
Create an onboarding resource Create an onboarding resource in the current organization POST /relocation/onboarding/resource
Inputs: body (required).
onboarding_post_task_create_deploymentC
Create or update an onboarding deployment and associated resources Create or update an onboarding deployment and associated resources in the current organization POST /relocation/onboarding/task/create-deployment
Inputs: body (required).
onboarding_post_task_create_deployment_bulkC
Create or update onboarding deployments in bulk Create or update onboarding deployments in bulk in the current organization POST /relocation/onboarding/task/create-deployment-bulk
Inputs: body (required).
onboarding_post_wo_execute_planC
Execute the given onboarding plan Execute the given onboarding plan in the current organization POST /relocation/api/wo/execute-plan
Inputs: body (required).
onboarding_post_wo_query_unmanaged_machineC
Query for compute resources representing unmanaged machines from the Provisioning service inventory Query for compute resources representing unmanaged machines from the Provisioning service inventory in the current organization POST /relocation/api/wo/query-unmanaged-machine
Inputs: body (required).
policy_create_policyB
Creates a new policy, updates an existing policy, or trigger a policy dry-run. Create a new policy or update an existing policy based on request body and validate its fields according to business rules or dry-run an existing policy to rehearse actual policy effect on application. POST /policy/api/policies
Inputs: body (required), dryRun, validationOnly.
policy_delete_policyCDestructiveIdempotent
Delete a policy Delete a specified policy corresponding to its unique id. DELETE /policy/api/policies/{id}
Inputs: id (required).
policy_get_decision_by_idBRead-onlyIdempotent
Returns a policy decision by id. Find a specific policy decision based on the input policy decision id. GET /policy/api/policyDecisions/{id}
Inputs: id (required).
policy_get_decisionsBRead-onlyIdempotent
Fetch a list of policy decisions. Returns a paginated list of policy decisions. If a dryRunId is provided, the return value has a field indicating whether the dry run is complete. GET /policy/api/policyDecisions
Inputs: top, page, size, skip, +6 more.
policy_get_policiesBRead-onlyIdempotent
Returns a paginated list of policies. Find all the policies associated with current org. GET /policy/api/policies
Inputs: top, page, size, skip, +7 more.
policy_get_policyBRead-onlyIdempotent
Returns a specified policy. Find a specific policy based on the input policy id. GET /policy/api/policies/{id}
Inputs: id (required), computeStats.
policy_get_policy_type_by_idBRead-onlyIdempotent
Returns the policy type with the specified ID. Find a specific policy type based on the input policy type id. GET /policy/api/policyTypes/{id}
Inputs: id (required).
policy_get_policy_type_scope_schemaCRead-onlyIdempotent
Returns the policy scope schema for the type with the specified ID. Return the policy scope schema for the given policy type. GET /policy/api/policyTypes/{id}/scopeSchema
Inputs: id (required).
policy_get_typesBRead-onlyIdempotent
Returns a paginated list of policy types. Find all the policy types available in the current org. GET /policy/api/policyTypes
Inputs: top, page, size, skip, +3 more.
project_delete_projectCDestructiveIdempotent
Deletes a project Deletes a project by id. DELETE /project-service/api/projects/{id}
Inputs: id (required), apiVersion.
project_get_aboutBRead-onlyIdempotent
Get about page
The page contains information about the supported API versions and the latest API version. The version parameter is optional but highly recommended. If you do not specify explicitly an exact version, you will be calling the latest supported API version. Here is an example of a call which specifies the exact version you are using: GET /project-service/api/projects?apiVersion=2019-01-15
GET /project-service/api/about
Inputs: no named parameters.
project_get_all_projectsCRead-onlyIdempotent
Get all projects Get all projects with specified paging parameters. GET /project-service/api/projects
Inputs: page, size, select, orderby, +5 more.
project_get_projectCRead-onlyIdempotent
Retrieves a project Retrieves a project by id. GET /project-service/api/projects/{id}
Inputs: id (required), apiVersion, withAnyPermission.
project_get_projects_by_id_resource_metadataCRead-onlyIdempotent
Retrieves a resource metadata for a project Retrieves a resource metadata for a project by id. GET /project-service/api/projects/{id}/resource-metadata
Inputs: id (required), apiVersion.
project_modify_projectC
Modifies a project Modifies a project by id. Fields that can be modified: name, description, constraints, properties, cost, operation timeout, shared resources. PATCH /project-service/api/projects/{id}
Inputs: id (required), body (required), apiVersion.
project_modify_project_costsC
Modifies a project cost Modifies the cost of a project specified by id. PATCH /project-service/api/projects/{id}/cost
Inputs: id (required), body (required), apiVersion.
project_modify_project_principalsC
Modifies principals assigned to a project Modifies principals assigned to a project by id. PATCH /project-service/api/projects/{id}/principals
Inputs: id (required), body (required), apiVersion, syncPrincipals, +1 more.
project_patch_projects_by_id_resource_metadataB
Modifies a project resource metadata Modifies the resources metadata of a project specified by id. PATCH /project-service/api/projects/{id}/resource-metadata
Inputs: id (required), body (required), apiVersion.
project_post_projectsC
Creates a project POST /project-service/api/projects
Inputs: body (required), apiVersion, validatePrincipals.
project_sync_projects_principalsC
Sync principals assigned to any project within user organization POST /project-service/api/projects/{id}/sync-principals
Inputs: id (required), apiVersion.
provider_add_certificate_library_itemC
Add an item to the certificate library POST /cloudapi/1.0.0/ssl/certificateLibrary
Inputs: body (required).
provider_add_consumer_ref_to_cert_library_itemC
Adds the specified consumer reference to a library item. POST /cloudapi/1.0.0/ssl/certificateLibrary/{certLibraryItemId}/consumers
Inputs: body (required), certLibraryItemId (required).
provider_change_passwordB
Modify the existing password of a local user. Modify an existing user's own password POST /cloudapi/1.0.0/users/{userUrn}/changePassword
Inputs: body (required), userUrn (required).
provider_create_custom_rights_categoryB
Create a new custom rights category. Creates a new custom rights category. POST /cloudapi/1.0.0/rightsCategories
Inputs: body (required).
provider_create_groupB
Create a new group. LDAP and provider org VIDB groups are verified against the IDP before import. POST /cloudapi/1.0.0/groups
Inputs: body (required).
provider_create_rightB
Create a new right. Creates a new right associated with a service. POST /cloudapi/1.0.0/rights
Inputs: body (required).
provider_create_userB
Create a new user. LDAP and provider org VIDB users are verified against the backing IDP before import. POST /cloudapi/1.0.0/users
Inputs: body (required).
provider_delete_1_0_0_sessions_by_idBDestructiveIdempotent
Logs out the current user DELETE /cloudapi/1.0.0/sessions/{id}
Inputs: id (required).
provider_delete_certificateBDestructiveIdempotent
Revoke trusting specified certificate DELETE /cloudapi/1.0.0/ssl/trustedCertificates/{trustedCertificate}
Inputs: trustedCertificate (required).
provider_delete_certificate_library_itemADestructiveIdempotent
Remove certificate library item. Delete the specified certificate library item. Only items that are not in use can be deleted. Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0) DELETE /cloudapi/1.0.0/ssl/certificateLibrary/{id}
Inputs: id (required).
provider_delete_custom_rights_categoryCDestructiveIdempotent
Delete an individual custom rights category. Deletes the requested Custom Rights Category by id. DELETE /cloudapi/1.0.0/rightsCategories/{id}
Inputs: id (required).
provider_delete_groupCDestructiveIdempotent
Delete the specified group. DELETE /cloudapi/1.0.0/groups/{groupUrn}
Inputs: groupUrn (required).
provider_delete_oidc_relying_partyCDestructiveIdempotent
Deletes a specific OIDC relying party. Delete a specific OIDC relying party. DELETE /cloudapi/1.0.0/openIdProvider/relyingParties/{id}
Inputs: id (required).
provider_delete_rightCDestructiveIdempotent
Delete an individual custom right. Deletes the requested Custom Right by id. DELETE /cloudapi/1.0.0/rights/{id}
Inputs: id (required).
provider_delete_service_accountBDestructiveIdempotent
Deletes a service account DELETE /cloudapi/1.0.0/serviceAccounts/{id}
Inputs: id (required).
provider_delete_tokenADestructiveIdempotent
Delete a specific token. Use this to revoke the current token in case of a leak. DELETE /cloudapi/1.0.0/tokens/{id}
Inputs: id (required).
provider_delete_userBDestructiveIdempotent
Delete the specified user. DELETE /cloudapi/1.0.0/users/{userUrn}
Inputs: userUrn (required).
provider_deny_device_authorizationB
Denies a device authorization request A device's request for access on behalf of a service account, as identified by the specified user code, is denied POST /cloudapi/1.0.0/deviceLookup/deny
Inputs: body (required).
provider_find_device_authorization_requestB
Looks up a device authorization request for approval Looks up a service account identified by the specified user code for processing its authorization request POST /cloudapi/1.0.0/deviceLookup
Inputs: body (required).
provider_get_active_themeARead-onlyIdempotent
Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in the requested flavor. All mandatory resources are included, even if the theme does…
Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in the requested flavor. All mandatory resources are included, even if the theme does not explicitly define such flavor(in which case the main flavor is used). To fetch each file, build a URL from filesRoot + files[i] and GET it. This resource is accessible without authentication.
GET /cloudapi/v1/themes/active/{orgName}/{flavor}
Inputs: flavor (required), orgName (required).
provider_get_active_theme_main_flavorARead-onlyIdempotent
Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in its main flavor. To fetch each file, build a URL from filesRoot + files[i] and…
Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in its main flavor. To fetch each file, build a URL from filesRoot + files[i] and GET it. This resource is accessible without authentication.
GET /cloudapi/v1/themes/active/{orgName}
Inputs: orgName (required).
provider_get_certificateBRead-onlyIdempotent
Get specified certificate Get the PEM-encoded certificate with the requested URN GET /cloudapi/1.0.0/ssl/trustedCertificates/{trustedCertificate}
Inputs: trustedCertificate (required).
provider_get_certificate_library_itemARead-onlyIdempotent
Get the specified certificate library item Retrieves the specified certificate library item. Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0) GET /cloudapi/1.0.0/ssl/certificateLibrary/{id}
Inputs: id (required).
provider_get_current_sessionBRead-onlyIdempotent
Returns the current session identified by credentials supplied using the Authorization header Returns the specified session for the authorization token GET /cloudapi/1.0.0/sessions/current
Inputs: no named parameters.
provider_get_current_session_rightsBRead-onlyIdempotent
Returns the rights associated with the current session. Please note that the 'impliedRights' and 'isPublishable' fields will not be set for rights returned from this endpoint. Returns the rights associated with the current session. GET /cloudapi/1.0.0/sessions/current/rights
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_get_current_sessionsARead-onlyIdempotent
List all sessions for current user GET /cloudapi/1.0.0/sessions
Inputs: page (required), pageSize (required).
provider_get_groupCRead-onlyIdempotent
Get a specified group. GET /cloudapi/1.0.0/groups/{groupUrn}
Inputs: groupUrn (required).
provider_get_notification_settingsCRead-onlyIdempotent
Retrieves configured notification settings. Get configured notification settings. GET /cloudapi/1.0.0/orgNotificationSettings
Inputs: no named parameters.
provider_get_oidc_relying_partyCRead-onlyIdempotent
Retrieves a specific OIDC relying party. Get a specific OIDC relying party. GET /cloudapi/1.0.0/openIdProvider/relyingParties/{id}
Inputs: id (required).
provider_get_orgCRead-onlyIdempotent
Get specified organization. GET /cloudapi/1.0.0/orgs/{orgUrn}
Inputs: orgUrn (required).
provider_get_org_ldap_settingsCRead-onlyIdempotent
Get all the organization LDAP settings. Get all organization LDAP settings. GET /cloudapi/v1/orgSettings/ldap
Inputs: no named parameters.
provider_get_org_settingsCRead-onlyIdempotent
Get all the organization settings accessible to the user. Get all organization settings accessible to the user. GET /cloudapi/v1/orgSettings
Inputs: no named parameters.
provider_get_preferenceBRead-onlyIdempotent
Get specified user preference. GET /cloudapi/1.0.0/preferences/{classifier}
Inputs: classifier (required).
provider_get_rightARead-onlyIdempotent
Retrieve an individual right. Retrieves the requested Right by id. GET /cloudapi/1.0.0/rights/{id}
Inputs: id (required).
provider_get_rights_categoryCRead-onlyIdempotent
Retrieve an individual Right category. Retrieves the requested Rights Category by id. GET /cloudapi/1.0.0/rightsCategories/{id}
Inputs: id (required).
provider_get_roleCRead-onlyIdempotent
Get specified role GET /cloudapi/1.0.0/roles/{id}
Inputs: id (required).
provider_get_service_accountBRead-onlyIdempotent
Retrieves a specific service account GET /cloudapi/1.0.0/serviceAccounts/{id}
Inputs: id (required).
provider_get_sessionBRead-onlyIdempotent
Returns the specified session for current user GET /cloudapi/1.0.0/sessions/{id}
Inputs: id (required).
provider_get_theme_fileARead-onlyIdempotent
Load a file of a theme with the given id, if it exists. This resource is accessible without authentication and without the need to specify Accept header containing an api version.
GET /cloudapi/v1/themes/files/{themeRootFolder}/{fileName}
Inputs: fileName (required), themeRootFolder (required).
provider_get_theme_flavor_fileBRead-onlyIdempotent
Load a file of a theme with the given id, if it exists. This resource is accessible without authentication and without the need to specify Accept header containing an api version.
GET /cloudapi/v1/themes/files/{themeRootFolder}/{flavor}/{fileName}
Inputs: flavor (required), fileName (required), themeRootFolder (required).
provider_get_tokenBRead-onlyIdempotent
Retrieves a specific token GET /cloudapi/1.0.0/tokens/{id}
Inputs: id (required).
provider_get_tokensCRead-onlyIdempotent
Retrieve tokens GET /cloudapi/1.0.0/tokens
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_get_userARead-onlyIdempotent
Get a specified user by id. If the id of a service account is specified instead, a simplified view of the service account is returned instead. Get a specified user by id. GET /cloudapi/1.0.0/users/{userUrn}
Inputs: userUrn (required).
provider_get_user_preferenceCRead-onlyIdempotent
Get a preference for a specific user. GET /cloudapi/1.0.0/users/{userUrn}/preferences/{classifier}
Inputs: userUrn (required), classifier (required).
provider_grant_device_authorizationA
Grants a device authorization request Grants access to service account identified by the specified user code. Subsequent polling by the device will result in access token to be transmitted as per device code flow specification POST /cloudapi/1.0.0/deviceLookup/grant
Inputs: body (required).
provider_logout_current_sessionADestructiveIdempotent
Logout current session Logs out and terminates the current session identified by credentials supplied using the Authorization header DELETE /cloudapi/1.0.0/sessions/current
Inputs: no named parameters.
provider_modify_user_groupsBIdempotent
Modifies the list of groups that the user with the given id belongs to. Adds a list of group references that the user with the given id belongs to. This endpoint allows for the group membership info to be pre-populated before a user logs in for the first time. PUT /cloudapi/1.0.0/users/{userUrn}/groups
Inputs: body (required), userUrn (required).
provider_post_1_0_0_sessionsB
Logs in a user POST /cloudapi/1.0.0/sessions
Inputs: no named parameters.
provider_post_1_0_0_users_by_user_urn_take_ownershipB
Transfer ownership of this user's owned entities to the caller. Transfer ownership of this user's owned entities (vApps, media, etc) to the caller. POST /cloudapi/1.0.0/users/{userUrn}/takeOwnership
Inputs: userUrn (required).
provider_query_audit_trailCRead-onlyIdempotent
Get list of audit trail events GET /cloudapi/1.0.0/auditTrail
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_certificate_libraryCRead-onlyIdempotent
Get the certificate library items Get a list of the certificate library items GET /cloudapi/1.0.0/ssl/certificateLibrary
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_cert_library_item_consumer_refsBRead-onlyIdempotent
Gets a paged list of consumers (as references) of a particular certificate library item Get list of consumers (as references) of a particular certificate library item GET /cloudapi/1.0.0/ssl/certificateLibrary/{certLibraryItemId}/consumers
Inputs: page (required), pageSize (required), certLibraryItemId (required), filter, +2 more.
provider_query_groupsCRead-onlyIdempotent
Get a list of groups. GET /cloudapi/1.0.0/groups
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_group_usersCRead-onlyIdempotent
Get a list of users of any type that belong to the specified group. GET /cloudapi/1.0.0/groups/{groupUrn}/users
Inputs: page (required), groupUrn (required), pageSize (required), filter, +2 more.
provider_query_oidc_relying_partiesCRead-onlyIdempotent
Retrieve OIDC relying parties. Get a list of all OIDC relying parties meeting the query parameters. GET /cloudapi/1.0.0/openIdProvider/relyingParties
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_orgsBRead-onlyIdempotent
Get list of all orgs accessible to the user. GET /cloudapi/1.0.0/orgs
Inputs: page (required), pageSize (required), filter, sortAsc, +2 more.
provider_query_preferences_vcfCRead-onlyIdempotent
Query user preferences for the logged in user. Query user preferences for the logged in user with sorting, paging, and filtering support. GET /cloudapi/v1/preferences
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_rightsBRead-onlyIdempotent
Get list of rights visible to logged-in user Get list of rights GET /cloudapi/1.0.0/rights
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_rights_categoriesCRead-onlyIdempotent
Get a list of Rights Categories visible to the logged in user Get list of Rights Categories GET /cloudapi/1.0.0/rightsCategories
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_role_rightsBRead-onlyIdempotent
Gets a paged list of rights (as references) contained by a particular role Get list of rights (as references) contained by a particular role GET /cloudapi/1.0.0/roles/{id}/rights
Inputs: id (required), page (required), pageSize (required), filter, +2 more.
provider_query_service_accountsCRead-onlyIdempotent
Retrieve service accounts Get a list of all service accounts. GET /cloudapi/1.0.0/serviceAccounts
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_tenant_rolesCRead-onlyIdempotent
Get list of roles for an organization GET /cloudapi/1.0.0/roles
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_trusted_certificatesBRead-onlyIdempotent
Get currently trusted certificates GET /cloudapi/1.0.0/ssl/trustedCertificates
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_query_user_groupsCRead-onlyIdempotent
Get a list of groups that the user with the given id belongs to. Get a list of references of groups that the user with the given id belongs to. GET /cloudapi/1.0.0/users/{userUrn}/groups
Inputs: page (required), userUrn (required), pageSize (required), filter, +2 more.
provider_query_user_preferencesCRead-onlyIdempotent
Query user preferences for a specific user. Query user preferences for a specific user GET /cloudapi/1.0.0/users/{userUrn}/preferences
Inputs: page (required), userUrn (required), pageSize (required), filter, +2 more.
provider_query_usersCRead-onlyIdempotent
Get a list of users. GET /cloudapi/1.0.0/users
Inputs: page (required), pageSize (required), filter, sortAsc, +1 more.
provider_regenerate_oidc_relying_party_secretC
Regenerate the client secret of an OIDC relying party. Regenerates the client secret of an OIDC relying party. POST /cloudapi/1.0.0/openIdProvider/relyingParties/{id}/regenerateSecret
Inputs: id (required).
provider_register_oidc_relying_partyB
Register an OIDC relying party. Registers a new OIDC relying party. POST /cloudapi/1.0.0/openIdProvider/relyingParties
Inputs: body (required).
provider_replace_cert_library_item_consumer_refsCIdempotent
Replaces the existing consumer refs with the used by references supplied. Replaces the existing consumer refs with the consumer references supplied. PUT /cloudapi/1.0.0/ssl/certificateLibrary/{certLibraryItemId}/consumers
Inputs: body (required), certLibraryItemId (required).
provider_resolve_entityCRead-onlyIdempotent
Get specified entity object GET /cloudapi/1.0.0/entity/{id}
Inputs: id (required).
provider_revoke_service_accountB
Revokes the token associated with the given service account. Revokes the token associated with given service account URN, invalidates any existing sessions. POST /cloudapi/1.0.0/serviceAccounts/{id}/revoke
Inputs: id (required).
provider_search_ldap_groupsCRead-onlyIdempotent
Search LDAP Groups Searches LDAP for given group(s) GET /cloudapi/1.0.0/ldap/search/group
Inputs: q.
provider_search_ldap_usersCRead-onlyIdempotent
Search LDAP Users Searches LDAP for given user(s) GET /cloudapi/1.0.0/ldap/search/user
Inputs: q.
provider_sync_ldapA
Synchronize LDAP users/settings Begins the LDAP sync task POST /cloudapi/1.0.0/ldap/sync
Inputs: no named parameters.
provider_take_ownershipC
Transfer ownership of this service account's owned entities to the caller. Transfer ownership of this service account's owned entities (vApps, media, etc) to the caller. POST /cloudapi/1.0.0/serviceAccounts/{id}/takeOwnership
Inputs: id (required).
provider_testB
Test a connection Tests a connection, including SSL handshake and hostname verification. POST /cloudapi/1.0.0/testConnection
Inputs: body (required).
provider_test_ldapB
Tests LDAP Connection and Settings Tests that custom LDAP settings are valid, and that the system can use them to search for a user or group POST /cloudapi/1.0.0/ldap/test
Inputs: body (required), username.
provider_trust_certificateC
Add to list of currently trusted certificates POST /cloudapi/1.0.0/ssl/trustedCertificates
Inputs: body (required).
provider_update_certificateCIdempotent
Updates an existing trusted certificate PUT /cloudapi/1.0.0/ssl/trustedCertificates/{trustedCertificate}
Inputs: body (required), trustedCertificate (required).
provider_update_certificate_library_itemBIdempotent
Update the specified certificate library item. Updates the specified certificate library item. Only the alias and description fields may be edited Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0) PUT /cloudapi/1.0.0/ssl/certificateLibrary/{id}
Inputs: id (required), body (required).
provider_update_groupCIdempotent
Modify the details of the specified group. Modify details of the specified group. PUT /cloudapi/1.0.0/groups/{groupUrn}
Inputs: body (required), groupUrn (required).
provider_update_notification_settingsBIdempotent
Updates notification settings. PUT /cloudapi/1.0.0/orgNotificationSettings
Inputs: body (required).
provider_update_oidc_relying_partyCIdempotent
Updates a specific OIDC relying party. Updates an OIDC relying party. PUT /cloudapi/1.0.0/openIdProvider/relyingParties/{id}
Inputs: id (required), body (required).
provider_update_orgAIdempotent
Updates an organization. Updates an organization. If the managedBy field is being updated, the operation is asynchronous and a task is returned in the location header. Otherwise, the operation is synchronous. PUT /cloudapi/1.0.0/orgs/{orgUrn}
Inputs: body (required), orgUrn (required).
provider_update_org_ldap_settingsCIdempotent
Updates the organization LDAP settings. PUT /cloudapi/v1/orgSettings/ldap
Inputs: body (required).
provider_update_org_settingsCIdempotent
Updates the organization settings accessible to the user. PUT /cloudapi/v1/orgSettings
Inputs: body (required).
provider_update_preferenceCIdempotent
Update specified user preference PUT /cloudapi/1.0.0/preferences/{classifier}
Inputs: body (required), classifier (required).
provider_update_service_accountCIdempotent
Updates a service account PUT /cloudapi/1.0.0/serviceAccounts/{id}
Inputs: id (required), body (required).
provider_update_tokenCIdempotent
Update a specific token Update a token PUT /cloudapi/1.0.0/tokens/{id}
Inputs: id (required), body (required).
provider_update_userBIdempotent
Modify the details of a user. A non-administrator user may only modify their own password. An administrator can edit any user. Modify basic details of the specified user. PUT /cloudapi/1.0.0/users/{userUrn}
Inputs: body (required), userUrn (required).
provider_update_user_preferenceCIdempotent
Update a preference for a specific user. PUT /cloudapi/1.0.0/users/{userUrn}/preferences/{classifier}
Inputs: body (required), userUrn (required), classifier (required).
vcfa_connection_statusARead-only
Show the VCF Automation connection: host, org, auth mode in use, token expiry, read-only flag and how many operation tools are loaded per service. Pass test=true to log in now and call GET /iaas/api/about.
Inputs: test.
vcfa_describe_operationARead-only
Return the full, untruncated request schema (all nesting levels) and parameter list for any operation tool by name. Use it before calling a create/update tool whose body schema is summarised.
Inputs: tool (required).
vro_run_workflowC
Start Workflow Run Starts Workflow Run. POST /vro/runs
Inputs: body (required).
vro_workflow_get_aggregatedCRead-onlyIdempotent
Get aggregated list of workflows for all configurations Get aggregated list of workflows, grouped by id and name, along with information for all configurations in which each workflow is present GET /vro/aggregated-workflows
Inputs: page (required).
vro_workflow_get_aggregated_oneCRead-onlyIdempotent
Get aggregated information for a workflow Get a workflow with a specific ID GET /vro/aggregated-workflows/{id}
Inputs: id (required).
vro_workflow_get_allCRead-onlyIdempotent
Get a list of workflows GET /vro/workflows
Inputs: page (required), expand.
vro_workflow_get_oneCRead-onlyIdempotent
Get a workflow definition GET /vro/workflows/{workflowId}
Inputs: workflowId (required), expand, endpointConfigurationLink.
vro_workflow_run_get_allCRead-onlyIdempotent
List Workflow Runs Retrieves list of Workflow Runs possibly filtered by eventId and workflowId. GET /vro/runs
Inputs: page (required).
vro_workflow_run_get_by_run_idBRead-onlyIdempotent
Find Workflow Run by run ID Retrieves the Workflow Run for the specific run ID GET /vro/runs/{runId}
Inputs: runId (required).
vro_workflow_run_logs_get_by_run_idCRead-onlyIdempotent
Find Workflow Run logs by run ID Retrieves the Workflow Run logs for the specific run ID GET /vro/runs/{runId}/logs
Inputs: runId (required), severity, localOnly, olderThan.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 698 tools
The 698-tool surface contains many overlapping or duplicate-looking operations across services: for example iaas_get_deployments vs deployment_get_deployments, iaas_get_projects vs project_get_all_projects, multiple cloud-account CRUD variants, and deprecated identity endpoints duplicating provider/cloudapi tools. An agent will struggle to choose the correct endpoint without deep knowledge of VCF service boundaries.
Names are mostly snake_case and service-prefixed, but the verb conventions are highly inconsistent: get vs retrieve vs query vs list vs fetch, create vs post, update vs modify vs patch, and path-derived names such as provider_delete_1_0_0_sessions_by_id and provider_post_1_0_0_sessions. The mix of deprecated names, odd abbreviations, and generated endpoint labels makes selection unpredictable.
A 698-tool server is far beyond a reasonable tool surface for an agent-facing MCP server, even for a broad platform. The count includes many deprecated, admin, and duplicate endpoints that should be filtered or consolidated.
Coverage is extremely broad across IaaS, catalog, deployments, blueprints, ABX, approvals, identity/provider, projects, policy, onboarding, vRO, event broker, forms, and content. There are likely minor gaps and lifecycle inconsistencies, but the surface appears to cover most VCF Automation workflows.
Maintenance
Related MCP Connectors
Remote MCP for 1,500+ APIs. Vault-managed credentials; OAuth or API key. Search, load, and execute.
Governed MCP gateway: one endpoint for your tools, with credential custody and audit log.
Single-connection MCP gateway discovering and executing 490+ verified MCP & A2A tools.
One OAuth connector for your team's remote MCP servers, with Tool Packs, guardrails and logs.
Related MCP Servers
- AlicenseAqualityBmaintenanceGoverned AI-ops MCP server for Nutanix Prism Central v4 REST API, offering 47 read/write tools for clusters, VMs, storage, network, catalog, data protection, alerts, and LCM upgrades with built-in audit, budget, and risk-tier governance.51MIT
- FlicenseNot gradedqualityDmaintenanceEnables LLM clients to browse and manage VCF Automation projects, catalog items, and deployments through MCP tools, including provisioning, day-2 actions, and deleting infrastructure.-
- AlicenseNot gradedqualityAmaintenanceEnables LLMs to interact with generated REST API services by exposing MCP tools and resources for CRUD operations, listing, and retrieval. It lets AI clients discover and call create, update, delete, list, and get-by-id actions against the same data available over REST.MIT
- AlicenseNot gradedqualityBmaintenanceEnables AI agents to discover and invoke tools generated from existing OpenAPI-described REST APIs through a governed MCP gateway with centralized authentication, policy-based access control, rate limiting, PII redaction, auditing, and token-efficient progressive discovery.MIT