OpenAPI definition Operations Index

OpenAPI definition Operations Index

All available OpenAPI definition Operations

Catalog Items
GET
Get Catalog Items

Returns a paginated list of catalog items.

GET
Get Catalog Filters

Returns the catalog item filters in context of given user.

GET
Get Catalog Filter By Id

Returns the catalog item filter with the supplied ID.

POST
Assign Catalog Item To Projects

Allows assigning/un-assigning of a global catalog item to other projects in the same organization.

POST
Republish Catalog Item

Updates an existing catalog item.

POST
Unpublish Catalog Item

Unpublishes a catalog item with the specified ID. If content is of type template, unreleases all its versions.

GET
Get Catalog Item

Returns the catalog item with the specified ID.

GET
Geta Catalog Item Form

Retrieves a form for given catalog item

POST
Request Catalog Item Instances

Creates deployments from a catalog item.

GET
Get Versions

Returns a paginated list of catalog item versions.

GET
Get Version By Id

Returns a detailed catalog item version.

GET
Geta Catalog Item Version Form

Retrieves a form for given catalog item version

POST
Publish Catalog Item

Publishes a catalog item and shares it with the members of a specified project.

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 Deployment Action Form

Returns Form for deployment action 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.

GET
Get Resource Action Form 1

Returns Form for 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 V3

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.

DELETE
Delete Deployment

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

GET
Get Deployment By Id V3

Returns the deployment 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

Find all the policies associated with current org.

POST
Create Policy

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

Delete a specified policy corresponding to its unique id.

GET
Get Policy

Find a specific policy based on the input policy id.

Policy Assignments
GET
Get Assignments

Returns a paginated list of policy assignments. This can be filtered by policy Ids, target names, policy types, project ID, or assignment phase.

Policy Assignments Filters
GET
Get Policy Assignment Filter Types

Get policy assignment filter types.

GET
Get Policy Assignment Filter By Id

Get policy assignment filter entries by filter 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.

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.

GET
Get Resource Action Form

Returns Form for 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.

GET
Get Resource By Id

Returns the resource with the supplied ID.

Supervisor Resources
GET
Get Supervisor Resources

Returns a paginated list of supervisor resources. The supported odata fields are kind, name, namespace, and creationTimestamp. OData filtering is not supported

GET
Get Supervisor Resource By Id

Returns a supervisor resource with the specified 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