VCF Automation API Operations Index

VCF Automation API Operations Index

All available VCF Automation API Operations

Billing Metrics
GET
Get Billing Metrics

Get billing metrics for current org.

Catalog Admin Items
GET
Get Catalog Items 1

Returns a paginated list of catalog items.

GET
Get Catalog Item 1

Returns the catalog item with the specified id.

PATCH
Update Catalog Item

Updates a catalog item with specified icon id or request limit.

GET
Get Versions 1

Returns a paginated list of catalog item versions.

GET
Get Version By Id 1

Returns a detailed catalog item version.

PATCH
Update Catalog Item Version

Patch the catalog item version with form id. Nullify the formId if the formId is an empty string.

Catalog Item Types
GET
Get Types 1

Returns a paginated list of all available Catalog Item Types.

GET
Get Type By Id

Returns the Catalog Item Type with the specified ID.

Catalog Items
GET
Get Catalog Items

Returns a paginated list of catalog items.

GET
Get Catalog Item

Returns the catalog item with the specified ID.

POST
Request Catalog Item Instances 1

Creates a deployment from a catalog item.

POST
Submit Upfront Price Request For Catalog Item

Returns upfront price response for a given catalog item.

GET
Get Upfront Price Response For Catalog Item

Returns upfront prices of a given catalog item.

GET
Get Versions

Returns a paginated list of catalog item versions.

GET
Get Version By Id

Returns a detailed catalog item version.

Catalog Sources
GET
Get Page

Returns a paginated list of catalog sources.

POST
Post

Creates a new catalog source or updates an existing catalog source based on the request body and imports catalog items from it.

DELETE
Delete 2

Deletes the catalog source with the supplied ID.

GET
Get

Returns the catalog source with the supplied ID.

Deployment Actions
GET
Get Deployment Actions

Returns the complete list of available actions that can be performed on a given deployment.

GET
Get Deployment Action

Returns an action for the deployment specified by its Deployment ID and Action ID.

GET
Get Resource Actions 1

Returns the complete list of available actions that can be performed on a given resource.

GET
Get Resource Action 1

Returns an action for the resource specified by its Resource ID and Action ID.

POST
Submit Resource Action Request 1

Submit a resource action request.

Deployments
GET
Get Deployments 1

Returns a paginated list of deployments.

GET
Get Deployment Filters

Returns the Deployment filters in context of given user.

GET
Get Deployment Filter By Id

Returns the Deployment filter with the supplied ID.

GET
Check Deployment Name Exists

Returns OK if a deployment with the supplied name exists.

GET
Check Deployment Name Deprecated

Returns OK if a deployment with the supplied name exists.

DELETE
Delete Deployment

Deletes the deployment with the supplied ID, cleans up the associated resources from the Cloud Provider.

GET
Get Deployment By Id 1

Returns the deployment with the supplied ID.

PATCH
Patch Deployment

Updates the deployment with the supplied ID.

GET
Get Deployment Expense History By Id

Returns the deployment expense history with the supplied ID.

GET
Get Deployment Resources

Returns a paginated list of resources corresponding to the deployment with the supplied ID.

DELETE
Delete Resource

Deletes the resource with the specified ID and attempts to delete resource from the Cloud Provider.

GET
Get Resource By Id 1

Returns the resource with the specified ID that is correlated with the supplied deployment.

GET
Get Deployments For Project

Returns a count of deployments using the project.

Icons
POST
Upload

Create an icon.

DELETE
Delete 1

Delete an existing icon by its unique id.

GET
Download

Download an existing icon by its unique id.

Notification Scenario
GET
Get Scenario

Retrieves notification scenarios

Notification Scenario Branding
DELETE
Delete Scenario Branding

Deletes a notification scenario branding

POST
Create Or Update 1

Creates or updates a notification scenario branding of an organization

Notification Scenario Configuration
GET
Get All Scenario Configs

Retrieves all notification scenario configurations of an organization

PATCH
Patch Config

Enable or disabled a notification scenario configuration of an organization

POST
Create Or Update

Creates or updates a notification scenario configuration of an organization

DELETE
Delete

Deletes a notification scenario configuration by scenario id of an organization

GET
Get Scenario Config

Retrieves a notification scenario configuration by scenario id of an organization

POST
Preview Notification Config

Preview Notification Scenario Config

POST
Send Test Notification

Send Test Notification Scenario Config

Policies
GET
Get Policies 1

Find all the policies associated with current org.

POST
Create Policy 1

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.

DELETE
Delete Policy 1

Delete a specified policy corresponding to its unique id.

GET
Get Policy 1

Find a specific policy based on the input policy id.

Policy Decisions
GET
Get 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
Get Decision By Id

Find a specific policy decision based on the input policy decision id.

Policy Types
GET
Get Types

Find all the policy types available in the current org.

GET
Get Policy Type By Id

Find a specific policy type based on the input policy type id.

GET
Get Policy Type Scope Schema

Return the policy scope schema for the given policy type.

Pricing Card Assignments
GET
Get All Metering Policy Assignments

Returns a paginated list of pricing card assignments

POST
Create Metering Policy 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

GET
Get Metering Assignment Strategy

Returns a pricing card assignment strategy for the Org

PATCH
Change Metering Assignment Strategy

Updates the pricing card assignment strategy for the Org.

POST
Create Metering Assignment Strategy

Create a new pricing card assignment strategy based on request body and validate its field according to business rules.

DELETE
Delete Metering Policy Assignment

Deletes the pricing card assignment with the specified id

GET
Get Metering Policy Assignment

Returns a pricing card assignments by id

PATCH
Patch Metering Policy Assignment

Updates the pricing card assignment id with the supplied id. Request body with ALL entityType will delete the older assignments for the given pricingCardId

Pricing Cards
GET
Get Policies

Returns a paginated list of pricing cards

POST
Create Policy

Create a new pricing card based on request body and validate its field according to business rules.

DELETE
Delete Policy

Deletes the pricing card with the specified id

GET
Get Policy

Returns the pricing card with the specified id

PUT
Update Policy

Updates the pricing card with the specified Id

Requests
GET
Get Deployment Requests

Returns the requests for the deployment.

POST
Submit Deployment Action Request

Submit a deployment action request

GET
Get Request

Returns the request with the given ID.

POST
Action Deployment Request

Cancel can be submitted on In-progress requests and Dismiss can be submitted on Failed requests.

GET
Get Request Events

Returns all the events for a request.

GET
Get Event Logs

Returns the logs for an event.

GET
Get Event Logs Content

Returns the log file for an event.

GET
List Resource Requests

Get all requests for a resource

POST
Submit Resource Action Request

Submit a resource action request.

Resource Actions
GET
Get Resource Actions

Returns the complete list of available actions that can be performed on a given resource.

GET
Get Resource Action

Returns an action for the resource specified by its Resource ID and Action ID.

Resource Types
GET
List Resource Types

Returns a paginated list of Resource Types.

GET
Get Resource Type

Returns the Resource type with the supplied ID.

Resources
GET
Get Resources

Returns a paginated list of resources.

POST
Create Resource

Returns the resource request response.

GET
Get Resource Filters

Returns the Resource filters in context of given user.

GET
Get Resource Filter By Id

Returns the Resource filter with the supplied ID.

GET
Get Resource By Id

Returns the resource with the supplied ID.

User Events
GET
Get User Events

Returns paged user events for given deployment ID. User events represent: Create, Day2, Approval or vRO User Interaction