openapi: 3.0.3 info: title: Harness APIs version: '1.0' description: > The Harness Software Delivery Platform uses OpenAPI Specification v3.0. Harness constantly improves these APIs. Please be aware that some improvements could cause breaking changes. # Introduction The Harness API allows you to integrate and use all the services and modules we provide on the Harness Platform. If you use client-side SDKs, Harness functionality can be integrated with your client-side automation, helping you reduce manual efforts and deploy code faster. For more information about how Harness works, read our [documentation](https://developer.harness.io/docs/getting-started) or visit the [Harness Developer Hub](https://developer.harness.io/). ## How it works The Harness API is a RESTful API that uses standard HTTP verbs. You can send requests in JSON, YAML, or form-data format. The format of the response matches the format of your request. You must send a single request at a time and ensure that you include your authentication key. For more information about this, go to [Authentication](#section/Introduction/Authentication). ## Get started Before you start integrating, get to know our API better by reading the following topics: * [Harness key concepts](https://developer.harness.io/docs/getting-started/learn-harness-key-concepts/) * [Authentication](#section/Introduction/Authentication) * [Requests and responses](#section/Introduction/Requests-and-Responses) * [Common Parameters](#section/Introduction/Common-Parameters-Beta) * [Status Codes](#section/Introduction/Status-Codes) * [Errors](#tag/Error-Response) * [Versioning](#section/Introduction/Versioning-Beta) * [Pagination](#section/Introduction/Pagination-Beta) The methods you need to integrate with depend on the functionality you want to use. Work with your Harness Solutions Engineer to determine which methods you need. ## Authentication To authenticate with the Harness API, you need to: 1. Generate an API token on the Harness Platform. 2. Send the API token you generate in the `x-api-key` header in each request. ### Generate an API token To generate an API token, complete the following steps: 1. Go to the [Harness Platform](https://app.harness.io/). 2. On the left-hand navigation, click **My Profile**. 3. Click **+API Key**, enter a name for your key and then click **Save**. 4. Within the API Key tile, click **+Token**. 5. Enter a name for your token and click **Generate Token**. **Important**: Make sure to save your token securely. Harness does not store the API token for future reference, so make sure to save your token securely before you leave the page. ### Send the API token in your requests Send the token you created in the Harness Platform in the x-api-key header. For example: `x-api-key: YOUR_API_KEY_HERE` ## Requests and Responses The structure for each request and response is outlined in the API documentation. We have examples in JSON and YAML for every request and response. You can use our online editor to test the examples. ## Common Parameters [Beta] | Field Name | Type | Default | Description | |------------|---------|---------|----------------| | identifier | string | none | URL-friendly version of the name, used to identify a resource within it's scope and so needs to be unique within the scope. | | name | string | none | Human-friendly name for the resource. | | org | string | none | Limit to provided org identifiers. | | project | string | none | Limit to provided project identifiers. | | description| string | none | More information about the specific resource. | | tags | map[string]string | none | List of labels applied to the resource. | | order | string | desc | Order to use when sorting the specified fields. Type: enum(asc,desc). | | sort | string | none | Fields on which to sort. Note: Specify the fields that you want to use for sorting. When doing so, consider the operational overhead of sorting fields. | | limit | int | 30 | Pagination: Number of items to return. | | page | int | 1 | Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page. | | created | int64 | none | Unix timestamp that shows when the resource was created (in milliseconds). | | updated | int64 | none | Unix timestamp that shows when the resource was last edited (in milliseconds). | ## Status Codes Harness uses conventional HTTP status codes to indicate the status of an API request. Generally, 2xx responses are reserved for success and 4xx status codes are reserved for failures. A 5xx response code indicates an error on the Harness server. | Error Code | Description | |-------------|-------------| | 200 | OK | | 201 | Created | | 202 | Accepted | | 204 | No Content | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 412 | Precondition Failed | | 415 | Unsupported Media Type | | 500 | Server Error | To view our error response structures, go [here](#tag/Error-Response). ## Versioning [Beta] ### Harness Version The current version of our Beta APIs is yet to be announced. The version number will use the date-header format and will be valid only for our Beta APIs. ### Generation All our beta APIs are versioned as a Generation, and this version is included in the path to every API resource. For example, v1 beta APIs begin with `app.harness.io/v1/`, where v1 is the API Generation. The version number represents the core API and does not change frequently. The version number changes only if there is a significant departure from the basic underpinnings of the existing API. For example, when Harness performs a system-wide refactoring of core concepts or resources. ## Pagination [Beta] We use pagination to place limits on the number of responses associated with list endpoints. Pagination is achieved by the use of limit query parameters. The limit defaults to 30. Its maximum value is 100. Following are the pagination headers supported in the response bodies of paginated APIs: 1. X-Total-Elements : Indicates the total number of entries in a paginated response. 2. X-Page-Number : Indicates the page number currently returned for a paginated response. 3. X-Page-Size : Indicates the number of entries per page for a paginated response. For example: ``` X-Total-Elements : 30 X-Page-Number : 0 X-Page-Size : 10 ``` contact: name: API Support email: contact@harness.io url: https://harness.io/ x-logo: url: >- https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook altText: Harness termsOfService: https://harness.io/terms-of-use/ servers: - url: https://app.harness.io description: Harness host URL - url: https://{vanity} description: Vanity URL variables: vanity: default: app.harness.io externalDocs: description: Find out more about Swagger url: http://swagger.io security: - x-api-key: [] tags: - name: Governance Status description: | - name: Policy description: | - name: Policy Set description: | - name: Governance Metadata description: | x-displayName: Governance Metadata [Beta] - name: Test Error Metadata description: | - name: Error Metadata description: | - name: Field Error description: | - name: Error Response description: | x-displayName: Error Response [Beta] - name: Account Roles description: This contains APIs for Account-scoped Roles. x-displayName: Account Roles [Beta] - name: Organization Roles description: This contains APIs for Organization-scoped Roles. x-displayName: Organization Roles [Beta] - name: Project Roles description: This contains APIs for Project-scoped Roles. x-displayName: Project Roles [Beta] - name: Account Role Assignments description: This contains APIs for Account-scoped Role Assignments. x-displayName: Account Role Assignments [Beta] - name: Org Role Assignments description: This contains APIs for Organization-scoped Role Assignments. x-displayName: Organization Role Assignments [Beta] - name: Project Role Assignments description: This contains APIs for Project-scoped Role Assignments. x-displayName: Project Role Assignments [Beta] - name: Organization description: >- Create and manage organizations in your account. You use organizations to group together related projects. For example, you can use an organization to group together projects within a business unit or division. - name: Org Project description: This contains APIs for projects. x-displayName: Project [Beta] - name: Account Secret description: This contains APIs for account-scoped secrets. x-displayName: Account Secrets [Beta] - name: Org Secret description: This contains APIs for organization-scoped secrets. x-displayName: Organization Secrets [Beta] - name: Project Secret description: This contains APIs for project-scoped secrets. x-displayName: Project Secrets [Beta] - name: Account Services description: This contains APIs for account-scoped services. x-displayName: Account Services [Beta] - name: Org Services description: This contains APIs for organization-scoped services. x-displayName: Organization Services [Beta] - name: Project Services description: This contains APIs for project-scoped services. x-displayName: Project Services [Beta] - name: Project Environments description: This contains APIs for project-scoped environments. x-displayName: Project Environments [Beta] - name: Account Favorites description: This contains APIs for account-scoped Favorites. x-displayName: Account Favorites [Beta] - name: Org Favorites description: This contains APIs for organization-scoped Favorites. x-displayName: Organization Favorites [Beta] - name: Project Favorites description: This contains APIs for project-scoped Favorites. x-displayName: Project Favorites [Beta] - name: Account Rancher Infrastructure description: This contains APIs for Rancher infra entities for account level. x-displayName: Account Rancher Infrastructure [Beta] - name: Org Rancher Infrastructure description: This contains APIs for Rancher infra entities for org level. x-displayName: Org Rancher Infrastructure [Beta] - name: Project Rancher Infrastructure description: This contains APIs for Rancher infra entities for project level. x-displayName: Project Rancher Infrastructure [Beta] - name: K8s Release Service Mapping description: This contains APIs for Fetching Release details regarding a pod. x-displayName: K8s Release Service Mapping [Beta] - name: EULA description: This contains APIs for EULA. x-displayName: EULA [Beta] - name: Account Certificate description: This contains APIs for account-scoped Certificates x-displayName: Account Certificates [Beta] - name: Org Certificate description: This contains APIs for organization-scoped Certificates x-displayName: Org Certificates [Beta] - name: Project Certificate description: This contains APIs for project-scoped Certificates x-displayName: Project Certificates [Beta] - name: IP Allowlist description: This contains APIs for IP Allowlist. x-displayName: IP Allowlist [Beta] - name: GitX Webhooks description: This contains APIs for Account GitX Webhooks. x-displayName: Account GitX Webhooks - name: Org GitX Webhooks description: This contains APIs for Org GitX Webhooks. x-displayName: Org GitX Webhooks - name: Project GitX Webhooks description: This contains APIs for Project GitX Webhooks. x-displayName: Project GitX Webhooks - name: Gitx Webhooks Events description: This contains APIs for Account Gitx Webhooks Events. x-displayName: Account Gitx Webhooks Events - name: Org Gitx Webhooks Events description: This contains APIs for Org Gitx Webhooks Events. x-displayName: Org Gitx Webhooks Events - name: Project Gitx Webhooks Events description: This contains APIs for Project Gitx Webhooks Events. x-displayName: Project Gitx Webhooks Events - name: Account Webhooks description: This contains APIs for Account Webhooks. x-displayName: Account Webhooks - name: Org Webhooks description: This contains APIs for Org Webhooks. x-displayName: Org Webhooks - name: Project Webhooks description: This contains APIs for Project Webhooks. x-displayName: Project Webhooks - name: Account Banner description: This contains APIs for Account Banners. x-displayName: Account Banner - name: Account Licensed Modules description: This contains APIs for Account Licensed Modules. x-displayName: Account Licensed Modules - name: Account Connector description: This contains APIs for Account-scoped Connectors. x-displayName: Account Connectors [Beta] - name: Org Connector description: This contains APIs for Organization-scoped Connectors. x-displayName: Organization Connectors [Beta] - name: Project Connector description: This contains APIs for Project-scoped Connectors. x-displayName: Project Connectors [Beta] - name: Account Resource Groups description: This contains APIs for Account-scoped Resource Groups. x-displayName: Account Resource Groups [Beta] - name: Organization Resource Groups description: This contains APIs for Organization-scoped Resource Groups. x-displayName: Organization Resource Groups [Beta] - name: Project Resource Groups description: This contains APIs for Project-scoped Resource Groups. x-displayName: Project Resource Groups [Beta] - name: Filter Resource Groups description: This contains the filter endpoint for Resource Groups. x-displayName: Filter Resource Groups [Beta] - name: Streaming Destinations description: This contains APIs for Streaming Destinations. - name: Notification Channels description: This contains APIs for Notification Channels - name: Notification Rules description: This contains APIs for Notification Rules - name: Notification Attachments description: This contains APIs for Notification Attachments - name: Pipelines description: This contains APIs for performing CRUD operations on Pipelines. x-displayName: Pipelines [Beta] - name: Input Sets description: This contains APIs for Input Sets. x-displayName: Input Sets [Beta] - name: Approvals description: This contains APIs for Approvals. x-displayName: Approvals - name: Pipeline Execution description: This contains APIs for Pipeline Execution. x-displayName: Pipeline Execution [Beta] - name: Triggers description: This contains APIs for performing CRUD operations on Triggers. x-displayName: Triggers [Beta] - name: Steps description: This contains APIs for Steps. x-displayName: Steps [Beta] - name: Schemas description: This contains APIs for Schemas. x-displayName: Schemas [Beta] - name: Account Template description: This contains APIs for Account-scoped Templates. x-displayName: Account Templates [Beta] - name: Org Template description: This contains APIs for Organization-scoped Templates. x-displayName: Organization Templates [Beta] - name: Project Template description: This contains APIs for Project-scoped Templates. x-displayName: Project Templates [Beta] - name: AccountInfo description: Account Information x-displayName: Account Information - name: AllowList description: Backstage Allow List x-displayName: Backstage Allow List - name: AppConfig description: IDP App Configurations x-displayName: IDP App Configurations - name: AuthInfo description: IDP app Auth Information x-displayName: IDP app Auth Information - name: BackstageEnvVariable description: Backstage Environment Variable x-displayName: Backstage Environment Variable - name: BackstagePermissions description: Backstage Permissions x-displayName: Backstage Permissions - name: ConnectorInfo description: Connector Information x-displayName: Connector Information - name: CatalogCustomProperties description: Catalog Custom Properties x-displayName: Catalog Custom Properties - name: DataSource description: DataSource Information x-displayName: DataSource Information - name: HarnessDataPoints description: Harness DataPoints Information x-displayName: Harness DataPoints Information - name: KubernetesDataPoints description: Kubernetes DataPoints Information x-displayName: Kubernetes DataPoints Information - name: LayoutProxy description: Layout Proxy x-displayName: Layout Proxy - name: LicenseUsageResource description: License Usage Resource x-displayName: License Usage Resource - name: MergedPluginsConfig description: Merged Plugins Configurations x-displayName: Merged Plugins Configurations - name: Namespace description: Backstage Namespace x-displayName: Backstage Namespace - name: OnboardingResource description: Onboarding x-displayName: Onboarding - name: PluginInfo description: Plugin Information x-displayName: Plugin Information - name: Provision description: Provision x-displayName: Provision - name: Scores description: Scores Information x-displayName: Scores Information - name: ScoresV2 description: Scores Information V2 x-displayName: Scores Information V2 - name: StatusInfo description: Status Information x-displayName: Status Information - name: BackstageHarness description: Backstage Harness x-displayName: Backstage Harness - name: Groups description: Groups x-displayName: Groups - name: HomePageLayout description: Home Page Layout x-displayName: Home Page Layout - name: Entities description: >- APIs for managing catalog Entities which represent the core components of your system. Entities can represent services, APIs, user groups, resources, and more. These endpoints allow you to create, retrieve, update, delete, and query entities across different scopes. x-displayName: Entities - name: Teams description: Teams x-displayName: Teams - name: Integrations description: Integrations x-displayName: Integrations - name: AggregationRules description: Aggregation Rules x-displayName: Aggregation Rules - name: Kinds description: This contains APIs for Kinds. x-displayName: Kinds - name: LayoutsV3 description: This contains APIs for LayoutsV3. x-displayName: LayoutsV3 - name: LayoutsV4 description: This contains APIs for LayoutsV4. x-displayName: LayoutsV4 - name: CustomPluginsV2 description: This contains APIs for Custom Plugins V2. x-displayName: CustomPluginsV2 - name: Environment description: The environment service for working with Environment-type infrastructures - name: Infrastructure description: The infrastructure service for working with infrastructures - name: Instance description: The instance service for working with instances - name: Accounts description: This contains APIs related to accounts as defined in Harness - name: Drift Detection description: >- APIs to track drift between the last deployed manifest and the live cluster state - name: EnvironmentGroup description: This contains APIs related to EnvironmentGroup. - name: Usage description: This contains APIs specific to CD license usage - name: Connectors description: This contains APIs related to Connectors as defined in Harness - name: GoogleSecretManagerConnector description: >- This contains APIs specific to Google Secret Manager Connector as defined in Harness - name: MCPConnector description: This contains APIs specific to the MCP Connector as defined in Harness - name: File Store description: This contains APIs related to File Store in Harness - name: Filter description: This contains APIs related to Filter as defined in Harness - name: Git Branches description: Contains APIs related to Git Sync Branch - name: Git Full Sync description: Contains APIs related to Git Full Sync - name: Git Sync Settings description: Contains APIs related to Git Sync Settings - name: SCM description: Contains APIs related to Scm - name: User Source Code Manager description: Contains APIs related to User Source Code Manager - name: Git Sync description: Contains APIs for CRUD on Git Sync - name: Git Sync Errors description: Contains APIs related to Git Sync Errors - name: Nextgen Ldap description: This contains APIs related to Nextgen Ldap as defined in Harness - name: Authentication Settings description: >- This contains APIs related to Authentication settings as defined in Harness - name: AccountSetting description: This contains APIs related to Account Settings as defined in Harness - name: Agent mTLS Endpoint Management description: Contains APIs related to Agent mTLS Endpoint management. - name: CustomDeployment description: This contains APIs related to Custom Deployment - name: Delegate Download Resource description: Contains APIs related to Downloading Delegates - name: Delegate Group Tags Resource description: Contains APIs related to Delegate Group Tags management - name: Delegate Setup Resource description: Contains Delegate Setup APIs - name: Delegate Token Resource description: Contains APIs related to Delegate Token management - name: Environments description: This contains APIs related to Environments - name: Infrastructures description: This contains APIs related to Infrastructure Definitions - name: Invite description: This contains APIs related to Invite as defined in Harness - name: Oidc-Access-Token description: >- This contains APIs related to OIDC Access Token generation as defined in Harness - name: Oidc-ID-Token description: >- This contains APIs related to OIDC ID Token generation as defined in Harness - name: OIDC description: This contains APIs related to the Harness OIDC config - name: Onboarding description: This contains APIs related to platform onboarding flows - name: Provider description: This contains APIs related to Provider - name: ApiKey description: This fetches API keys defined in Harness - name: ValidateHost description: This contains APIs related to SSH or WinRm host validation - name: Keys description: This contains APIs related to Keys as defined in Harness - name: Hosts description: This contains APIs related to Hosts as defined in Harness - name: Secret Managers description: This contains APIs related to SecretManagers as defined in Harness - name: Secrets description: This contains APIs related to Secrets as defined in Harness - name: Project description: This contains APIs related to Project as defined in Harness - name: Token description: This contains APIs related to Token as defined in Harness - name: User Group description: This contains APIs related to User Group as defined in Harness - name: Services description: This contains APIs related to Services - name: Overrides description: This contains APIs related to Overrides - name: ServiceOverrides description: This contains APIs related to Service Overrides V2 - name: SMTP description: This contains APIs related to SmtpConfig as defined in Harness - name: tas description: This contains APIs related to tas - name: User description: This contains APIs related to User as defined in Harness - name: Variables description: This contains APIs related to Variables as defined in Harness. - name: Freeze CRUD description: This contains APIs related to Freeze CRUD - name: Freeze Evaluation description: This contains APIs related to evaluation Freeze status - name: Freeze Schema description: This contains APIs related to construct schema for Freeze - name: Clusters description: This contains APIs related to Gitops Clusters - name: GitOps description: APIs related to GitOps resources - name: Service Dashboard description: This contains APIs related to Service Dashboard - name: Rollback description: This contains APIs related to Post Prod Rollback of specific service - name: Service Account description: This has all the APIs specific to the Service Accounts in Harness. - name: Canny description: This contains APIs required for the creation of Canny tickets - name: Tunneling description: This contains APIs related to tunneling - name: Source Code Manager description: Contains APIs related to Source Code Manager - name: Webhook Event Handler description: Contains APIs corresponding to Webhook Triggers. - name: Setting description: This contains APIs related to Settings as defined in Harness - name: UserSetting description: This contains APIs related to User Settings as defined in Harness - name: TriggersEvents description: This contains APIs related to Trigger Event History. - name: Webhook Triggers description: This contains APIs related to Webhook Triggers. - name: Pipeline Dashboard description: This contains APIs related to Pipeline Dashboard - name: Pipeline data retention description: This contains APIs related to retention of pipeline execution data - name: Pipeline description: >- This contains pipeline APIs for files as provided as runtime input during pipeline execution - name: Pipeline Input Set description: This contains APIs related to Input Sets - name: OrchestrationGovernor description: >- Internal admin API to halt / throttle / resume the pipeline orchestration event flow. - name: Branch Sequences description: APIs for managing branch-scoped build sequence IDs - name: Execution Input description: APIs for runtime execution input on pipeline steps and stages. - name: Pipeline Execution Details description: This contains APIs for fetching Pipeline Execution Details - name: Queued Pipeline Executions description: APIs for observing queued pipeline executions at account level - name: Pipeline Execute description: This contains APIs for Executing a Pipeline - name: Pipeline Refresh description: This contains APIs related to validation of templates in pipeline yaml - name: Access Control List description: This contains the APIs to perform access control checks - name: ManagedRoles description: This contains APIs for CRUD on ManagedRoles - name: Permissions description: This contains the APIs related to permissions - name: Role Assignments description: This contains APIs for CRUD on role assignments - name: Roles description: This contains APIs for CRUD on roles - name: Harness Resource Type description: This contains APIs related to Harness Resource Type - name: Zendesk description: This contains APIs specific to the creation of zendesk ticket - name: Harness Resource Group description: This contains APIs specific to the Harness Resource Group - name: Anomalies Ignorelist Rule description: This contains APIs related to Anomalies Ignorelist Rule Management. - name: Anomalies description: Get details about any anomalous spike in your cloud and AI costs - name: BI Dashboards description: Get details of BI-dashboards specific to CACM - name: Budgets description: Manage Budgets in bulk - name: Budget Groups description: >- Manage Budget Groups and receive alerts when your costs exceed (or are forecasted to exceed) your configured budget group. - name: Cost Categories description: >- Allows you to categorize based on business requirements and get a contextual view of your expenses. - name: Cloud Accounts description: APIs for listing cloud accounts across cloud providers. - name: K8S Connectors Metadata description: Health related metadata for your k8S clusters having cost access enabled. - name: Notification Settings v2 description: Set notification channels to get cloud and AI cost anomaly alerts - name: Overview description: Get overview of CACM features. - name: CACM global cost settings description: Get/set cost preferences for CACM features - name: Data Job Status description: >- Track and monitor the status of data ingestion and processing jobs across your cloud cost data pipeline. - name: Recommendation cost settings description: Get/set cost type preferences for recommendations - name: Unit Metric description: Unit Metric resource. - name: Anomaly Comments description: APIs to manage anomaly comments - name: Cloud and AI cost anomaly details description: Get resource level insights into your cloud and AI cost anomalies - name: Cloud and AI cost anomalies v2 description: Get details about any anomalies in your cloud and AI costs - name: Cost Details description: Fetch cloud and AI cost data for cost analysis - name: Currency Preferences description: >- Select destination currency to view different cloud provider currencies in destination currency - name: External Data Provider description: This contains APIs related to External Data Provider Support for CACM - name: GenAI Traces description: Get GenAI trace summaries and span waterfall data - name: AiEngine description: 'This contains APIs related to Generative AI Support for Governance ' - name: CACM governance cost settings description: Get/set cost type settings for CACM governance - name: Governance Enforcement Recommendation APIs description: This contains APIs related to CACM Governance Enforcement Recommendations - name: Governance Alert description: This contains APIs related to Governance Alert Management - name: Governance Overview description: This contains APIs related to CACM Governance Overview Page - name: Governance Recommendation APIs description: This contains APIs related to CACM Governance Recommendations - name: RuleEnforcement description: 'This contains APIs related to Rule Enforcement ' - name: Rule Executions description: This contains APIs related to Rule Executions - name: Rule description: This contains APIs related to Governance Rule Management - name: Rule Sets description: >- Rule sets serve as logical bindings on top of individual rules that help you organize and manage rules. - name: Perspectives Folders description: >- Group your Perspectives using Folders in ways that are more meaningful to your business needs. - name: Perspective Reports description: Manage cost reports created on Perspectives. - name: Perspectives description: >- Group your resources using Perspectives in ways that are more meaningful to your business needs. - name: Cost Category Jira Project Mapping description: Cost Category Jira Project Mapping CRUD APIs. - name: Recommendations Details description: Recommendations details for workloads and node pools. - name: Recommendations description: Recommendations for workloads and node pools. - name: Recommendation Jira description: Recommendation CRUD apis for jira. - name: Recommendation Preferences description: Recommendation apis for recommendations preferences. - name: Recommendation Presets description: Recommendation apis for recommendations presets. - name: Recommendation Servicenow description: Recommendation CRUD apis for servicenow. - name: Recommendation Tags description: Recommendation apis for recommendations tags. - name: Recommendation Ignore List description: Recommendation CRUD apis for recommendations ignore list. - description: APIs to create and manage Feature Flag SDK API Keys name: API Keys - description: APIs to create and manage Feature Flags name: Feature Flags - description: APIs to create and manage Feature Flag Targets name: Targets - description: APIs to create and manage Feature Flag Target Groups name: Target Groups - description: APIs to create and manage Feature Flag Tags name: Tags - description: APIs used by the ff-proxy name: Proxy - description: APIs to create and manage Feature Flag Environment perspectives name: Environment Perspectives - description: APIS to create and manage Target Group Attributes name: Attributes - name: AutoStopping Rules description: >- This contains APIs to create and manage AutoStopping Rules for your cloud resources. - name: AutoStopping Rules V2 description: >- This contains Autostopping v2 APIs that support the usage of Autostopping Proxy for managing cloud resources. - name: AutoStopping Load Balancers description: >- This contains APIs to create and manage load balancers used for AutoStopping. - name: AutoStopping Fixed Schedules description: This contains APIs to manage fixed schedules for the AutoStopping Rules. - name: Cluster Orchestrator description: >- This contains APIs to onboard and manage Cluster Orchestrator for Kubernetes - name: AutoStopping Alerts description: >- This contains APIs to create and manage alerts for AutoStopping events and notifications. - name: Commitment Orchestrator Events APIs description: This contains APIs to fetch commitment orchestrator events data. - name: AuditFilters description: This contains APIs related to Filter of type Audit as defined in Harness - name: Audit description: This contains APIs related to Audit as defined in Harness - name: AuditYaml description: This contains APIs related to Audit Yaml as defined in Harness - name: Global Templates description: This contains a list of APIs specific to the Global Templates - name: Templates description: >- This contains a list of APIs specific to the Templates Validations and Refresh - name: Template Schemas description: This contains a list of APIs specific to the Template Schemas - name: Monitored Services description: This contains APIs related to CRUD operations of Monitored Services - name: Downtime description: This contains APIs related to CRUD operations of Downtime - name: Srm Notification description: This contains APIs related to CRUD operations of srm notifications - name: SLOs dashboard description: This contains APIs related to SLOs dashboard - name: NG SLOs description: This contains APIs related to CRUD operations of SLOs (simple & composite) - name: SLOs description: This contains APIs related to CRUD operations of SLOs - name: Healthsources description: This contains APIs related to CV Health Sources - name: aida description: AIDA API's for Harness OPA - name: dashboard description: >- Aggregate summary of policies, policy sets and evaluations for display on the dashboard - name: examples description: Example rego policies and corresponding input - name: policies description: Create, edit and delete Governance policies written in rego - name: evaluate description: Perform evaluations - name: evaluations description: Access evaluation results - name: policysets description: Create, edit and delete Governance policy sets - name: system description: System version and health - description: APIs to create, update, list registries name: Registries - description: APIs to get, list artifacts name: Artifacts - description: APIs to get details of docker artifacts name: Docker Artifacts - description: APIs to get details of helm artifacts name: Helm Artifacts - description: APIs to create, update, list webhooks name: Webhooks - description: registry V2 endpoints name: Registry V2 - description: V3 registries endpoints name: Registry V3 - Registries - description: V3 packages endpoints name: Registry V3 - Packages - description: V3 versions endpoints name: Registry V3 - Versions - description: V3 files endpoints name: Registry V3 - Files - description: V3 metadata endpoints name: Registry V3 - Metadata - description: V3 firewall endpoints name: Registry V3 - Firewall - description: V3 transfer endpoints name: Registry V3 - Transfer - description: V3 system-level endpoints for registry configuration and discovery name: Registry V3 - System - description: V3 lifecycle rule endpoints name: Registry V3 - Lifecycle - description: V3 internal admin endpoints for search backfill name: Registry V3 - Internal - description: V3 principal endpoints name: Registry V3 - Principal - name: approvals description: >- Approval service handles the approval API to approve or reject pipeline executions - name: ccm_costs description: CCM Costs Service returns cloud cost management summaries for workspaces. - name: costs description: >- Costs Service handles the API related with the costs attached to workspaces. This API is read only as all the cost are generated in the plugin side - name: insights description: Insights Service lists insights for a workspace. - name: migration description: Migration Service handles one-off connector and template migrations. - name: module-registry description: >- The module-registry service is a private registry for Terraform/Opentofu modules - name: provider-registry description: >- The provider-registry service implements HashiCorp's Provider Registry Protocol for private Terraform providers - name: provisioner_activities description: >- Provisioner Activities Service handles the API for managing provisioner activity lifecycle. This API provides explicit start and complete endpoints for provisioner operations (CDK, Terraform). - name: remediation description: Remediation service handles the API for AI-powered drift remediation runs - name: remediation-agent description: Project-level remediation agent configuration - name: activities description: Activities Service handles the API for workspace activities - name: executions description: >- Executions Service handles the API for workflow executions. At this time it is a read-only API with no ability to directly create or edit executions. Instead these are triggered from the Workspaces Service. - name: settings description: >- Settings service handles all API endpoints related to configuration settings - name: tf-standard-backend description: HTTP standard backend for Terraform - name: unified-executions description: >- Unified Executions Service handles the API for unified workflow executions. - name: usage description: Usage service handles licencing - name: variable_sets description: >- Variable Sets Service handles the API for managing variable sets assigned to workspaces. - name: workspace_templates description: >- Workspace Templates Service handles the API for managing template associations with workspaces. - name: workspaces description: |- Workspaces Service handles the API for managing workspaces and triggering workflows against them. - name: variables description: Variables Service handles the API for managing workspace variables. - name: ansible description: Ansible Service handles the API for ansible entities. - name: ExemptionRules description: Manage admin-defined rules that gate Exemption creation - name: Exemptions description: Access and modify Exemptions to Security Issues - name: FpTriage description: Agent ingest endpoints for the FP Triage agent's pre- and post-plugins - name: pipeline-security description: Pipeline Security API for STO - name: Products description: Access Scan Tool information - name: Pull Requests description: Access and Modify Pull Requests - name: Qwiet description: Qwiet/ShiftLeft integration endpoints - name: RemediationAgent description: Agent ingest endpoints for the remediation agent's pre- and post-plugins - name: System description: Unauthenticated support endpoints - name: Repositories description: Read APIs backing the STO Target Code Repositories page. - name: Target Variants description: Access and modify Scan Target Variants - name: Frontend description: Endpoints that power the STO micro-frontend - name: Issues description: Access and modify Security Issues - name: Scans description: Access and modify Security Test Scans - name: STO Data Frontend description: Endpoints that power the other modules micro-frontend with STO data - name: Test Targets description: Access and modify Scan Targets - name: Reference Identifiers description: Reference Identifiers Lookup - description: >- This contains APIs for performing CRUD operations on Database Schema Entity name: Database Schema x-displayName: Database Schema - description: This contains APIs for getting Migration State of Database Schema Entity name: Migration State x-displayName: Migration State - description: >- This contains APIs for performing CRUD operations on Database Instance Entity name: Database Instance x-displayName: Database Instance - description: This contains APIs for managing database snapshots and snapshot metadata name: Database Snapshot x-displayName: Database Snapshot - description: >- This contains APIs for creating and retrieving database migration log information name: Log Ingest x-displayName: Log Ingest - description: This contains APIs for Pipeline Plugin Inputs name: Pipeline Step x-displayName: Pipeline Step - description: This contains APIs for tracking changeSet deployment status name: Deployed State x-displayName: Deployed State - description: This contains APIs for execution config for image tags name: Execution Config x-displayName: Execution Config - name: Collection categories description: This contains APIs specific to the Collection categories - name: Collections description: This contains APIs specific to Collections - name: Contributors description: This contains APIs specific to the Contributors - name: DORA description: This contains APIs specific to the DORA reports - name: orchestration description: This contains APIs for SBOM. x-displayName: SBOM (SSCA) - name: Release Groups x-displayName: Release Groups [Beta] - name: Releases x-displayName: Releases [Beta] - name: Orchestration Processes x-displayName: Orchestration Processes [Beta] - name: Orchestration Activities x-displayName: Orchestration Activities [Beta] - name: Orchestration Executions x-displayName: Orchestration Executions [Beta] - name: Conflicts x-displayName: Conflicts [Beta] - name: Freeze x-displayName: Freeze [Beta] - name: Reports x-displayName: Reports [Beta] - name: Uploads x-displayName: Uploads [Beta] paths: /v1/roles: parameters: [] get: summary: List Roles operationId: list-roles-acc description: Returns a list of Roles present in the Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' responses: '200': $ref: '#/components/responses/RolesListResponse' tags: - Account Roles post: summary: Create a Role operationId: create-role-acc description: Creates a custom Role in the Account scope. parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateRoleRequest' responses: '201': $ref: '#/components/responses/RoleResponse' security: - x-api-key: [] tags: - Account Roles /v1/public-access/enable: parameters: [] post: summary: Enable Public Access for a Resource operationId: enable-public-access description: Enable Public Access for a Resource parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/PublicAccessRequest' responses: '201': $ref: '#/components/responses/PublicAccessResponse' security: - x-api-key: [] x-internal: false tags: - Public Access /v1/analyze-access-policies: parameters: [] post: summary: Analyze access policies within account operationId: analyze-account-access-policies description: Analyze access policies within account parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' requestBody: $ref: '#/components/requestBodies/AccessPolicyAnalysisRequest' responses: '200': $ref: '#/components/responses/AccessPolicyAnalysisResponse' security: - x-api-key: [] x-internal: false tags: - Analyze Account Access Policy /v1/orgs/{org}/analyze-access-policies: parameters: - $ref: '#/components/parameters/OrgParam' post: summary: Analyze access policies within a organization operationId: analyze-org-access-policies description: Analyze access policies within a organization parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' requestBody: $ref: '#/components/requestBodies/AccessPolicyAnalysisRequest' responses: '200': $ref: '#/components/responses/AccessPolicyAnalysisResponse' security: - x-api-key: [] x-internal: false tags: - Analyze Organization Access Policy /v1/orgs/{org}/projects/{project}/analyze-access-policies: parameters: - name: org in: path required: true schema: type: string description: Organization identifier - $ref: '#/components/parameters/ProjectParam' post: summary: Analyze access policies within a project operationId: analyze-project-access-policies description: Analyze access policies within a project parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' requestBody: $ref: '#/components/requestBodies/AccessPolicyAnalysisRequest' responses: '200': $ref: '#/components/responses/AccessPolicyAnalysisResponse' security: - x-api-key: [] x-internal: false tags: - Analyze Project Access Policy /v1/public-access/is-resource-public: parameters: [] post: summary: Returns if a Resource is public or not operationId: is-resource-public description: 'Returns if a Resource is public or not ' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/PublicAccessRequest' responses: '200': $ref: '#/components/responses/PublicAccessResponse' security: - x-api-key: [] tags: - Public Access x-internal: true /v1/public-access/check-public: parameters: [] post: summary: Returns if a list of Resource is public or not operationId: check-public description: 'Returns if a list of Resources is public or not ' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/PublicAccessCheckRequest' responses: '200': $ref: '#/components/responses/PublicAccessCheckResponse' security: - x-api-key: [] tags: - Public Access x-internal: true /v1/public-access/disable: parameters: [] put: summary: Disable public access on a Resource operationId: disable-public-access responses: '200': $ref: '#/components/responses/PublicAccessResponse' description: Disable Public Access security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: string in: query name: account description: Account Identifier - schema: type: string in: query name: org description: Organisation Identifier - schema: type: string in: query name: project description: Project Identifier - schema: type: string in: query name: resource_type description: Resource type - schema: type: string in: query name: resource_identifier description: Resource Identifier tags: - Public Access x-internal: true /v1/roles/{role}: parameters: - $ref: '#/components/parameters/RoleParam' get: summary: Retrieve a Role responses: '200': $ref: '#/components/responses/RoleResponse' operationId: get-role-acc description: Retrieves a Role from Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Roles put: summary: Update a Role operationId: update-role-acc responses: '200': $ref: '#/components/responses/RoleResponse' description: Updates a Role from Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateRoleRequest' tags: - Account Roles delete: summary: Delete a Role operationId: delete-role-acc responses: '200': $ref: '#/components/responses/RoleResponse' description: Deletes a custom Role from Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Roles /v1/orgs/{org}/roles: parameters: - $ref: '#/components/parameters/OrgParam' get: summary: List Roles tags: - Organization Roles responses: '200': $ref: '#/components/responses/RolesListResponse' operationId: list-roles-org description: Returns a list of Roles present in the Organization scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' post: summary: Create a Role operationId: create-role-org responses: '201': $ref: '#/components/responses/RoleResponse' description: Creates a custom Role in the Organization scope. security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/CreateRoleRequest' parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Organization Roles /v1/orgs/{org}/roles/{role}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/RoleParam' get: summary: Retrieve a Role responses: '200': $ref: '#/components/responses/RoleResponse' operationId: get-role-org description: Retrieves a Role from Organization scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Organization Roles put: summary: Update a Role operationId: update-role-org responses: '200': $ref: '#/components/responses/RoleResponse' description: Updates a Role from Organization scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateRoleRequest' tags: - Organization Roles delete: summary: Delete a Role operationId: delete-role-org responses: '200': $ref: '#/components/responses/RoleResponse' description: Deletes a custom Role from Organization scope. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Organization Roles /v1/orgs/{org}/projects/{project}/roles: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' get: summary: List Roles responses: '200': $ref: '#/components/responses/RolesListResponse' operationId: list-roles-project description: Returns a list of Roles present in the Project scope. parameters: - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' security: - x-api-key: [] tags: - Project Roles post: summary: Create a Role operationId: create-role-project responses: '201': $ref: '#/components/responses/RoleResponse' description: Creates a custom Role in the Project scope. security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/CreateRoleRequest' parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Project Roles /v1/orgs/{org}/projects/{project}/roles/{role}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/RoleParam' get: summary: Retrieve a Role responses: '200': $ref: '#/components/responses/RoleResponse' operationId: get-role-project security: - x-api-key: [] description: Retrieves a Role from Project scope. parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Project Roles put: summary: Update a Role operationId: update-role-project responses: '200': $ref: '#/components/responses/RoleResponse' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/CreateRoleRequest' description: Updates a Role from Project scope. tags: - Project Roles parameters: - $ref: '#/components/parameters/AccountHeader' delete: summary: Delete a Role operationId: delete-role-project responses: '200': $ref: '#/components/responses/RoleResponse' description: Deletes a custom Role from Project scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Project Roles /v1/role-assignments: get: summary: List role assignments tags: - Account Role Assignments responses: '200': $ref: '#/components/responses/RoleAssignmentListResponse' operationId: get-account-scoped-role-assignments description: Retrieves the information of the role assignments parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' security: - x-api-key: [] post: summary: Create a role assignment operationId: create-account-scoped-role-assignments responses: '201': $ref: '#/components/responses/RoleAssignmentResponse' description: Create a role assignment parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Role Assignments requestBody: $ref: '#/components/requestBodies/RoleAssignmentRequest' security: - x-api-key: [] /v1/role-assignments/{role-assignment}: parameters: - schema: type: string name: role-assignment in: path required: true description: Role assignment identifier get: summary: Retrieve a role assignment tags: - Account Role Assignments responses: '200': $ref: '#/components/responses/RoleAssignmentResponse' operationId: get-account-scoped-role-assignment description: >- Retrieves the information of the role assignment with the matching role assignment identifier. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] delete: summary: Delete a role assignment operationId: delete-account-scoped-role-assignment responses: '200': $ref: '#/components/responses/RoleAssignmentResponse' description: >- Deletes the information of the role assignment with the matching role assignment identifier. parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Role Assignments security: - x-api-key: [] /v1/orgs/{org}/role-assignments: get: summary: List role assignments tags: - Org Role Assignments responses: '200': $ref: '#/components/responses/RoleAssignmentListResponse' operationId: get-org-scoped-role-assignments description: Retrieves the information of the role assignments parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' security: - x-api-key: [] post: summary: Create a role assignment operationId: create-org-scoped-role-assignments responses: '201': $ref: '#/components/responses/RoleAssignmentResponse' description: Create a role assignment parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Role Assignments requestBody: $ref: '#/components/requestBodies/RoleAssignmentRequest' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgParam' /v1/orgs/{org}/role-assignments/{role-assignment}: parameters: - schema: type: string name: role-assignment in: path required: true description: Role assignment identifier - $ref: '#/components/parameters/OrgParam' get: summary: Retrieve a role assignment tags: - Org Role Assignments responses: '200': $ref: '#/components/responses/RoleAssignmentResponse' operationId: get-org-scoped-role-assignment description: >- Retrieves the information of the role assignment with the matching role assignment identifier. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] delete: summary: Delete a role assignment operationId: delete-org-scoped-role-assignment responses: '200': $ref: '#/components/responses/RoleAssignmentResponse' description: >- Deletes the information of the role assignment with the matching role assignment identifier. parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Role Assignments security: - x-api-key: [] /v1/orgs/{org}/projects/{project}/role-assignments: get: summary: List role assignments tags: - Project Role Assignments responses: '200': $ref: '#/components/responses/RoleAssignmentListResponse' operationId: get-project-scoped-role-assignments description: Retrieves the information of the role assignments parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' security: - x-api-key: [] post: summary: Create a role assignment operationId: create-project-scoped-role-assignments responses: '201': $ref: '#/components/responses/RoleAssignmentResponse' description: Create a role assignment parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Project Role Assignments requestBody: $ref: '#/components/requestBodies/RoleAssignmentRequest' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' /v1/orgs/{org}/projects/{project}/role-assignments/{role-assignment}: parameters: - schema: type: string name: role-assignment in: path required: true description: Role assignment identifier - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' get: summary: Retrieve a role assignment tags: - Project Role Assignments responses: '200': $ref: '#/components/responses/RoleAssignmentResponse' operationId: get-project-scoped-role-assignment description: >- Retrieves the information of the role assignment with the matching role assignment identifier. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] delete: summary: Delete a role assignment operationId: delete-project-scoped-role-assignment responses: '200': $ref: '#/components/responses/RoleAssignmentResponse' description: >- Deletes the information of the role assignment with the matching role assignment identifier. parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Project Role Assignments security: - x-api-key: [] /v1/role-assignments/count: get: summary: Get role assignments count for an account tags: - Account Role Assignments responses: '200': description: Role assignments count for the account. content: application/json: schema: type: integer format: int32 operationId: get-role-assignments-count x-stoplight: id: 7roi0ybzyljem parameters: - $ref: '#/components/parameters/AccountHeader' description: Get role assignments count for an account. x-internal: true security: - x-api-key: [] /v1/roles/count: get: summary: Get roles count for an account tags: - Account Roles responses: '200': description: Roles count for the account. content: application/json: schema: type: integer format: int32 operationId: get-roles-count x-stoplight: id: 7roi0ybzyljem parameters: - $ref: '#/components/parameters/AccountHeader' description: Get roles count for an account. x-internal: true security: - x-api-key: [] /v1/orgs/{org}/projects/{project}/services/{service}: get: summary: Retrieve a service operationId: get-service parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified service security: - x-api-key: [] responses: '200': $ref: '#/components/responses/ServiceResponse' tags: - Project Services parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/ServicePathParam' put: summary: Update Service operationId: update-service responses: '200': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/ServiceUpdateRequest' description: Updates the specified service security: - x-api-key: [] tags: - Project Services delete: summary: Delete a Service operationId: delete-service responses: '200': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested service. security: - x-api-key: [] tags: - Project Services /v1/orgs/{org}/projects/{project}/services: get: summary: List Services responses: '200': $ref: '#/components/responses/ServiceListResponse' operationId: get-services parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/ServiceIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list of services that you are permitted to use in a pipeline. - $ref: '#/components/parameters/DeploymentType' - schema: type: boolean name: git_ops_enabled in: query description: Enables you to use the service in Harness GitOps PR pipelines. - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the services for which you have view permissions in the given project. tags: - Project Services post: summary: Create a Service operationId: create-service responses: '201': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/ServiceCreateRequest' description: Creates a service security: - x-api-key: [] tags: - Project Services parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' /v1/orgs/{org}/services/{service}: get: summary: Retrieve a service operationId: get-org-scoped-service parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified service security: - x-api-key: [] responses: '200': $ref: '#/components/responses/ServiceResponse' tags: - Org Services parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ServicePathParam' put: summary: Update Service operationId: update-org-scoped-service responses: '200': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/ServiceUpdateRequest' description: Updates the specified service security: - x-api-key: [] tags: - Org Services delete: summary: Delete a service operationId: delete-org-scoped-service responses: '200': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested service security: - x-api-key: [] tags: - Org Services /v1/orgs/{org}/services: get: summary: List Services responses: '200': $ref: '#/components/responses/ServiceListResponse' operationId: get-org-scoped-services parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/ServiceIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list of services that you are permitted to use in a pipeline. - $ref: '#/components/parameters/DeploymentType' - schema: type: boolean name: git_ops_enabled in: query description: Enables you to use the service in Harness GitOps PR pipelines. - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the services for which you have view permissions in the given project. tags: - Org Services post: summary: Create a service operationId: create-org-scoped-service responses: '201': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/ServiceCreateRequest' description: Creates a service security: - x-api-key: [] tags: - Org Services parameters: - $ref: '#/components/parameters/OrgPathParam' /v1/services/{service}: get: summary: Retrieve a service operationId: get-account-scoped-service parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified service security: - x-api-key: [] responses: '200': $ref: '#/components/responses/ServiceResponse' tags: - Account Services parameters: - $ref: '#/components/parameters/ServicePathParam' put: summary: Update service operationId: update-account-scoped-service responses: '200': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/ServiceUpdateRequest' description: Updates the specified service security: - x-api-key: [] tags: - Account Services delete: summary: Delete a service operationId: delete-account-scoped-service responses: '200': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested service security: - x-api-key: [] tags: - Account Services /v1/services: get: summary: List services responses: '200': $ref: '#/components/responses/ServiceListResponse' operationId: get-account-scoped-services parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/ServiceIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list of services that you are permitted to use in a pipeline. - $ref: '#/components/parameters/DeploymentType' - schema: type: boolean name: git_ops_enabled in: query description: Enables you to use the service in Harness GitOps PR pipelines. - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the services for which you have view permissions in the given project. tags: - Account Services post: summary: Create a service operationId: create-account-scoped-service responses: '201': $ref: '#/components/responses/ServiceResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/ServiceCreateRequest' description: Creates a service security: - x-api-key: [] tags: - Account Services parameters: [] /v1/creditOverUsage/{accountIdentifier}: get: summary: Get over usage count of Credits for a given account tags: - Credits OverUsage Data By Account responses: '200': $ref: '#/components/schemas/CreditOverUsage' '400': headers: {} description: '' content: application/json: schema: type: object properties: {} operationId: credits-overusage x-internal: false security: - bearerAuth: [] parameters: - name: accountIdentifier in: path required: true description: Account Identifier for the Entity. schema: type: string /v1/subscription/{accountIdentifier}: get: summary: Retrieve type of licenses for an account tags: - Account License Type operationId: get-license-type responses: '200': $ref: '#/components/schemas/LicenseTypeResponse' '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-internal: false security: - bearerAuth: [] parameters: - name: accountIdentifier in: path required: true description: Account Identifier for the Entity. schema: type: string /v1/subscription/devops/{accountIdentifier}: get: summary: >- Get subscriptions information for the Devops Essentials package for an accountIdentifier. tags: - Devops Essentials License Data By Account responses: '200': $ref: '#/components/schemas/DevopsEssentialsResponse' '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-internal: false operationId: get-devops-essentials-license security: - bearerAuth: [] parameters: - name: accountIdentifier in: path required: true description: Account Identifier for the Entity. schema: type: string /v1/orgs: post: summary: Create an organization [Beta] operationId: create-organization responses: '201': $ref: '#/components/responses/OrganizationResponse' description: Creates a new organization. security: - x-api-key: [] tags: - Organization requestBody: $ref: '#/components/requestBodies/CreateOrganizationRequest' parameters: - $ref: '#/components/parameters/AccountHeader' get: summary: List organizations [Beta] operationId: get-organizations responses: '200': $ref: '#/components/responses/OrganizationListResponse' description: Retrieves the information of the organizations. security: - x-api-key: [] tags: - Organization parameters: - $ref: '#/components/parameters/OrgsQueryParam' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' parameters: [] /v1/orgs/{org}: parameters: - schema: type: string name: org in: path required: true description: Organization identifier get: summary: Retrieve an organization [Beta] responses: '200': $ref: '#/components/responses/OrganizationResponse' operationId: get-organization description: >- Retrieves the information of the organization with the matching organization identifier. security: - x-api-key: [] tags: - Organization parameters: - $ref: '#/components/parameters/AccountHeader' put: summary: Update an organization [Beta] operationId: update-organization responses: '200': $ref: '#/components/responses/OrganizationResponse' description: >- Updates the information of the organization with the matching organization identifier. security: - x-api-key: [] tags: - Organization requestBody: $ref: '#/components/requestBodies/UpdateOrganizationRequest' parameters: - $ref: '#/components/parameters/AccountHeader' delete: summary: Delete an organization [Beta] operationId: delete-organization responses: '200': $ref: '#/components/responses/OrganizationResponse' description: >- Deletes the information of the organization with the matching organization identifier. security: - x-api-key: [] tags: - Organization parameters: - $ref: '#/components/parameters/AccountHeader' /v1/orgs/{org}/projects: post: summary: Create a project responses: '201': $ref: '#/components/responses/ProjectResponse' operationId: create-org-scoped-project security: - x-api-key: [] description: Creates a new project requestBody: $ref: '#/components/requestBodies/CreateProjectRequest' parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Project get: summary: List projects responses: '200': $ref: '#/components/responses/ProjectListResponse' operationId: get-org-scoped-projects description: Retrieves the information of the projects. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/ProjectsQueryParam' - schema: type: boolean default: true in: query name: has_module description: >- This boolean specifies whether to filter projects which has the module of type passed in the moduleType parameter or not - schema: type: string in: query name: module_type description: Project's module type - $ref: '#/components/parameters/onlyFavorites' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' tags: - Org Project parameters: - $ref: '#/components/parameters/OrgPathParam' /v1/orgs/{org}/projects/{project}: get: summary: Retrieve a project responses: '200': $ref: '#/components/responses/ProjectResponse' operationId: get-org-scoped-project description: >- Retrieves the information of the project with the matching project identifier. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Project put: summary: Update a project responses: '200': $ref: '#/components/responses/ProjectResponse' operationId: update-org-scoped-project description: >- Updates the information of the project with the matching project identifier. security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/UpdateProjectRequest' parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Project delete: summary: Delete a project responses: '200': $ref: '#/components/responses/ProjectResponse' operationId: delete-org-scoped-project description: >- Deletes the information of the project with the matching project identifier. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Project parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' /v1/ip-allowlist: post: summary: Create a IP Allowlist config operationId: create-ip-allowlist-config responses: '201': $ref: '#/components/responses/IPAllowlistConfigResponse' description: Creates a new IP Allowlist config parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/IPAllowlistConfigRequest' tags: - IP Allowlist x-internal: false get: summary: List IP Allowlist Configs operationId: get-ip-allowlist-configs responses: '200': $ref: '#/components/responses/IPAllowlistConfigListResponse' description: Retrieves the information of the IP Allowlist Config parameters: - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' - schema: type: string in: query description: This is to filter IP allowlist configs only blocked from UI or API name: allowed_source_type security: - x-api-key: [] tags: - IP Allowlist x-internal: false parameters: [] /v1/ip-allowlist/{ip-config-identifier}: get: summary: Retrieve a IP Allowlist config operationId: get-ip-allowlist-config parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified IP Allowlist config security: - x-api-key: [] responses: '200': $ref: '#/components/responses/IPAllowlistConfigResponse' tags: - IP Allowlist x-internal: false parameters: - schema: type: string name: ip-config-identifier in: path required: true put: summary: Update IP Allowlist config operationId: update-ip-allowlist-config responses: '200': $ref: '#/components/responses/IPAllowlistConfigResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/IPAllowlistConfigRequest' description: Updates the specified IP Allowlist config security: - x-api-key: [] tags: - IP Allowlist x-internal: false delete: summary: Delete an IP Allowlist config operationId: delete-ip-allowlist-config responses: '204': description: No Content parameters: - $ref: '#/components/parameters/AccountHeader' description: Deletes the specified IP Allowlist config security: - x-api-key: [] tags: - IP Allowlist x-internal: false /v1/ip-allowlist/validate-unique-identifier/{ip-config-identifier}: get: summary: Validate unique IP Allowlist config identifier operationId: validate-unique-ip-allowlist-config-identifier description: Checks whether the IP Allowlist config identifier is unique or not parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - IP Allowlist x-internal: false responses: '200': $ref: '#/components/responses/IPAllowlistValidateUniqueIdentifierResponse' parameters: - schema: type: string name: ip-config-identifier in: path required: true /v1/ip-allowlist/validate/ip-address: get: summary: Validate IP address lies in a specified range or not operationId: validate-ip-address-allowlisted-or-not responses: '200': $ref: '#/components/responses/IPAllowlistConfigValidateResponse' description: >- Checks whether the IP address is allowed or not. It also supports checking against a specific IP block range. parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: string in: query name: ip_address description: This is the IP address that needs to be checked if allowed or not required: true - schema: type: string in: query name: custom_ip_address_block description: >- This is the IP address or block of IP address against which we need to verify if a given IP address is allowed or not. If not passed we do the validation against the IP configs within Harness. - schema: type: boolean default: false in: query name: include_disabled_configs description: >- This setting controls the visibility of IP allowlist configurations. When set to 'true', it displays both enabled and disabled configurations. When set to 'false' or left unset, it displays only the enabled configurations. allowReserved: false security: - x-api-key: [] tags: - IP Allowlist x-internal: false parameters: [] /v1/ip-allowlist/allowed/ip-address: get: summary: Check if IP address is allowed or not operationId: allowed-ip-address responses: '200': $ref: '#/components/responses/IPAllowlistConfigValidateResponse' description: Checks whether the IP address is allowed or not. parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: string in: query name: ip_address description: This is the IP address that needs to be checked if allowed or not required: true security: - x-api-key: [] tags: - IP Allowlist x-internal: true parameters: [] /v1/secrets: post: summary: Create a secret operationId: create-account-scoped-secret responses: '201': $ref: '#/components/responses/SecretResponse' description: Creates a new secret parameters: - $ref: '#/components/parameters/PrivateSecret' - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/SecretRequest' tags: - Account Secret get: summary: List secrets operationId: get-account-scoped-secrets responses: '200': $ref: '#/components/responses/SecretListResponse' description: Retrieves the information of the secrets. parameters: - schema: type: array items: type: string in: query name: secret description: Identifier field of secrets - schema: type: array items: type: string enum: - SSHKeyPath - SSHKeyReference - SSHPassword - SSHKerberosTGTKeyTabFile - SSHKerberosTGTPassword - SecretFile - SecretText - WinRmTGTKeyTabFile - WinRmTGTPassword - WinRmNTLM in: query name: type description: Secret types on which the filter will be applied - schema: type: boolean default: false in: query name: recursive description: 'Expand current scope to include all child scopes ' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' tags: - Account Secret security: - x-api-key: [] parameters: [] /v1/secrets/validate-secret-ref: post: summary: Validate secret reference operationId: validate-account-secret-ref description: Validates if the secret at the secretManager path can be referenced parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Account Secret requestBody: $ref: '#/components/requestBodies/SecretValidationRequest' responses: '200': $ref: '#/components/responses/SecretValidationResponse' parameters: [] /v1/orgs/{org}/secrets: parameters: - $ref: '#/components/parameters/OrgPathParam' post: summary: Create a secret operationId: create-org-scoped-secret responses: '201': $ref: '#/components/responses/SecretResponse' description: Creates a new secret requestBody: $ref: '#/components/requestBodies/SecretRequest' parameters: - $ref: '#/components/parameters/PrivateSecret' - $ref: '#/components/parameters/AccountHeader' tags: - Org Secret security: - x-api-key: [] get: summary: List secrets operationId: get-org-scoped-secrets responses: '200': $ref: '#/components/responses/SecretListResponse' description: Retrieves the information of the secrets. parameters: - schema: type: array items: type: string in: query name: secret description: Identifier field of secrets - schema: type: array items: type: string enum: - SSHKeyPath - SSHKeyReference - SSHPassword - SSHKerberosTGTKeyTabFile - SSHKerberosTGTPassword - SecretFile - SecretText - WinRmTGTKeyTabFile - WinRmTGTPassword - WinRmNTLM in: query name: type description: Secret types on which the filter will be applied - schema: type: boolean default: false in: query name: recursive description: 'Expand current scope to include all child scopes ' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' tags: - Org Secret security: - x-api-key: [] /v1/orgs/{org}/secrets/validate-secret-ref: post: summary: Validate secret reference operationId: validate-org-secret-ref description: Validates if the secret at the secretManager path can be referenced parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/SecretValidationRequest' responses: '200': $ref: '#/components/responses/SecretValidationResponse' tags: - Org Secret parameters: - schema: type: string name: org in: path required: true description: Identifier field of the organization the resource is scoped to /v1/orgs/{org}/projects/{project}/secrets: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' post: summary: Create a secret operationId: create-project-scoped-secret responses: '201': $ref: '#/components/responses/SecretResponse' description: Creates a new secret requestBody: $ref: '#/components/requestBodies/SecretRequest' parameters: - $ref: '#/components/parameters/PrivateSecret' - $ref: '#/components/parameters/AccountHeader' tags: - Project Secret security: - x-api-key: [] get: summary: List secrets operationId: get-project-scoped-secrets responses: '200': $ref: '#/components/responses/SecretListResponse' description: Retrieves the information of the secrets. parameters: - schema: type: array items: type: string in: query name: secret description: Identifier field of secrets - schema: type: array items: type: string enum: - SSHKeyPath - SSHKeyReference - SSHPassword - SSHKerberosTGTKeyTabFile - SSHKerberosTGTPassword - SecretFile - SecretText - WinRmTGTKeyTabFile - WinRmTGTPassword - WinRmNTLM in: query name: type description: Secret types on which the filter will be applied - schema: type: boolean default: false in: query name: recursive description: 'Expand current scope to include all child scopes ' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' tags: - Project Secret security: - x-api-key: [] /v1/orgs/{org}/projects/{project}/secrets/validate-secret-ref: post: summary: Validate secret reference operationId: validate-project-secret-ref description: Validates if the secret at the secretManager path can be referenced parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/SecretValidationRequest' responses: '200': $ref: '#/components/responses/SecretValidationResponse' tags: - Project Secret parameters: - schema: type: string name: org in: path required: true description: Identifier field of the organization the resource is scoped to - schema: type: string name: project in: path required: true description: Identifier field of the project to which the resource is scoped. /v1/secrets/{secret}: parameters: - schema: type: string name: secret in: path required: true description: Identifier field of the secret get: summary: Retrieve a secret responses: '200': $ref: '#/components/responses/SecretResponse' operationId: get-account-scoped-secret description: Retrieves the information of the secret. parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Secret security: - x-api-key: [] delete: summary: Deletes a secret tags: - Account Secret operationId: delete-account-scoped-secret responses: '200': $ref: '#/components/responses/SecretResponse' description: >- Deletes the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] put: summary: Update a secret operationId: update-account-scoped-secret responses: '200': $ref: '#/components/responses/SecretResponse' description: >- Updates the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Secret requestBody: $ref: '#/components/requestBodies/SecretRequest' security: - x-api-key: [] /v1/orgs/{org}/secrets/{secret}: parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: secret in: path required: true description: Identifier field of the secret get: summary: Retrieve a secret tags: - Org Secret responses: '200': $ref: '#/components/responses/SecretResponse' operationId: get-org-scoped-secret description: Retrieves the information of the secret. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] delete: summary: Delete a secret tags: - Org Secret operationId: delete-org-scoped-secret responses: '200': $ref: '#/components/responses/SecretResponse' description: >- Deletes the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] put: summary: Update a secret operationId: update-org-scoped-secret responses: '200': $ref: '#/components/responses/SecretResponse' description: >- Updates the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/SecretRequest' tags: - Org Secret security: - x-api-key: [] /v1/orgs/{org}/projects/{project}/secrets/{secret}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - schema: type: string name: secret in: path required: true description: Identifier field of the secret get: summary: Retrieve a secret tags: - Project Secret responses: '200': $ref: '#/components/responses/SecretResponse' operationId: get-project-scoped-secret description: Retrieves the information of the secret. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] delete: summary: Delete a secret tags: - Project Secret operationId: delete-project-scoped-secret responses: '200': $ref: '#/components/responses/SecretResponse' description: >- Deletes the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] put: summary: Update a secret operationId: update-project-scoped-secret responses: '200': $ref: '#/components/responses/SecretResponse' description: >- Updates the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/SecretRequest' tags: - Project Secret security: - x-api-key: [] /v1/favorites: post: summary: Create a favorite at account level operationId: create-account-favorite description: Creates favorite resource of a user at account level requestBody: $ref: '#/components/requestBodies/FavoriteRequest' parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] responses: '201': $ref: '#/components/responses/FavoriteResponse' tags: - Account Favorites x-internal: true /v1/favorites/{user-id}: parameters: - $ref: '#/components/parameters/UserIdPathParam' get: summary: Retrieve a favorite resources of a user at account level operationId: get-account-favorites parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ResourceType' description: Retrieves the favorite resource of a user at account level security: - x-api-key: [] responses: '200': $ref: '#/components/responses/FavoriteListResponse' tags: - Account Favorites x-internal: true delete: summary: Delete a account level favorite operationId: delete-account-favorite responses: '204': description: No Content parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ResourceType' - $ref: '#/components/parameters/ResourceId' security: - x-api-key: [] tags: - Account Favorites description: Deletes the requested favorite at account level. x-internal: true /v1/orgs/{org}/favorites: parameters: - $ref: '#/components/parameters/OrgPathParam' post: summary: Create a favorite at org level operationId: create-org-favorite description: Creates favorite resource of a user at organisation level requestBody: $ref: '#/components/requestBodies/FavoriteRequest' parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] responses: '201': $ref: '#/components/responses/FavoriteResponse' tags: - Org Favorites x-internal: true /v1/orgs/{org}/favorites/{user-id}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/UserIdPathParam' get: summary: Retrieve a favorite resources of a user at organization level operationId: get-org-favorites parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ResourceType' description: Retrieves the favorite resource of a user at organization level security: - x-api-key: [] responses: '200': $ref: '#/components/responses/FavoriteListResponse' tags: - Org Favorites x-internal: true delete: summary: Delete a org level favorite operationId: delete-org-favorite responses: '204': description: No Content parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ResourceType' - $ref: '#/components/parameters/ResourceId' description: Deletes the requested favorite at organization level. security: - x-api-key: [] tags: - Org Favorites x-internal: true /v1/orgs/{org}/projects/{project}/favorites: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' post: summary: Create a favorite at project level operationId: create-project-favorite description: Creates favorite resource of a user at project level requestBody: $ref: '#/components/requestBodies/FavoriteRequest' parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] responses: '201': $ref: '#/components/responses/FavoriteResponse' tags: - Project Favorites x-internal: true /v1/orgs/{org}/projects/{project}/favorites/{user-id}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/UserIdPathParam' get: summary: Retrieve a favorite resources of a user at project level operationId: get-project-favorites parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ResourceType' description: Retrieves the favorite resource of a user at project level security: - x-api-key: [] responses: '200': $ref: '#/components/responses/FavoriteListResponse' tags: - Project Favorites x-internal: true delete: summary: Delete a project level favorite operationId: delete-project-favorite responses: '204': description: No Content parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ResourceType' - $ref: '#/components/parameters/ResourceId' description: Deletes the requested favorite at project level. security: - x-api-key: [] tags: - Project Favorites x-internal: true /v1/module-versions: get: summary: List Module Versions tags: - Module Versions responses: '200': $ref: '#/components/responses/ModuleVersionsListResponse' operationId: list-module-versions description: Lists Versions of different Modules. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' x-internal: true /v1/rancher/connectors/{connector}/clusters: parameters: - $ref: '#/components/parameters/ConnectorPathParam' get: summary: List rancher clusters using account level connector tags: - Account Rancher Infrastructure responses: '200': $ref: '#/components/responses/RancherListClustersResponse' operationId: list-account-scoped-rancher-clusters-using-connector description: List rancher clusters using the given account level rancher connector parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' security: - x-api-key: [] /v1/orgs/{org}/rancher/connectors/{connector}/clusters: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ConnectorPathParam' get: summary: List rancher clusters using org level connector tags: - Org Rancher Infrastructure responses: '200': $ref: '#/components/responses/RancherListClustersResponse' operationId: list-org-scoped-rancher-clusters-using-connector parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: List rancher clusters using the given org level rancher connector /v1/orgs/{org}/projects/{project}/rancher/connectors/{connector}/clusters: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/ConnectorPathParam' get: summary: List rancher clusters using project level connector tags: - Project Rancher Infrastructure responses: '200': $ref: '#/components/responses/RancherListClustersResponse' operationId: list-project-scoped-rancher-clusters-using-connector parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: List rancher clusters using the given project level rancher connector /v1/rancher/environments/{environment}/infrastructure-definitions/{infrastructure-definition}/clusters: parameters: - $ref: '#/components/parameters/EnvironmentPathParam' - $ref: '#/components/parameters/InfrastructureDefinitionPathParam' get: summary: List rancher clusters using account level env and infra def tags: - Account Rancher Infrastructure responses: '200': $ref: '#/components/responses/RancherListClustersResponse' operationId: list-account-scoped-rancher-clusters-using-env-and-infra parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- List rancher clusters using the given account level environment and infrastructure definition. /v1/orgs/{org}/rancher/environments/{environment}/infrastructure-definitions/{infrastructure-definition}/clusters: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' - $ref: '#/components/parameters/InfrastructureDefinitionPathParam' get: summary: List rancher clusters using org level env and infra def tags: - Org Rancher Infrastructure responses: '200': $ref: '#/components/responses/RancherListClustersResponse' operationId: list-org-scoped-rancher-clusters-using-env-and-infra parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- List rancher clusters using the given org level environment and infrastructure definition. /v1/orgs/{org}/projects/{project}/rancher/environments/{environment}/infrastructure-definitions/{infrastructure-definition}/clusters: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' - $ref: '#/components/parameters/InfrastructureDefinitionPathParam' get: summary: List rancher clusters using project level env and infra def tags: - Project Rancher Infrastructure responses: '200': $ref: '#/components/responses/RancherListClustersResponse' operationId: list-project-scoped-rancher-clusters-using-env-and-infra parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- List rancher clusters using the given project level environment and infrastructure definition. /v1/orgs/{org}/projects/{project}/services/{service}/primary-manifests: parameters: - $ref: '#/components/parameters/ServicePathParam' - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' get: summary: List primary manifests of a project scoped service responses: '200': $ref: '#/components/responses/ManifestsResponseDTO' operationId: get-primary-manifests description: >- Returns a list of eligible primary manifests from all configured manifest in a project-scoped service. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Project Services x-internal: true post: summary: List primary manifests of a project scoped service responses: '200': $ref: '#/components/responses/ManifestsResponseDTO' description: >- Returns a list of eligible primary manifests from all configured manifest in a project-scoped service. operationId: post-primary-manifests parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/GitEntityFindInfoRequestBody' security: - x-api-key: [] tags: - Project Services x-internal: true /v1/orgs/{org}/services/{service}/primary-manifests: parameters: - $ref: '#/components/parameters/ServicePathParam' - $ref: '#/components/parameters/OrgPathParam' get: summary: List primary manifests of a org scoped service responses: '200': $ref: '#/components/responses/ManifestsResponseDTO' operationId: get-org-scoped-primary-manifests description: >- Returns a list of eligible primary manifests from all configured manifest in an org-scoped service. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Org Services x-internal: true post: summary: List primary manifests of a org scoped service responses: '200': $ref: '#/components/responses/ManifestsResponseDTO' description: >- Returns a list of eligible primary manifests from all configured manifest in an org-scoped service. operationId: post-org-scoped-primary-manifests parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/GitEntityFindInfoRequestBody' security: - x-api-key: [] tags: - Org Services x-internal: true /v1/services/{service}/primary-manifests: parameters: - $ref: '#/components/parameters/ServicePathParam' get: summary: List primary manifests of a account scoped service responses: '200': $ref: '#/components/responses/ManifestsResponseDTO' operationId: get-account-scoped-primary-manifests description: >- Returns a list of eligible primary manifests from all configured manifest in an account-scoped service. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Account Services x-internal: true post: summary: List primary manifests of a account scoped service responses: '200': $ref: '#/components/responses/ManifestsResponseDTO' description: >- Returns a list of eligible primary manifests from all configured manifest in an account-scoped service. operationId: post-account-scoped-primary-manifests parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/GitEntityFindInfoRequestBody' security: - x-api-key: [] tags: - Account Services x-internal: true /v1/eula/sign: post: summary: Sign an End User License Agreement operationId: sign-eula responses: '200': $ref: '#/components/responses/EulaSignResponse' description: Sign an End User License Agreement. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/EulaSignRequest' tags: - EULA x-internal: false /v1/eula/validate-sign: get: summary: Validate specified agreement is signed or not operationId: validate-eula-sign parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/AgreementType' description: >- Check whether End User License Agreement has been signed for specified agreement type. security: - x-api-key: [] responses: '200': $ref: '#/components/responses/EulaSignResponse' tags: - EULA x-internal: false /v1/gitx-webhooks: post: summary: Create a GitX webhook at Account level operationId: create-gitx-webhook responses: '201': $ref: '#/components/responses/CreateGitXWebhookResponse' description: Create GitXWebhook at account level security: - x-api-key: [] tags: - GitX Webhooks parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateGitXWebhookRequest' x-internal: false get: summary: Lists all the GitX Webhooks at Account level operationId: list-gitx-webhooks responses: '200': $ref: '#/components/responses/ListGitXWebhookResponse' description: List GitX webhooks security: - x-api-key: [] tags: - GitX Webhooks parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - schema: type: string in: query name: webhook_identifier x-internal: false /v1/gitx-webhooks/{gitx-webhook}: parameters: - $ref: '#/components/parameters/GitXWebhookIdentifier' get: summary: Fetch GitX Webhook at Account level responses: '200': $ref: '#/components/responses/GetGitXWebhookResponse' operationId: get-gitx-webhook description: Fetch a gitx webhook x-internal: false security: - x-api-key: [] tags: - GitX Webhooks parameters: - $ref: '#/components/parameters/AccountHeader' put: summary: Updates a GitX Webhook at Account level operationId: update-gitx-webhook responses: '200': $ref: '#/components/responses/UpdateGitXWebhookResponse' security: - x-api-key: [] tags: - GitX Webhooks description: Update a Gitx webhook requestBody: $ref: '#/components/requestBodies/UpdateGitXWebhookRequest' x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader' delete: summary: Deletes a GitX Webhook at Account level operationId: delete-gitx-webhook responses: '204': description: No Content description: Deletes a gitx webhooks security: - x-api-key: [] tags: - GitX Webhooks parameters: - $ref: '#/components/parameters/AccountHeader' x-internal: false /v1/gitx-webhook-events: get: summary: Lists all the GitX Webhooks events at Account level tags: - GitX Webhooks responses: '200': $ref: '#/components/responses/ListGitXWebhookEventResponse' operationId: list-gitx-webhook-events description: List GitX webhook Events security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - schema: type: string in: query name: webhook_identifier - schema: type: integer format: int64 in: query name: event_start_time - schema: type: integer format: int64 in: query name: event_end_time - schema: type: string in: query name: repo_name - schema: type: string in: query name: file_path - schema: type: string in: query name: event_identifier - schema: type: array items: type: string enum: - SKIPPED - FAILED - PROCESSING - SUCCESSFUL - QUEUED - WARNING - UNKNOWN in: query name: event_status - schema: type: string in: query name: connector_ref - schema: type: boolean in: query name: include_parent_scope - schema: type: string in: query name: commit_id - schema: type: string in: query name: branch x-internal: true /v1/kubernetes/releases/service-mapping: get: summary: List service and environment details using namespace and releasename tags: - K8s Release Service Mapping responses: '200': $ref: '#/components/responses/ReleaseDetailsResponse' operationId: get-v1-releaseDetails description: >- Return details of service and environment mapped to pods namespace and release-name for a given account. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/BatchReleaseDetailsRequest' x-internal: true post: summary: List service and environment details using namespace and releasename tags: - K8s Release Service Mapping responses: '200': $ref: '#/components/responses/ReleaseDetailsResponse' operationId: post-v1-releaseDetails description: >- Return details of service and environment mapped to pods namespace and release-name for a given account. parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/BatchReleaseDetailsRequest' x-internal: false parameters: [] /v1/orgs/{org}/gitx-webhooks: parameters: - $ref: '#/components/parameters/OrgPathParam' get: summary: Lists all the GitX Webhooks at Org level tags: - Org Gitx Webhooks responses: '200': $ref: '#/components/responses/ListGitXWebhookResponse' operationId: list-org-gitx-webhooks description: List org level GitX webhooks security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - schema: type: string in: query name: webhook_identifier x-internal: false post: summary: Create Org Level GitX webhook operationId: create-org-gitx-webhook responses: '200': $ref: '#/components/responses/CreateGitXWebhookResponse' description: Create GitXWebhook at org level tags: - Org Gitx Webhooks x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateGitXWebhookRequest' /v1/orgs/{org}/gitx-webhooks/{gitx-webhook}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/GitXWebhookIdentifier' get: summary: Fetch GitX Webhook at org level tags: - Org Gitx Webhooks responses: '200': $ref: '#/components/responses/GetGitXWebhookResponse' operationId: get-org-gitx-webhook description: Fetch a org level gitx webhook parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] x-internal: false put: summary: Updates a GitX Webhook at org level operationId: update-org-gitx-webhook responses: '200': $ref: '#/components/responses/UpdateGitXWebhookResponse' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' description: Update a org level Gitx webhook requestBody: $ref: '#/components/requestBodies/UpdateGitXWebhookRequest' tags: - Org Gitx Webhooks x-internal: false delete: summary: Deletes a GitX Webhook at org level operationId: delete-org-gitx-webhook responses: '204': description: No Content description: Deletes a org level gitx webhooks security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Gitx Webhooks x-internal: false /v1/orgs/{org}/gitx-webhook-events: parameters: - $ref: '#/components/parameters/OrgPathParam' get: summary: Lists all the GitX Webhooks events at org level responses: '200': $ref: '#/components/responses/ListGitXWebhookEventResponse' operationId: list-org-gitx-webhook-events security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - schema: type: string in: query name: webhook_identifier - schema: type: integer format: int64 in: query name: event_start_time - schema: type: integer format: int64 in: query name: event_end_time - schema: type: string in: query name: repo_name - schema: type: string in: query name: file_path - schema: type: string in: query name: event_identifier - schema: type: array items: type: string enum: - SKIPPED - FAILED - PROCESSING - SUCCESSFUL - QUEUED - UNKNOWN in: query name: event_status - schema: type: string in: query name: connector_ref - schema: type: boolean in: query name: include_parent_scope - schema: type: string in: query name: commit_id - schema: type: string in: query name: branch tags: - Org Gitx Webhooks Events x-internal: true description: List GitX webhook Events at org level /v1/orgs/{org}/projects/{project}/gitx-webhooks: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' get: summary: Lists all the GitX Webhooks at project level tags: - Project Gitx Webhooks responses: '200': $ref: '#/components/responses/ListGitXWebhookResponse' operationId: list-project-gitx-webhook security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - schema: type: string in: query name: webhook_identifier description: List project level GitX webhooks x-internal: false post: summary: Create Project level GitX webhook operationId: create-project-gitx-webhook responses: '200': $ref: '#/components/responses/CreateGitXWebhookResponse' description: Create GitXWebhook at project level requestBody: $ref: '#/components/requestBodies/CreateGitXWebhookRequest' parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Project Gitx Webhooks /v1/orgs/{org}/projects/{project}/gitx-webhooks/{gitx-webhook}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/GitXWebhookIdentifier' get: summary: Fetch GitX Webhook at project level tags: - Project Gitx Webhooks responses: '200': $ref: '#/components/responses/GetGitXWebhookResponse' operationId: get-project-gitx-webhook x-internal: false description: Fetch a project level gitx webhook security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' put: summary: Updates a GitX Webhook at project level operationId: update-project-gitx-webhook responses: '200': $ref: '#/components/responses/UpdateGitXWebhookResponse' description: Update a project level Gitx webhook security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateGitXWebhookRequest' tags: - Project Gitx Webhooks x-internal: false delete: summary: Deletes a GitX Webhook at project level operationId: delete-project-gitx-webhook responses: '204': description: No Content description: Deletes a project level gitx webhooks tags: - Project Gitx Webhooks x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' /v1/orgs/{org}/projects/{project}/gitx-webhook-events: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' get: summary: Lists all the GitX Webhooks events at project level tags: - Project Gitx Webhooks Events responses: '200': $ref: '#/components/responses/ListGitXWebhookEventResponse' operationId: list-project-gitx-webhook-events security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - schema: type: string in: query name: webhook_identifier - schema: type: integer format: int64 in: query name: event_start_time - schema: type: integer format: int64 in: query name: event_end_time - schema: type: string in: query name: repo_name - schema: type: string in: query name: file_path - schema: type: string in: query name: event_identifier - schema: type: array items: type: string enum: - SKIPPED - FAILED - PROCESSING - SUCCESSFUL - QUEUED - UNKNOWN in: query name: event_status - schema: type: string in: query name: connector_ref - schema: type: boolean in: query name: include_parent_scope - schema: type: string in: query name: commit_id - schema: type: string in: query name: branch x-internal: true description: List GitX webhook Events at project level /v1/gitx-webhook-events/{gitx-webhook-event}: parameters: - schema: type: string name: gitx-webhook-event in: path required: true description: GitX Webhook Event Identifier patch: summary: Update the Webhook Event status operationId: patch-gitx-webhook-events-gitx-webhook-event responses: '200': $ref: '#/components/responses/UpdateGitXWebhookEventResponse' x-internal: true description: Update the webhook event Status tags: - GitX Webhook Event security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateGitXWebhookEventRequest' /v1/certificates/{certificate}: get: summary: Retrieves the specified Certificate in account scope tags: - Account Certificate responses: '200': $ref: '#/components/responses/CertificateResponse' operationId: get-account-scoped-certificate description: Retrieves the specified certificate in account scope x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' parameters: - schema: type: string name: certificate in: path required: true description: Identifier field of the certificate put: summary: Updates the specified Certificate in account scope operationId: update-account-scoped-certificate responses: '200': $ref: '#/components/responses/CertificateResponse' description: Updates the specified Certificate in account scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Certificate x-internal: true requestBody: $ref: '#/components/requestBodies/UpdateCertificateRequest' delete: summary: Deletes the specified Certificate from account scope operationId: delete-account-scoped-certificate responses: '204': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} description: Deletes the specified Certificate from account scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' x-internal: true tags: - Account Certificate /v1/orgs/{org}/certificates/{certificate}: get: summary: Retrieves the specified Certificate in organization scope responses: '200': $ref: '#/components/responses/CertificateResponse' operationId: get-org-scoped-certificate description: Retrieves the specified certificate in org scope x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Certificate parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: certificate in: path required: true description: Identifier field of the certificate put: summary: Updates the specified Certificate in org scope operationId: update-org-scoped-certificate responses: '200': $ref: '#/components/responses/CertificateResponse' x-internal: true description: Updates the specified Certificate in org scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateCertificateRequest' tags: - Org Certificate delete: summary: Deletes the specified Certificate from org scope operationId: delete-org-scoped-certificate responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} description: Deletes the specified Certificate from org scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' x-internal: true tags: - Org Certificate /v1/orgs/{org}/projects/{project}/certificates/{certificate}: get: summary: Retrieves the specified Certificate in project scope responses: '200': $ref: '#/components/responses/CertificateResponse' operationId: get-project-scoped-certificate description: Retrieves the specified certificate in project scope x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Project Certificate parameters: - schema: type: string name: certificate in: path required: true description: Identifier field of the certificate - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' put: summary: Updates the specified Certificate in project scope operationId: update-project-scoped-certificate responses: '200': $ref: '#/components/responses/CertificateResponse' description: Updates the specified Certificate in project scope tags: - Project Certificate security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateCertificateRequest' x-internal: true delete: summary: Deletes the specified Certificate from project scope operationId: delete-project-scoped-certificate responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} description: Deletes the specified Certificate from project scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' x-internal: true tags: - Project Certificate /v1/certificates/validate-unique-identifier/{certificate}: get: summary: >- Validate if the specified Certificate identifier is available for use in account scope tags: - Account Certificate responses: '200': $ref: '#/components/responses/CertificateValidateUniqueIdentifierResponse' operationId: validate-account-scoped-certificate-identifier description: >- Validate if the specified certificate identifier is available for use in account scope x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' parameters: - schema: type: string name: certificate in: path required: true description: Identifier field of the certificate /v1/orgs/{org}/certificates/validate-unique-identifier/{certificate}: get: summary: >- Validate if the specified Certificate identifier is available for use in organization scope responses: '200': $ref: '#/components/responses/CertificateValidateUniqueIdentifierResponse' operationId: validate-org-scoped-certificate-identifier description: >- Validate if the specified certificate identifier is available for use in organization scope x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Org Certificate parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: certificate in: path required: true description: Identifier field of the certificate /v1/orgs/{org}/projects/{project}/certificates/validate-unique-identifier/{certificate}: get: summary: >- Validate if the specified Certificate identifier is available for use in project scope responses: '200': $ref: '#/components/responses/CertificateValidateUniqueIdentifierResponse' operationId: validate-project-scoped-certificate-identifier description: >- Validate if the specified certificate identifier is available for use in project scope x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Project Certificate parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - schema: type: string name: certificate in: path required: true description: Identifier field of the certificate /v1/certificates: get: summary: Retrieves the list of Certificates in account scope tags: - Account Certificate responses: '200': $ref: '#/components/responses/CertificateListResponse' operationId: get-account-scoped-certificates description: Retrieves the list of certificates in account scope x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' - schema: type: boolean default: 'false' in: query name: include_all_available_at_scope description: Include all entities accessible at current scope post: summary: Creates a new Certificate in account scope operationId: create-account-scoped-certificates responses: '201': $ref: '#/components/responses/CertificateResponse' description: Creates a new certificate in account scope parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Certificate security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/CreateCertificateRequest' x-internal: true /v1/orgs/{org}/certificates: parameters: - $ref: '#/components/parameters/OrgPathParam' get: summary: Retrieves the list of Certificates in organization scope tags: - Org Certificate responses: '200': $ref: '#/components/responses/CertificateListResponse' operationId: get-org-scoped-certificates x-internal: true description: Retrieves the list of certificates in organization scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' - schema: type: boolean default: 'false' in: query name: include_all_available_at_scope description: Include all entities accessible at current scope post: summary: Creates a new Certificate in organization scope operationId: create-org-scoped-certificates responses: '201': $ref: '#/components/responses/CertificateResponse' description: Creates a new certificate in organization scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateCertificateRequest' x-internal: true tags: - Org Certificate /v1/orgs/{org}/projects/{project}/certificates: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' get: summary: Retrieves the list of Certificates in project scope tags: - Project Certificate responses: '200': $ref: '#/components/responses/CertificateListResponse' operationId: get-project-scoped-certificates description: Retrieves the list of certificates in project scope x-internal: true parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' - schema: type: boolean default: 'false' in: query description: Include all entities accessible at current scope name: include_all_available_at_scope security: - x-api-key: [] post: summary: Creates a new Certificate in project scope operationId: create-project-scoped-certificates responses: '201': $ref: '#/components/responses/CertificateResponse' description: Creates a new certificate in project scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateCertificateRequest' x-internal: true tags: - Project Certificate /v1/banners: get: summary: Retrieves the list of Banners in account scope tags: - Account Banner responses: '200': $ref: '#/components/responses/BannerListResponse' operationId: get-account-scoped-banners x-stoplight: id: ld5yy1r4xvhtt description: Retrieves the list of Banners in account scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' - schema: type: string enum: - 'true' - 'false' in: query name: enabled description: Show banners with enabled field filtering allowEmptyValue: true post: summary: Creates a new Banner in account scope operationId: create-account-scoped-banners x-stoplight: id: 7qljrrvy7z0ha responses: '201': $ref: '#/components/responses/BannerResponse' parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/CreateBannerRequest' description: Creates a new Banner in Account Scope. tags: - Account Banner /v1/banners/validate-unique-identifier/{bannerId}: parameters: - schema: type: string name: bannerId in: path required: true description: Identifier field of the BannerDTO get: summary: >- Validate if the specified Banner identifier is available for use in account scope tags: - Account Banner responses: '200': $ref: '#/components/responses/BannerBooleanResponse' operationId: validate-account-scoped-banner-identifier parameters: - $ref: '#/components/parameters/AccountHeader' description: >- Validate if the specified BannerDTO identifier is available for use in account scope security: - x-api-key: [] /v1/banners/allowed: get: summary: Check for a current account max 5 banners are enabled or not tags: - Account Banner responses: '200': $ref: '#/components/responses/BannerBooleanResponse' operationId: banners-allowed description: Check for a current account max 5 banners are enabled or not. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' /v1/ldap-settings: post: summary: Create Account LDAP Settings operationId: create-ng-ldap-settings responses: '201': $ref: '#/components/responses/LdapSettingsResponse' x-stoplight: id: n04275yl5c0g3 description: Create NG Ldap setttings parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/LdapSettingsRequest' tags: - Ldap Settings parameters: [] get: summary: Get ldap settings for the account tags: - ldap-settings responses: '200': $ref: '#/components/responses/LdapSettingsResponse' operationId: get-account-ldap-settings x-stoplight: id: x58m09htlk67j security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' /v1/ldap-settings/{ldap-settings-id}: parameters: - schema: type: string name: ldap-settings-id in: path required: true get: summary: Get Account Ldap Settings by identifier tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LdapSettingsResponse' operationId: get-ldap-settings x-stoplight: id: 9655d1754op9c description: Get Account NG Ldap settings parameters: - $ref: '#/components/parameters/AccountHeader' put: summary: Update Account Ldap Settings operationId: update-ldap-settings responses: '200': $ref: '#/components/responses/LdapSettingsResponse' x-stoplight: id: 63u2f75vg76gz description: Update NG Ldap settings for the account requestBody: $ref: '#/components/requestBodies/LdapSettingsRequest' tags: - Ldap Settings parameters: - $ref: '#/components/parameters/AccountHeader' delete: summary: Delete Account Ldap Settings operationId: delete-ldap-settings responses: '204': description: No Content x-stoplight: id: hw0azqcr4ehs9 description: 'Delete Account Ldap settings ' parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Ldap Settings /v1/ldap-settings/validate/connection-settings: post: summary: Validate Ldap Connection Settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LdapValidateResponse' operationId: validate-connection-settings x-stoplight: id: 24rd6s9hp2b0a parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/LdapSettingsRequest' /v1/ldap-settings/validate/user-settings: post: summary: Validate Ldap User Settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LdapValidateResponse' operationId: validate-user-settings x-stoplight: id: 5fw3lcfs79wpo parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/LdapSettingsRequest' /v1/ldap-settings/validate/group-settings: post: summary: Validate Ldap Group Settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LdapValidateResponse' operationId: validate-group-settings x-stoplight: id: uvedvfpk6ldue parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/LdapSettingsRequest' /v1/ldap-settings/sync-groups: put: summary: Ldap Settings Sync User Groups operationId: ldap-settings-sync-groups responses: '200': description: OK x-stoplight: id: 7xnw3fstsnqe7 parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Ldap Settings /v1/ldap-settings/sync-group/{group-id}: parameters: - $ref: '#/components/parameters/UserGroupIdentifierPathParam' get: summary: Ldap Sync Group with user group id tags: - Ldap Settings responses: '200': description: OK operationId: ldap-settings-sync-group-with-id x-stoplight: id: el2bfbrc5mubt description: Ldap Sync Group with user group id parameters: - $ref: '#/components/parameters/AccountHeader' /v1/ldap-settings/search-group/{group-id}: parameters: - $ref: '#/components/parameters/UserGroupIdentifierPathParam' get: summary: Search Ldap groups with matching name tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LdapGroupResponse' operationId: ldap-settings-search-group x-stoplight: id: xkgeu3g9n1ul2 parameters: - $ref: '#/components/parameters/AccountHeader' /v1/ldap-settings/link/{group-id}: parameters: - $ref: '#/components/parameters/UserGroupIdentifierPathParam' post: summary: Link ldap settings to userGroup responses: '200': $ref: '#/components/responses/LinkGroupToLdapSettings' operationId: link-ldap-settings x-stoplight: id: 02mvlbq51owqg tags: - Ldap Settings security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' x-internal: true requestBody: $ref: '#/components/requestBodies/LinkSSOGroupRequest' /v1/ldap-settings/unlink/{group-id}: parameters: - $ref: '#/components/parameters/UserGroupIdentifierPathParam' post: summary: Unlink group from ldap settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/UnlinkGroupToLdapSettings' operationId: unlink-ldap-settings x-stoplight: id: jsug66jtmolab x-internal: true x-extension-1: null parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UnlinkSSOGroupRequest' /v1/ldap-settings/unlink/orgs/{org}/{group-id}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/UserGroupIdentifierPathParam' post: summary: Unlink SSO Group from ldap-settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/UnlinkGroupToLdapSettings' operationId: unlink-ldap-settings-org x-stoplight: id: 2aznpzh987hr7 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' x-internal: true requestBody: $ref: '#/components/requestBodies/UnlinkSSOGroupRequest' /v1/ldap-settings/link/orgs/{org}/{group-id}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/UserGroupIdentifierPathParam' get - copy: summary: Link ldap settings tags: [] responses: '200': $ref: '#/components/responses/LinkGroupToLdapSettings' operationId: link-ldap-settings-proj x-internal: true x-extension-1: null parameters: - $ref: '#/components/parameters/AccountHeader' post: summary: Link dap settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LinkGroupToLdapSettings' operationId: link-ldap-settings-org x-stoplight: id: 86uren6k078bj security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' x-internal: true requestBody: $ref: '#/components/requestBodies/LinkSSOGroupRequest' /v1/ldap-settings/unlink/orgs/{org}/projects/{project}/{group-id}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/UserGroupIdentifierPathParam' post: summary: Unlink SSO Group from ldap-settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/UnlinkGroupToLdapSettings' operationId: unlink-ldap-settings-proj x-stoplight: id: us9tp7838hrh2 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' x-internal: true requestBody: $ref: '#/components/requestBodies/UnlinkSSOGroupRequest' /v1/ldap-settings/link/orgs/{org}/projects/{project}/{group-id}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/UserGroupIdentifierPathParam' post: summary: Link ldap-settings tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LinkGroupToLdapSettings' operationId: link-ldap-settings-proj x-stoplight: id: dqjjk8ekm6qwl security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' x-internal: true requestBody: $ref: '#/components/requestBodies/LinkSSOGroupRequest' /v1/orgs/{org}/projects/{project}/environments: post: summary: Creates an Environment operationId: create-environment responses: '201': $ref: '#/components/responses/EnvironmentResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/EnvironmentCreateRequest' description: Creates an Environment security: - x-api-key: [] tags: - Project Environments x-internal: false parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' get: summary: List Environments responses: '200': $ref: '#/components/responses/EnvironmentListResponse' operationId: get-environments parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/EnvironmentIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list of environments that you are permitted to use in a pipeline. - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the enviornments for which you have view permissions in the given project. tags: - Project Environments /v1/orgs/{org}/projects/{project}/environments/{environment}: get: summary: Retrieve a environment operationId: get-environment parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified environment security: - x-api-key: [] responses: '200': $ref: '#/components/responses/EnvironmentResponse' tags: - Project Environments parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' put: summary: Update Environment operationId: update-environment responses: '200': $ref: '#/components/responses/EnvironmentResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/EnvironmentUpdateRequest' description: Updates the specified environment security: - x-api-key: [] tags: - Project Environments delete: summary: Delete a Environment operationId: delete-environment responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested environment security: - x-api-key: [] tags: - Project Environments /v1/orgs/{org}/environments: post: summary: Creates an org scoped Environment operationId: create-org-scoped-environment responses: '201': $ref: '#/components/responses/EnvironmentResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/EnvironmentCreateRequest' description: Creates an org scoped Environment security: - x-api-key: [] tags: - Org Environments x-internal: false parameters: - $ref: '#/components/parameters/OrgPathParam' get: summary: List org scoped Environments responses: '200': $ref: '#/components/responses/EnvironmentListResponse' operationId: get-org-scoped-environments parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/EnvironmentIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list org scoped of environments that you are permitted to use in a pipeline. - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the org scoped environments for which you have view permissions in the given org. tags: - Org Environments /v1/orgs/{org}/environments/{environment}: get: summary: Retrieve an org scoped environment operationId: get-org-scoped-environment parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified org scoped environment security: - x-api-key: [] responses: '200': $ref: '#/components/responses/EnvironmentResponse' tags: - Org Environments parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' put: summary: Update org scoped Environment operationId: update-org-scoped-environment responses: '200': $ref: '#/components/responses/EnvironmentResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/EnvironmentUpdateRequest' description: Updates the specified org scoped environment security: - x-api-key: [] tags: - Org Environments delete: summary: Delete an org scoped Environment operationId: delete-org-scoped-environment responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested org scoped environment security: - x-api-key: [] tags: - Org Environments /v1/environments: post: summary: Creates an account scoped Environment operationId: create-account-scoped-environment responses: '201': $ref: '#/components/responses/EnvironmentResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/EnvironmentCreateRequest' description: Creates an account scoped Environment security: - x-api-key: [] tags: - Account Environments x-internal: false get: summary: List account scoped Environments responses: '200': $ref: '#/components/responses/EnvironmentListResponse' operationId: get-account-scoped-environments parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/EnvironmentIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list account scoped of environments that you are permitted to use in a pipeline. - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the account scoped environments for which you have view permissions in the given account. tags: - Account Environments /v1/environments/{environment}: get: summary: Retrieve an account scoped environment operationId: get-account-scoped-environment parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified account scoped environment security: - x-api-key: [] responses: '200': $ref: '#/components/responses/EnvironmentResponse' tags: - Account Environments parameters: - $ref: '#/components/parameters/EnvironmentPathParam' put: summary: Update account scoped Environment operationId: update-account-scoped-environment responses: '200': $ref: '#/components/responses/EnvironmentResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/EnvironmentUpdateRequest' description: Updates the specified account scoped environment security: - x-api-key: [] tags: - Account Environments delete: summary: Delete an account scoped Environment operationId: delete-account-scoped-environment responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested account scoped environment security: - x-api-key: [] tags: - Account Environments /v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures: post: summary: Creates an Infrastructure operationId: create-infrastructure responses: '201': $ref: '#/components/responses/InfrastructureResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/InfrastructureCreateRequest' description: Creates an Infrastructure security: - x-api-key: [] tags: - Project Infrastructures x-internal: false parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' get: summary: List Infrastructures responses: '200': $ref: '#/components/responses/InfrastructureListResponse' operationId: get-infrastructures parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/InfraIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list of infrastructure that you are permitted to use in a pipeline. - schema: type: array items: type: string in: query name: service_refs description: Specifies services to which scoped infra are to be fetched. - schema: type: string in: query name: template_identifier description: >- The Identifier of deployment template if infrastructure is of type custom deployment. - schema: type: string in: query name: template_version description: >- The version label of deployment template if infrastructure is of type custom deployment(deployment template). - $ref: '#/components/parameters/DeploymentType' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the infrastructure for which you have view permissions in the given project. tags: - Project Infrastructures /v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}: get: summary: Retrieve a infrastructure operationId: get-infrastructure parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified infrastructure security: - x-api-key: [] responses: '200': $ref: '#/components/responses/InfrastructureResponse' tags: - Project Infrastructures parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' - $ref: '#/components/parameters/InfrastructureDefinitionPathParam' put: summary: Update Infrastructure operationId: update-infrastructure responses: '200': $ref: '#/components/responses/InfrastructureResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/InfrastructureUpdateRequest' description: Updates the specified infrastructure security: - x-api-key: [] tags: - Project Infrastructures delete: summary: Delete a Infrastructure operationId: delete-infrastructure responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested environment security: - x-api-key: [] tags: - Project Infrastructures /v1/orgs/{org}/environments/{environment}/infrastructures: post: summary: Creates an org scoped Infrastructure operationId: create-org-scoped-infrastructure responses: '201': $ref: '#/components/responses/InfrastructureResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/InfrastructureCreateRequest' description: Creates an org scoped Infrastructure security: - x-api-key: [] tags: - Org Infrastructures x-internal: false parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' get: summary: List org scoped Infrastructures responses: '200': $ref: '#/components/responses/InfrastructureListResponse' operationId: get-org-scoped-infrastructures parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/InfraIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list org scoped of infrastructure that you are permitted to use in a pipeline. - schema: type: array items: type: string in: query name: service_refs description: Specifies services to which scoped infra are to be fetched. - schema: type: string in: query name: template_identifier description: >- The Identifier of deployment template if infrastructure is of type custom deployment. - schema: type: string in: query name: template_version description: >- The version label of deployment template if infrastructure is of type custom deployment(deployment template). - $ref: '#/components/parameters/DeploymentType' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the org scoped infrastructures for which you have view permissions in the given org. tags: - Org Infrastructures /v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}: get: summary: Retrieve an org scoped Infrastructure operationId: get-org-scoped-infrastructure parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified org scoped infrastructure security: - x-api-key: [] responses: '200': $ref: '#/components/responses/InfrastructureResponse' tags: - Org Infrastructures parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/EnvironmentPathParam' - $ref: '#/components/parameters/InfrastructureDefinitionPathParam' put: summary: Update org scoped Infrastructure operationId: update-org-scoped-infrastructure responses: '200': $ref: '#/components/responses/InfrastructureResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/InfrastructureUpdateRequest' description: Updates the specified org scoped infrastructure security: - x-api-key: [] tags: - Org Infrastructures delete: summary: Delete an org scoped Infrastructure operationId: delete-org-scoped-infrastructure responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested org scoped infrastructure security: - x-api-key: [] tags: - Org Infrastructures /v1/environments/{environment}/infrastructures: post: summary: Creates an account scoped Infrastructure operationId: create-account-scoped-infrastructure responses: '201': $ref: '#/components/responses/InfrastructureResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/InfrastructureCreateRequest' description: Creates an account scoped Infrastructure security: - x-api-key: [] tags: - Account Infrastructures x-internal: false parameters: - $ref: '#/components/parameters/EnvironmentPathParam' get: summary: List account scoped Infrastructures responses: '200': $ref: '#/components/responses/InfrastructureListResponse' operationId: get-account-scoped-infrastructures parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/InfraIdentifiers' - $ref: '#/components/parameters/Sort1' - schema: type: boolean in: query name: is_access_list description: >- Specifies whether the list is an access list. An access list is a list account scoped of infrastructures that you are permitted to use in a pipeline. - schema: type: array items: type: string in: query name: service_refs description: Specifies services to which scoped infra are to be fetched. - schema: type: string in: query name: template_identifier description: >- The Identifier of deployment template if infrastructure is of type custom deployment. - schema: type: string in: query name: template_version description: >- The version label of deployment template if infrastructure is of type custom deployment(deployment template). - $ref: '#/components/parameters/DeploymentType' - $ref: '#/components/parameters/Order' security: - x-api-key: [] description: >- Returns a list of the account scoped infrastructures for which you have view permissions in the given account. tags: - Account Infrastructures /v1/environments/{environment}/infrastructures/{infrastructure-definition}: get: summary: Retrieve an account scoped Infrastructure operationId: get-account-scoped-infrastructure parameters: - $ref: '#/components/parameters/AccountHeader' description: Retrieves the specified account scoped infrastructure security: - x-api-key: [] responses: '200': $ref: '#/components/responses/InfrastructureResponse' tags: - Account Infrastructures parameters: - $ref: '#/components/parameters/EnvironmentPathParam' - $ref: '#/components/parameters/InfrastructureDefinitionPathParam' put: summary: Update account scoped Infrastructure operationId: update-account-scoped-infrastructure responses: '200': $ref: '#/components/responses/InfrastructureResponse' parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/InfrastructureUpdateRequest' description: Updates the specified account scoped infrastructure security: - x-api-key: [] tags: - Account Infrastructures delete: summary: Delete an account scoped Infrastructure operationId: delete-account-scoped-infrastructure responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/ForceDelete' description: Deletes the requested account scoped infrastructure security: - x-api-key: [] tags: - Account Infrastructures /v1/licenseUsageActivity/export/{accountIdentifier}: post: summary: Get exported License Usage Data for an account based on the filters tags: - Export License Usage Data By Account responses: '200': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} operationId: export-license-usage-activity x-internal: false security: - bearerAuth: [] parameters: - name: accountIdentifier in: path required: true description: Account Identifier for the Entity. schema: type: string - name: startTime in: query required: true description: Start Time of the Interval for the Entity. schema: type: integer format: int64 - name: endTime in: query required: true description: End Time of the Interval for the Entity. schema: type: integer format: int64 requestBody: required: true description: Details of the filters applied content: application/json: schema: $ref: '#/components/schemas/LicenseUsageActivityFilterPropertiesDTO' /v1/ldap-settings/iterations: post: summary: Ldap Settings iterations tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LdapSettingsIterationsResponse' operationId: ldap-settings-iterations x-stoplight: id: o0f3p82mazw6a security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CronExpressionRequest' /v1/ldap-settings/ldap-login-test: post: summary: Ldap login test tags: - Ldap Settings responses: '200': $ref: '#/components/responses/LdapTestLoginResponse' operationId: ldap-settings-ldap-login-test x-stoplight: id: xy60v4zxek7xz security: - x-api-key: [] x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/LdapTestLoginRequest' /v1/gitx-webhook-events/{gitx-webhook-event}/validation-info: get: summary: Get file validations for a given event identifier tags: - GitX Webhooks Event File Validation responses: '200': $ref: '#/components/responses/GetGitXWebhookEventFileValidationResponse' operationId: gitx-webhook-event-file-validation x-internal: true description: Get file validations for a given event identifier security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: string in: path name: gitx-webhook-event - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' /v1/credits/allocation/export/{accountIdentifier}: get: summary: Get credits allocation Data for an account for a given moduleType tags: - Credits allocation by account and moduleType responses: '200': description: Successful response with CSV file content: text/csv: {} '400': headers: {} description: '' content: application/json: schema: type: object properties: {} operationId: credits-allocation-export-data x-internal: false security: - bearerAuth: [] parameters: - name: accountIdentifier in: path required: true description: Account Identifier for the Entity. schema: type: string - name: moduleType in: query required: true description: Module type for the account schema: type: string /v1/licenseUsageActivity/{accountIdentifier}: post: summary: Get License Usage Data for an account for a given time range tags: - License Usage Data By Account responses: '200': $ref: '#/components/responses/LicenseUsageActivity' '400': headers: {} description: '' content: application/json: schema: type: object properties: {} operationId: license-usage-activity x-internal: false security: - bearerAuth: [] parameters: - name: accountIdentifier in: path required: true description: Account Identifier for the Entity. schema: type: string - name: startTime in: query required: true description: Start Time of the Interval for the Entity. schema: type: integer format: int64 - name: endTime in: query required: true description: End Time of the Interval for the Entity. schema: type: integer format: int64 - name: rollup in: query required: true description: >- Rollup all credit usages in the specified timestamp to a single value. schema: type: boolean requestBody: required: true description: Details of the filters applied content: application/json: schema: $ref: '#/components/schemas/LicenseUsageActivityFilterPropertiesDTO' /v1/iro/get-sync-data-collection-result: post: summary: Retrieve data from Prometheus APM to fetch data. tags: - Prometheus Data Retrieval responses: '200': $ref: '#/components/responses/PrometheusMetricsResponse' '400': headers: {} description: '' content: application/json: schema: type: object properties: {} operationId: get-sync-data-collection-result security: - bearerAuth: [] parameters: - name: accountIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query schema: type: string - name: orgIdentifier in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrometheusQueryRequest' /v1/gitx-webhook-events/list-branches: get: summary: List all Branches for GitX Webhook Events. responses: '200': $ref: '#/components/responses/ListGitXWebhookBranchesResponse' operationId: list-webhook-event-branches parameters: - $ref: '#/components/parameters/AccountHeader' - in: query name: org schema: type: string - in: query name: project schema: type: string - schema: type: string in: query name: webhook_identifier - schema: type: string in: query name: repo_name - schema: type: string in: query name: connector_ref - schema: type: boolean in: query name: include_parent_scope description: List branches for webhook events. security: - x-api-key: [] x-internal: true tags: - GitX Events Resource parameters: [] /v1/webhooks/list: post: summary: Lists all the Webhooks at Account level tags: - Account Webhooks responses: '200': $ref: '#/components/responses/ListWebhookResponse' operationId: list-account-webhooks x-stoplight: id: q959f3zrosr8j description: Lists webhooks security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' requestBody: $ref: '#/components/requestBodies/ListWebhookRequest' /v1/orgs/{org}/webhooks/list: parameters: - $ref: '#/components/parameters/OrgPathParam' post: summary: Lists all the Webhooks at Org level tags: - Org Webhooks responses: '200': $ref: '#/components/responses/ListWebhookResponse' operationId: list-org-webhooks x-stoplight: id: xtibpkmzi48xi description: List org level webhooks security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' requestBody: $ref: '#/components/requestBodies/ListWebhookRequest' /v1/orgs/{org}/projects/{project}/webhooks/list: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' post: summary: List all the Webhooks at Project level tags: - Project Webhooks responses: '200': $ref: '#/components/responses/ListWebhookResponse' operationId: list-project-webhooks x-stoplight: id: d0984c6o07vmf description: List project level webhooks security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' requestBody: $ref: '#/components/requestBodies/ListWebhookRequest' /v1/webhooks: post: summary: Create a webhook at Account level responses: '201': $ref: '#/components/responses/CreateWebhookResponse' operationId: create-account-webhooks x-stoplight: id: 8eiwo6om8vhyx description: Create webhooks at account level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateWebhookRequest' tags: - Account Webhooks /v1/orgs/{org}/webhooks: parameters: - $ref: '#/components/parameters/OrgPathParam' post: summary: Create a webhook at Org level responses: '201': $ref: '#/components/responses/CreateWebhookResponse' operationId: create-org-webhooks x-stoplight: id: 218lrnqztn5db description: Create webhooks at org level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateWebhookRequest' tags: - Org Webhooks /v1/orgs/{org}/projects/{project}/webhooks: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' post: summary: Create a webhook at Project level responses: '201': $ref: '#/components/responses/CreateWebhookResponse' operationId: create-project-webhooks x-stoplight: id: 3hemfo8zsii5j description: Create webhooks at project level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/CreateWebhookRequest' tags: - Project Webhooks /v1/webhooks/{webhook}: parameters: - $ref: '#/components/parameters/WebhookIdentifier' get: summary: Fetch Webhook at Account level responses: '200': $ref: '#/components/responses/GetWebhookResponse' operationId: get-account-webhook x-stoplight: id: htrbf7iw1pgbm description: Fetch Webhook at Account level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Webhooks put: summary: Updates a Webhook at Account level tags: - Account Webhooks responses: '200': $ref: '#/components/responses/UpdateWebhookResponse' operationId: update-account-webhook x-stoplight: id: stg0ym0cf83ms description: Updates a Webhook at Account level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateWebhookRequest' delete: summary: Deletes a Webhook at account level tags: - Account Webhooks responses: '204': description: No Content operationId: delete-account-webhook x-stoplight: id: hy1e8ggf1za4k description: Deletes a Webhook at account level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' /v1/orgs/{org}/webhooks/{webhook}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/WebhookIdentifier' get: summary: Fetch Webhook at org level tags: - Org Webhooks responses: '200': $ref: '#/components/responses/GetWebhookResponse' operationId: get-org-webhook x-stoplight: id: phxcvl7c27s2b description: Fetch Webhook at org level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' put: summary: Updates a Webhook at Org level tags: - Org Webhooks responses: '200': $ref: '#/components/responses/UpdateWebhookResponse' operationId: update-org-webhook x-stoplight: id: qnxs9xauehxf1 description: Updates a Webhook at Org level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateWebhookRequest' delete: summary: Deletes a Webhook at org level tags: - Org Webhooks responses: '204': description: No Content operationId: delete-org-webhook x-stoplight: id: hp71yii6vje5j description: Deletes a Webhook at org level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' /v1/orgs/{org}/projects/{project}/webhooks/{webhook}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - $ref: '#/components/parameters/WebhookIdentifier' get: summary: Fetch Webhook at project level tags: - Project Webhooks responses: '200': $ref: '#/components/responses/GetWebhookResponse' operationId: get-project-webhook x-stoplight: id: 91vr2lhknz7e2 description: Fetch Webhook at project level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' put: summary: Updates a Webhook at Project level tags: - Project Webhooks responses: '200': $ref: '#/components/responses/UpdateWebhookResponse' operationId: update-project-webhook x-stoplight: id: qkzw38ihe33sm description: Updates a Webhook at Project level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateWebhookRequest' delete: summary: Deletes a Webhook at project level tags: - Project Webhooks responses: '204': description: No Content operationId: delete-project-webhook x-stoplight: id: zrxeghi06sstt description: Deletes a Webhook at project level security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' /v1/licensedModules: get: summary: Get Licensed Modules for an account tags: - Account Licensed Modules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LicensedModules' '400': description: Bad Request operationId: get-account-licensed-modules x-stoplight: id: 48ywtaz7t7c2m description: Get Licensed Modules for an account security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' /v1/banners/{banner}: parameters: - schema: type: string name: banner in: path required: true description: Identifier field of the Banner put: summary: Updates the specified Banner in account scope operationId: update-account-scoped-banner responses: '200': $ref: '#/components/responses/BannerResponse' description: Updates the specified Banner in account scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/UpdateBannerRequest' tags: - Account Banner delete: summary: Deletes the specified Banner in account scope operationId: delete-account-scoped-banner responses: '204': description: No Content '400': description: '' content: application/json: schema: type: object properties: {} description: Deletes the specified Banner in account scope security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Account Banner /v1/devSubscriptions: get: summary: Get total users count by month for the provided year tags: - Total users count responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriptionUsageDTO' '400': description: Bad Request operationId: get-v1-devSubscriptions x-stoplight: id: t2sfdg3924zq1 description: Get subscriptions data for account parameters: - $ref: '#/components/parameters/AccountHeader' parameters: - schema: type: string in: query name: year description: Year to get the subscriptions data for /v1/moduleLicenseUtilization: get: summary: utilization tags: - Module License Utilization responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleUtilizationDTO' '400': description: Bad Request operationId: get-v1-moduleLicenseUtilization x-stoplight: id: ou43i1cdk84oz parameters: - $ref: '#/components/parameters/AccountHeader' /v1/updateModuleAccess: put: summary: update tags: - Update Module Access responses: '200': description: OK '400': description: Bad Request operationId: put-v1-updateModuleAccess x-stoplight: id: xqx83k6nobtol parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: content: application/json: schema: type: object properties: entities: $ref: '#/components/schemas/UpdateAccessRequest' /v1/listPrincipalsWithAccess: get: summary: list tags: - Principals With Access responses: '200': description: OK content: application/json: schema: type: object properties: principalsWithAccess: $ref: '#/components/schemas/PrincipalWithAccessResponse' '400': description: Bad Request operationId: get-v1-listPrincipalsWithAccess x-stoplight: id: sa5b0bfaplklt parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: string in: query name: moduleType description: Module to fetch the users for required: true - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' post: summary: Your POST endpoint tags: - Principals With Access responses: '200': description: OK content: application/json: schema: type: object properties: principalsWithAccess: $ref: '#/components/schemas/PrincipalWithAccessResponse' '400': description: Bad Request operationId: post-v1-listPrincipalsWithAccess x-stoplight: id: qdy1p2ocwewgn parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: string in: query name: moduleType description: Module to fetch the users for required: true - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' requestBody: content: application/json: schema: type: object properties: filter: $ref: '#/components/schemas/PrincipalWithAccessFilter' /v1/banners/active: get: summary: Return Active Banners tags: - Account Banner responses: '200': $ref: '#/components/responses/BannerListResponse' operationId: get-account-scoped-active-banners description: >- This API endpoint will return max 5 banners as that is the enabled banners count. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/SearchTerm1' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit1' - $ref: '#/components/parameters/Sort1' - $ref: '#/components/parameters/Order' /v1/dailyModuleAccountAccess: get: summary: Your GET endpoint tags: - Daily Module Account Access responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DailyModuleAccountAccessDTO' operationId: get-v1-dailyModuleAccountAccess x-stoplight: id: ottg9ts46qi5m requestBody: content: application/json: schema: type: object nullable: true parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: integer in: query name: year description: Year for which the data is requested required: true - schema: type: integer in: query name: month description: Month for which the data is requested required: true - schema: type: string in: query name: moduleType description: Module for which the data is requested required: true /v1/moduleAccess: get: summary: Get module access tags: - Get Module Access responses: '200': description: OK content: application/json: schema: type: object properties: hasAccess: type: boolean operationId: get-v1-moduleAccess x-stoplight: id: t1jwlv6z8sa1x parameters: - $ref: '#/components/parameters/AccountHeader' - schema: type: string in: query name: moduleType description: Module to check user access for - schema: type: string in: query name: userId description: User id /v1/oidc-provider: post: summary: Create OIDC provider tags: - Oidc Provider responses: '200': $ref: '#/components/responses/OidcProviderResponse' '400': description: Bad Request '500': description: Internal Server Error operationId: create-oidc-provider x-stoplight: id: 8j9gyvedhvef1 requestBody: $ref: '#/components/requestBodies/OidcProviderRequest' parameters: - schema: type: string in: header name: Harness-Account description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. get: summary: Get OIDC providers tags: - Oidc Provider responses: '200': $ref: '#/components/responses/OidcProvidersResponse' '400': description: Bad Request '404': description: Not Found '500': description: Internal Server Error operationId: list-oidc-provider x-stoplight: id: z6j7sbsuajq8k parameters: - schema: type: string in: header name: Harness-Account description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. /v1/oidc-provider/{providerIdentifier}: get: summary: GET OIDC provider tags: - Oidc Provider responses: '200': $ref: '#/components/responses/OidcProvidersResponse' '400': description: Bad Request '404': description: Not Found '500': description: Internal Server Error operationId: get-oidc-provider x-stoplight: id: cubdvrj4itv8p parameters: - $ref: '#/components/parameters/OidcProviderId' - schema: type: string in: header name: Harness-Account description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. description: '' put: summary: Update OIDC provider tags: - Oidc Provider responses: '200': $ref: '#/components/responses/OidcProviderResponse' '400': description: Bad Request '500': description: Internal Server Error operationId: update-oidc-provider x-stoplight: id: wq62jc99nwlly requestBody: $ref: '#/components/requestBodies/OidcProviderRequest' parameters: - $ref: '#/components/parameters/OidcProviderId' - schema: type: string in: header description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. name: Harness-Account delete: summary: Delete OIDC provider tags: - Oidc Provider responses: '200': $ref: '#/components/responses/OidcProviderResponse' '400': description: Bad Request '500': description: Internal Server Error operationId: delete-oidc-provider x-stoplight: id: 9omza80n0xdqu parameters: - $ref: '#/components/parameters/OidcProviderId' - schema: type: string in: header description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. name: Harness-Account /v1/oidc-provider/{providerIdentifier}/decrypt: get: summary: GET OIDC provider with secret tags: - Oidc Provider responses: '200': $ref: '#/components/responses/OidcProvidersResponse' '400': description: Bad Request '404': description: Not Found '500': description: Internal Server Error operationId: get-oidc-provider-internal x-internal: true x-stoplight: id: cubdvrj4itv8p parameters: - $ref: '#/components/parameters/OidcProviderId' - schema: type: string in: header name: Harness-Account description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. description: '' /v1/notification-trigger/ir/slo-notification: post: summary: SLO Notification Trigger tags: - Incident Response responses: '200': description: OK content: {} '400': description: Bad Request '500': description: Internal Server Error operationId: sloNotificationTrigger x-internal: true x-stoplight: id: f4xe8dn1qa6x3 parameters: - schema: type: string in: header name: Harness-Account description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. requestBody: content: application/json: schema: $ref: '#/components/schemas/SLONotificationDTO' /v1/oauth/zoom: get: summary: Internal API to generate OAuth Token for Zoom tags: - Zoom Utils responses: '200': description: OK content: application/json: schema: type: object properties: access_token: type: string x-stoplight: id: 0pbtp82fglrgg token_type: type: string x-stoplight: id: y4rwrgipoqww3 refresh_token: type: string x-stoplight: id: 6sgylqvlyinws expires_in: type: integer x-stoplight: id: mfsqxsdtfwg22 scope: type: string x-stoplight: id: heagx4kr7djob api_url: type: string x-stoplight: id: s3v6t9nbleurb operationId: zoomOauthTokenGenerate x-internal: true x-stoplight: id: 3xl1gdk59jd1l parameters: - schema: type: string in: query name: authorization_code /v1/oauth/msteams: get: summary: Internal API to generate OAuth Token for MS Teams tags: - MS Teams Utils responses: '200': $ref: '#/components/responses/MsTeamsTokenResponse' operationId: msTeamsOauthTokenGenerate x-internal: true x-stoplight: id: avbtzt1bif7x7 parameters: - schema: type: string in: query name: authorization_code /v1/oauth/confluence: get: summary: Internal API to generate OAuth Token for Confluence tags: - Confluence Utils responses: '200': $ref: '#/components/responses/ConfluenceTokenResponse' operationId: confluenceOauthTokenGenerate x-internal: true x-stoplight: id: avbtzt1bif8x7 parameters: - schema: type: string in: query name: authorization_code /v1/oauth/slack: get: summary: Internal API to generate OAuth Token for Slack tags: - Slack Utils responses: '200': $ref: '#/components/responses/SlackTokenResponse' operationId: slackOauthTokenGenerate x-internal: true x-stoplight: id: avbtzt1bif2x8 parameters: - schema: type: string in: query name: authorization_code /v1/connectors: post: summary: Create a Connector operationId: create-account-scoped-connector responses: '201': $ref: '#/components/responses/ConnectorResponse' description: Creates a new connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/ConnectorRequest' tags: - Account Connector get: summary: List connectors operationId: get-account-scoped-connectors responses: '200': $ref: '#/components/responses/ConnectorListResponse' description: Retrieves the information of the connectors. tags: - Account Connector parameters: - schema: type: boolean default: false in: query name: recursive description: 'Expand current scope to include all child scopes ' - $ref: '#/components/parameters/SearchTerm2' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit2' - $ref: '#/components/parameters/Sort2' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] x-internal: true /v1/connectors/{connector}: get: summary: Retrieve a connector operationId: get-account-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorResponse' description: > Retrieves the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. tags: - Account Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] put: summary: Update a connector operationId: update-account-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorResponse' description: >- Updates the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader1' requestBody: $ref: '#/components/requestBodies/ConnectorRequest' tags: - Account Connector security: - x-api-key: [] parameters: - schema: type: string name: connector in: path required: true description: Connector identifier delete: summary: Delete a connector operationId: delete-account-scoped-connector responses: '200': description: OK description: >- Deletes the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. tags: - Account Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] /v1/connectors/{connector}/test-connection: get: summary: Test a connector operationId: test-account-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorTestConnectionResponse' description: > Tests connection of the connector with the matching connector identifier. tags: - Account Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] parameters: - schema: type: string name: connector in: path required: true description: Connector identifier /v1/orgs/{org}/connectors: post: summary: Create a Connector operationId: create-org-scoped-connector responses: '201': $ref: '#/components/responses/ConnectorResponse' description: Creates a new connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/ConnectorRequest' tags: - Org Connector parameters: - $ref: '#/components/parameters/OrgPathParam' get: summary: List connectors operationId: get-org-scoped-connectors responses: '200': $ref: '#/components/responses/ConnectorListResponse' description: Retrieves the information of the connectors. tags: - Org Connector parameters: - schema: type: boolean default: false in: query name: recursive description: 'Expand current scope to include all child scopes ' - $ref: '#/components/parameters/SearchTerm2' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit2' - $ref: '#/components/parameters/Sort2' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] x-internal: true /v1/orgs/{org}/connectors/{connector}: get: summary: Retrieve a connector operationId: get-org-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorResponse' description: > Retrieves the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. tags: - Org Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] put: summary: Update a connector operationId: update-org-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorResponse' description: >- Updates the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader1' requestBody: $ref: '#/components/requestBodies/ConnectorRequest' tags: - Org Connector security: - x-api-key: [] delete: summary: Delete a connector operationId: delete-org-scoped-connector responses: '200': description: OK description: >- Deletes the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. tags: - Org Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: connector in: path required: true description: Connector identifier /v1/orgs/{org}/connectors/{connector}/test-connection: get: summary: Test a connector operationId: test-org-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorTestConnectionResponse' description: > Tests connection of the connector with the matching connector identifier. tags: - Org Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: connector in: path required: true description: Connector identifier /v1/orgs/{org}/projects/{project}/connectors: post: summary: Create a Connector operationId: create-project-scoped-connector responses: '201': $ref: '#/components/responses/ConnectorResponse' description: Creates a new connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/ConnectorRequest' tags: - Project Connector parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' get: summary: List connectors operationId: get-project-scoped-connectors responses: '200': $ref: '#/components/responses/ConnectorListResponse' description: Retrieves the information of the connectors. tags: - Project Connector parameters: - schema: type: boolean default: false in: query name: recursive description: 'Expand current scope to include all child scopes ' - $ref: '#/components/parameters/SearchTerm2' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit2' - $ref: '#/components/parameters/Sort2' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] x-internal: true /v1/orgs/{org}/projects/{project}/connectors/{connector}: get: summary: Retrieve a connector operationId: get-project-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorResponse' description: > Retrieves the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. tags: - Project Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] put: summary: Update a connector operationId: update-project-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorResponse' description: >- Updates the information of the secret with the matching secret identifier. parameters: - $ref: '#/components/parameters/AccountHeader1' requestBody: $ref: '#/components/requestBodies/ConnectorRequest' tags: - Project Connector security: - x-api-key: [] delete: summary: Delete a connector operationId: delete-project-scoped-connector responses: '200': description: OK description: >- Deletes the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. tags: - Project Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - schema: type: string name: connector in: path required: true description: Connector identifier /v1/orgs/{org}/projects/{project}/connectors/{connector}/test-connection: get: summary: Test a connector operationId: test-project-scoped-connector responses: '200': $ref: '#/components/responses/ConnectorTestConnectionResponse' description: > Tests connection of the connector with the matching connector identifier. tags: - Project Connector parameters: - $ref: '#/components/parameters/AccountHeader1' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - schema: type: string name: connector in: path required: true description: Connector identifier /v1/resource-groups: parameters: [] get: summary: List Resource Groups operationId: list-resource-groups-acc description: Returns a list of Resource Groups present in the Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/AccountHeader2' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' responses: '200': $ref: '#/components/responses/ResourceGroupsListResponse' tags: - Account Resource Groups post: summary: Create a Resource Group operationId: create-resource-group-acc description: Creates a custom Resource Group in the Account scope. parameters: - $ref: '#/components/parameters/AccountHeader2' security: - x-api-key: [] tags: - Account Resource Groups requestBody: $ref: '#/components/requestBodies/CreateResourceGroupRequest' responses: '201': $ref: '#/components/responses/ResourceGroupsResponse' /v1/resource-groups/{resource-group}: parameters: - $ref: '#/components/parameters/ResourceGroupParam' get: summary: Retrieve a Resource Group operationId: get-resource-group-acc description: Retrieves a Resource Group from Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Account Resource Groups responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' x-internal: false put: summary: Update a Resource Group operationId: update-resource-group-acc responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' description: Updates a Resource Group from Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Account Resource Groups requestBody: $ref: '#/components/requestBodies/CreateResourceGroupRequest' delete: summary: Delete a Resource Group operationId: delete-resource-group-acc responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' description: Deletes a custom Resource Group from Account scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Account Resource Groups /v1/orgs/{org}/resource-groups: parameters: - $ref: '#/components/parameters/OrgParam' get: summary: List Resource Groups tags: - Organization Resource Groups responses: '200': $ref: '#/components/responses/ResourceGroupsListResponse' operationId: list-resource-groups-org description: Returns a list of Resource Groups present in the Organization scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/AccountHeader2' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' post: summary: Create a Resource Group operationId: create-resource-group-org description: Creates a custom Resource Group in the Organization scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Organization Resource Groups requestBody: $ref: '#/components/requestBodies/CreateResourceGroupRequest' responses: '201': $ref: '#/components/responses/ResourceGroupsResponse' /v1/orgs/{org}/resource-groups/{resource-group}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ResourceGroupParam' get: summary: Retrieve a Resource Group operationId: get-resource-group-org description: Retrieves a Resource Group from Organization scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Organization Resource Groups responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' put: summary: Update a Resource Group operationId: update-resource-group-org responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' description: Updates a Resource Group from Organization scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' requestBody: $ref: '#/components/requestBodies/CreateResourceGroupRequest' tags: - Organization Resource Groups delete: summary: Delete a Resource Group operationId: delete-resource-group-org responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' description: Deletes a custom Resource Group from Organization scope. parameters: - $ref: '#/components/parameters/AccountHeader2' security: - x-api-key: [] tags: - Organization Resource Groups /v1/orgs/{org}/projects/{project}/resource-groups: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' get: summary: List Resource Groups responses: '200': $ref: '#/components/responses/ResourceGroupsListResponse' operationId: list-resource-groups-project description: Returns a list of Resource Groups present in the Project scope. parameters: - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/AccountHeader2' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' security: - x-api-key: [] tags: - Project Resource Groups post: summary: Create a Resource Group operationId: create-resource-group-project description: Creates a custom Resource Group in the Project scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Project Resource Groups requestBody: $ref: '#/components/requestBodies/CreateResourceGroupRequest' responses: '201': $ref: '#/components/responses/ResourceGroupsResponse' /v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/ResourceGroupParam' get: summary: Retrieve a Resource Group operationId: get-resource-group-project security: - x-api-key: [] description: Retrieves a Resource Group from Project scope. parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Project Resource Groups responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' put: summary: Update a Resource Group operationId: update-resource-group-project responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/CreateResourceGroupRequest' description: Updates a Resource Group from Project scope. tags: - Project Resource Groups parameters: - $ref: '#/components/parameters/AccountHeader2' delete: summary: Delete a Resource Group operationId: delete-resource-group-project responses: '200': $ref: '#/components/responses/ResourceGroupsResponse' description: Deletes a custom Resource Group from Project scope. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' tags: - Project Resource Groups /v1/resource-groups/filter: parameters: [] post: summary: Filter Resource Groups operationId: filter-resource-groups responses: '200': $ref: '#/components/responses/ResourceGroupsListResponse' description: Returns a list of Resource Groups based on filter criteria. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader2' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' tags: - Filter Resource Groups requestBody: $ref: '#/components/requestBodies/FilterResourceGroupRequest' /v1/streaming-destinations: parameters: [] post: summary: Create a Streaming Destination operationId: create-streaming-destinations description: Creates a custom Streaming Destination parameters: - $ref: '#/components/parameters/AccountHeader3' security: - x-api-key: [] responses: '201': $ref: '#/components/responses/StreamingDestinationResponse' requestBody: $ref: '#/components/requestBodies/CreateStreamingDestinationRequest' x-internal: true tags: - Streaming Destinations get: summary: List Streaming Destinations operationId: get-streaming-destinations responses: '200': $ref: '#/components/responses/StreamingDestinationListResponse' parameters: - $ref: '#/components/parameters/AccountHeader3' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/Status' description: Get list of Streaming Destinations security: - x-api-key: [] tags: - Streaming Destinations x-internal: true /v1/streaming-destinations/aggregate: get: summary: List Streaming Destinations operationId: getStreamingDestinationsAggregate responses: '200': $ref: '#/components/responses/StreamingDestinationAggregateListResponse' parameters: - $ref: '#/components/parameters/AccountHeader3' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/Status' description: Get list of Streaming Destinations security: - x-api-key: [] tags: - Streaming Destinations x-internal: true /v1/streaming-destinations/{streaming-destination}: parameters: - $ref: '#/components/parameters/StreamingDestinationParam' put: summary: Update a Streaming Destination operationId: update-streaming-destination description: Update a Streaming Destination parameters: - $ref: '#/components/parameters/AccountHeader3' requestBody: $ref: '#/components/requestBodies/CreateStreamingDestinationRequest' responses: '200': $ref: '#/components/responses/StreamingDestinationResponse' security: - x-api-key: [] tags: - Streaming Destinations x-internal: true delete: summary: Delete a Streaming Destination operationId: delete-disabled-streaming-destination description: Deletes an existing and disabled Streaming Destination parameters: - $ref: '#/components/parameters/AccountHeader3' security: - x-api-key: [] responses: '204': $ref: '#/components/responses/StreamingDestinationResponse' x-internal: true tags: - Streaming Destinations get: summary: Get a Streaming Destination operationId: get-streaming-destination description: Get a Streaming Destination parameters: - $ref: '#/components/parameters/AccountHeader3' security: - x-api-key: [] responses: '200': $ref: '#/components/responses/StreamingDestinationResponse' x-internal: true tags: - Streaming Destinations /v1/streaming-destinations/{streaming-destination}/validate-unique-identifier: get: summary: Validate Uniqueness of Identifier tags: - Streaming Destinations responses: '200': $ref: '#/components/responses/StreamingDestinationValidateResponse' headers: {} operationId: validateUniqueIdentifier description: Validate uniqueness of identifier for Streaming Destination parameters: - $ref: '#/components/parameters/AccountHeader3' security: - x-api-key: [] x-internal: true parameters: - name: streaming-destination in: path required: true schema: type: string description: Streaming Destination identifier /v1/streaming-destinations/cards: get: summary: Your GET endpoint tags: - Streaming Destinations responses: '200': $ref: '#/components/responses/StreamingDestinationCardsResponse' operationId: get-streaming-destinations-cards x-internal: true description: Get the info for cards on streaming destination page security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader3' /v1/audits: post: summary: List Audits operationId: post-audits responses: '200': $ref: '#/components/responses/AuditListResponse' description: Get list of Audits parameters: - $ref: '#/components/parameters/AccountHeader3' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Order' security: - x-api-key: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AuditFilterPropertiesV1DTO' description: This has the filter attributes for listing Audit Events tags: - Audits x-internal: true /v1/orgs/{org}/projects/{project}/notification-channels: get: summary: List Notification channels responses: '200': $ref: '#/components/responses/NotificationChannelListResponse' operationId: list-notification-channels x-stoplight: id: 110wzj88g7je4 description: Returns a list of notification channels for the scope. parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Limit3' - $ref: '#/components/parameters/SearchTerm3' - $ref: '#/components/parameters/Sort3' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/notification_channel_type' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/IncludeParentScope' security: - x-api-key: [] tags: - Notification Channels post: summary: Create Notification channel operationId: create-notification-channel responses: '201': $ref: '#/components/responses/NotificationChannelResponse' x-stoplight: id: hnjw4i11veokz description: Create Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationChannelRequest' security: - x-api-key: [] tags: - Notification Channels parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' /v1/orgs/{org}/projects/{project}/notification-rules: get: summary: List Notification rules responses: '200': $ref: '#/components/responses/NotificationRuleListResponse' operationId: list-notification-rules x-stoplight: id: faoyjfx01yacj description: Get list of notification rules parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Limit3' - $ref: '#/components/parameters/Sort3' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm3' - $ref: '#/components/parameters/Page' - schema: type: string in: query name: resource description: Notification entity name - schema: type: string in: query name: event description: Notification event name security: - x-api-key: [] tags: - Notification Rules post: summary: Create Notification Rule operationId: create-notification-rule responses: '201': $ref: '#/components/responses/NotificationRuleResponse' x-stoplight: id: fy1asg68jb20y description: Create Notification Rule parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationRuleRequest' security: - x-api-key: [] tags: - Notification Rules parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' /v1/orgs/{org}/projects/{project}/notification-channels/{notification-channel}: parameters: - schema: type: string name: notification-channel in: path required: true description: identifier - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' get: summary: Get Notification channel responses: '200': $ref: '#/components/responses/NotificationChannelResponse' operationId: get-notification-channel x-stoplight: id: s152cc3xhzlg4 description: Get Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Channels delete: summary: Delete Notification Channel operationId: delete-notification-channel responses: '204': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-stoplight: id: 7wecyef99sub3 description: Delete notification channel parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Channels put: summary: Update Notification Channel operationId: update-notification-channel responses: '200': $ref: '#/components/responses/NotificationChannelResponse' x-stoplight: id: kqsk5i3w0wkwr description: Update Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationChannelRequest' security: - x-api-key: [] tags: - Notification Channels /v1/orgs/{org}/projects/{project}/notification-rules/{notification-rule}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - schema: type: string name: notification-rule in: path required: true description: identifier get: summary: Get Notification Rule responses: '200': $ref: '#/components/responses/NotificationRuleResponse' operationId: get-notification-rule x-stoplight: id: k9gw1089s3jd6 description: Get notification rule parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Rules delete: summary: Delete Notification Rule operationId: delete-notification-rule responses: '204': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-stoplight: id: lsi3h5gkmxugh description: Delete notification rule parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Rules put: summary: Update Notification Rule operationId: update-notification-rule responses: '200': $ref: '#/components/responses/NotificationRuleResponse' x-stoplight: id: s22i78x6pwd00 description: Update Notification Rule parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationRuleRequest' security: - x-api-key: [] tags: - Notification Rules /v1/orgs/{org}/notification-channels: get: summary: List Notification channels at org level responses: '200': $ref: '#/components/responses/NotificationChannelListResponse' operationId: list-notification-channels-org x-stoplight: id: r96qavu1tdkl3 description: Returns a list of notification channels for the scope. parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Limit3' - $ref: '#/components/parameters/SearchTerm3' - $ref: '#/components/parameters/Sort3' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/notification_channel_type' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/IncludeParentScope' security: - x-api-key: [] tags: - Notification Channels x-internal: true post: summary: Create Notification channel operationId: create-notification-channel-org responses: '201': $ref: '#/components/responses/NotificationChannelResponse' x-stoplight: id: 3c3z42mq3u5cs description: Create Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationChannelRequest' security: - x-api-key: [] tags: - Notification Channels x-internal: true parameters: - $ref: '#/components/parameters/OrgPathParam' /v1/notification-channels: get: summary: List Notification channels at account level responses: '200': $ref: '#/components/responses/NotificationChannelListResponse' operationId: list-notification-channels-account x-stoplight: id: fizbxgypnkyx4 description: Returns a list of notification channels for the scope. parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Limit3' - $ref: '#/components/parameters/SearchTerm3' - $ref: '#/components/parameters/Sort3' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/notification_channel_type' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/IncludeParentScope' security: - x-api-key: [] tags: - Notification Channels x-internal: true post: summary: Create Notification channel operationId: create-notification-channel-account responses: '201': $ref: '#/components/responses/NotificationChannelResponse' x-stoplight: id: i879xsqwx95bd description: Create Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationChannelRequest' security: - x-api-key: [] tags: - Notification Channels x-internal: true /v1/orgs/{org}/notification-rules: get: summary: List Notification rules at org level responses: '200': $ref: '#/components/responses/NotificationRuleListResponse' operationId: list-notification-rules-org x-stoplight: id: h2pjf55hgmfkq description: Get list of notification rules parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit3' - $ref: '#/components/parameters/Sort3' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm3' - schema: type: string in: query name: resource description: Notification entity name - schema: type: string in: query name: event description: Notification event name security: - x-api-key: [] tags: - Notification Rules x-internal: true post: summary: Create Notification Rule operationId: create-notification-rule-org responses: '201': $ref: '#/components/responses/NotificationRuleResponse' x-stoplight: id: zd8fe9zq9vz65 description: Create Notification Rule parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationRuleRequest' security: - x-api-key: [] tags: - Notification Rules x-internal: true parameters: - $ref: '#/components/parameters/OrgPathParam' /v1/notification-rules: get: summary: List Notification rules at account level responses: '200': $ref: '#/components/responses/NotificationRuleListResponse' operationId: list-notification-rules-account x-stoplight: id: rpxkf8nmka63c description: Get list of notification rules for account parameters: - $ref: '#/components/parameters/AccountHeader' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit3' - $ref: '#/components/parameters/Sort3' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm3' - schema: type: string in: query name: resource description: Notification resource name - schema: type: string in: query name: event description: Notification event name security: - x-api-key: [] tags: - Notification Rules x-internal: true post: summary: Create Notification Rule operationId: create-notification-rule-account responses: '201': $ref: '#/components/responses/NotificationRuleResponse' x-stoplight: id: 4gde7c2oe66y1 description: Create Notification Rule parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationRuleRequest' security: - x-api-key: [] tags: - Notification Rules x-internal: true /v1/orgs/{org}/notification-channels/{notification-channel}: parameters: - schema: type: string name: notification-channel in: path required: true description: identifier - $ref: '#/components/parameters/OrgPathParam' get: summary: Get Notification channel responses: '200': $ref: '#/components/responses/NotificationChannelResponse' operationId: get-notification-channel-org x-stoplight: id: ky2btllctnj0n description: Get Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Channels x-internal: true delete: summary: Delete Notification Channel operationId: delete-notification-channel-org responses: '204': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-stoplight: id: 80yugthenbxim description: Delete notification channel parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Channels x-internal: true put: summary: Update Notification Channel operationId: update-notification-channel-org responses: '200': $ref: '#/components/responses/NotificationChannelResponse' x-stoplight: id: rdwfm4wav1fl6 description: Update Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationChannelRequest' security: - x-api-key: [] tags: - Notification Channels x-internal: true /v1/notification-channels/{notification-channel}: parameters: - schema: type: string name: notification-channel in: path required: true description: identifier get: summary: Get Notification channel responses: '200': $ref: '#/components/responses/NotificationChannelResponse' operationId: get-notification-channel-account x-stoplight: id: 0j2ergmt8dnlo description: Get Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Channels x-internal: true delete: summary: Delete Notification Channel operationId: delete-notification-channel-account responses: '204': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-stoplight: id: vij0xc5vjo1hw description: Delete notification channel parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Channels x-internal: true put: summary: Update Notification Channel operationId: update-notification-channel-account responses: '200': $ref: '#/components/responses/NotificationChannelResponse' x-stoplight: id: 55xmh2nbu3pxu description: Update Notification Channel parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationChannelRequest' security: - x-api-key: [] tags: - Notification Channels x-internal: true /v1/orgs/{org}/notification-rules/{notification-rule}: parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: notification-rule in: path required: true description: identifier get: summary: Get Notification Rule responses: '200': $ref: '#/components/responses/NotificationRuleResponse' operationId: get-notification-rule-org x-stoplight: id: tixx3mc8h9lx9 description: Get notification rule parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Rules x-internal: true delete: summary: Delete Notification Rule operationId: delete-notification-rule-org responses: '204': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-stoplight: id: ob3ocvnujbsdn description: Delete notification rule parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Rules x-internal: true put: summary: Update Notification Rule operationId: update-notification-rule-org responses: '200': $ref: '#/components/responses/NotificationRuleResponse' x-stoplight: id: 27vuuzo23p92w description: Update Notification Rule parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationRuleRequest' security: - x-api-key: [] tags: - Notification Rules x-internal: true /v1/notification-rules/{notification-rule}: parameters: - schema: type: string name: notification-rule in: path required: true description: identifier get: summary: Get Notification Rule responses: '200': $ref: '#/components/responses/NotificationRuleResponse' operationId: get-notification-rule-account x-stoplight: id: n6wp9eszwjzp0 description: Get notification rule parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Rules x-internal: true delete: summary: Delete Notification Rule operationId: delete-notification-rule-account responses: '204': description: No Content '400': headers: {} description: '' content: application/json: schema: type: object properties: {} x-stoplight: id: 5dxk1ps427ia7 description: Delete notification rule parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] tags: - Notification Rules x-internal: true put: summary: Update Notification Rule operationId: update-notification-rule-account responses: '200': $ref: '#/components/responses/NotificationRuleResponse' x-stoplight: id: v4l0x6kyqmcut description: Update Notification Rule parameters: - $ref: '#/components/parameters/AccountHeader' requestBody: $ref: '#/components/requestBodies/NotificationRuleRequest' security: - x-api-key: [] tags: - Notification Rules x-internal: true /v1/orgs/{org}/projects/{project}/notification-rules/validate-rules/{notification-rule}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - schema: type: string name: notification-rule in: path required: true description: Notification Rule Identifier get: summary: Validate notification rule identifier tags: - Notification Rules responses: '200': $ref: '#/components/responses/ValidateIdentifierResponse' '302': description: Found operationId: validate-notification-rule-identifier x-stoplight: id: zrupqdwqv03id description: Validate notification rule identifier parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] /v1/orgs/{org}/validate-rules/{notification-rule}: parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: notification-rule in: path required: true description: Notification Rule Identifier get: summary: Validate notification rule identifier tags: - Notification Rules responses: '200': $ref: '#/components/responses/ValidateIdentifierResponse' '302': description: Found operationId: validate-notification-rule-identifier-org x-stoplight: id: 8ouru8hu0buzm description: Validate notification rule identifier org level parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] /v1/validate-rules/{notification-rule}: parameters: - schema: type: string name: notification-rule in: path required: true description: identifier get: summary: Validate notification rule identifier tags: - Notification Rules responses: '200': $ref: '#/components/responses/ValidateIdentifierResponse' '302': description: Found operationId: validate-notification-rule-identifier-account x-stoplight: id: imzpediwp0dzw parameters: - $ref: '#/components/parameters/AccountHeader' description: Validate notification rule identifier security: - x-api-key: [] /v1/notification-resource-list: get: summary: List of notification entities and events tags: - Notification Rules responses: '200': description: Shared Response content: application/json: schema: type: array items: $ref: '#/components/schemas/NotificationResourceDTO' operationId: notification-resource-list x-stoplight: id: pdsj5o8j3jsqe parameters: - $ref: '#/components/parameters/AccountHeader' x-internal: true security: - x-api-key: [] /v1/orgs/{org}/validate-channels/{notification-channel}: parameters: - $ref: '#/components/parameters/OrgPathParam' - schema: type: string name: notification-channel in: path required: true description: identifier get: summary: Validate unique identifier for notification channel tags: - Notification Channels responses: '200': $ref: '#/components/responses/ValidateIdentifierResponse' '302': description: Found operationId: validate-notification-channel-identifier-org x-stoplight: id: pa28zngw5cpyb parameters: - $ref: '#/components/parameters/AccountHeader' security: - x-api-key: [] /v1/orgs/{org}/projects/{project}/validate-channels/{notification-channel}: parameters: - $ref: '#/components/parameters/OrgPathParam' - $ref: '#/components/parameters/ProjectPathParam' - schema: type: string name: notification-channel in: path required: true description: identifier get: summary: Validate Notification Channel Identifier responses: '200': $ref: '#/components/responses/ValidateIdentifierResponse' '302': description: Found operationId: validate-notification-channel-identifier x-stoplight: id: 3b5yactyqx0hs parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Notification Channels security: - x-api-key: [] /v1/validate-channels/{notification-channel}: parameters: - schema: type: string name: notification-channel in: path required: true description: identifier get: summary: Validate Notification channel identifier tags: - Notification Channels responses: '200': $ref: '#/components/responses/ValidateIdentifierResponse' '302': description: Found operationId: validate-notification-channel-identifier-account x-stoplight: id: 6sqcbt99vrutt parameters: - $ref: '#/components/parameters/AccountHeader' description: Validate Notification Channel Indetifier security: - x-api-key: [] /v1/attachments: post: summary: Save Notification Attachment operationId: create-attachment responses: '200': $ref: '#/components/responses/SaveAttachmentResponse' description: Save Notification Attachment x-internal: true requestBody: $ref: '#/components/requestBodies/SaveAttachmentRequest' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader' tags: - Notification Attachments parameters: [] /v1/orgs/{org}/projects/{project}/pipelines: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' get: summary: List Pipelines operationId: list-pipelines description: Returns a list of Pipelines. parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/Sort4' - $ref: '#/components/parameters/Order' - schema: type: string enum: - CD - CI - CV - CF - CE - STO in: query name: module description: Harness module which is part of the Pipeline. - schema: type: string in: query name: filter_identifier description: Identifier of a saved Filter. - schema: type: array items: type: string in: query name: pipeline_identifiers description: >- List of Pipeline identifiers on the basis of which the Pipelines are filtered. - schema: type: string pattern: ^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$ minLength: 1 maxLength: 128 in: query name: name description: Pipeline Name on the basis of which the Pipelines are filtered. - schema: type: string maxLength: 1024 in: query name: description description: >- Pipeline Description on the basis of which the Pipelines are filtered. - schema: type: array items: type: string maxItems: 128 example: key:value examples: key_and_value: value: key:value summary: Tag having both Key and Value. key_only: value: key summary: Tag having only Key. in: query name: tags description: Filter tags as a key:value pair. - schema: type: array items: type: string in: query name: service_names description: Service names on the basis of which the Pipelines are filtered. [CD] - schema: type: array items: type: string in: query name: env_names description: >- Names of Environments on the basis of which the Pipelines are filtered. [CD] - schema: type: string in: query name: deployment_type description: >- Deployment type on the basis of which the Pipelines are filtered. [CD] - schema: type: string in: query name: repository description: >- Repository name on the basis of which the Pipelines are filtered. [CI] security: - x-api-key: [] tags: - Pipelines responses: '200': $ref: '#/components/responses/PipelineListResponseBody' x-stoplight: id: 30zs16zs1jnaq post: summary: Create a Pipeline operationId: create-pipeline description: Creates a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' tags: - Pipelines requestBody: $ref: '#/components/requestBodies/PipelineCreateRequestBody' responses: '201': $ref: '#/components/responses/PipelineCreateResponseBody' x-stoplight: id: mdxs0qz4oh0dc /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' - $ref: '#/components/parameters/IgnoreError' post: summary: Create a Trigger operationId: create-trigger description: Create a Trigger. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' tags: - Triggers requestBody: $ref: '#/components/requestBodies/TriggerRequestBody' responses: '201': $ref: '#/components/responses/TriggerResponseBody' x-stoplight: id: uegqlh7uxc0dh x-internal: true /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' - $ref: '#/components/parameters/TriggerParam' get: summary: Retrieve a Trigger operationId: get-trigger description: Retrieve a Trigger. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' tags: - Triggers responses: '200': $ref: '#/components/responses/TriggerGetResponseBody' x-internal: true put: summary: Update a Trigger operationId: update-trigger security: - x-api-key: [] description: Updates a Trigger. parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/IgnoreError' tags: - Triggers requestBody: $ref: '#/components/requestBodies/TriggerRequestBody' responses: '200': $ref: '#/components/responses/TriggerResponseBody' x-internal: true delete: summary: Delete a Trigger operationId: delete-trigger description: Deletes a Trigger. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' tags: - Triggers responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} x-internal: true /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' get: summary: Retrieve a Pipeline operationId: get-pipeline security: - x-api-key: [] description: Retrieves a Pipeline. parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/Branch' - schema: type: boolean default: false in: query name: template_applied description: If true, returns Pipeline YAML with Templates applied on it. - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). - schema: type: string default: 'false' in: header name: Load-From-Cache description: Flag to enable loading the remote pipeline from git or git cache - schema: type: boolean default: false in: query name: load_from_fallback_branch description: Flag to load the pipeline from the created non default branch - schema: type: boolean default: 'false' in: query name: validate_async description: >- Flag to tell whether to start an asynchronous validation process or not tags: - Pipelines responses: '200': $ref: '#/components/responses/PipelineGetResponseBody' x-stoplight: id: rn41qzdjn8lh1 put: summary: Update a Pipeline operationId: update-pipeline security: - x-api-key: [] description: Updates a Pipeline. parameters: - $ref: '#/components/parameters/AccountHeader4' tags: - Pipelines requestBody: $ref: '#/components/requestBodies/PipelineUpdateRequestBody' responses: '200': $ref: '#/components/responses/PipelineCreateResponseBody' x-stoplight: id: 9gbauax4g8mkt delete: summary: Delete a Pipeline operationId: delete-pipeline description: Deletes a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' tags: - Pipelines responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} x-stoplight: id: 4jx8uy7y3r44p patch: summary: Patch API for pipeline operationId: patch-pipeline responses: '200': $ref: '#/components/responses/PipelineCreateResponseBody' description: Patch API for pipeline tags: - Pipelines security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' requestBody: $ref: '#/components/requestBodies/PipelinePatchRequestBody' /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/validate: parameters: - name: org in: path required: true schema: type: string description: Organization identifier - name: project in: path required: true schema: type: string description: Project identifier - name: pipeline in: path required: true schema: type: string description: Pipeline identifier post: summary: Start a Pipeline Validation Event operationId: start-pipeline-validation-event security: - x-api-key: [] description: >- Starts a Pipeline Validation Event and returns the UUID of the Event created x-internal: true parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). - schema: type: boolean default: 'false' in: header name: Load-From-Cache description: Flag to enable loading the remote pipeline from git or git cache - schema: type: boolean in: query name: load_from_fallback_branch description: Flag to load the pipeline from the created non default branch tags: - Pipelines responses: '200': $ref: '#/components/responses/PipelineValidationUUIDResponseBody' x-stoplight: id: sw5u2qvvrztc1 /v1/orgs/{org}/projects/{project}/pipelines/validate/{uuid}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/UuidParam' get: summary: Get Pipeline Validation Result operationId: get-pipeline-validate-result security: - x-api-key: [] description: Get Pipeline Validation Result for given UUID x-internal: true tags: - Pipelines parameters: - $ref: '#/components/parameters/AccountHeader4' responses: '200': $ref: '#/components/responses/PipelineValidationResponseBody' x-stoplight: id: 7oq9a7yzeq62m /v1/orgs/{org}/projects/{project}/input-sets: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' post: summary: Create an Input Set operationId: create-input-set responses: '201': $ref: '#/components/responses/InputSetResponseBody' tags: - Input Sets description: Creates an Input Set for a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PipelineInputSetParam' requestBody: $ref: '#/components/requestBodies/InputSetCreateRequestBody' x-stoplight: id: rs93jxpccd461 get: summary: List Input Sets operationId: list-input-sets responses: '200': $ref: '#/components/responses/InputSetListResponseBody' tags: - Input Sets description: Returns a List of Input Sets for a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PipelineInputSetParam' - $ref: '#/components/parameters/PageIndex' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/SearchTerm' - $ref: '#/components/parameters/Sort4' - $ref: '#/components/parameters/Order' x-stoplight: id: r1m5r04ew0edo /v1/orgs/{org}/projects/{project}/input-sets/{input-set}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/InputSetParam' get: summary: Retrieve an Input Set tags: - Input Sets responses: '200': $ref: '#/components/responses/InputSetResponseBody' operationId: get-input-set description: Retrieves an Input Set for a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PipelineInputSetParam' - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: parent_entity_connector_ref description: Connector reference for Parent Entity (Pipeline). - schema: type: string in: query name: parent_entity_repo_name description: Repository name for Parent Entity (Pipeline). - schema: type: boolean default: 'false' in: query name: load_from_fallback_branch description: Flag to load the pipeline from the created non default branch - schema: type: string default: 'false' in: header description: >- Specifies whether the remote pipeline should be loaded from Git or Git cache. name: Load-From-Cache x-stoplight: id: cghityrhzn3qi put: summary: Update an Input Set operationId: update-input-set responses: '200': $ref: '#/components/responses/InputSetResponseBody' description: Updates an Input Set for a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PipelineInputSetParam' tags: - Input Sets requestBody: $ref: '#/components/requestBodies/InputSetUpdateRequestBody' x-stoplight: id: yngruwctpu1nf delete: summary: Delete an Input Set operationId: delete-input-set responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} tags: - Input Sets description: Deletes an Input Set for a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PipelineInputSetParam' x-stoplight: id: mgc4ka4g4nczv /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/inputs: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' get: summary: Get Pipeline Inputs operationId: get-pipeline-inputs responses: '200': $ref: '#/components/responses/InputsResponseBody' description: Return Inputs for a Pipeline. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string in: query name: branch_name description: Name of the branch (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). tags: - Inputs x-internal: true x-stoplight: id: 7ylrtcm85ki3c /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/move-config: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' post: summary: Move Pipeline YAML from inline to remote operationId: moveConfig description: Creates a remote entity by fetching pipeline YAML from Harness. responses: '200': $ref: '#/components/responses/PipelineMoveConfigResponseBody' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' requestBody: $ref: '#/components/requestBodies/PipelineMoveConfigRequestBody' tags: - Pipelines x-internal: false x-stoplight: id: qw42s90zscen1 /v1/orgs/{org}/projects/{project}/input-sets/{input-set}/move-config: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/InputSetParam' post: summary: Move InputSet YAML from inline to remote operationId: inputSetsMoveConfig description: Creates a remote entity by fetching the input set YAML from Harness. parameters: - $ref: '#/components/parameters/AccountHeader4' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/InputSetMoveConfigRequestBody' responses: '200': $ref: '#/components/responses/InputSetMoveConfigResponseBody' tags: - Input Sets x-internal: false x-stoplight: id: z1803ifds8q83 /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/import: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' post: summary: Get Pipeline YAML from Git Repository operationId: importPipelineFromGit responses: '200': $ref: '#/components/responses/PipelineSaveResponseBody' description: >- Fetches Pipeline YAML from Git Repository and saves a record for it in Harness tags: - Pipelines requestBody: $ref: '#/components/requestBodies/PipelineImportRequestBody' parameters: - $ref: '#/components/parameters/AccountHeader4' x-stoplight: id: 1zb3cae63roiy /v1/orgs/{org}/projects/{project}/input-sets/{input-set}/import: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/InputSetParam' post: summary: Get Input Set YAML from Git Repository operationId: importInputSetFromGit responses: '200': $ref: '#/components/responses/InputSetImportResponseBody' parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PipelineInputSetParam' requestBody: $ref: '#/components/requestBodies/InputSetImportRequestBody' description: >- Fetches InputSet YAML from Git Repository and saves a record for it in Harness tags: - Input Sets x-stoplight: id: qa15eqrayvc6f /v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/ExecutionIdParam' get: summary: Gets Approval Instances by Execution Id operationId: getApprovalInstancesByExecutionId responses: '200': $ref: '#/components/responses/ApprovalInstanceListResponseBody' '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} description: Gets Approval Instances by Execution Id [Beta] security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - name: approval_status in: query description: This filters approval instances based on status schema: type: string enum: - WAITING - APPROVED - REJECTED - FAILED - ABORTED - EXPIRED - name: approval_type in: query description: This filters approval instances based on type schema: type: string enum: - HarnessApproval - JiraApproval - CustomApproval - ServiceNowApproval - name: node_execution_id in: query description: >- This filters approval instances based on runtime identifier of the step schema: type: string tags: - Approvals x-stoplight: id: wb59o71f1bds4 post: summary: Approve or Reject an Execution by Pipeline Execution ID operationId: addHarnessApprovalActivityByPipelineExecutionId responses: '200': $ref: '#/components/responses/ApprovalInstanceResponseBody' '400': description: Bad Request content: application/json: schema: type: object properties: {} x-stoplight: id: vea4t933wijxl description: Approve or Reject an Execution by Pipeline Execution ID [Beta] security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string in: query name: callback_id description: >- This filters approval instances based on callback id given in the step parameters tags: - Approvals requestBody: $ref: '#/components/requestBodies/HarnessApprovalActivityRequestBody' /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/git-metadata: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' put: summary: Update GitMetadata for Remote Pipelines operationId: update-pipeline-git-metadata responses: '200': $ref: '#/components/responses/GitMetadataUpdateResponseBody' requestBody: $ref: '#/components/requestBodies/GitMetadataUpdateRequestBody' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader4' tags: - Pipelines description: Update git-metadata in remote pipeline x-stoplight: id: i92x28iwkosxx /v1/orgs/{org}/projects/{project}/input-sets/{input-set}/git-metadata: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/InputSetParam' put: summary: Update GitMetadata for Remote InputSet operationId: update-input-set-git-metadata responses: '200': $ref: '#/components/responses/GitMetadataUpdateResponseBody' requestBody: $ref: '#/components/requestBodies/GitMetadataUpdateRequestBody' security: - x-api-key: [] tags: - Input Sets description: Update git-metadata in remote inputSet and return the updated inputSet parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/PipelineInputSetParam' x-stoplight: id: 27vwjxn4ddjd9 /v1/pipeline-schema/individual-schema: parameters: [] get: summary: Get Individual Static Schema operationId: get-individual-static-schema responses: '200': $ref: '#/components/responses/IndividualSchemaResponseBody' x-stoplight: id: 0k8ms0d67bib3 description: get individual schema for any step/stage/strategy/stepgroup. parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string enum: - step - stage - pipeline - strategy - step_group - trigger in: query name: node_group - schema: type: string in: query name: node_type - schema: type: string enum: - iacm - cd - ci - security - approval - custom - cf - template in: query name: node_group_differentiator - schema: type: string default: v0 enum: - v0 - v1 in: query name: version security: - x-api-key: [] tags: - Schemas x-internal: true /v1/pipeline-schema/inputs-schema: parameters: [] post: summary: Get Inputs Schema operationId: get-inputs-schema responses: '200': $ref: '#/components/responses/PipelineInputSchemaDetailsResponseBody' x-stoplight: id: ep4bfvpcvsdfl tags: - Schemas parameters: - $ref: '#/components/parameters/AccountHeader4' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/PipelineInputsSchemaRequestBody' x-internal: true /v1/step-pallete: parameters: [] post: summary: Get steps for the steps-pallete operationId: get-steps responses: '200': $ref: '#/components/responses/StepsDataResponseBody' tags: - Steps parameters: - $ref: '#/components/parameters/AccountHeader4' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/StepPalleteFilterRequestBody' x-internal: true /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' post: summary: Execute Pipeline operationId: execute-pipeline responses: '200': $ref: '#/components/responses/PipelineExecuteResponseBody' x-stoplight: id: 1afpa0a08cfyg requestBody: $ref: '#/components/requestBodies/PipelineExecuteRequestBody' parameters: - schema: type: string in: query name: module description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI - schema: type: boolean default: 'false' in: query name: use_fqn_if_error_response description: Use FQN in error response. - schema: type: boolean default: 'false' in: query name: notify_only_user - schema: type: string in: query name: notes description: Notes of a pipeline execution - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). description: Pipeline Execution API tags: - Pipeline Execution /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/inputs-schema: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' get: summary: Get inputs schema details tags: - Pipelines responses: '200': $ref: '#/components/responses/PipelineInputSchemaDetailsResponseBody' operationId: get-inputs-schema-details x-stoplight: id: hdedvdslufq8m parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). description: '' x-internal: true /v1/orgs/{org}/projects/{project}/input-sets/merge: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' post: summary: '' operationId: merged-input-sets responses: '200': $ref: '#/components/responses/MergeInputSetResponseBody' x-stoplight: id: ljg2bbzoqmc07 description: Gets merged input sets parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string in: header name: Load-From-Cache description: Flag to enable loading the remote Pipeline from git or git cache - $ref: '#/components/parameters/PipelineInputSetParam' - $ref: '#/components/parameters/PipelineRepoID' - $ref: '#/components/parameters/PipelineBranch' - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: parent_entity_connector_ref description: Connector reference for Parent Entity (Pipeline). - schema: type: string in: query name: parent_entity_repo_name description: Repository name for Parent Entity (Pipeline). requestBody: $ref: '#/components/requestBodies/MergeInputSetRequestBody' x-internal: true tags: - Input Sets /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/rerun/{execution-id}: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' - $ref: '#/components/parameters/ExecutionIdParam' post: summary: Rerun Pipeline operationId: rerun-pipeline responses: '200': $ref: '#/components/responses/PipelineExecuteResponseBody' x-stoplight: id: 8rms04nwjz7uq parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string in: query name: module description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI. - schema: type: boolean default: false in: query name: use_fqn_if_error - schema: type: string in: query name: notes description: Notes of a pipeline execution - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). requestBody: $ref: '#/components/requestBodies/RerunPipelineRequestBody' description: Rerun Pipeline Execution tags: - Pipeline Execution x-internal: true /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/retry/{execution-id}: post: summary: Retry Pipeline operationId: retry-pipeline-with-inputset-pipeline-yaml responses: '200': $ref: '#/components/responses/PipelineExecuteResponseBody' x-stoplight: id: s6t1sk8tjrzpj description: Retry a executed Pipeline with inputSet Pipeline yaml. parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string in: query name: module description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI. - schema: type: array items: type: string in: query name: retry_stages allowEmptyValue: false description: >- This param contains the identifier of stages from where to resume. It will be a list if we want to retry from parallel group. - schema: type: boolean default: true in: query name: run_all_stages description: >- This param provides an option to run only the failed stages when Pipeline fails at parallel group. By default, it will run all the stages in the failed parallel group. - schema: type: string in: query name: notes description: Notes of a Pipeline execution. requestBody: $ref: '#/components/requestBodies/RerunPipelineRequestBody' x-internal: true tags: - Pipeline Execution parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' - $ref: '#/components/parameters/ExecutionIdParam' /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages-execution-list: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' get: summary: Get Stages execution List for a given Pipeline execution. tags: - Pipeline Execution responses: '200': $ref: '#/components/responses/StageExecutionResponseList' operationId: get-stages-execution-list x-stoplight: id: aixvxgt5qd21j description: >- Returns list of Stage identifiers with their names and stage dependencies parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string default: 'false' in: header name: Load-From-Cache description: Flag to enable loading the remote Pipeline from git or git cache - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/rerun/{execution-id}/stages: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' - $ref: '#/components/parameters/ExecutionIdParam' post: summary: Re-run Stages Execution of a Pipeline tags: - Pipeline Execution responses: '200': $ref: '#/components/responses/PipelineExecuteResponseBody' operationId: rerun-stages-execution-of-pipeline x-stoplight: id: fiduvh2471by2 parameters: - $ref: '#/components/parameters/AccountHeader4' - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience) - schema: type: boolean default: false in: query name: use_fqn_if_error description: Use FQN in error response - schema: type: string in: query name: module description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI. - schema: type: string in: query name: notes description: Notes of a pipeline execution requestBody: $ref: '#/components/requestBodies/RunStageRequestBody' /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/dynamic: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' post: summary: Execute Pipeline with dynamic Input YAML tags: - Pipeline Execution responses: '200': $ref: '#/components/responses/PipelineExecuteResponseBody' operationId: runDynamicExecutionWithInputYaml description: >- API for executing a dynamic pipeline input YAML. Refer to the developer documentation for detailed usage and configuration instructions https://developer.harness.io/docs/platform/pipelines/dynamic-execution-pipeline/#dynamic-execution-api parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string in: query name: moduleType description: The module from which execution was triggered. - schema: type: string in: query name: notes default: '' description: Notes of a pipeline execution - schema: type: boolean default: false in: query name: notify_only_user requestBody: $ref: '#/components/requestBodies/DynamicPipelineExecuteRequestBody' x-stoplight: id: izltjry4il9gp /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages: parameters: - $ref: '#/components/parameters/OrgParam' - $ref: '#/components/parameters/ProjectParam' - $ref: '#/components/parameters/PipelineParam' post: summary: Execute given Stages of a Pipeline tags: - Pipeline Execution responses: '200': $ref: '#/components/responses/PipelineExecuteResponseBody' operationId: execute-stages-with-input-yaml x-stoplight: id: gp30uxkm66ijj description: Execute given Stages of a Pipeline with Input Yaml parameters: - $ref: '#/components/parameters/AccountHeader4' - schema: type: string in: query name: module description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI. - schema: type: string default: 'false' in: query name: use_fqn_if_error description: Use FQN in error response. - schema: type: string in: query name: notes description: Notes of a Pipeline execution. - $ref: '#/components/parameters/Branch' - schema: type: string in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string in: query name: repo_name description: Name of the repository (for Git Experience). requestBody: $ref: '#/components/requestBodies/RunStageRequestBody' /v1/templates: post: summary: Create Template operationId: create-templates-acc parameters: - $ref: '#/components/parameters/AccountHeaderParam' requestBody: $ref: '#/components/requestBodies/TemplateCreateBody' responses: '201': $ref: '#/components/responses/TemplateResponse' tags: - Account Template description: Creates a Template in the Account scope. get: summary: Get Templates List operationId: get-templates-list-acc responses: '200': $ref: '#/components/responses/TemplateMetaDataList' parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit4' - $ref: '#/components/parameters/Sort5' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm4' - $ref: '#/components/parameters/TemplateListType' - $ref: '#/components/parameters/IncludeAllTemplatesAccessibleAtScope' - $ref: '#/components/parameters/TemplateNames' - $ref: '#/components/parameters/TemplateIds' - $ref: '#/components/parameters/Description' - $ref: '#/components/parameters/EntityType' - $ref: '#/components/parameters/TemplateChildTypes' tags: - Account Template description: Retrieves list of Template with meta-data at Account scope. parameters: [] /v1/templates/git-metadata/{template}: put: summary: Update Git details operationId: update-git-metadata-details parameters: - $ref: '#/components/parameters/AccountHeaderParam' requestBody: $ref: '#/components/requestBodies/TemplateUpdateGitMetadataRequestBody' responses: '200': $ref: '#/components/responses/TemplateUpdateGitMetadataResponse' tags: - Account Template description: Update Git details for multiple version. x-stoplight: id: tog1x9p2m2dy5 parameters: - $ref: '#/components/parameters/Template' /v1/templates/{template}: parameters: - $ref: '#/components/parameters/Template' get: summary: Get Stable Template tags: - Account Template responses: '200': $ref: '#/components/responses/TemplateWithInputsResponse' operationId: get-template-stable-acc parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/GetTemplateInputYaml' - $ref: '#/components/parameters/Branch1' - $ref: '#/components/parameters/ParentConnectorRef' - $ref: '#/components/parameters/ParentRepoName' - $ref: '#/components/parameters/ParentAccountId' - $ref: '#/components/parameters/ParentOrgId' - $ref: '#/components/parameters/ParentProjectId' description: Retrieves stable version of Template at Account scope. /v1/templates/{template}/versions/{version}: parameters: - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Version' get: summary: Retrieve a Template tags: - Account Template responses: '200': $ref: '#/components/responses/TemplateWithInputsResponse' operationId: get-template-acc parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/GetTemplateInputYaml' - $ref: '#/components/parameters/Branch1' - $ref: '#/components/parameters/ParentConnectorRef' - $ref: '#/components/parameters/ParentRepoName' - $ref: '#/components/parameters/ParentAccountId' - $ref: '#/components/parameters/ParentOrgId' - $ref: '#/components/parameters/ParentProjectId' description: Retrieves particular version of Template at Account scope. put: summary: Update Template operationId: update-template-acc responses: '200': $ref: '#/components/responses/TemplateResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Account Template description: Updates particular version of Template at Account scope. requestBody: $ref: '#/components/requestBodies/TemplateUpdateBody' delete: summary: Delete Template operationId: delete-template-acc parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/Comments' - $ref: '#/components/parameters/ForceDelete1' tags: - Account Template description: Deletes particular version of Template at Account scope. responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} /v1/templates/{template}/versions/{version}/stable: parameters: - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Version' put: summary: Update Stable Template operationId: update-template-stable-acc responses: '200': $ref: '#/components/responses/TemplateUpdateStableResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Account Template description: Updates the stable version of Template at Account scope. requestBody: $ref: '#/components/requestBodies/TemplateFetchBody' /v1/orgs/{org}/templates/git-metadata/{template}: put: summary: Update Git details operationId: update-git-metadata-details-org parameters: - $ref: '#/components/parameters/AccountHeaderParam' requestBody: $ref: '#/components/requestBodies/TemplateUpdateGitMetadataRequestBody' responses: '200': $ref: '#/components/responses/TemplateUpdateGitMetadataResponse' tags: - Org Template description: Update Git details for multiple version. x-stoplight: id: xu5qlm73hydwx parameters: - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Org' /v1/orgs/{org}/templates: parameters: - $ref: '#/components/parameters/Org' post: summary: Create Template operationId: create-templates-org responses: '201': $ref: '#/components/responses/TemplateResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Org Template description: Creates a Template in the Organization scope. requestBody: $ref: '#/components/requestBodies/TemplateCreateBody' get: summary: Get Templates List operationId: get-templates-list-org responses: '200': $ref: '#/components/responses/TemplateMetaDataList' parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit4' - $ref: '#/components/parameters/Sort5' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm4' - $ref: '#/components/parameters/TemplateListType' - $ref: '#/components/parameters/IncludeAllTemplatesAccessibleAtScope' - $ref: '#/components/parameters/TemplateNames' - $ref: '#/components/parameters/TemplateIds' - $ref: '#/components/parameters/Description' - $ref: '#/components/parameters/EntityType' - $ref: '#/components/parameters/TemplateChildTypes' tags: - Org Template description: Retrieves list of Template with meta-data at Organization scope. /v1/orgs/{org}/templates/{template}: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Template' get: summary: Get Stable Template operationId: get-template-stable-org responses: '200': $ref: '#/components/responses/TemplateWithInputsResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/GetTemplateInputYaml' - $ref: '#/components/parameters/Branch1' - $ref: '#/components/parameters/ParentConnectorRef' - $ref: '#/components/parameters/ParentRepoName' - $ref: '#/components/parameters/ParentAccountId' - $ref: '#/components/parameters/ParentOrgId' - $ref: '#/components/parameters/ParentProjectId' tags: - Org Template description: Retrieves stable version of Template at Organization scope. /v1/orgs/{org}/templates/{template}/versions/{version}: parameters: - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Version' get: summary: Retrieve a Template operationId: get-template-org responses: '200': $ref: '#/components/responses/TemplateWithInputsResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/GetTemplateInputYaml' - $ref: '#/components/parameters/Branch1' - $ref: '#/components/parameters/ParentConnectorRef' - $ref: '#/components/parameters/ParentRepoName' - $ref: '#/components/parameters/ParentAccountId' - $ref: '#/components/parameters/ParentOrgId' - $ref: '#/components/parameters/ParentProjectId' tags: - Org Template description: Retrieves particular version of Template at Organization scope. put: summary: Update Template operationId: update-template-org responses: '200': $ref: '#/components/responses/TemplateResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Org Template description: Updates particular version of Template at Organization scope. requestBody: $ref: '#/components/requestBodies/TemplateUpdateBody' delete: summary: Delete Template operationId: delete-template-org parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/Comments' - $ref: '#/components/parameters/ForceDelete1' tags: - Org Template description: Deletes particular version of Template at Organization scope. responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} /v1/orgs/{org}/templates/{template}/versions/{version}/stable: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Version' put: summary: Update Stable Template operationId: update-template-stable-org responses: '200': $ref: '#/components/responses/TemplateUpdateStableResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Org Template description: Updates the stable version of Template at Organization scope. requestBody: $ref: '#/components/requestBodies/TemplateFetchBody' /v1/orgs/{org}/projects/{project}/templates/git-metadata/{template}: put: summary: Update Git details operationId: update-git-metadata-details-project parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Project' - $ref: '#/components/parameters/AccountHeaderParam' requestBody: $ref: '#/components/requestBodies/TemplateUpdateGitMetadataRequestBody' responses: '200': $ref: '#/components/responses/TemplateUpdateGitMetadataResponse' tags: - Project Template description: Update Git details for multiple version. x-stoplight: id: 9ta5osrcrp83u parameters: - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Project' /v1/orgs/{org}/projects/{project}/templates: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Project' post: summary: Create Template operationId: create-templates-project responses: '201': $ref: '#/components/responses/TemplateResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Project Template description: Creates a Template in the Project scope. requestBody: $ref: '#/components/requestBodies/TemplateCreateBody' get: summary: Get Templates List operationId: get-templates-list-project responses: '200': $ref: '#/components/responses/TemplateMetaDataList' parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/Limit4' - $ref: '#/components/parameters/Sort5' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/SearchTerm4' - $ref: '#/components/parameters/TemplateListType' - $ref: '#/components/parameters/IncludeAllTemplatesAccessibleAtScope' - $ref: '#/components/parameters/TemplateNames' - $ref: '#/components/parameters/TemplateIds' - $ref: '#/components/parameters/Description' - $ref: '#/components/parameters/EntityType' - $ref: '#/components/parameters/TemplateChildTypes' tags: - Project Template description: Retrieves list of Template with meta-data at Project scope. /v1/orgs/{org}/projects/{project}/templates/{template}: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Project' - $ref: '#/components/parameters/Template' get: summary: Get Stable Template tags: - Project Template responses: '200': $ref: '#/components/responses/TemplateWithInputsResponse' operationId: get-template-stable-project parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/GetTemplateInputYaml' - $ref: '#/components/parameters/Branch1' - $ref: '#/components/parameters/ParentConnectorRef' - $ref: '#/components/parameters/ParentRepoName' - $ref: '#/components/parameters/ParentAccountId' - $ref: '#/components/parameters/ParentOrgId' - $ref: '#/components/parameters/ParentProjectId' description: Retrieves stable version of Template at Project scope. /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}: parameters: - $ref: '#/components/parameters/Project' - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Version' get: summary: Retrieve a Template tags: - Project Template responses: '200': $ref: '#/components/responses/TemplateWithInputsResponse' operationId: get-template-project parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/GetTemplateInputYaml' - $ref: '#/components/parameters/Branch1' - $ref: '#/components/parameters/ParentConnectorRef' - $ref: '#/components/parameters/ParentRepoName' - $ref: '#/components/parameters/ParentAccountId' - $ref: '#/components/parameters/ParentOrgId' - $ref: '#/components/parameters/ParentProjectId' description: Retrieves particular version of Template at Project scope. put: summary: Update Template operationId: update-template-project responses: '200': $ref: '#/components/responses/TemplateResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Project Template description: Updates particular version of Template at Project scope. requestBody: $ref: '#/components/requestBodies/TemplateUpdateBody' delete: summary: Delete Template operationId: delete-template-project parameters: - $ref: '#/components/parameters/AccountHeaderParam' - $ref: '#/components/parameters/Comments' - $ref: '#/components/parameters/ForceDelete1' tags: - Project Template description: Deletes particular version of Template at Project scope. responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: {} examples: example-resp: value: {} application/yaml: schema: type: object properties: {} examples: example-resp: value: | {} /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}/stable: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Project' - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Version' put: summary: Update Stable Template operationId: update-template-stable-project responses: '200': $ref: '#/components/responses/TemplateUpdateStableResponse' parameters: - $ref: '#/components/parameters/AccountHeaderParam' tags: - Project Template description: Updates the stable version of Template at Project scope. requestBody: $ref: '#/components/requestBodies/TemplateFetchBody' /v1/templates/{template}/import: post: summary: Import Template operationId: import-template-acc responses: '200': $ref: '#/components/responses/TemplateImportResponseBody' requestBody: $ref: '#/components/requestBodies/TemplateImportRequestBody' parameters: - $ref: '#/components/parameters/AccountHeaderParam' description: Import template at account level tags: - Account Template parameters: - $ref: '#/components/parameters/Template' /v1/orgs/{org}/templates/{template}/import: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Template' post: summary: Import template operationId: import-template-org responses: '200': $ref: '#/components/responses/TemplateImportResponseBody' description: Import template at org level tags: - Org Template requestBody: $ref: '#/components/requestBodies/TemplateImportRequestBody' parameters: - $ref: '#/components/parameters/AccountHeaderParam' /v1/orgs/{org}/projects/{project}/templates/{template}/import: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Project' - $ref: '#/components/parameters/Template' post: summary: Import Template operationId: import-template-project responses: '200': $ref: '#/components/responses/TemplateImportResponseBody' description: Import template at a project level tags: - Project Template parameters: - $ref: '#/components/parameters/AccountHeaderParam' requestBody: $ref: '#/components/requestBodies/TemplateImportRequestBody' /v1/template-schema/individual-schema: get: summary: Your GET endpoint tags: - Schemas responses: '200': $ref: '#/components/responses/TemplateSchemaResponse' operationId: get-template-schema x-stoplight: id: h6h9r4i2dcor0 description: Gets Templates Schema parameters: - schema: type: string enum: - artifactsourcetemplate - customdeployment - monitoredservice - secretmanager - stage - pipeline - step - stepgroup - template in: query name: node_group - schema: type: string in: query name: node_type - $ref: '#/components/parameters/AccountHeaderParam' - schema: type: string enum: - v0 - v1 default: v0 in: query name: version x-internal: true parameters: [] /v1/template-schema/inputs-schema: post: summary: get inputs-schema api tags: - Schemas responses: '200': $ref: '#/components/responses/TemplateInputSchemaDetailsResponseBody' operationId: get-inputs-schema1 x-stoplight: id: pqgesg6op1rb1 parameters: - $ref: '#/components/parameters/AccountHeaderParam' - schema: type: string in: query name: org_id description: Org Identifier - schema: type: string in: query name: project_id description: Project Identifier description: '' x-internal: true requestBody: $ref: '#/components/requestBodies/TemplateInputsSchemaRequestBody' /v1/templates/{template}/versions/{version}/inputs-schema: parameters: - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Version' get: summary: Get inputs schema for account level templates tags: - Account Template responses: '200': $ref: '#/components/responses/TemplateInputSchemaDetailsResponseBody' operationId: get-acc-templates-inputs-schema x-stoplight: id: 21m2y3edtnhla description: get inputs schema for account level templates parameters: - $ref: '#/components/parameters/AccountHeaderParam' x-internal: true /v1/orgs/{org}/templates/{template}/versions/{version}/inputs-schema: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Version' get: summary: Get inputs schema for org level templates tags: - Org Template responses: '200': $ref: '#/components/responses/TemplateInputSchemaDetailsResponseBody' operationId: get-org-templates-inputs-schema x-stoplight: id: w181v2ceicvz6 x-internal: true description: get inputs schema for org level templates parameters: - $ref: '#/components/parameters/AccountHeaderParam' /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}/inputs-schema: parameters: - $ref: '#/components/parameters/Org' - $ref: '#/components/parameters/Project' - $ref: '#/components/parameters/Template' - $ref: '#/components/parameters/Version' get: summary: Get inputs schema for project level templates tags: - Project Template responses: '200': $ref: '#/components/responses/TemplateInputSchemaDetailsResponseBody' operationId: get-project-templates-inputs-schema x-stoplight: id: 9lff7z2spnh4w parameters: - $ref: '#/components/parameters/AccountHeaderParam' description: get inputs schema for project level templates x-internal: true /v1/backstage-env-variables: get: summary: List Backstage Env Variables responses: '200': $ref: '#/components/responses/BackstageEnvVariableResponseList' operationId: get-backstage-env-variables description: Get all backsage env variables mapping for a given account parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' - $ref: '#/components/parameters/Sort6' security: - x-api-key: [] x-internal: true tags: - BackstageEnvVariable post: summary: Create Backstage Environment Variable operationId: create-backstage-env-variable responses: '201': $ref: '#/components/responses/BackstageEnvVariableResponse' description: Creates an backstage environment variable parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/BackstageEnvVariableRequest' x-internal: true tags: - BackstageEnvVariable /v1/backstage-env-variables/sync: put: summary: Sync Backstage Environment Variables operationId: sync-backstage-env-variables description: >- Synchronize all backstage environment variables mapping for a given account x-internal: true parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] responses: '204': description: No Content tags: - BackstageEnvVariable /v1/backstage-env-variables/{backstage-env-variable}: parameters: - $ref: '#/components/parameters/BackstageEnvVariable' get: summary: Get Backstage Environment Variable responses: '200': $ref: '#/components/responses/BackstageEnvVariableResponse' operationId: get-backstage-env-variable description: >- Get backstage environment variable mapping for a given backstage env variable security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true tags: - BackstageEnvVariable put: summary: Updates a backstage env variable operationId: update-backstage-env-variable responses: '200': $ref: '#/components/responses/BackstageEnvVariableResponse' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/BackstageEnvVariableRequest' description: Updates the specified backstage env variable x-internal: true tags: - BackstageEnvVariable delete: summary: Deletes a backstage env variable operationId: delete-backstage-env-variable description: Deletes the requested backstage env variable security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true responses: '204': description: No Content tags: - BackstageEnvVariable /v1/backstage-env-variables/batch: post: summary: Creates Multiple backstage env variables operationId: create-backstage-env-variables responses: '201': $ref: '#/components/responses/BackstageEnvVariableResponseList' description: Creates multiple backstage env variables x-internal: true requestBody: $ref: '#/components/requestBodies/BackstageEnvVariableBatchRequest' parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] tags: - BackstageEnvVariable put: summary: Updates Multiple backstage env variables operationId: update-backstage-env-variables responses: '200': $ref: '#/components/responses/BackstageEnvVariableResponseList' description: Updates the multiple backstage env variables specified in the request x-internal: true security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/BackstageEnvVariableBatchRequest' parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - BackstageEnvVariable delete: summary: Deletes Multiple backstage env variables operationId: delete-backstage-env-variables responses: '204': description: No Content description: Deletes the multiple backstage env variables specified in the request x-internal: true security: - x-api-key: [] parameters: - schema: type: array default: null items: type: string in: query name: backstage-env-variable description: Identifier field of backstage env variable - $ref: '#/components/parameters/AccountHeader5' tags: - BackstageEnvVariable /v1/backstage-env-variables/resolve: get: summary: Resolve Backstage Environment Variables tags: - BackstageEnvVariable responses: '200': $ref: '#/components/responses/ResolvedEnvVariableResponse' operationId: resolve-backstage-env-variables description: >- Returns a list of backstage env variables with their decrypted values for the given account x-internal: true parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Namespace' security: - x-api-key: [] /v1/backstage-env-variables/reload/{namespace}: put: summary: Reload backstage env variables operationId: reload-backstage-env-variables responses: '204': description: No Content x-stoplight: id: 2atylhkq79myt description: Reload backstage env variables security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true tags: - BackstageEnvVariable parameters: - $ref: '#/components/parameters/NamespacePathParam' /v1/backstage-permissions: get: summary: Get Backstage Permissions responses: '200': $ref: '#/components/responses/BackstagePermissionsResponse' operationId: get-backstage-permissions parameters: - $ref: '#/components/parameters/AccountHeader5' description: Get all backstage permissions for a given account security: - x-api-key: [] x-internal: true tags: - BackstagePermissions post: summary: Create backstage Permissions operationId: create-backstage-permissions responses: '201': $ref: '#/components/responses/BackstagePermissionsResponse' description: Creates backstage Permissions for a given account security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/BackstagePermissionsRequest' x-internal: true tags: - BackstagePermissions put: summary: Updates Backstage Permission operationId: update-backstage-permissions responses: '200': $ref: '#/components/responses/BackstagePermissionsResponse' description: Update Backstage Permission security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true requestBody: $ref: '#/components/requestBodies/BackstagePermissionsRequest' tags: - BackstagePermissions /v1/status-info/{type}: parameters: - $ref: '#/components/parameters/StatusType' get: summary: Gets Status Info by type tags: - StatusInfo operationId: get-status-info-by-type description: Get status info for the given type parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] responses: '200': $ref: '#/components/responses/StatusInfoResponse' x-internal: true post: summary: Saves Status Info by type tags: - StatusInfo operationId: save-status-info-by-type responses: '201': $ref: '#/components/responses/StatusInfoResponse' description: Saves status info for the given type security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/StatusInfoRequest' x-internal: true /v2/status-info/{type}: get: summary: Get Status Info by type description: Get Status Info for the given type tags: - StatusInfoV2 responses: '200': $ref: '#/components/responses/StatusInfoResponseV2' operationId: get-status-info-type-v2 x-stoplight: id: g2rre6x1jk36w parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/StatusType' security: - x-api-key: [] x-internal: true /v1/namespace-info: get: summary: Get Namespace Info responses: '200': $ref: '#/components/responses/NamespaceResponse' operationId: get-namespace-info description: Get the corresponding customer namepsace using account id. x-internal: true security: - x-api-key: [] tags: - Namespace parameters: - $ref: '#/components/parameters/AccountHeader5' post: summary: Create Namespace operationId: create-namespace description: Create Namespace from accountId security: - x-api-key: [] x-internal: true responses: '200': $ref: '#/components/responses/NamespaceResponse' tags: - Namespace parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/account-info/{namespace}: get: summary: Get Account Info responses: '200': $ref: '#/components/responses/NamespaceResponse' operationId: get-account-for-namespace description: Get account information for given namespace security: - x-api-key: [] tags: - AccountInfo x-internal: true parameters: - schema: type: string name: namespace description: Backstage Namespace in: path required: true /v1/provision-idp: post: summary: Provision IDP operationId: provision-idp responses: '200': $ref: '#/components/responses/NamespaceResponse' tags: - Provision description: Provision IDP for given account security: - x-api-key: [] x-internal: true parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/onboarding/harness-entities: get: summary: Get Harness Entities operationId: get-harness-entities responses: '200': $ref: '#/components/responses/HarnessEntitiesResponse' tags: - OnboardingResource x-internal: true description: Get Harness Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/Order1' - $ref: '#/components/parameters/SearchTerm5' - schema: type: string default: null in: query name: project_to_filter description: >- This would be used to filter resources having attributes matching the project filter. /v1/onboarding/harness-entities-count: get: summary: Get Harness Entities Count operationId: get-harness-entities-count responses: '200': $ref: '#/components/responses/HarnessEntitiesCountResponse' description: Get Harness Entities Count security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - OnboardingResource x-internal: true /v1/onboarding/import-harness-entities: post: summary: Import Harness Entities to IDP operationId: import-harness-entities description: Import Harness Entities to IDP security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/ImportHarnessEntitiesRequest' tags: - OnboardingResource responses: '200': $ref: '#/components/responses/ImportEntitiesResponse' x-internal: true /v1/layout: get: summary: List Layouts responses: '200': $ref: '#/components/responses/LayoutResponse' operationId: get-all-layouts x-internal: true description: Get all layouts security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - LayoutProxy post: summary: Create layout operationId: create-layout responses: '200': $ref: '#/components/responses/LayoutResponse' description: Create layout x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - LayoutProxy requestBody: content: application/json: schema: $ref: '#/components/schemas/LayoutRequest' delete: summary: Delete layout operationId: delete-layout responses: '204': description: No Content description: Delete layout x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - LayoutProxy requestBody: $ref: '#/components/requestBodies/LayoutRequest' /v1/layout/{layout-identifier}: get: summary: Get layout responses: '200': $ref: '#/components/responses/LayoutResponse' operationId: get-layout security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - LayoutProxy description: Get Layout x-internal: true parameters: - $ref: '#/components/parameters/LayoutIdentifier' /v1/layout/health: get: summary: Get Layout Health responses: '200': $ref: '#/components/responses/LayoutResponse' operationId: get-layout-health description: Get Layout Health x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - LayoutProxy /v1/plugin-toggle/{plugin-id}: post: summary: Toggle Plugin operationId: toggle-plugin-for-account description: Toggle Backstage Plugin responses: '200': $ref: '#/components/responses/AppConfigResponse' parameters: - schema: type: string in: header name: Harness-Account description: Identifier field of the account the resource is scoped to. - $ref: '#/components/parameters/PluginName' - $ref: '#/components/parameters/Enabled' security: - x-api-key: [] tags: - AppConfig x-internal: false parameters: - $ref: '#/components/parameters/PluginId' /v1/plugins-info: get: summary: List Available Plugins tags: - PluginInfo responses: '200': $ref: '#/components/responses/PluginInfoResponseList' operationId: get-plugins description: Get all plugins available security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: false post: summary: Save custom plugin info operationId: save-custom-plugins-info responses: '201': $ref: '#/components/responses/CustomPluginInfoResponse' x-stoplight: id: t4vsvfeuf169r security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true requestBody: $ref: '#/components/requestBodies/CustomPluginCreateRequest' tags: - PluginInfo /v1/plugins-info/{plugin-id}: get: summary: Get Plugin tags: - PluginInfo responses: '200': $ref: '#/components/responses/PluginDetailedInfoResponse' operationId: get-plugins-info-plugin-id description: Get plugin details for given pluginId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Meta' x-internal: false put: summary: Update custom plugin info operationId: update-custom-plugins-info responses: '200': $ref: '#/components/responses/CustomPluginInfoResponse' x-stoplight: id: jt3xnyhpgnfe9 security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/CustomPluginInfoRequest' tags: - PluginInfo parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true parameters: - $ref: '#/components/parameters/PluginId' delete: summary: Delete custom plugin info operationId: delete-custom-plugin-info responses: '204': description: No Content x-stoplight: id: 1brpcp6chep0j x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/PluginName' tags: - PluginInfo /v2/custom-plugins: get: summary: Get all V2 Custom Plugins available tags: - CustomPluginsV2 responses: '200': $ref: '#/components/responses/CustomPluginsV2ResponseBodyList' operationId: get-custom-plugins-v2 x-stoplight: id: qd1pqx1p9pupp description: Get all V2 Custom Plugins available x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' post: summary: Create V2 Custom Plugin tags: - CustomPluginsV2 operationId: create-custom-plugins-v2 responses: '201': $ref: '#/components/responses/CustomPluginV2Response' x-stoplight: id: 8kz8v205wqtp3 description: Create V2 Custom Plugin security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/CustomPluginV2CreateRequest' x-internal: false /v2/custom-plugins/{plugin-id}: get: summary: Get custom plugin v2 details for given pluginId tags: - CustomPluginsV2 responses: '200': $ref: '#/components/responses/CustomPluginV2Response' operationId: get-custom-plugin-v2 description: Get custom plugin v2 details for given pluginId x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/PluginId' x-stoplight: id: 7q984jp8e5lrp put: summary: Update custom plugin v2 details for given pluginId tags: - CustomPluginsV2 operationId: update-custom-plugin-v2 responses: '200': $ref: '#/components/responses/CustomPluginV2Response' x-stoplight: id: qfrmn9px8zk9p description: Update custom plugin v2 details for given pluginId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/PluginId' requestBody: $ref: '#/components/requestBodies/CustomPluginV2UpdateRequest' x-internal: false delete: summary: Delete custom plugin v2 details for given pluginId tags: - CustomPluginsV2 operationId: delete-custom-plugin-v2 description: Delete custom plugin v2 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/PluginId' responses: '204': description: No Content x-internal: false /v1/app-config: post: summary: Save Or Update Plugin Config operationId: save-or-update-plugin-app-config description: Save or Update Plugin Config responses: '200': $ref: '#/components/responses/AppConfigResponse' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/AppConfigRequest' x-internal: false tags: - AppConfig /v1/connectors-info: get: summary: List Connectors Info tags: - ConnectorInfo responses: '200': $ref: '#/components/responses/ConnectorInfoResponseList' operationId: get-connectors-info description: Get all connectors info security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true /v1/connector-info: get: summary: Get Connector Info tags: - ConnectorInfo operationId: get-connector-info responses: '200': $ref: '#/components/responses/ConnectorInfoResponse' description: Get Connector Info security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: false post: summary: Create or Update Connector Info tags: - ConnectorInfo operationId: save-connector-info responses: '201': $ref: '#/components/responses/ConnectorInfoResponse' description: Create or update connector info parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/ConnectorInfoRequest' x-internal: false /v1/connector-info/{provider-type}: get: summary: Get Connector Info by Provider Type tags: - ConnectorInfo responses: '200': $ref: '#/components/responses/ConnectorInfoResponse' operationId: get-connector-info-by-providerType description: Get connector info by connector provider type security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/ProviderType' x-internal: false /v1/merged-plugins-config: get: summary: Retrieve Merged Config for Enabled Plugins. responses: '200': $ref: '#/components/responses/MergedPluginConfigResponse' operationId: get-merged-plugins-config security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true description: API for retriving merged configs for enabled plugin of account. tags: - MergedPluginsConfig /v1/backstage-plugins-info: get: summary: List Available Backstage Plugins tags: - PluginInfo responses: '200': $ref: '#/components/responses/PluginInfoResponseList' operationId: get-backstage-plugins description: Get all backstage plugins available security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true /v1/plugin/request: post: summary: Request for a Plugin operationId: post-plugin-request responses: '201': description: Created tags: - PluginInfo description: Request for a Plugin x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/RequestPluginRequest' get: summary: Get all plugin requests for an account operationId: get-plugin-request responses: '200': $ref: '#/components/responses/PluginRequestResponseList' tags: - PluginInfo x-internal: false description: Get all plugin requests for an account security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' /v1/layout/ingest: post: summary: Ingest plugin layout operationId: layout-ingest responses: '200': $ref: '#/components/responses/LayoutResponse' tags: - LayoutProxy description: Ingest plugin layout security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/LayoutIngestRequest' /v1/sync-app-config: put: summary: Sync merged app-config for a given account operationId: sync-app-config responses: '204': description: No Content description: >- API to sync app-config for a given account. This API can be accessed by Support User only. x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - schema: type: boolean default: false in: query name: base_config description: Set true to sync base app-config too tags: - MergedPluginsConfig /v1/onboarding/generate-yaml: post: summary: Generate YAML Definition for entity operationId: onboarding-generate-yaml responses: '200': $ref: '#/components/responses/GenerateYamlResponse' tags: - OnboardingResource x-internal: true description: Generate YAML Definition for entity security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/GenerateYamlRequest' /v1/auth-info/{auth-id}: get: summary: Get Auth Info tags: - AuthInfo responses: '200': $ref: '#/components/responses/AuthInfoResponse' operationId: get-auth-info-auth-id description: Get auth details for given authId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/AuthId' x-internal: true post: summary: Save Auth Info tags: - AuthInfo operationId: save-auth-info-auth-id responses: '201': $ref: '#/components/responses/BackstageEnvVariableResponseList' description: Save auth details for given authId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/AuthId' x-internal: true requestBody: content: application/json: schema: $ref: '#/components/schemas/BackstageEnvVariableBatchRequest' /v1/allow-list: get: summary: Get backend url allow list tags: - AllowList responses: '200': $ref: '#/components/responses/AllowListResponse' operationId: get-allow-list security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true description: Get backend url allow list post: summary: Save backend url allow list description: Save backend url allow list tags: - AllowList operationId: save-allow-list responses: '201': $ref: '#/components/responses/AllowListResponse' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true requestBody: content: application/json: schema: $ref: '#/components/schemas/AllowListRequest' description: Save backend url allow list /v1/configuration-entities: put: summary: Updates entities present in the configuration screen operationId: update-configuration-entities responses: '200': $ref: '#/components/responses/ConfigurationEntitiesResponse' description: Updates entities present in the configuration screen security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/ConfigurationEntitiesRequest' x-internal: true tags: - MergedPluginsConfig x-stoplight: id: 67gwj4u4mz6nb /v1/data-sources: get: summary: Get Datasources Present In Account tags: - DataSource responses: '200': $ref: '#/components/responses/DataSourcesResponse' operationId: get-all-datasources-for-account x-stoplight: id: vdsu1dzt8t3tz parameters: - $ref: '#/components/parameters/AccountHeader5' description: API for getting all the datasources present in account. x-internal: false security: - x-api-key: [] /v1/data-sources/{data-source}/datapoints: parameters: - schema: type: string name: data-source in: path required: true description: Identifier for datasource get: summary: Get DataPoints present in DataSources for an account tags: - DataSource responses: '200': $ref: '#/components/responses/DatapointResponse' operationId: get-data-points-for-data-source x-stoplight: id: aogrjef7pusxj description: Get DataPoints Present in DataSources x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/scores/summary: get: summary: Get Score Summary for Scorecards responses: '200': $ref: '#/components/responses/ScorecardSummaryInfoResponse' operationId: get-all-scorecard-summary x-stoplight: id: 6hoo6kwpvy1p8 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/EntityIdentifier' x-internal: false tags: - Scores parameters: [] /v1/scores: get: summary: Get Scores for Scorecards responses: '200': $ref: '#/components/responses/ScorecardScoreResponse' operationId: get-scorecards-scores-overview x-stoplight: id: lpnl6xzlj655z security: - x-api-key: [] x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/EntityIdentifier' tags: - Scores parameters: [] /v1/scores/aggregate: post: summary: Get Aggregated Scores for Catalog entities responses: '200': $ref: '#/components/responses/EntityScoresResponseList' operationId: get-aggregated-scores x-stoplight: id: i14tbedz1cc8u security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScorecardFilter' x-internal: false tags: - Scores /v1/scores/graph: get: summary: Get Data for check status for graph responses: '200': $ref: '#/components/responses/ScorecardGraphSummaryResponse' operationId: get-scorecards-graphs-score-summary x-stoplight: id: 8pd67sxvs7wwe x-internal: true parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/EntityIdentifier' - schema: type: string default: null in: query name: scorecard_identifier description: 'Identifier for scorecard ' security: - x-api-key: [] tags: - Scores parameters: [] /v1/scores/recalibrate: parameters: [] post: summary: Trigger recalibration of scores for a scorecard operationId: scorecard-recalibrate responses: '200': $ref: '#/components/responses/ScorecardRecalibrateResponse' x-stoplight: id: 3px6djmawemwv description: API for Recalibrating the score for scorecard of entity security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/ScorecardRecalibrateRequest' parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: true tags: - Scores /v1/checks: get: summary: Get all checks available parameters: - $ref: '#/components/parameters/CheckType' - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' tags: - Checks x-stoplight: id: fybtgv0otf34d operationId: get-checks description: Get all checks available x-internal: false security: - x-api-key: [] responses: '200': $ref: '#/components/responses/CheckResponseList' post: summary: Create a custom check tags: - Checks operationId: create-check responses: '201': $ref: '#/components/responses/DefaultSaveResponse' x-stoplight: id: pzk9h0n0suta2 description: Create a custom check security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckDetailsRequest' x-internal: false /v1/checks/{check-id}: get: summary: Get check details for given checkId tags: - Checks responses: '200': $ref: '#/components/responses/CheckDetailsResponse' operationId: get-check x-stoplight: id: 7n0j23984d2ep description: Get check details for given checkId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/CheckIdentifier' - $ref: '#/components/parameters/CheckType' x-internal: false put: summary: Update check details for given checkId tags: - Checks operationId: update-check responses: '200': $ref: '#/components/responses/DefaultSaveResponse' x-stoplight: id: e6w24mxeru0p6 description: Update check details for given checkId x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/CheckIdentifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckDetailsRequest' delete: summary: Delete check details for given checkId operationId: delete-check description: Delete check details for given checkId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/CheckIdentifier' - $ref: '#/components/parameters/ForceDelete2' x-internal: false responses: '204': description: No Content tags: - Checks x-stoplight: id: pgtm5cqq7zqmt /v1/checks/{check-id}/stats: get: summary: Get check stats for given checkId tags: - Checks responses: '200': $ref: '#/components/responses/CheckStatsResponse' operationId: get-check-stats x-stoplight: id: x6f6yi2hkheeh description: Get check stats for given checkId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/CheckIdentifier' - $ref: '#/components/parameters/CheckType' /v1/checks/{check-id}/graph: get: summary: Get check graph data for given checkId tags: - Checks responses: '200': $ref: '#/components/responses/CheckGraphResponse' operationId: get-check-graph x-stoplight: id: x6f6yi2hkheeh description: Get check graph data for given checkId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/CheckIdentifier' - $ref: '#/components/parameters/CheckType' /v1/scorecards: get: summary: Get all scorecards available tags: - Scorecards responses: '200': $ref: '#/components/responses/ScorecardResponseList' operationId: get-scorecards x-stoplight: id: sd1pqx1g9pu0o description: Get all scorecards available x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' post: summary: Create scorecard tags: - Scorecards operationId: create-scorecard responses: '201': $ref: '#/components/responses/DefaultSaveResponse' x-stoplight: id: 7ky7v205witp4 description: Create scorecard security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScorecardDetailsRequest' x-internal: false /v1/scorecards/{scorecard-id}: get: summary: Get scorecard details for given scorecardId tags: - Scorecards responses: '200': $ref: '#/components/responses/ScorecardDetailsResponse' operationId: get-scorecard description: Get scorecard details for given scorecardId x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/ScorecardIdentifier' x-stoplight: id: 7q992jg8e5lre put: summary: Update scorecard details for given scorecardId tags: - Scorecards operationId: update-scorecard responses: '200': $ref: '#/components/responses/DefaultSaveResponse' x-stoplight: id: zfrmn6vx8zk2x description: Update scorecard details for given scorecardId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/ScorecardIdentifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScorecardDetailsRequest' x-internal: false delete: summary: Delete scorecard details for given scorecardId operationId: delete-scorecard description: Delete scorecard details for given scorecardId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/ScorecardIdentifier' x-internal: false responses: '204': description: No Content tags: - Scorecards x-stoplight: id: t4gtsw95rgoh8 /v1/scorecards/{scorecard-id}/stats: get: summary: Get scorecard stats for given scorecardId tags: - Scorecards responses: '200': $ref: '#/components/responses/ScorecardStatsResponse' operationId: get-scorecard-stats x-stoplight: id: y6e6yo2hkheeh description: Get scorecard stats for given scorecardId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/ScorecardIdentifier' /v1/entity-facets: get: summary: Get all entity facets for given kind tags: - Scorecards responses: '200': $ref: '#/components/responses/FacetsResponse' operationId: get-entity-facets x-stoplight: id: 8fjdnw2gtfpr7 description: Get all entity facets for given kind security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/CatalogKind' /v1/data-sources/harness/data-point/values: parameters: [] post: summary: Get data points data for harness data source operationId: get-harness-data-point-values responses: '200': $ref: '#/components/responses/DataSourceDataPointInfoResponse' x-stoplight: id: fv69lcewj02rp parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/DataSourceDataPointInfoRequest' x-internal: true tags: - HarnessDataPoints /v1/data-sources/data-points/map: get: summary: Get Data Sources and Data Points Map for Account tags: - DataSource responses: '200': $ref: '#/components/responses/DataSourceDataPointsMapResponse' operationId: get-data-sources-data-points-map x-stoplight: id: hxskmevkt524r description: API for getting the map of data sources and data points for account x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/data-sources/kubernetes/data-point/values: post: summary: Get data points data for kubernetes data source operationId: get-k8s-data-point-values tags: - KubernetesDataPoints responses: '200': $ref: '#/components/responses/DataSourceDataPointInfoResponse' x-stoplight: id: 9fg71j8suvpxn requestBody: $ref: '#/components/requestBodies/KubernetesConfigRequest' parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] /v1/data-sources/scm/data-point/values: post: summary: Get data points data for scm data source operationId: get-scm-data-point-values tags: - ScmDataPoints responses: '200': $ref: '#/components/responses/DataSourceDataPointInfoResponse' x-stoplight: id: 9fi72j8suwpyn requestBody: $ref: '#/components/requestBodies/ScmConfigRequest' parameters: - $ref: '#/components/parameters/AccountHeader5' security: - x-api-key: [] /v1/license/usage/save: post: summary: Save IDP module license usage operationId: idp-license-usage-save responses: '200': $ref: '#/components/responses/LicenseUsageSaveResponse' x-stoplight: id: 7ptx9noskc4vz x-internal: true description: Save IDP module license usage security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - LicenseUsageResource requestBody: $ref: '#/components/requestBodies/LicenseUsageSaveRequest' /v2/scores/recalibrate: post: summary: Trigger recalibration of scores for a scorecard operationId: scorecard-recalibrate-v2 responses: '202': $ref: '#/components/responses/ScorecardRecalibrateResponseV2' x-stoplight: id: 7bibsplzghpox description: API for triggering score recalibration for a scorecard tags: - ScoresV2 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/ScorecardRecalibrateRequest' x-internal: true /v1/scores/recalibrate/status: get: summary: Get score recalibration status tags: - Scores responses: '200': $ref: '#/components/responses/ScorecardRecalibrateResponseV2' operationId: get-scores-recalibrate-status x-stoplight: id: 2qlp5rle9cmv8 description: Get status of score computation request security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/ScorecardRecalibrateRequest' x-internal: true parameters: [] /v1/aggregation-rules: get: summary: Get all aggregation rules tags: - AggregationRules responses: '200': $ref: '#/components/responses/AggregationRuleResponseList' operationId: get-aggregation-rules description: List aggregation rules security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' post: summary: Create an aggregation rule tags: - AggregationRules operationId: create-aggregation-rule responses: '201': $ref: '#/components/responses/AggregationRuleDetailsResponse' description: Create an aggregation rule security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregationRuleDetailsRequest' /v1/aggregation-rules/{aggregation-rule-id}: get: summary: Get an aggregation rule tags: - AggregationRules responses: '200': $ref: '#/components/responses/AggregationRuleDetailsResponse' operationId: get-aggregation-rule description: Get an aggregation rule security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/AggregationRuleIdentifier' put: summary: Update an aggregation rule tags: - AggregationRules operationId: update-aggregation-rule responses: '200': $ref: '#/components/responses/DefaultSaveResponse' description: Update an aggregation rule security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/AggregationRuleIdentifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregationRuleDetailsRequest' delete: summary: Delete an aggregation rule tags: - AggregationRules operationId: delete-aggregation-rule description: Delete an aggregation rule security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/AggregationRuleIdentifier' - $ref: '#/components/parameters/ForceDelete2' responses: '204': description: No Content x-internal: false /v1/aggregation-rules/review: post: summary: Review aggregation computation targets tags: - AggregationRules operationId: review-aggregation-rules description: Resolve platform entities that will contain the aggregated values security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregationSelectionReviewRequest' responses: '200': $ref: '#/components/responses/AggregationSelectionReviewResponse' /v1/aggregation-rules/{aggregation-rule-id}/compute: post: summary: Trigger computation for an aggregation rule tags: - AggregationRules operationId: trigger-aggregation-rule-computation description: >- Trigger computation for a rule. If a computation is already running for the rule, the request is rejected. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/AggregationRuleIdentifier' responses: '200': description: Computation triggered successfully /v1/backstage-harness/sync: post: summary: Sync Backstage Entities as Harness Entities for all IDP enabled accounts tags: - BackstageHarness responses: '200': $ref: '#/components/responses/BackstageHarnessSyncEntitiesResponse' operationId: backstage-harness-sync-all-accounts description: >- Syncs Backstage Entities as Harness Entities for all IDP enabled accounts x-internal: true security: - x-api-key: [] /v1/backstage-harness/sync/for-account: post: summary: Sync Backstage Entities as Harness Entities for given account tags: - BackstageHarness responses: '200': $ref: '#/components/responses/BackstageHarnessSyncEntitiesResponse' operationId: backstage-harness-sync-for-account description: Syncs Backstage Entities as Harness Entities for given account x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/backstage-harness/sync/for-entity: post: summary: >- Sync Backstage entity as Harness entity for given account and entity with specified action and sync mode tags: - BackstageHarness requestBody: $ref: '#/components/requestBodies/BackstageHarnessSyncRequest' responses: '200': $ref: '#/components/responses/BackstageHarnessSyncEntitiesResponse' operationId: backstage-harness-sync-for-account-entity description: >- Sync Backstage entity as Harness entity for given account and entity with specified action and sync mode x-internal: true security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/catalog/custom-properties: post: summary: Ingest catalog custom properties tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyByFieldResponse' operationId: ingest-catalog-custom-properties x-stoplight: id: 3eczjage6lz9a x-internal: false description: Ingest catalog custom properties security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/DryRunCatalogCustomProperties' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomPropertyFilterRequest' application/yaml: schema: $ref: '#/components/schemas/CustomPropertyFilterRequest' parameters: [] delete: summary: Delete catalog custom properties tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyDeleteByFieldResponse' operationId: delete-catalog-custom-properties x-stoplight: id: vb71p39cmv358 description: Delete catalog custom properties x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/DryRunCatalogCustomProperties' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomPropertyFilterDeleteRequest' application/yaml: schema: $ref: '#/components/schemas/CustomPropertyFilterDeleteRequest' /v1/catalog/custom-properties/entity: get: summary: Get catalog custom properties for given entity tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyByEntityGetResponse' operationId: get-catalog-custom-properties-by-entity x-stoplight: id: 3edqlaqe8lz9b x-internal: false description: Get catalog custom properties for given entity security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/EntityRef' post: summary: Ingest catalog custom properties for given entity tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyResponse' operationId: ingest-catalog-custom-properties-by-entity x-stoplight: id: 3eczoaje6lz0g x-internal: false description: Ingest catalog custom properties for given entity security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/DryRunCatalogCustomProperties' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomPropertyByEntityRequest' application/yaml: schema: $ref: '#/components/schemas/CustomPropertyByEntityRequest' delete: summary: Delete catalog custom properties for given entity tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyResponse' operationId: delete-catalog-custom-properties-by-entity x-stoplight: id: vb71p39dmz358 description: Delete catalog custom properties for given entity x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/DryRunCatalogCustomProperties' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomPropertyByEntityDeleteRequest' application/yaml: schema: $ref: '#/components/schemas/CustomPropertyByEntityDeleteRequest' /v1/catalog/custom-properties/property: get: summary: Get entities for given custom property tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyByFieldGetResponse' operationId: get-entities-by-catalog-custom-property x-stoplight: id: 3edljble6lz9a x-internal: false description: Get entities for given custom property security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Property' post: summary: Ingest entities for given custom property tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyResponse' operationId: ingest-entities-by-catalog-custom-property x-stoplight: id: 3eczoaje6lz0g x-internal: false description: Ingest entities for given custom property security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/DryRunCatalogCustomProperties' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomPropertyByFieldRequest' application/yaml: schema: $ref: '#/components/schemas/CustomPropertyByFieldRequest' delete: summary: Delete entities for given custom property tags: - CatalogCustomProperties responses: '200': $ref: '#/components/responses/CustomPropertyResponse' operationId: delete-entities-by-catalog-custom-property x-stoplight: id: vb71p39dmz358 description: Delete entities for given custom property x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/DryRunCatalogCustomProperties' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomPropertyByFieldDeleteRequest' application/yaml: schema: $ref: '#/components/schemas/CustomPropertyByFieldDeleteRequest' /v1/groups/{group-identifier}: get: summary: Get Group Details responses: '200': $ref: '#/components/responses/GroupResponse' operationId: get-group-details x-stoplight: id: nby8lq3g0vg27 parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: false tags: - Groups security: - x-api-key: [] parameters: - schema: type: string name: group-identifier in: path required: true delete: summary: Delete a group responses: '204': description: No Content operationId: delete-group x-stoplight: id: up9xj9134iolf parameters: - $ref: '#/components/parameters/AccountHeader5' x-internal: false tags: - Groups security: - x-api-key: [] /v1/groups: get: summary: Get all groups for account responses: '200': $ref: '#/components/responses/GroupResponseList' operationId: get-all-groups-for-account x-stoplight: id: qi2aylcdl7t09 x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - Groups security: - x-api-key: [] post: summary: Save a group responses: '200': $ref: '#/components/responses/GroupResponse' operationId: save-group x-stoplight: id: c6hf0g9o84pnc parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/GroupRequest' x-internal: false tags: - Groups security: - x-api-key: [] put: summary: Update Groups responses: '200': $ref: '#/components/responses/GroupResponseList' operationId: update-groups x-stoplight: id: eaxiri07lz2kj x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/GroupRequestList' tags: - Groups security: - x-api-key: [] parameters: [] /v1/groups/yaml: get: summary: Get Groups Yaml responses: '200': $ref: '#/components/responses/GroupsYamlResponse' operationId: get-groups-yaml x-stoplight: id: wbu7fk4liwa52 x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' tags: - Groups security: - x-api-key: [] parameters: [] /v1/groups/workflows: get: summary: Get workflows for account tags: - Groups security: - x-api-key: [] responses: '200': $ref: '#/components/responses/WorkflowsInfoResponse' operationId: get-workflows-for-account x-stoplight: id: czv3pmqlvtng4 x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' parameters: [] /v1/home-page-layout: get: summary: Get Home Page Layout Details tags: - HomePageLayout security: - x-api-key: [] responses: '200': $ref: '#/components/responses/HomePageLayoutResponse' operationId: get-home-page-layout-info x-stoplight: id: 5qz0to5vb79zr x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' post: summary: Save Home Page Layout Details responses: '200': $ref: '#/components/responses/HomePageLayoutResponse' operationId: save-home-page-layout-info x-stoplight: id: n3iaiocyjv0kh x-internal: false requestBody: $ref: '#/components/requestBodies/HomePageLayoutRequest' tags: - HomePageLayout security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/home-page-layout/yaml: get: summary: Get yaml for home page layout tags: - HomePageLayout security: - x-api-key: [] responses: '200': $ref: '#/components/responses/HomePageLayoutYamlResponse' operationId: get-yaml-for-home-page-layout x-stoplight: id: 1zne0xmh0mj6o x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/home-page-layout/custom-card/{card-identifier}/quick-links/{quick-link-identifier}/icon: parameters: - schema: type: string name: card-identifier in: path required: true - schema: type: string name: quick-link-identifier in: path required: true delete: summary: Delete custom link card quick links icon tags: - HomePageLayout security: - x-api-key: [] responses: '204': description: No Content operationId: delete-custom-link-card-quick-links x-stoplight: id: hovwmpqwogep9 x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/home-page-layout/header/quick-links/{quick-link-identifier}/icon: parameters: - schema: type: string name: quick-link-identifier in: path required: true delete: summary: Delete header quick links icon tags: - HomePageLayout security: - x-api-key: [] responses: '204': description: No Content operationId: delete-headers-quick-links-icon x-stoplight: id: 12si1vwf5qnvv x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/home-page-layout/card/{card-identifier}/icon: parameters: - schema: type: string name: card-identifier in: path required: true delete: summary: Delete card icon tags: - HomePageLayout security: - x-api-key: [] responses: '204': description: No Content operationId: delete-home-page-layout-cards-icon x-stoplight: id: wgvh8oyencivj x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' /v1/home-page-layout/icon: delete: summary: Delete homepage layout icon tags: - HomePageLayout security: - x-api-key: [] responses: '204': description: No Content operationId: delete-home-page-layout-icon x-stoplight: id: f7kbixtn6dju0 x-internal: false parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/DeleteHomePageLayoutIconRequest' /v1/entities: post: operationId: create-entity summary: Create an Entity description: >- Creates a new Entity in the specified scope (Account, Organization, or Project). Entities are the core components of the catalog system and can represent various resources such as services, APIs, user groups, and more. Each entity has a specific kind and type that defines its purpose in the system. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/AccountHeader5' - name: convert in: query required: false schema: type: boolean default: false description: >- When set to true, converts Backstage style YAML to Harness entity YAML format - name: dry_run in: query required: false schema: type: boolean default: false description: >- When set to true, validates the entity creation without actually creating it requestBody: $ref: '#/components/requestBodies/EntityCreateRequestBody' responses: '201': $ref: '#/components/responses/EntityResponseBody' description: Entity successfully created get: operationId: get-entities summary: Get Entities description: >- Retrieves a paginated list of Entities based on the provided filters. This endpoint supports comprehensive filtering options to help you find specific entities across different scopes, kinds, and other properties. The response includes pagination metadata and counts for owned and favorite entities. When a search returns no matching entities, the API returns a 200 status code with an empty data array. This is the expected behavior for this list API. Note that 400 status codes are only returned when a specific entity is requested and not found (e.g., in the Get Entity Details endpoint). tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/LimitWithRestriction' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' - name: scopes description: >- Filter entities by specific scopes (account.\*, account, account.org, account.org.project, account.orgId, account.orgId.projectId, account.orgId.\*) in: query schema: type: string default: null - name: entity_refs description: >- Filter entities by their entity references (comma-separated list in the format of kind:scope/identifier) in: query schema: type: string default: null - name: owned_by_me description: >- When true, returns only entities owned by the current user or their groups in: query schema: type: boolean default: false - name: favorites description: >- When true, returns only entities marked as favorites by the current user in: query schema: type: boolean default: false - $ref: '#/components/parameters/KindQueryParam' - name: type description: Filter entities by their type (e.g., Service, Website) in: query schema: type: string default: null - name: owner description: Filter entities by their owner references in: query schema: type: string default: null - name: lifecycle description: >- Filter entities by their lifecycle stage (e.g., experimental, production) in: query schema: type: string default: null - name: tags description: Filter entities by their associated tags (comma-separated list) in: query schema: type: string default: null responses: '200': $ref: '#/components/responses/EntityResponseBodyList' description: >- Paginated list of entities matching the filter criteria with pagination metadata in headers (X-Total-Elements, X-Page-Number, X-Page-Size) and ownership counts (Total-Owned, Total-Starred) /v1/teams/hierarchy: get: summary: Get Team Hierarchy description: >- Returns the full hierarchy of Teams (sub-teams nested to N levels) for selecting a parent Team within the requested scope. operationId: get-team-hierarchy x-stoplight: id: get-team-hierarchy x-internal: true tags: - Teams security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - name: scopes description: Filter entities on the scopes in: query schema: type: string - name: include_child_scopes description: Include Sub-Teams that are in the child scopes in: query schema: type: boolean - name: custom description: Filter only Custom User Groups in: query schema: type: boolean - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/LimitWithRestriction' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' responses: '200': $ref: '#/components/responses/TeamHierarchyResponse' /v1/teams/{scope}/{identifier}/owned-entities: get: operationId: get-team-owned-entities summary: Get entities owned by a team description: >- List all catalog entities owned by the given team. When include_child_teams is true, also includes entities owned by all descendant subteams at any depth in the team hierarchy. The team must be a group entity (kind=group). tags: - Teams security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/ScopeParam' - $ref: '#/components/parameters/IdentifierParam' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/LimitWithRestriction' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' - name: include_child_teams description: >- When true, also include entities owned by all descendant subteams at any depth. in: query schema: type: boolean responses: '200': $ref: '#/components/responses/EntityResponseBodyList' /v1/entities/bulk-field-update: post: summary: Submit a bulk field update on catalog entities tags: - Entities responses: '202': $ref: '#/components/responses/BulkFieldUpdateSubmitResponse' operationId: submit-bulk-update-entity-field x-internal: false description: >- Submit an asynchronous bulk field update. Selects catalog entities by either a filter or a list of entityRefs and updates a single allowlisted field (given as key/value, e.g. key "owner", value "group:account/TeamA") on every entity the caller is permitted to edit. Validation and edit-permission are checked synchronously; the mutation is processed asynchronously. Returns an operationId to poll for status. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkEntityFieldUpdateRequest' application/yaml: schema: $ref: '#/components/schemas/BulkEntityFieldUpdateRequest' /v1/entities/bulk-field-update/{operation-id}: get: summary: Get bulk field update operation status tags: - Entities responses: '200': $ref: '#/components/responses/BulkFieldUpdateOperationResponse' operationId: get-bulk-update-entity-field-operation x-internal: false description: >- Get the status and result of a previously submitted bulk field update operation. security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - name: operation-id in: path required: true description: The operationId returned when the bulk update was submitted. schema: type: string /v1/entities/by-refs: post: summary: Get entities by refs description: >- Fetches entities matching the entity references specified in the request body, in conjunction with other provided filters. tags: - Entities responses: '200': $ref: '#/components/responses/EntityResponseBodyList' operationId: get-entities-by-refs x-stoplight: id: yztu80rla7s8m parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/LimitWithRestriction' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' - name: scopes description: Filter entities on the scopes in: query schema: type: string default: null - name: owned_by_me description: >- Filter entities owned by the user and the groups that the user is part of. in: query schema: type: boolean default: false - name: favorites description: Filter entities that are marked as favorites for the user. in: query schema: type: boolean default: false - $ref: '#/components/parameters/KindQueryParam' - name: type description: Types on which the Entities are filtered. in: query schema: type: string default: null - name: owner description: Owners on which the Entities are filtered. in: query schema: type: string default: null - name: lifecycle description: Lifecycles on which the Entities are filtered. in: query schema: type: string default: null - name: tags description: Tags on which the Entities are filtered. in: query schema: type: string default: null security: - x-api-key: [] requestBody: $ref: '#/components/requestBodies/EntitesByRefsRequest' /v1/entities/import: post: operationId: import-entity summary: Import an Entity from Git description: >- Imports a new Entity from Git in the specified scope (Account, Organization, or Project). tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/GitImportRequestBody' responses: '201': $ref: '#/components/responses/EntityResponseBody' /v1/entities/groups: get: operationId: get-entities-groups x-internal: true summary: Get Entities Groups description: >- Retrieves entities organized in hierarchical groups based on account, organization, and project. This endpoint is useful for displaying entities in a structured UI view where entities need to be presented in their organizational context. The response contains both grouped and ungrouped entities at each level. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - name: search_on_entities in: query required: false schema: type: string default: null description: Filter entities by a search term across entity attributes - name: search_on_groups in: query required: false schema: type: string default: null description: Filter groups by a search term across group attributes - name: scopes description: >- Filter entities by specific scopes (account.\*, account, account.org, account.org.project, account.orgId, account.orgId.projectId, account.orgId.\*) in: query schema: type: string default: null - $ref: '#/components/parameters/KindQueryParam' - name: owned_by_me description: >- When true, returns only entities owned by the current user and their groups in: query schema: type: boolean default: false - name: favorites description: >- When true, returns only entities marked as favorites by the current user in: query schema: type: boolean default: false - name: type description: Filter entities by their type in: query schema: type: string default: null - name: owner description: Filter entities by their owner references in: query schema: type: string default: null - name: lifecycle description: Filter entities by their lifecycle stage in: query schema: type: string default: null - name: tags description: Filter entities by their associated tags in: query schema: type: string default: null responses: '200': $ref: '#/components/responses/EntitiesGroupsResponseBody' description: Entities grouped by organization and project /v1/entities/move/{scope}/{kind}/{identifier}: post: operationId: move-entity summary: Move an Entity description: Move an existing Inline entity to Remote. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/ScopeParam' - $ref: '#/components/parameters/KindParam' - $ref: '#/components/parameters/IdentifierParam' - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/EntityMoveRequestBody' responses: '201': $ref: '#/components/responses/DefaultSaveResponse' /v1/entities/git-metadata/{scope}/{kind}/{identifier}: put: summary: Update GitMetadata for Remote Entities operationId: update-git-metadata description: Update GitMetadata for Remote Entities responses: '200': $ref: '#/components/responses/DefaultSaveResponse' requestBody: $ref: '#/components/requestBodies/GitMetadataUpdateRequestBody1' security: - x-api-key: [] parameters: - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/ScopeParam' - $ref: '#/components/parameters/KindParam' - $ref: '#/components/parameters/IdentifierParam' - $ref: '#/components/parameters/AccountHeader5' tags: - Entities x-stoplight: id: 2uv1mspdrbzvj /v1/entities/convert/{option}: post: operationId: convert-entity summary: Convert Entity Format description: >- Converts entity YAML between Backstage and Harness formats. This is useful when migrating entities between systems or when standardizing entity definitions across different platforms. The conversion preserves all semantic information while adapting to the target format conventions. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - name: option in: path required: true schema: type: string enum: - backstage-to-harness - harness-to-backstage description: >- Conversion direction - either convert from Backstage to Harness format or vice versa requestBody: $ref: '#/components/requestBodies/EntityRequestBody' responses: '200': $ref: '#/components/responses/EntityConvertResponseBody' description: Entity YAML successfully converted to the target format /v1/entities/{scope}/{kind}/{identifier}: parameters: - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/ScopeParam' - $ref: '#/components/parameters/KindParam' - $ref: '#/components/parameters/IdentifierParam' put: operationId: update-entity summary: Update an Entity description: >- Updates an existing Entity identified by its scope, kind, and identifier. All fields in the entity definition will be replaced with the new values provided in the request. This operation is idempotent and will create the entity if it doesn't already exist. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/EntityUpdateRequestBody' responses: '200': $ref: '#/components/responses/EntityResponseBody' description: Entity successfully updated delete: operationId: delete-entity summary: Delete an Entity description: >- Permanently removes an Entity identified by its scope, kind, and identifier from the system. This operation cannot be undone, so use it with caution. Any references to the deleted entity from other entities will become invalid. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '204': description: Entity successfully deleted with no content returned get: operationId: get-entity summary: Get Entity Details description: >- Retrieves the complete details of an Entity identified by its scope, kind, and identifier, including its YAML definition, metadata, and relationships with other entities. This endpoint provides the most comprehensive view of a specific entity. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - schema: type: string default: null in: query name: branch_name description: Name of the branch (for Git Experience). - schema: type: string default: null in: query name: connector_ref description: >- Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience). - schema: type: string default: null in: query name: repo_name description: Name of the repository (for Git Experience). - schema: type: string default: 'false' in: header name: Load-From-Cache description: Flag to enable loading the remote entity from git or git cache - schema: type: boolean default: false in: query name: load_from_fallback_branch description: Flag to load the entity from the created non default branch responses: '200': $ref: '#/components/responses/EntityResponseBody' description: Complete entity details successfully retrieved /v1/entities/kinds: parameters: - $ref: '#/components/parameters/AccountIdentifierQueryParam' - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' get: operationId: get-entities-kinds summary: Get Entity Kinds description: >- Returns a list of all supported Entity Kinds along with their display names, descriptions, and counts. This is useful for populating filter dropdowns in UIs and for understanding what kinds of entities are available in the system. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '200': $ref: '#/components/responses/EntityKindsResponseBody' description: List of available entity kinds with their metadata and counts /v1/entities/filters: parameters: - $ref: '#/components/parameters/AccountIdentifierQueryParam' - $ref: '#/components/parameters/KindQueryParam' - name: scopes description: >- Filter entities by specific scopes (account.\*, account, account.org, account.org.project, account.orgId, account.orgId.projectId, account.orgId.\*) in: query schema: type: string default: null get: operationId: get-entities-filters summary: Get Entity Filter Options description: >- Returns the available filter options that can be used when querying entities. This helps in building dynamic filter UIs for entity exploration and discovery. The response includes filter names and their possible values based on the current entities in the system. tags: - Entities security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '200': $ref: '#/components/responses/EntityFiltersResponseBodyList' description: List of available filter options and their possible values post: summary: Get Entities Filters By Query description: >- Returns the available filter options that can be used when querying entities based on the provided query.This helps in building dynamic filter UIs for entity exploration and discovery.The response includes filter names and their possible values based on the current entities in the system. tags: - Entities security: - x-api-key: [] responses: '200': $ref: '#/components/responses/EntityFiltersResponseBodyList' operationId: get-entities-filters-by-query x-stoplight: id: 34d8rd6couqo6 parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/EntityFilterQueryRequest' /v1/entities/json-schema: parameters: - $ref: '#/components/parameters/KindQueryParam' get: operationId: get-json-schema summary: Get Entity JSON Schema description: >- Returns the JSON Schema for validating Entity definitions. This is useful for client-side validation before submitting entity creation or update requests. The schema can be filtered by entity kind to get specific validation rules. tags: - Entities security: - x-api-key: [] responses: '200': $ref: '#/components/responses/EntityJsonSchemaResponseBody' description: JSON Schema for entity validation successfully retrieved /v1/idp-environments: post: summary: Create Compile And Execute Environment description: Create environment in catalog, compiles it and then finally execute it. tags: - Environment responses: '200': description: OK operationId: create-compile-and-execute-environment x-stoplight: id: ve9qj9hgiro5a x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - name: dryRun in: query required: false schema: type: boolean default: false description: >- When true, only compiles and validates the environment without creating entity or executing. When false (default), compiles, creates entity, and executes. requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvironmentProxyCreateRequest' parameters: [] /v1/idp-environments/{environment-id}: parameters: - schema: type: string name: environment-id in: path required: true put: summary: Update Compile And Execute Environment description: Update environment in catalog, compiles it and then finally execute it. tags: - Environment responses: '200': description: OK operationId: update-compile-and-execute-environment x-stoplight: id: j5gxzay5ncy66 x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvironmentProxyUpdateRequest' delete: summary: Delete Environment description: Delete any environment that is no longer active tags: - Environment responses: '200': description: OK operationId: delete-environment1 x-stoplight: id: g5au3w8dvrhxk security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/OrgIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' /v1/integrations/{integration}: get: summary: Get all integrations available tags: - Integrations responses: '200': $ref: '#/components/responses/IntegrationResponseList' operationId: get-integrations x-stoplight: id: sd1pqx1p9pu0o description: Get all integrations available x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/Integration' - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' post: summary: Create integration tags: - Integrations operationId: create-integration responses: '201': $ref: '#/components/responses/IntegrationResponse' x-stoplight: id: 7ky8v205wqtp4 description: Create integration security: - x-api-key: [] parameters: - $ref: '#/components/parameters/Integration' - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/DryRun' - $ref: '#/components/parameters/WriteValidation' requestBody: $ref: '#/components/requestBodies/IntegrationRequest' x-internal: false delete: summary: Delete integrations tags: - Integrations operationId: delete-integrations responses: '204': description: No Content description: Delete integrations security: - x-api-key: [] parameters: - $ref: '#/components/parameters/Integration' - $ref: '#/components/parameters/AccountHeader5' x-internal: true /v1/integrations/{integration}/{integration-id}: get: summary: Get integration details for given integrationId tags: - Integrations responses: '200': $ref: '#/components/responses/IntegrationResponse' operationId: get-integration description: Get integration details for given integrationId x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Integration' - $ref: '#/components/parameters/IntegrationIdentifier' x-stoplight: id: 7q983jg8e5lre put: summary: Update integration details for given integrationId tags: - Integrations operationId: update-integration responses: '200': $ref: '#/components/responses/IntegrationResponse' x-stoplight: id: zfrmn9vx8zk2x description: Update integration details for given integrationId security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Integration' - $ref: '#/components/parameters/IntegrationIdentifier' - $ref: '#/components/parameters/DryRun' requestBody: $ref: '#/components/requestBodies/IntegrationRequest' x-internal: false /v1/integrations/{integration-id}/discover/entities: get: summary: Get discovered entities for integration tags: - Integrations responses: '200': $ref: '#/components/responses/DiscoverEntitiesResponseList' operationId: discover-entities description: Get discovered entities for integration x-internal: false security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/IntegrationIdentifier' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/Limit5' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' post: summary: Save discovered entities for integration tags: - Integrations operationId: save-discover-entities responses: '202': description: >- Save discovered entities for integration request accepted for processing description: Save discovered entities for integration security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/IntegrationIdentifier' requestBody: $ref: '#/components/requestBodies/SaveDiscoverEntitiesRequest' x-internal: false /v1/integrations/{integration-id}/entities/unlink: post: summary: Unlink entities for integration tags: - Integrations operationId: unlinkIntegrationEntities responses: '200': $ref: '#/components/responses/UnlinkIntegrationEntitiesResponse' description: Unlink entities for integration security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/IntegrationIdentifier' requestBody: $ref: '#/components/requestBodies/UnlinkIntegrationEntitiesRequest' x-internal: false /v1/kinds: post: operationId: create-kind summary: Create a Kind description: Create a Kind. tags: - Kinds security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/KindCreateRequestBody' responses: '201': $ref: '#/components/responses/KindResponseBody' get: operationId: get-kinds summary: Get Kinds description: Get Kinds. tags: - Kinds security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/Page1' - $ref: '#/components/parameters/LimitWithRestriction' - $ref: '#/components/parameters/Sort6' - $ref: '#/components/parameters/SearchTerm5' - $ref: '#/components/parameters/KindType' responses: '200': $ref: '#/components/responses/KindResponseBodyList' /v1/kinds/{identifier}: parameters: - $ref: '#/components/parameters/IdentifierParam' put: operationId: update-kind summary: Update a Kind description: Update a Kind. tags: - Kinds security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/KindUpdateRequestBody' responses: '200': $ref: '#/components/responses/KindResponseBody' delete: operationId: delete-kind summary: Delete a Kind description: Delete a Kind. tags: - Kinds security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '204': description: No Content get: operationId: get-kind summary: Get Kind description: Get Kind. tags: - Kinds security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' - $ref: '#/components/parameters/KindType' responses: '200': $ref: '#/components/responses/KindResponseBody' /v1/kinds/schema: get: operationId: get-kind-schema summary: Get Kind Schema description: Get Kind Schema. tags: - Kinds security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '200': $ref: '#/components/responses/KindSchemaResponseBody' /v1/kinds/schema/validate: post: operationId: kind-schema-validate summary: Validate kind schema description: Validate kind schema. tags: - Kinds security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/KindSchemaValidateRequestBody' responses: '204': description: No Content /v3/layout: get: operationId: get-layouts-v3 summary: Get Layouts V3 description: Get Layouts V3. tags: - LayoutsV3 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '200': $ref: '#/components/responses/LayoutResponse' post: operationId: create-layout-v3 summary: Create layout V3 description: Create layout V3. tags: - LayoutsV3 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/LayoutRequest' responses: '200': $ref: '#/components/responses/LayoutResponse' delete: operationId: delete-layout-v3 summary: Delete layout V3 description: Delete layout V3. tags: - LayoutsV3 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: $ref: '#/components/requestBodies/LayoutRequest' responses: '200': description: Layout response content: text/plain: schema: $ref: '#/components/schemas/LayoutResponse' application/json: schema: $ref: '#/components/schemas/LayoutResponse' /v3/layout/{layout-identifier}: get: operationId: get-layout-v3 summary: Get layout V3 description: Get Layout V3. tags: - LayoutsV3 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '200': $ref: '#/components/responses/LayoutResponse' parameters: - $ref: '#/components/parameters/LayoutIdentifier' /v3/layout/health: get: operationId: get-layout-health-v3 summary: Get Layout Health V3 description: Get Layout Health V3. tags: - LayoutsV3 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '200': $ref: '#/components/responses/LayoutResponse' /v3/layout/ingest: post: operationId: layout-ingest-v3 summary: Ingest layout V3 description: Ingest layout V3. tags: - LayoutsV3 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' requestBody: content: application/json: schema: $ref: '#/components/schemas/LayoutIngestRequest' responses: '200': $ref: '#/components/responses/LayoutResponse' /v4/layout: get: operationId: get-layouts-v4 summary: Get Layouts V4 description: Get Layouts V4. tags: - LayoutsV4 security: - x-api-key: [] parameters: - $ref: '#/components/parameters/AccountHeader5' responses: '200': $ref: '#/components/responses/LayoutResponse' /api/environments/compile: post: tags: - Environment summary: Compile Environment description: >- Endpoint for compiling an environment and a target state to a valid infrastructure operationId: Environment#Compile parameters: - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CompileRequestBody' responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CompileResponseBody' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/environments/schemas: get: tags: - Environment summary: Schemas Environment description: >- Endpoint for retrieving the environment and environment blueprint schemas operationId: Environment#Schemas parameters: - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SchemasRequestBody' responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/SchemasResponseBody' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures: get: tags: - Infrastructure summary: List Infrastructure description: Endpoint for listing all infrastructures. operationId: Infrastructure#List parameters: - name: offset in: query description: Offset for pagination allowEmptyValue: true schema: type: integer description: Offset for pagination format: int64 - name: limit in: query description: Limit for pagination allowEmptyValue: true schema: type: integer description: Limit for pagination format: int64 - name: desc in: query description: Order by descending order allowEmptyValue: true schema: type: boolean description: Order by descending order - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InfrastructureList' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures/{executionID}/abort: post: tags: - Infrastructure summary: Abort Infrastructure description: Endpoint for aborting an infrastructure execution. operationId: Infrastructure#Abort parameters: - name: executionID in: path description: ID of the execution to abort required: true schema: type: string description: ID of the execution to abort - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SchemasRequestBody' responses: '200': description: OK response. '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures/{id}: delete: tags: - Infrastructure summary: Delete Infrastructure description: Endpoint for deleting a specific infrastructure. operationId: Infrastructure#Delete parameters: - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: id in: path description: ID of the infrastructure required: true schema: type: string description: ID of the infrastructure - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] get: tags: - Infrastructure summary: Get Infrastructure description: Endpoint for retrieving a specific infrastructure. operationId: Infrastructure#Get parameters: - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: id in: path description: ID of the infrastructure required: true schema: type: string description: ID of the infrastructure - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InfrastructureOutput' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures/{id}/executions: get: tags: - Infrastructure summary: ListExecutions Infrastructure description: Endpoint for listing executions for a specific infrastructure. operationId: Infrastructure#ListExecutions parameters: - name: offset in: query description: Offset for pagination allowEmptyValue: true schema: type: integer description: Offset for pagination format: int64 - name: limit in: query description: Limit for pagination allowEmptyValue: true schema: type: integer description: Limit for pagination format: int64 - name: desc in: query description: Order by descending order allowEmptyValue: true schema: type: boolean description: Order by descending order - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: id in: path description: ID of the infrastructure required: true schema: type: string description: ID of the infrastructure - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InfrastructureExecutionList' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures/{id}/specs: get: tags: - Infrastructure summary: ListSpecs Infrastructure description: Endpoint for listing specs for a specific infrastructure. operationId: Infrastructure#ListSpecs parameters: - name: offset in: query description: Offset for pagination allowEmptyValue: true schema: type: integer description: Offset for pagination format: int64 - name: limit in: query description: Limit for pagination allowEmptyValue: true schema: type: integer description: Limit for pagination format: int64 - name: desc in: query description: Order by descending order allowEmptyValue: true schema: type: boolean description: Order by descending order - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: id in: path description: ID of the infrastructure required: true schema: type: string description: ID of the infrastructure - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InfrastructureSpecList' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures/approve: post: tags: - Infrastructure summary: ApprovePipelineExecution Infrastructure description: Endpoint for approving a pipeline approval step. operationId: Infrastructure#ApprovePipelineExecution parameters: - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApprovePipelineExecutionRequestBody' responses: '200': description: OK response. '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures/execute: post: tags: - Infrastructure summary: Execute Infrastructure description: >- Endpoint for executing an infrastructure, with the options of either dryrunning this process, or forcing it. operationId: Infrastructure#Execute parameters: - name: dryRun in: query description: Dry run the infrastructure allowEmptyValue: true schema: type: boolean description: Dry run the infrastructure - name: force in: query description: Force updates to all instances in the infrastructure allowEmptyValue: true schema: type: boolean description: Force updates to all instances in the infrastructure - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteRequestBody' responses: '200': description: OK response. content: application/json: schema: type: string '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/infrastructures/executions/{id}: get: tags: - Infrastructure summary: GetExecution Infrastructure description: >- Endpoint for retrieving a specific execution for a specific infrastructure. operationId: Infrastructure#GetExecution parameters: - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: id in: path description: ID of the event to fetch required: true schema: type: string description: ID of the event to fetch - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InfrastructureExecution' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/instances: get: tags: - Instance summary: List Instance description: >- Endpoint for listing instances, with the option of filtering for a specific infrastructure. operationId: Instance#List parameters: - name: infrastructureID in: query description: ID of an Infrastructure to filter by allowEmptyValue: true schema: type: string description: ID of an Infrastructure to filter by - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: offset in: query description: Offset for pagination allowEmptyValue: true schema: type: integer description: Offset for pagination format: int64 - name: limit in: query description: Limit for pagination allowEmptyValue: true schema: type: integer description: Limit for pagination format: int64 - name: desc in: query description: Order by descending order allowEmptyValue: true schema: type: boolean description: Order by descending order - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InstanceList' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/instances/{id}: get: tags: - Instance summary: Get Instance description: Endpoint for retrieving a specific instance. operationId: Instance#Get parameters: - name: infrastructureID in: query description: ID of the infrastructure allowEmptyValue: true schema: type: string description: ID of the infrastructure - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: id in: path description: ID of the instance required: true schema: type: string description: ID of the instance - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/Instance' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/instances/{instanceID}/force-state: post: tags: - Instance summary: ForceState Instance description: Endpoint for forcing a specific instance to a specific state. operationId: Instance#ForceState parameters: - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: instanceID in: path description: ID of the instance to force status for required: true schema: type: string description: ID of the instance to force status for - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ForceStateRequestBody' responses: '200': description: OK response. '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/instances/events: get: tags: - Instance summary: ListEvents Instance description: Endpoint for listing events for a specific instance. operationId: Instance#ListEvents parameters: - name: instanceID in: query description: ID of an instance to filter by allowEmptyValue: true schema: type: string description: ID of an instance to filter by - name: infrastructureID in: query description: ID of an infrastructure to filter by allowEmptyValue: true schema: type: string description: ID of an infrastructure to filter by - name: infrastructureRevision in: query description: Revision of the infrastructure to filter by allowEmptyValue: true schema: type: integer description: Revision of the infrastructure to filter by format: int64 - name: offset in: query description: Offset for pagination allowEmptyValue: true schema: type: integer description: Offset for pagination format: int64 - name: limit in: query description: Limit for pagination allowEmptyValue: true schema: type: integer description: Limit for pagination format: int64 - name: desc in: query description: Order by descending order allowEmptyValue: true schema: type: boolean description: Order by descending order - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InstanceEventList' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /api/instances/events/{id}: get: tags: - Instance summary: GetEvent Instance description: Endpoint for retrieving a specific instance event. operationId: Instance#GetEvent parameters: - name: orgIdentifier in: query description: Org is the organization identifier. allowEmptyValue: true schema: type: string description: Org is the organization identifier. - name: projectIdentifier in: query description: Project is the project identifier. allowEmptyValue: true schema: type: string description: Project is the project identifier. - name: id in: path description: ID of the event to fetch required: true schema: type: string description: ID of the event to fetch - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. minLength: 1 maxLength: 128 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/InstanceEvent' '400': description: 'bad_request: Bad Request' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'not_found: Not Found' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'already_exists: Already Exists' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'internal_error: Internal Server Error' content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: 'unimplemented: Not Implemented' content: application/json: schema: $ref: '#/components/schemas/Error' security: - x-api-key: [] /ng/api/accounts/{accountIdentifier}: get: tags: - Accounts summary: Gets an account operationId: getAccountNG parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns an account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAccount' /ng/api/accounts/feature-flags/{accountIdentifier}: get: tags: - Accounts summary: Returns a list of all enabled feature flags in the account operationId: enabledFeatureFlags parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns a list of all enabled feature flags in the account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCollectionFeatureFlag' /ng/api/accounts/{accountIdentifier}/immutable-delegate-enabled: get: tags: - Accounts summary: Checks if immutable delegate is enabled for account operationId: isImmutableDelegateEnabled parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if immutable delegate is enabled for account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/accounts/license/update/{accountIdentifier}: put: tags: - Accounts summary: License update from UI operationId: licenseUpdateFromUING parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: accountStatus in: query description: Account License Status for the Entity. required: true schema: type: string - name: accountType in: query description: Account License Type for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns an boolean content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/accounts/{accountIdentifier}/name: put: tags: - Accounts summary: Update Account Name operationId: updateAccountNameNG parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: This is details of the Account. Name is mandatory. content: application/json: schema: $ref: '#/components/schemas/Account' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns an account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAccount' /ng/api/accounts/{accountIdentifier}/default-experience: put: tags: - Accounts summary: Update Default Experience operationId: updateAccountDefaultExperienceNG parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: This is details of the Account. DefaultExperience is mandatory content: application/json: schema: $ref: '#/components/schemas/Account' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns an account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAccount' /ng/api/drift-detection/{entityId}: get: tags: - Drift Detection summary: >- Get the captured deployment snapshot and latest drift check result for a deployed target operationId: getDriftDetectionDetail parameters: - name: entityId in: path description: Identifier of the deployed target (e.g. infrastructure key) required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string responses: default: description: Returns the drift detection detail content: application/json: schema: $ref: '#/components/schemas/ResponseDTODriftDetectionDetail' /ng/api/drift-detection: get: tags: - Drift Detection summary: >- List deployed targets (service/env/infra) tracked for drift detection in a project operationId: listDriftDetectionTargets parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 25 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string responses: default: description: Returns the paginated list of drift detection targets content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseDriftDetectionSummary /ng/api/environmentGroup: post: tags: - EnvironmentGroup summary: Create an Environment Group operationId: postEnvironmentGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean requestBody: description: Details of the Environment Group to be created content: application/json: schema: $ref: '#/components/schemas/EnvironmentGroupRequest' examples: Create: summary: Sample Environment Group create payload description: Sample Environment Group payload value: name: environmentGroup identifier: environmentGroupId orgIdentifier: default projectIdentifier: projectIdentifier yaml: | environmentGroup: name: environmentGroup identifier: environmentGroupId description: "" tags: {} orgIdentifier: default projectIdentifier: projectIdentifier envIdentifiers: - EnvironmentId1 - EnvironmentId2 application/yaml: schema: $ref: '#/components/schemas/EnvironmentGroupRequest' examples: Create: summary: Sample Environment Group create payload description: Sample Environment Group payload value: name: environmentGroup identifier: environmentGroupId orgIdentifier: default projectIdentifier: projectIdentifier yaml: | environmentGroup: name: environmentGroup identifier: environmentGroupId description: "" tags: {} orgIdentifier: default projectIdentifier: projectIdentifier envIdentifiers: - EnvironmentId1 - EnvironmentId2 required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- If the YAML is valid, returns created Environment Group. If not, it sends what is wrong with the YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroup' /ng/api/environmentGroup/{envGroupIdentifier}: get: tags: - EnvironmentGroup summary: Gets an Environment Group by identifier operationId: getEnvironmentGroup parameters: - name: envGroupIdentifier in: path description: Environment Group Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: deleted in: query description: Specify whether environment group is deleted or not schema: type: boolean default: false - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: The saved Environment Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroup' put: tags: - EnvironmentGroup summary: Update an Environment Group by Identifier operationId: updateEnvironmentGroup parameters: - name: If-Match in: header schema: type: string - name: envGroupIdentifier in: path description: Environment Group Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: Details of the Environment Group to be updated content: application/json: schema: $ref: '#/components/schemas/EnvironmentGroupRequest' examples: Update: summary: Sample Environment Group update payload description: Sample Environment Group payload value: name: environmentGroup identifier: environmentGroupId orgIdentifier: default projectIdentifier: projectIdentifier yaml: | environmentGroup: name: environmentGroup identifier: environmentGroupId description: "" tags: {} orgIdentifier: default projectIdentifier: projectIdentifier envIdentifiers: - EnvironmentId1 - EnvironmentId2 application/yaml: schema: $ref: '#/components/schemas/EnvironmentGroupRequest' examples: Update: summary: Sample Environment Group update payload description: Sample Environment Group payload value: name: environmentGroup identifier: environmentGroupId orgIdentifier: default projectIdentifier: projectIdentifier yaml: | environmentGroup: name: environmentGroup identifier: environmentGroupId description: "" tags: {} orgIdentifier: default projectIdentifier: projectIdentifier envIdentifiers: - EnvironmentId1 - EnvironmentId2 required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Environment Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroup' delete: tags: - EnvironmentGroup summary: Delete en Environment Group by Identifier operationId: deleteEnvironmentGroup parameters: - name: If-Match in: header schema: type: string - name: envGroupIdentifier in: path description: Environment Group Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: Last Object Id schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Environment Group is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroupDelete' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGroupDelete' /ng/api/environmentGroup/list: post: tags: - EnvironmentGroup summary: Gets Environment Group list operationId: getEnvironmentGroupList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: envGroupIdentifiers in: query schema: type: array items: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 25 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string - name: filterIdentifier in: query description: Filter identifier schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: includeAllEnvGroupsAccessibleAtScope in: query description: Specify true if all accessible environment groups are to be included schema: type: boolean default: false requestBody: description: >- This is the body for the filter properties for listing Environment Groups content: application/json: schema: $ref: '#/components/schemas/FilterProperties' application/yaml: schema: $ref: '#/components/schemas/FilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Environment Groups content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseEnvironmentGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseEnvironmentGroup' /ng/api/license-usage-cd/v2/{usageType}/csv/download: get: tags: - Usage summary: Download CD Usage CSV report operationId: downloadCDUsageCSVReport parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: usageType in: path required: true schema: type: string enum: - ServiceDeployment - Gitops - PipelineExecution - name: timestamp in: query schema: type: integer format: int64 default: 0 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Download CSV Active Services report /ng/api/connectors/ccmK8sList: post: tags: - Connectors summary: >- Fetches the list of CCM K8S Connectors corresponding to the request's filter criteria. operationId: getCCMK8SConnectorList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: searchTerm in: query description: >- This would be used to filter Connectors. Any Connector having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: filterIdentifier in: query schema: type: string - name: includeAllConnectorsAvailableAtScope in: query description: >- Specify whether or not to include all the Connectors accessible at the scope. For eg if set as true, at the Project scope we will get org and account Connector also in the response schema: type: boolean - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: getDistinctFromBranches in: query description: >- This when set to true along with GitSync enabled for the Connector, you can get one connector entity from each identifier. The connector entity can belong to any branch schema: type: boolean - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: Details of the filters applied content: application/json: schema: $ref: '#/components/schemas/ConnectorFilterProperties' text/yaml: schema: $ref: '#/components/schemas/ConnectorFilterProperties' text/html: schema: $ref: '#/components/schemas/ConnectorFilterProperties' text/plain: schema: $ref: '#/components/schemas/ConnectorFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Connectors content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseCcmK8sConnectorResponse text/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseCcmK8sConnectorResponse text/html: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseCcmK8sConnectorResponse /ng/api/connectors: get: tags: - Connectors summary: List all Connectors using filters description: Lists all the Connectors matching the specified filters. operationId: getConnectorList parameters: - name: pageIndex in: query description: Page number of navigation. By default, it is set to 0. schema: type: integer format: int32 default: 0 - name: pageSize in: query description: >- Number of entries per page.The default number of entries per page is 100, while the maximum number allowed is 1000. schema: maximum: 1000 type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: >- This would be used to filter Connectors. Any Connector having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: type in: query description: Filter Connectors by type schema: type: string enum: - K8sCluster - Git - Splunk - AppDynamics - Prometheus - Dynatrace - Vault - AzureKeyVault - DockerRegistry - Local - AwsKms - GcpKms - AwsSecretManager - Gcp - Aws - Azure - Artifactory - Jira - Jsm - Nexus - Github - Gitlab - Bitbucket - Codecommit - CEAws - CEAzure - GcpCloudCost - CEK8sCluster - HttpHelmRepo - NewRelic - Datadog - SumoLogic - PagerDuty - CustomHealth - ServiceNow - ErrorTracking - Pdc - AzureRepo - Jenkins - OciHelmRepo - CustomSecretManager - ElasticSearch - GcpSecretManager - AzureArtifacts - Tas - Spot - Bamboo - TerraformCloud - SignalFX - Harness - Rancher - JDBC - Zoom - MsTeams - Confluence - Slack - Salesforce - LangSmith - MLFlow - OpsGenie - GithubMcp - Mcp - OpenAI - Cursor - Devin - GithubCopilot - Anthropic - GoogleChat - XMatters - CustomHttp - name: category in: query description: Filter Connectors by category schema: type: string enum: - CLOUD_PROVIDER - SECRET_MANAGER - CLOUD_COST - ARTIFACTORY - CODE_REPO - MONITORING - TICKETING - DATABASE - COMMUNICATION - DOCUMENTATION - ML_OPS - MCP - AI - CUSTOM - name: source_category in: query description: >- Filter Connectors by Source Category. Available Source Categories are CLOUD_PROVIDER, SECRET_MANAGER, CLOUD_COST, ARTIFACTORY, CODE_REPO, MONITORING and TICKETING schema: type: string enum: - CLOUD_PROVIDER - SECRET_MANAGER - CLOUD_COST - ARTIFACTORY - CODE_REPO - MONITORING - TICKETING - DATABASE - COMMUNICATION - DOCUMENTATION - ML_OPS - MCP - AI - CUSTOM - name: version in: query schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Connectors content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseConnectorResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseConnectorResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseConnectorResponse' deprecated: true put: tags: - Connectors summary: Update a Connector description: Updates a Connector for the given ID. operationId: updateConnector parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: >- This is the updated Connector. Please provide values for all fields, not just the fields you are updating content: application/json: schema: $ref: '#/components/schemas/Connector2' text/yaml: schema: $ref: '#/components/schemas/Connector2' text/html: schema: $ref: '#/components/schemas/Connector2' text/plain: schema: $ref: '#/components/schemas/Connector2' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Connector content: application/json: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' post: tags: - Connectors summary: Create a Connector description: Creates a new Harness Connector. operationId: createConnector parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: storeType in: query description: Tells whether the Entity is to be saved on Git or not schema: type: string enum: - INLINE - REMOTE - INLINE_HC - name: repoName in: query description: Name of the repository. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: Details of the Connector to create content: application/json: schema: $ref: '#/components/schemas/Connector2' text/yaml: schema: $ref: '#/components/schemas/Connector2' text/html: schema: $ref: '#/components/schemas/Connector2' text/plain: schema: $ref: '#/components/schemas/Connector2' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created Connector content: application/json: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' /ng/api/connectors/{identifier}: get: tags: - Connectors summary: Return Connector details description: Returns the Connector's details for the given Account and Connector ID. operationId: getConnector parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Connector Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the connector with the requested accountIdentifier and connectorIdentifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOConnectorResponse' delete: tags: - Connectors summary: Delete a Connector description: Deletes a Connector for the given ID. operationId: deleteConnector parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Connector ID required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: Last Object Id schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Connector is deleted successfully and false if the Connector is not deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/connectors/fieldValues: get: tags: - Connectors summary: List all the configured field values for the given Connector type. description: >- Returns all the configured field values for the given Connector type, which can be used during connector creation. operationId: getAllAllowedFieldValues parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: connectorType in: query description: Connector type required: true schema: type: string enum: - K8sCluster - Git - Splunk - AppDynamics - Prometheus - Dynatrace - Vault - AzureKeyVault - DockerRegistry - Local - AwsKms - GcpKms - AwsSecretManager - Gcp - Aws - Azure - Artifactory - Jira - Jsm - Nexus - Github - Gitlab - Bitbucket - Codecommit - CEAws - CEAzure - GcpCloudCost - CEK8sCluster - HttpHelmRepo - NewRelic - Datadog - SumoLogic - PagerDuty - CustomHealth - ServiceNow - ErrorTracking - Pdc - AzureRepo - Jenkins - OciHelmRepo - CustomSecretManager - ElasticSearch - GcpSecretManager - AzureArtifacts - Tas - Spot - Bamboo - TerraformCloud - SignalFX - Harness - Rancher - JDBC - Zoom - MsTeams - Confluence - Slack - Salesforce - LangSmith - MLFlow - OpsGenie - GithubMcp - Mcp - OpenAI - Cursor - Devin - GithubCopilot - Anthropic - GoogleChat - XMatters - CustomHttp responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns all the configured field values for the given Connector type, which can be used during connector creation. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFieldValues' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFieldValues' text/html: schema: $ref: '#/components/schemas/ResponseDTOFieldValues' /ng/api/connectors/getceawstemplateurl: post: tags: - Connectors summary: Get the Template URL of connector operationId: getCEAwsTemplate parameters: - name: eventsEnabled in: query description: Specify whether or not to enable events schema: type: boolean - name: curEnabled in: query description: Specify whether or not to enable CUR schema: type: boolean - name: optimizationEnabled in: query description: Specify whether or not to enable optimization schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the cloud formation template URL to configure the Cloud Cost AWS Connector content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' text/html: schema: $ref: '#/components/schemas/ResponseDTOString' deprecated: true /ng/api/connectors/catalogue: get: tags: - Connectors summary: Lists all Connectors for an account description: Lists all the Connectors for the given Account ID. operationId: getConnectorCatalogue parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the Connector catalogue response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOConnectorCatalogueResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOConnectorCatalogueResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOConnectorCatalogueResponse' /ng/api/connectors/stats: get: tags: - Connectors summary: >- Gets the connector's statistics by Account Identifier, Project Identifier and Organization Identifier operationId: getConnectorStatistics parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the Connector's statistics content: application/json: schema: $ref: '#/components/schemas/ResponseDTOConnectorStatistics' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOConnectorStatistics' text/html: schema: $ref: '#/components/schemas/ResponseDTOConnectorStatistics' /ng/api/connectors/{connectorRef}/gcp-projects: get: tags: - Connectors summary: Get list of GCP Projects description: Returns the list of GCP project IDs that the connector has access to. operationId: getGcpProjects parameters: - name: connectorRef in: path description: Connector reference required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of GCP project IDs accessible by the connector content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGcpProjectResponseDTO' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGcpProjectResponseDTO' text/html: schema: $ref: '#/components/schemas/ResponseDTOGcpProjectResponseDTO' /ng/api/connectors/listV2: post: tags: - Connectors summary: >- Fetches the list of Connectors corresponding to the request's filter criteria. operationId: getConnectorListV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: searchTerm in: query description: >- This would be used to filter Connectors. Any Connector having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: filterIdentifier in: query schema: type: string - name: includeAllConnectorsAvailableAtScope in: query description: >- Specify whether or not to include all the Connectors accessible at the scope. For eg if set as true, at the Project scope we will get org and account Connector also in the response schema: type: boolean - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: getDistinctFromBranches in: query description: >- This when set to true along with GitSync enabled for the Connector, you can get one connector entity from each identifier. The connector entity can belong to any branch schema: type: boolean - name: version in: query schema: type: string - name: onlyFavorites in: query schema: type: boolean default: false - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: Details of the filters applied content: application/json: schema: $ref: '#/components/schemas/ConnectorFilterProperties' text/yaml: schema: $ref: '#/components/schemas/ConnectorFilterProperties' text/html: schema: $ref: '#/components/schemas/ConnectorFilterProperties' text/plain: schema: $ref: '#/components/schemas/ConnectorFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Connectors content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseConnectorResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseConnectorResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseConnectorResponse' /ng/api/connectors/listbyfqn: post: tags: - Connectors summary: Get list of Connectors by FQN description: >- Lists all Connectors for an Account by Fully Qualified Name (FQN) with a limit of max 1000 FQNs per request. operationId: listConnectorByFQN parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- A list of connectors' FQNs as strings. A maximum of 1000 FQNs are allowed. content: application/json: schema: type: array items: type: string text/yaml: schema: type: array items: type: string text/html: schema: type: array items: type: string text/plain: schema: type: array items: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Connectors content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListConnectorResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOListConnectorResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOListConnectorResponse' /ng/api/connectors/testConnection/{identifier}: post: tags: - Connectors summary: Test Harness Connector connection with third-party tool description: >- Tests if a Harness Connector can successfully connect Harness to a third-party tool. operationId: getTestConnectionResult parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Connector ID required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the Connector validation result content: application/json: schema: $ref: '#/components/schemas/ResponseDTOConnectorValidationResult' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOConnectorValidationResult' text/html: schema: $ref: '#/components/schemas/ResponseDTOConnectorValidationResult' /ng/api/connectors/testGitRepoConnection/{identifier}: post: tags: - Connectors summary: Test Git Connector sync with repo description: >- Tests if a Git Repo Connector can successfully connect Harness to a Git provider. operationId: getTestGitRepoConnectionResult parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: repoURL in: query description: >- URL of the repository, specify only in the case of Account Type Git Connector schema: type: string - name: identifier in: path description: Connector ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the Connector validation result content: application/json: schema: $ref: '#/components/schemas/ResponseDTOConnectorValidationResult' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOConnectorValidationResult' text/html: schema: $ref: '#/components/schemas/ResponseDTOConnectorValidationResult' /ng/api/connectors/validateUniqueIdentifier: get: tags: - Connectors summary: Test a Harness Connector description: >- Tests if a Connector can successfully connect Harness to a third-party tool using the an Account and Connector ID. operationId: validateTheIdentifierIsUnique parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query description: Connector ID schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Identifier is unique and false if the Identifier is not unique content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/google-secret-manager-connector/gcp-regions: get: tags: - GoogleSecretManagerConnector summary: Get list of GCP Regions description: Lists all GCP Regions operationId: getGcpRegions responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of GCP Regions content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOListString' text/html: schema: $ref: '#/components/schemas/ResponseDTOListString' /ng/api/mcp-connector/tools: get: tags: - MCPConnector summary: List tools exposed by an MCP server connector description: Returns the list of tools available from the connected MCP server operationId: listMCPTools parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: connectorIdentifier in: query description: Connector identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of MCP tools content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListMCPToolInfo' /ng/api/file-store: get: tags: - File Store summary: List Files and Folders metadata operationId: listFilesAndFolders parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifiers in: query description: >- This is the list of File IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: searchTerm in: query description: >- This will be used to filter files or folders. Any file or folder having the specified search term in its Name or Identifier will be filtered schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: List Files and Folders metadata content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageFile' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageFile' post: tags: - File Store summary: Create Folder or File including content operationId: create parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: content: multipart/form-data: schema: required: - name - parentIdentifier - type type: object properties: tags: type: string description: The File or Folder tags. (See example for expected format) content: type: object description: The content of the File as InputStream identifier: type: string description: Identifier of the File or Folder name: type: string description: Name of the File or Folder fileUsage: type: string description: This specifies the file usage type: type: string description: This specifies the type of the File enum: - FILE - FOLDER parentIdentifier: type: string description: >- This specifies parent directory identifier. The value of Root directory identifier is Root. description: type: string description: Description of the File or Folder mimeType: type: string description: Mime type of the File path: type: string description: The path of the File or Folder createdBy: $ref: '#/components/schemas/EmbeddedUserDetailsDTO' lastModifiedBy: $ref: '#/components/schemas/EmbeddedUserDetailsDTO' lastModifiedAt: type: integer description: Last modified time for the File or Folder format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns create response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFile' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFile' /ng/api/file-store/yaml: post: tags: - File Store summary: Creates File or Folder metadata via YAML operationId: createViaYAML parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: >- YAML definition of the File or Folder. The payload must contain a 'file' object with fields such as identifier, name, type (FILE or FOLDER), fileUsage (MANIFEST_FILE, CONFIG, or SCRIPT), parentIdentifier, and optional description, mimeType, tags. content: application/yaml: schema: $ref: '#/components/schemas/FileStoreRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns create response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFile' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFile' /ng/api/file-store/{identifier}: get: tags: - File Store summary: Get the Folder or File metadata operationId: getFile parameters: - name: identifier in: path description: The file identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Get the Folder or File metadata content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFile' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFile' put: tags: - File Store summary: Update Folder or File including content operationId: update parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: The file identifier required: true schema: type: string requestBody: content: multipart/form-data: schema: required: - name - parentIdentifier - type type: object properties: tags: type: string description: The File or Folder tags. (See example for expected format) identifier: type: string description: Identifier of the File or Folder name: type: string description: Name of the File or Folder fileUsage: type: string description: This specifies the file usage type: type: string description: This specifies the type of the File enum: - FILE - FOLDER parentIdentifier: type: string description: >- This specifies parent directory identifier. The value of Root directory identifier is Root. description: type: string description: Description of the File or Folder mimeType: type: string description: Mime type of the File path: type: string description: The path of the File or Folder createdBy: $ref: '#/components/schemas/EmbeddedUserDetailsDTO' lastModifiedBy: $ref: '#/components/schemas/EmbeddedUserDetailsDTO' lastModifiedAt: type: integer description: Last modified time for the File or Folder format: int64 content: type: object description: The content of the File as InputStream responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns update response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFile' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFile' delete: tags: - File Store summary: Delete File or Folder by identifier operationId: deleteFile parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: The file identifier required: true schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if deletion was successful. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/file-store/files/{identifier}/download: get: tags: - File Store summary: Download File operationId: downloadFile parameters: - name: identifier in: path description: The file identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Download File content /ng/api/file-store/files/createdBy: get: tags: - File Store summary: Get list of created by user details operationId: getCreatedByList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of created by user details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetEmbeddedUserDetailsDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSetEmbeddedUserDetailsDTO' /ng/api/file-store/files/{scopedFilePath}/content: get: tags: - File Store summary: Get file content of scopedFilePath operationId: getFileContentUsingScopedFilePath parameters: - name: scopedFilePath in: path description: >- The scoped file path reference. The path must start with '/' and can be prefixed with a scope: 'account:/my-file' for account scope, 'org:/my-file' for org scope, or 'project:/my-file' (or just '/my-file') for project scope. The request body must be a plain string (not JSON-encoded). Do not wrap the path in quotes. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the file content of scopedFilePath content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' deprecated: true /ng/api/file-store/files/content: post: tags: - File Store summary: Get file content by file path description: >- Returns the content of a file in the Harness file store as a string. The request body must be a plain-text string containing the scoped file path (not JSON-encoded, do not wrap in quotes). For account scope, prefix with 'account:' (e.g., 'account:/my-file'). For org scope, prefix with 'org:' (e.g., 'org:/my-file'). For project scope, optionally prefix with 'project:' or just provide the path (e.g., '/my-file'). The path must start with '/'. Scope query parameters must also match: project scope requires accountIdentifier, orgIdentifier, and projectIdentifier; org scope requires accountIdentifier and orgIdentifier; account scope requires only accountIdentifier. operationId: getFileContentUsingScopedFilePathV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: >- The scoped file path reference. The path must start with '/' and can be prefixed with a scope: 'account:/my-file' for account scope, 'org:/my-file' for org scope, or 'project:/my-file' (or just '/my-file') for project scope. The request body must be a plain string (not JSON-encoded). Do not wrap the path in quotes. content: application/json: schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the file content as a string content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/file-store/{identifier}/referenced-by: get: tags: - File Store summary: Get list of entities where file is referenced by queried entity type operationId: getReferencedBy parameters: - name: pageIndex in: query description: Page number of navigation. The default value is 0 schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Number of entries per page. The default value is 100 schema: maximum: 1000 type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: The file identifier required: true schema: type: string - name: entityType in: query description: Entity type schema: type: string enum: - CreatePR - MergePR - Projects - Pipelines - PipelineSteps - Http - Email - JiraCreate - JiraUpdate - JiraApproval - HarnessApproval - CustomApproval - Barrier - Queue - FlagConfiguration - ShellScript - K8sCanaryDeploy - K8sApply - K8sBlueGreenDeploy - K8sRollingDeploy - K8sRollingRollback - K8sScale - K8sDelete - K8sBGSwapServices - K8sCanaryDelete - TerraformApply - TerraformPlan - TerraformDestroy - TerraformRollback - HelmDeploy - HelmRollback - Connectors - Secrets - Files - Service - Environment - EnvironmentGroup - InputSets - CvConfig - Verify - Delegates - DelegateConfigurations - CvVerificationJob - IntegrationStage - IntegrationSteps - SecurityStage - SecuritySteps - CvKubernetesActivitySource - DeploymentSteps - DeploymentStage - ApprovalStage - PipelineStage - FeatureFlagStage - Template - TemplateStage - CustomDeployment - Triggers - MonitoredService - GitRepositories - FeatureFlags - ServiceNowApproval - ServiceNowCreate - ServiceNowUpdate - ServiceNowImportSet - GovernancePolicies - Policy - Run - RunTests - Plugin - RestoreCacheGCS - RestoreCacheS3 - SaveCacheGCS - SaveCacheS3 - Security - AquaTrivy - AWSECR - Bandit - BlackDuck - Brakeman - Burp - Checkmarx - Clair - DataTheorem - DockerContentTrust - External - FortifyOnDemand - Grype - JfrogXray - Mend - Metasploit - Nessus - NexusIQ - Nikto - Nmap - Openvas - Owasp - PrismaCloud - Prowler - Qualys - Reapsaw - ShiftLeft - Sniper - Snyk - Sonarqube - Sysdig - Tenable - Veracode - Zap - GitClone - ArtifactoryUpload - GCSUpload - S3Upload - BuildAndPushGCR - BuildAndPushGAR - BuildAndPushECR - BuildAndPushDockerRegistry - CreateStack - DeleteStack - ServerlessAwsLambdaDeploy - ServerlessAwsLambdaRollback - CustomStage - RollbackStack - Infrastructure - Command - StrategyNode - AzureSlotDeployment - AzureTrafficShift - FetchInstanceScript - AzureSwapSlot - AzureWebAppRollback - JenkinsBuild - EcsRollingDeploy - EcsRollingRollback - EcsCanaryDeploy - EcsCanaryDelete - AzureCreateARMResource - BuildAndPushACR - AzureCreateBPResource - AzureARMRollback - Background - Wait - ArtifactSource - EcsBlueGreenCreateService - EcsBlueGreenSwapTargetGroups - EcsBlueGreenRollback - ShellScriptProvision - Freeze - GitOpsUpdateReleaseRepo - GitOpsFetchLinkedApps - EcsRunTask - Chaos - ElastigroupDeploy - ElastigroupRollback - Action - ElastigroupSetup - Bitrise - TerragruntPlan - TerragruntApply - TerragruntDestroy - TerragruntRollback - IACMStage - IACMStep - IACM - Container - IACMTerraformPlugin - IACMApproval - ElastigroupBGStageSetup - ElastigroupSwapRoute - AsgCanaryDeploy - AsgCanaryDelete - SwapRoutes - SwapRollback - AppResize - AppRollback - CanaryAppSetup - BGAppSetup - BasicAppSetup - TanzuCommand - AsgRollingDeploy - AsgRollingRollback - GovernanceRuleAWS - TasRollingDeploy - TasRollingRollback - K8sDryRun - AsgBlueGreenSwapService - AsgBlueGreenDeploy - AsgBlueGreenRollback - TerraformCloudRun - TerraformCloudRollback - DeployCloudFunction - DeployCloudFunctionWithNoTraffic - CloudFunctionTrafficShift - CloudFunctionRollback - AwsLambdaDeploy - AwsSamDeploy - AwsSamRollback - SscaOrchestration - AwsLambdaRollback - GitOpsSync - BambooBuild - CdSscaOrchestration - RouteMapping - AWSSecurityHub - CustomIngest - BackstageEnvironmentVariable - Fossa - CodeQL - Gitleaks - DeployCloudFunctionGenOne - RollbackCloudFunctionGenOne - K8sBlueGreenStageScaleDown - AwsSamBuild - Semgrep - SscaEnforcement - IdpConnector - CdSscaEnforcement - DownloadManifests - ServerlessAwsLambdaPrepareRollbackV2 - ServerlessAwsLambdaRollbackV2 - Coverity - ServerlessAwsLambdaDeployV2 - AnalyzeDeploymentImpact - ServerlessAwsLambdaPackageV2 - RevertPR - AwsCdkBootstrap - AwsCdkSynth - AwsCdkDiff - AwsCdkDeploy - AwsCdkDestroy - IdpScorecard - IdpCheck - AwsCdkRollback - SlsaVerification - UpdateGitOpsApp - EcsServiceSetup - EcsUpgradeContainer - EcsBasicRollback - ChaosInfrastructure - Anchore - Overrides - AsgShiftTraffic - AquaSecurity - IDPStage - ChaosHub - CookieCutter - CreateRepo - DownloadAwsS3 - DirectPush - RegisterCatalog - K8sTrafficRouting - DownloadHarnessStore - CreateCatalog - SlackNotify - OsvScaner - IACMOpenTofuPlugin - AsgPhasedDeploy - AsgSetup - AsgRollback - Test - Wiz - Certificates - IACMCheckov - IACMTFCompliance - IACMTFLint - IACMTFSec - NotificationRule - NotificationChannel - K8sPatch - CreateOrganisation - CreateProject - DBSchemaApply - IACMPrepareExecution - DBSchemaRollback - K8sRollout - CreateResource - Checkov - ServiceDiscoveryAgent - ChaosInfrastructureV2 - Traceable - AzureFunctionDeploy - AzureFunctionRollback - GoogleCloudRunDeploy - GoogleCloudRunPrepareRollbackData - GoogleCloudRunTrafficShift - GoogleCloudRunRollback - GoogleCloudRunJob - UpdateCatalogProperty - IACMWorkspace - IACMModuleTestPlugin - CheckmarxOne - AsgSteadyState - SscaArtifactVerification - GitOpsApplication - HelmDelete - EcsBlueGreenTrafficShift - StandAloneTrafficShiftRollback - ElastigroupBlueGreenTrafficShift - IdpCatalog - IACMTerragruntPlugin - IACMAnsiblePlugin - GitHubAdvancedSecurity - AiVerify - AIExperiment - ModelScan - SaveCache - RestoreCache - DataSink - IdpCdService - IdpEnvironment - IdpEnvironmentBlueprint - SalesforceDeploy - SalesforceRollback - GitOpsRollout - AuditStreamingDestination - AIEvaluation - SalesforceValidate - SalesforceQuickDeploy - SASTSecret - SCA - SalesforceCreateScratchOrg - SalesforceDeleteScratchOrg - HarUpload - UserGroup - SalesforceApexTest - IACMAwsCdkPlugin - EcsScale - RestoreCacheAzure - SaveCacheAzure - Deployable - SalesforceComparisonPair - AlertSetting - SalesforceDownloadDeployables - SalesforceDownloadOrg - SalesforceEvaluateDiff - SalesforceChangeset - SalesforceSourceBackup - AiTestAutomation - SalesforceExecution - AsgScale - CortexCloud - IACMBlastRadiusAgent - IACMRemediationAgent - K8sBlueGreenStageScaleUp - DeployGoogleAgentRuntimeRevision - ShiftGoogleAgentRuntimeTraffic - RollbackGoogleAgentRuntimeRevision - K8sProgressiveCanaryRollback - DeployAwsAgentCoreRevision - ShiftAwsAgentCoreTraffic - RollbackAwsAgentCoreRevision - OpenAi - GitOpsRollback - IntegrationSetting - IntegrationConfiguration - MythosAgent - name: searchTerm in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of entities where file is referenced by content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseEntitySetupUsage' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseEntitySetupUsage' /ng/api/file-store/supported-entity-types: get: tags: - File Store summary: Get the list of supported entity types for files operationId: getEntityTypes parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of supported entity types for file content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListEntityType' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListEntityType' /ng/api/file-store/files/filter: post: tags: - File Store summary: Get filtered list of Files or Folders operationId: listFilesWithFilter parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: filterIdentifier in: query description: Filter identifier schema: type: string - name: searchTerm in: query description: >- This will be used to filter files or folders. Any file or folder having the specified search term in its Name or Identifier will be filtered schema: type: string requestBody: description: Details of the File filter properties to be applied content: application/json: schema: $ref: '#/components/schemas/FilesFilterPropertiesDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns filtered list of Files or Folder content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageFile' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageFile' /ng/api/file-store/folder: post: tags: - File Store summary: Get folder nodes at first level, not including sub-nodes operationId: getFolderNodes parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: fileUsage in: query description: The file usage schema: type: string enum: - MANIFEST_FILE - CONFIG - SCRIPT requestBody: description: Folder node for which to return the list of nodes content: application/json: schema: $ref: '#/components/schemas/FolderNode' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the folder populated with file store nodes as children content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFolderNode' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFolderNode' /ng/api/file-store/yaml/{identifier}: put: tags: - File Store summary: Update File or Folder metadata via YAML description: >- Updates the metadata of an existing file or folder using a YAML payload. This endpoint updates metadata (name, description, tags, etc.) only. operationId: updateViaYAML parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: The file identifier required: true schema: type: string requestBody: description: >- YAML definition of the File or Folder. The payload must contain a 'file' object with fields such as identifier, name, type (FILE or FOLDER), fileUsage (MANIFEST_FILE, CONFIG, or SCRIPT), parentIdentifier, and optional description, mimeType, tags. content: application/yaml: schema: $ref: '#/components/schemas/FileStoreRequest' examples: Update File via YAML: summary: Sample File Store update YAML request description: Sample YAML body for updating a file or folder value: | file: identifier: my_config_file name: My Config File type: FILE fileUsage: CONFIG parentIdentifier: Root description: Sample configuration file mimeType: text/plain tags: - key: env value: production required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns update response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFile' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFile' /ng/api/filters: get: tags: - Filter summary: List Filters description: Lists Filters for the given criteria. operationId: getFilterList parameters: - name: pageIndex in: query description: >- Page number of navigation. If left empty, default value of 0 is assumed. schema: type: integer format: int32 default: 0 - name: pageSize in: query description: >- Number of entries per page. If left empty, default value of 100 is assumed schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline - name: searchTerm in: query description: Text to search/filter the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Filters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' put: tags: - Filter summary: Update a Filter description: Updates the filter for the given ID. operationId: updateFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated Filter. This should have all the fields not just the updated ones content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' post: tags: - Filter summary: Create a Filter description: Creates a Filter. operationId: postFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Connector to create content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' /ng/api/filters/{identifier}: get: tags: - Filter summary: Return Filter Details description: Returns the settings of a filter for the given ID. operationId: getFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns Filter having filterIdentifier as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' delete: tags: - Filter summary: Delete a Filter description: Deletes a filter for the given ID. operationId: deleteFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/git-sync-branch/sync: post: tags: - Git Branches summary: Sync the content of new Git Branch into harness with Git Sync Config Id operationId: syncGitBranch parameters: - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns True if the new Git Branch is successfully synced into Harness content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/git-sync-branch/listBranchesWithStatus: get: tags: - Git Branches summary: >- Lists branches with their status(Synced, Unsynced) by Git Sync Config Id for the given scope operationId: getListOfBranchesWithStatus parameters: - name: yamlGitConfigIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: maximum: 100 type: integer format: int32 - name: searchTerm in: query description: Search Term. schema: type: string default: '' - name: branchSyncStatus in: query description: Used to filter out Synced and Unsynced branches schema: type: string enum: - SYNCED - SYNCING - UNSYNCED responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns a list of branches along with their status within the given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitBranchList' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitBranchList' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitBranchList' /ng/api/git-full-sync/config: get: tags: - Git Full Sync summary: Fetch Configuration for Git Full Sync for the provided scope operationId: getGitFullSyncConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the saved Git Full Sync Configuration for the provided scope. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' put: tags: - Git Full Sync summary: Update Configuration for Git Full Sync for the provided scope operationId: updateGitFullSyncConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Details of the Git Full sync Configuration content: application/json: schema: $ref: '#/components/schemas/GitFullSyncConfigRequest' text/yaml: schema: $ref: '#/components/schemas/GitFullSyncConfigRequest' text/html: schema: $ref: '#/components/schemas/GitFullSyncConfigRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the updated Git Full Sync Configuration for the provided scope. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' post: tags: - Git Full Sync summary: Create Configuration for Git Full Sync for the provided scope operationId: createGitFullSyncConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Details of the Git Full sync Configuration content: application/json: schema: $ref: '#/components/schemas/GitFullSyncConfigRequest' text/yaml: schema: $ref: '#/components/schemas/GitFullSyncConfigRequest' text/html: schema: $ref: '#/components/schemas/GitFullSyncConfigRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the saved Configuration details for Git Full Sync. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitFullSyncConfig' /ng/api/git-full-sync/files: post: tags: - Git Full Sync summary: List files in full sync along with their status operationId: listFullSyncFiles parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: searchTerm in: query description: Search Term. schema: type: string requestBody: description: Entity Type and Sync Status content: application/json: schema: $ref: '#/components/schemas/GitFullSyncEntityInfoFilter' text/yaml: schema: $ref: '#/components/schemas/GitFullSyncEntityInfoFilter' text/html: schema: $ref: '#/components/schemas/GitFullSyncEntityInfoFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the List of Files for Git Full sync. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseGitFullSyncEntityInfo text/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseGitFullSyncEntityInfo text/html: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseGitFullSyncEntityInfo /ng/api/git-full-sync: post: tags: - Git Full Sync summary: Trigger Full Sync operationId: triggerFullSync parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully Triggered Full Sync. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTriggerGitFullSyncResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOTriggerGitFullSyncResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOTriggerGitFullSyncResponse' /ng/api/git-sync-settings: get: tags: - Git Sync Settings summary: Get Git Sync Setting for the given scope operationId: getGitSyncSettings parameters: - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Git Sync Setting of the given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' put: tags: - Git Sync Settings summary: >- This updates the existing Git Sync settings within the scope. Only changing Connectivity Mode is allowed operationId: updateGitSyncSetting parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: This contains details of Git Sync Settings content: application/json: schema: $ref: '#/components/schemas/GitSyncSettings' text/yaml: schema: $ref: '#/components/schemas/GitSyncSettings' text/html: schema: $ref: '#/components/schemas/GitSyncSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Updated Git Sync Setting content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' post: tags: - Git Sync Settings summary: Creates Git Sync Setting in a scope operationId: createGitSyncSetting parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This contains details of Git Sync settings like - (scope, executionOnDelegate) content: application/json: schema: $ref: '#/components/schemas/GitSyncSettings' text/yaml: schema: $ref: '#/components/schemas/GitSyncSettings' text/html: schema: $ref: '#/components/schemas/GitSyncSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully created Git Sync Setting content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitSyncSettings' /ng/api/git-sync: get: tags: - Git Sync summary: Lists Git Sync Config for the given scope operationId: getGitSyncConfigList parameters: - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: List of Git Sync Config for the given scope content: application/json: schema: type: array items: $ref: '#/components/schemas/GitSyncConfig' text/yaml: schema: type: array items: $ref: '#/components/schemas/GitSyncConfig' text/html: schema: type: array items: $ref: '#/components/schemas/GitSyncConfig' put: tags: - Git Sync summary: Update existing Git Sync Config by Identifier operationId: updateGitSyncConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of Git Sync Config content: application/json: schema: $ref: '#/components/schemas/GitSyncConfig' text/yaml: schema: $ref: '#/components/schemas/GitSyncConfig' text/html: schema: $ref: '#/components/schemas/GitSyncConfig' text/plain: schema: $ref: '#/components/schemas/GitSyncConfig' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Updated Git Sync Config content: application/json: schema: $ref: '#/components/schemas/GitSyncConfig' text/yaml: schema: $ref: '#/components/schemas/GitSyncConfig' text/html: schema: $ref: '#/components/schemas/GitSyncConfig' post: tags: - Git Sync summary: Creates Git Sync Config in given scope operationId: createGitSyncConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of Git Sync Config content: application/json: schema: $ref: '#/components/schemas/GitSyncConfig' text/yaml: schema: $ref: '#/components/schemas/GitSyncConfig' text/html: schema: $ref: '#/components/schemas/GitSyncConfig' text/plain: schema: $ref: '#/components/schemas/GitSyncConfig' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully created Git Sync Config content: application/json: schema: $ref: '#/components/schemas/GitSyncConfig' text/yaml: schema: $ref: '#/components/schemas/GitSyncConfig' text/html: schema: $ref: '#/components/schemas/GitSyncConfig' /ng/api/git-sync/git-sync-enabled: get: tags: - Git Sync summary: Check whether Git Sync is enabled for given scope or not operationId: isGitSyncEnabled parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Result of whether Git Sync is enabled for the scope content: application/json: schema: $ref: '#/components/schemas/GitEnabled' text/yaml: schema: $ref: '#/components/schemas/GitEnabled' text/html: schema: $ref: '#/components/schemas/GitEnabled' /ng/api/git-sync/{identifier}/folder/{folderIdentifier}/default: put: tags: - Git Sync summary: Update existing Git Sync Config default root folder by Identifier operationId: updateDefaultFolder parameters: - name: projectId in: query description: Project Identifier for the Entity. schema: type: string - name: organizationId in: query description: Organization Identifier for the Entity. schema: type: string - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: identifier in: path description: Git Sync Config Id. [Applicable for Old Git Sync only] required: true schema: type: string - name: folderIdentifier in: path description: Folder Id required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Updated Git Sync Config default root folder content: application/json: schema: $ref: '#/components/schemas/GitSyncConfig' text/yaml: schema: $ref: '#/components/schemas/GitSyncConfig' text/html: schema: $ref: '#/components/schemas/GitSyncConfig' /ng/api/git-sync-errors/count: get: tags: - Git Sync Errors summary: Get Errors Count for the given scope, Repo and Branch operationId: getGitSyncErrorsCount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Search Term. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Count of both Git to Harness Errors and Connectivity Errors content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGitSyncErrorCount' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOGitSyncErrorCount' text/html: schema: $ref: '#/components/schemas/ResponseDTOGitSyncErrorCount' /ng/api/git-sync-errors: get: tags: - Git Sync Errors summary: >- Lists Git to Harness Errors by file or connectivity errors for the given scope, Repo and Branch operationId: listGitSyncErrors parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Search Term. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: gitToHarness in: query description: >- This specifies which errors to show - (Git to Harness or Connectivity), Put true to show Git to Harness Errors schema: type: boolean default: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Paginated list of Git to Harness Errors by file or connectivity errors content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseGitSyncError' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseGitSyncError' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseGitSyncError' /ng/api/git-sync-errors/commits/{commitId}: get: tags: - Git Sync Errors summary: Lists Git to Harness Errors for the given Commit Id operationId: listGitToHarnessErrorForCommit parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: commitId in: path description: Commit Id required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Paginated list of Git to Harness Errors for given Commit Id content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseGitSyncError' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseGitSyncError' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseGitSyncError' /ng/api/git-sync-errors/aggregate: get: tags: - Git Sync Errors summary: >- Lists Git to Harness Errors grouped by Commits for the given scope, Repo and Branch operationId: listGitToHarnessErrorsGroupedByCommits parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Search Term. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: numberOfErrorsInSummary in: query description: Number of errors that will be displayed in the summary schema: maximum: 5 type: integer format: int32 default: 5 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Paginated list of Git to Harness Errors grouped by Commit content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseGitSyncErrorAggregateByCommit text/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseGitSyncErrorAggregateByCommit text/html: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseGitSyncErrorAggregateByCommit /ng/api/ldap/ngLdapSettings: get: tags: - Nextgen Ldap summary: Get the NgLdap Setting description: For the given accountId fetch and return the ng ldap settings operationId: getNgLdapSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Get the NgLdap Setting content: application/x-kryo: schema: $ref: >- #/components/schemas/ResponseDTONGLdapSettingsWithEncryptedDataDetails /ng/api/ldap/ldap-login-test: post: tags: - Nextgen Ldap summary: Test LDAP authentication description: >- Tests LDAP authentication for the given Account ID, with a valid test email and password operationId: postLdapAuthenticationTest parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: email: type: string description: This should be a valid test email password: type: string description: This should be a valid password for the test email responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns authentication status content: application/json: schema: $ref: '#/components/schemas/RestResponseLdapResponse' application/yaml: schema: $ref: '#/components/schemas/RestResponseLdapResponse' /ng/api/ldap/{ldapId}/search/group: get: tags: - Nextgen Ldap summary: Return Ldap groups matching name description: >- Returns all userGroups for the configured Ldap in the account matching a given name. operationId: searchLdapGroups parameters: - name: ldapId in: path description: Ldap setting id required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: name in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns ldap groups matching a given name content: application/json: schema: $ref: '#/components/schemas/RestResponseCollectionLdapGroupResponse' application/yaml: schema: $ref: '#/components/schemas/RestResponseCollectionLdapGroupResponse' /ng/api/usage/cd/active-services/csv/download: get: tags: - Usage summary: Download CSV Active Services report operationId: downloadActiveServiceCSVReport parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: timestamp in: query schema: type: integer format: int64 default: 0 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Download CSV Active Services report /ng/api/usage/CD/serviceInstancesLicense: get: tags: - Usage summary: Gets License Usage By Module, Timestamp, and Account Identifier operationId: getCDLicenseUsageForServiceInstances parameters: - name: accountIdentifier in: query description: Account id to get the license usage. schema: type: string - name: timestamp in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns a license usage object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceInstanceUsageDTO' /ng/api/usage/CD/servicesLicense: get: tags: - Usage summary: Gets License Usage By Module, Timestamp, and Account Identifier operationId: getCDLicenseUsageForServices parameters: - name: accountIdentifier in: query description: Account id to get the license usage. schema: type: string - name: timestamp in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns a license usage object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceUsageDTO' /ng/api/usage/{module}: get: tags: - Usage summary: Gets License Usage By Module, Timestamp, and Account Identifier operationId: getLicenseUsage parameters: - name: accountIdentifier in: query description: Account id to get the license usage. schema: type: string - name: module in: path description: A Harness platform module. required: true schema: type: string - name: timestamp in: query schema: type: integer format: int64 - name: CDLicenseType in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns a license usage object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOLicenseUsage' /ng/api/authentication-settings/ldap/settings: get: tags: - Authentication Settings summary: Return configured Ldap settings for the account description: Returns configured Ldap settings and its details for the account. operationId: getLdapSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns ldap setting content: application/json: schema: $ref: '#/components/schemas/RestResponseLDAPSettings' put: tags: - Authentication Settings summary: Updates Ldap setting description: Updates configured Ldap settings along with the user, group queries. operationId: updateLdapSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated LdapSettings. Values for all fields is needed, not just the fields you are updating content: application/json: schema: $ref: '#/components/schemas/LDAPSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Updated Ldap settings along with the user, group settings content: application/json: schema: $ref: '#/components/schemas/RestResponseLDAPSettings' post: tags: - Authentication Settings summary: Create Ldap setting description: Creates Ldap settings along with the user, group queries. operationId: createLdapSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Create LdapSettings request body. Values for connection settings are needed, user and group settings can also be provided content: application/json: schema: $ref: '#/components/schemas/LDAPSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Creates Ldap settings along with the user, group queries content: application/json: schema: $ref: '#/components/schemas/RestResponseLDAPSettings' delete: tags: - Authentication Settings summary: Delete Ldap settings description: Delete configured Ldap settings on this account. operationId: deleteLdapSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully deleted Ldap settings configured on account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/delete-saml-metadata: delete: tags: - Authentication Settings summary: Delete SAML meta data description: Deletes SAML metadata for the given Account ID. operationId: deleteSamlMetaData parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully deleted SAML meta associated with a SAML setting content: application/json: schema: $ref: '#/components/schemas/RestResponseSSOConfig' /ng/api/authentication-settings/saml-metadata/{samlSSOId}/delete: delete: tags: - Authentication Settings summary: Delete SAML meta data for given SAML sso id description: Deletes SAML metadata for the given Account and SAML sso id operationId: deleteSamlMetaDataForSamlSSOId parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: samlSSOId in: path description: Saml Settings Identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully deleted SAML meta associated with a SAML SSO setting id content: application/json: schema: $ref: '#/components/schemas/RestResponseSSOConfig' /ng/api/authentication-settings/saml-metadata-upload/{samlSSOId}/authentication: put: tags: - Authentication Settings summary: Update authentication enabled or not for given SAML setting description: >- Updates if authentication is enabled or not for given SAML setting in Account ID. operationId: enableDisableAuthenticationForSAMLSetting parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enable in: query required: true schema: type: boolean default: true - name: samlSSOId in: path description: Saml Settings Identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Successfully updated login allowed status for SAML setting in account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings: get: tags: - Authentication Settings summary: Gets authentication settings for the given Account ID description: Gets authentication settings for the given Account ID. operationId: getAuthenticationSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully returns authentication settings of an Account content: application/json: schema: $ref: >- #/components/schemas/RestResponseAuthenticationSettingsResponse /ng/api/authentication-settings/v2: get: tags: - Authentication Settings summary: Gets authentication settings version 2 for the given Account ID description: Gets authentication settings version 2 for the given Account ID. operationId: getAuthenticationSettingsV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully returns authentication settings of an Account content: application/json: schema: $ref: >- #/components/schemas/RestResponseAuthenticationSettingsResponse /ng/api/authentication-settings/login-settings/password-strength: get: tags: - Authentication Settings summary: Get password strength description: Gets password strength for the given Account ID. operationId: getPasswordStrengthSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns password strength of an Account content: application/json: schema: $ref: '#/components/schemas/RestResponsePasswordStrengthPolicy' /ng/api/authentication-settings/saml-login-test: get: tags: - Authentication Settings summary: Test SAML connectivity description: Tests SAML connectivity for the given Account ID. operationId: getSamlLoginTest parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns connectivity status content: application/json: schema: $ref: '#/components/schemas/RestResponseLoginTypeResponse' /ng/api/authentication-settings/saml-login-test/{samlSSOId}: get: tags: - Authentication Settings summary: Test SAML connectivity description: Tests SAML connectivity for the given Account ID and SAML setting. operationId: getSamlLoginTestV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: samlSSOId in: path description: Saml Settings Identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns connectivity status content: application/json: schema: $ref: '#/components/schemas/RestResponseLoginTypeResponse' /ng/api/authentication-settings/oauth/remove-mechanism: delete: tags: - Authentication Settings summary: Delete OAuth Setting description: Deletes OAuth settings for a given Account ID. operationId: removeOauthMechanism parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully removed OAuth settings configured to an account. content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/public-access: put: tags: - Authentication Settings summary: Enable/disable public access at account level description: Enable/disable public access for the given Account ID. operationId: setPublicAccess parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Information about the session timeout for all users of this account in minutes. content: application/json: schema: type: boolean required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully configured public access for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/session-timeout-account-level: put: tags: - Authentication Settings summary: Set session timeout at account level description: Sets session timeout of all users for the given Account ID. operationId: setSessionTimeoutAtAccountLevel parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Information about the session timeout for all users of this account in minutes. content: application/json: schema: $ref: '#/components/schemas/SessionTimeoutSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully configured session timeout for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/two-factor-admin-override-settings: put: tags: - Authentication Settings summary: Set two factor authorization description: Sets Two-Factor authorization for the given Account ID. operationId: setTwoFactorAuthAtAccountLevel parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Boolean that specify whether or not to override two factor enabled setting content: '*/*': schema: $ref: '#/components/schemas/TwoFactorAdminOverrideSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully configured two factor authorization for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/update-auth-mechanism: put: tags: - Authentication Settings summary: Update Auth mechanism description: Updates the authentication mechanism for the given Account ID. operationId: updateAuthMechanism parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: authenticationMechanism in: query description: Type of Authentication Mechanism SSO or NON_SSO schema: type: string enum: - USER_PASSWORD - SAML - LDAP - OAUTH - OIDC responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully updated Auth mechanism for an account. content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/oauth/update-providers: put: tags: - Authentication Settings summary: Update Oauth providers description: Updates OAuth providers for the given Account ID. operationId: updateOauthProviders parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated OAuthSettings. Please provide values for all fields, not just the fields you are updating content: '*/*': schema: $ref: '#/components/schemas/OAuthSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully updated the Oauth providers for the account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/saml-metadata-upload: put: tags: - Authentication Settings summary: Update SAML metadata description: >- Updates SAML metadata of the SAML configuration configured for an account operationId: updateSamlMetaData parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: object description: SAML Metadata input file fileMetadata: $ref: '#/components/schemas/FormDataContentDisposition' displayName: type: string description: Display Name of the SAML groupMembershipAttr: type: string description: Group membership attribute authorizationEnabled: type: boolean description: Specify whether or not to enable authorization logoutUrl: type: string description: Logout URL entityIdentifier: type: string description: SAML metadata Identifier samlProviderType: type: string description: SAML provider type clientId: type: string description: Optional SAML clientId for Azure SSO clientSecret: type: string description: Optional SAML clientSecret reference string for Azure SSO jitEnabled: type: boolean description: Enable Just in time user provision default: false jitValidationKey: type: string description: >- Optional Key to match in SAML assertion for Just in time user provision jitValidationValue: type: string description: >- Optional Value to match in SAML assertion for Just in time user provision responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Successfully updated SAML metadata of SAML setting configured for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseSSOConfig' post: tags: - Authentication Settings summary: Upload SAML metadata description: Updates the SAML metadata for the given Account ID. operationId: uploadSamlMetaData parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: object description: Saml Metadata input file fileMetadata: $ref: '#/components/schemas/FormDataContentDisposition' displayName: type: string description: Display Name of the SAML groupMembershipAttr: type: string description: Group membership attribute authorizationEnabled: type: boolean description: Specify whether or not to enable authorization logoutUrl: type: string description: Logout URL entityIdentifier: type: string description: SAML metadata Identifier samlProviderType: type: string description: SAML provider type clientId: type: string description: Optional SAML clientId for Azure SSO clientSecret: type: string description: Optional SAML clientSecret reference string for Azure SSO friendlySamlName: type: string description: Friendly name of the app on SAML SSO provider end in Harness jitEnabled: type: boolean description: Enable Just in time user provision default: false jitValidationKey: type: string description: >- Optional Key to match in SAML assertion for Just in time user provision jitValidationValue: type: string description: >- Optional Value to match in SAML assertion for Just in time user provision responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Successfully uploads SAML metadata to the SAML setting configured for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseSSOConfig' /ng/api/authentication-settings/saml-metadata-upload/{samlSSOId}: put: tags: - Authentication Settings summary: Update SAML metadata for a given SAML SSO Id description: >- Updates SAML metadata of the SAML configuration with given SSO Id, configured for an account operationId: updateSamlMetaDataForSamlSSOId parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: samlSSOId in: path description: Saml Settings Identifier required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: object description: SAML Metadata input file fileMetadata: $ref: '#/components/schemas/FormDataContentDisposition' displayName: type: string description: Display Name of the SAML groupMembershipAttr: type: string description: Group membership attribute authorizationEnabled: type: boolean description: Specify whether or not to enable authorization logoutUrl: type: string description: Logout URL entityIdentifier: type: string description: SAML metadata Identifier samlProviderType: type: string description: SAML provider type clientId: type: string description: Optional SAML clientId for Azure SSO clientSecret: type: string description: Optional SAML clientSecret reference string for Azure SSO friendlySamlName: type: string description: Friendly name of the app on SAML SSO provider end in Harness jitEnabled: type: boolean description: Enable Just in time user provision default: false jitValidationKey: type: string description: >- Optional Key to match in SAML assertion for Just in time user provision jitValidationValue: type: string description: >- Optional Value to match in SAML assertion for Just in time user provision responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Successfully updated SAML metadata of SAML setting configured for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseSSOConfig' /ng/api/authentication-settings/whitelisted-domains: put: tags: - Authentication Settings summary: Updates the whitelisted domains description: Updates whitelisted domains configured for an account. operationId: updateWhitelistedDomains parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Set of whitelisted domains and IPs for the account content: '*/*': schema: uniqueItems: true type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully updated whitelisted domains configured with an account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/authentication-settings/saml-metadata: post: tags: - Authentication Settings summary: Upload SAML metadata description: Updates the SAML metadata for the given Account ID. operationId: uploadSamlMetaDataDs parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: object description: Saml Metadata input file fileMetadata: $ref: '#/components/schemas/FormDataContentDisposition' displayName: type: string description: Display Name of the SAML groupMembershipAttr: type: string description: Group membership attribute authorizationEnabled: type: boolean description: Specify whether or not to enable authorization logoutUrl: type: string description: Logout URL entityIdentifier: type: string description: SAML metadata Identifier samlProviderType: type: string description: SAML provider type clientId: type: string description: Optional SAML clientId for Azure SSO clientSecret: type: string description: Optional SAML clientSecret reference string for Azure SSO friendlySamlName: type: string description: Friendly name of the app on SAML SSO provider end in Harness jitEnabled: type: boolean description: Enable Just in time user provision default: false jitValidationKey: type: string description: >- Optional Key to match in SAML assertion for Just in time user provision jitValidationValue: type: string description: >- Optional Value to match in SAML assertion for Just in time user provision responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Successfully uploads SAML metadata to the SAML setting configured for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseSamlSettingsDTO' /ng/api/account-setting: get: tags: - AccountSetting summary: Get the AccountSetting by accountIdentifier operationId: getAccountSetting parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: type in: query required: true schema: type: string enum: - Connector responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the AccountSetting with the requested accountIdentifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAccountSettingResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOAccountSettingResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOAccountSettingResponse' put: tags: - AccountSetting summary: Updates account settings operationId: updateAccountSetting parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the AccountSetting to create content: application/json: schema: $ref: '#/components/schemas/AccountSettings' text/yaml: schema: $ref: '#/components/schemas/AccountSettings' text/html: schema: $ref: '#/components/schemas/AccountSettings' text/plain: schema: $ref: '#/components/schemas/AccountSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created account setting content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAccountSettingResponse' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOAccountSettingResponse' text/html: schema: $ref: '#/components/schemas/ResponseDTOAccountSettingResponse' /ng/api/account-setting/list: get: tags: - AccountSetting summary: Get the AccountSetting by accountIdentifier operationId: listAccountSetting parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: type in: query schema: type: string enum: - Connector responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of AccountSettings with requested accountIdentifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAccountSettings' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOListAccountSettings' text/html: schema: $ref: '#/components/schemas/ResponseDTOListAccountSettings' /ng/api/agent/mtls/endpoint: get: tags: - Agent mTLS Endpoint Management summary: Gets the agent mTLS endpoint for an account. operationId: getAgentMtlsEndpointForAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '200': description: Successfully retrieved mTLS endpoint details content: application/json: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' application/yaml: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' put: tags: - Agent mTLS Endpoint Management summary: Updates the existing agent mTLS endpoint for an account. operationId: updateAgentMtlsEndpointForAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: The details to update for the agent mTLS endpoint. content: application/json: schema: $ref: '#/components/schemas/AgentMtlsEndpointRequest' required: true responses: '200': description: Successfully updated mTLS endpoint content: application/json: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' application/yaml: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' post: tags: - Agent mTLS Endpoint Management summary: Creates the agent mTLS endpoint for an account. operationId: createAgentMtlsEndpointForAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: The details of the agent mTLS endpoint to create. content: application/json: schema: $ref: '#/components/schemas/AgentMtlsEndpointRequest' required: true responses: '200': description: Successfully created mTLS endpoint content: application/json: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' application/yaml: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' delete: tags: - Agent mTLS Endpoint Management summary: Removes the agent mTLS endpoint for an account. operationId: deleteAgentMtlsEndpointForAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '200': description: Successfully deleted mTLS endpoint content: application/json: schema: type: boolean application/yaml: schema: type: boolean '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' patch: tags: - Agent mTLS Endpoint Management summary: >- Updates selected properties of the existing agent mTLS endpoint for an account. operationId: patchAgentMtlsEndpointForAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: A subset of the details to update for the agent mTLS endpoint. content: application/json: schema: $ref: '#/components/schemas/AgentMtlsEndpointRequest' required: true responses: '200': description: Successfully patched mTLS endpoint content: application/json: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' application/yaml: schema: $ref: '#/components/schemas/AgentMtlsEndpointDetails' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/agent/mtls/check-availability: get: tags: - Agent mTLS Endpoint Management summary: Checks whether a given agent mTLS endpoint domain prefix is available. operationId: checkAgentMtlsEndpointDomainPrefixAvailability parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: domainPrefix in: query description: The domain prefix to check. required: true schema: type: string responses: '200': description: Successfully checked domain prefix availability content: application/json: schema: type: boolean application/yaml: schema: type: boolean '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/customDeployment/get-references: post: tags: - CustomDeployment summary: Gets Custom Deployment Entity References operationId: getCustomDeploymentEntityReferences parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Custom Deployment Yaml Request DTO containing entityYaml content: application/json: schema: $ref: '#/components/schemas/CustomDeploymentYamlRequestDTO' application/yaml: schema: $ref: '#/components/schemas/CustomDeploymentYamlRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns all entity references in the custom deployment template. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListEntityDetailProtoDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListEntityDetailProtoDTO' /ng/api/customDeployment/expression-variables: post: tags: - CustomDeployment summary: Gets Custom Deployment Expression Variables operationId: getCustomDeploymentExpressionVariables requestBody: description: Custom Deployment Yaml Request DTO containing entityYaml content: application/json: schema: $ref: '#/components/schemas/CustomDeploymentYamlRequestDTO' application/yaml: schema: $ref: '#/components/schemas/CustomDeploymentYamlRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns all Variables used that are valid to be used as expression in template. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOCustomDeploymentVariableResponseDTO application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOCustomDeploymentVariableResponseDTO /ng/api/customDeployment/variables/{templateIdentifier}: get: tags: - CustomDeployment summary: Gets Infra Variables from a Custom Deployment Template by identifier operationId: getCustomDeploymentInfraVariables parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Custom Deployment Identifier for the entity required: true schema: type: string - name: versionLabel in: query description: Version Label schema: type: string - name: deleted in: query description: Specifies whether Template is deleted or not schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: The saved Custom Deployment Infra Variables content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/customDeployment/get-updated-Yaml/{infraIdentifier}: post: tags: - CustomDeployment summary: Return the updated yaml for infrastructure based on Deployment template operationId: getUpdatedYamlForInfrastructure parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: infraIdentifier in: path description: Infrastructure Identifier for the entity required: true schema: type: string requestBody: description: YAML content: application/json: schema: $ref: '#/components/schemas/CustomDeploymentYamlDTO' application/yaml: schema: $ref: '#/components/schemas/CustomDeploymentYamlDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Return the updated yaml for infrastructure based on Deployment template content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCustomDeploymentRefreshYamlDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOCustomDeploymentRefreshYamlDTO' /ng/api/customDeployment/validate-infrastructure/{infraIdentifier}: get: tags: - CustomDeployment summary: This validates whether Infrastructure is valid or not operationId: validateInfrastructureForDeploymentTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: envIdentifier in: query description: Environment Identifier for the entity schema: type: string - name: infraIdentifier in: path description: Infrastructure Identifier for the entity required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns if the infra is valid or not. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOCustomDeploymentInfraResponseDTO application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOCustomDeploymentInfraResponseDTO /ng/api/download-delegates/docker: post: tags: - Delegate Download Resource summary: Downloads a docker delegate yaml file. operationId: downloadDockerDelegateYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Parameters needed for downloading docker delegate yaml content: application/json: schema: $ref: '#/components/schemas/DelegateDownloadRequest' required: true responses: '200': description: Successfully generated and downloaded docker delegate yaml file '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/download-delegates/kubernetes: post: tags: - Delegate Download Resource summary: Downloads a kubernetes delegate yaml file. operationId: downloadKubernetesDelegateYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Parameters needed for downloading kubernetes delegate yaml content: application/json: schema: $ref: '#/components/schemas/DelegateDownloadRequest' required: true responses: '200': description: Successfully generated and downloaded kubernetes delegate yaml file '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-group-tags/{groupIdentifier}: get: tags: - Delegate Group Tags Resource summary: Retrieves list of tags attached with Delegate group operationId: listTagsForDelegateGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: groupIdentifier in: path description: Delegate Group Identifier required: true schema: type: string responses: '200': description: Successfully retrieved delegate group details with tags content: application/json: schema: $ref: '#/components/schemas/DelegateGroupDTO' application/yaml: schema: $ref: '#/components/schemas/DelegateGroupDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' put: tags: - Delegate Group Tags Resource summary: >- Clears all existing tags with delegate group and attach given set of tags to delegate group. operationId: updateTagsOfDelegateGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: groupIdentifier in: path description: Delegate Group Identifier required: true schema: type: string requestBody: description: Set of tags content: application/json: schema: $ref: '#/components/schemas/DelegateGroupTags' required: true responses: '200': description: Successfully updated delegate group tags content: application/json: schema: $ref: '#/components/schemas/DelegateGroupDTO' application/yaml: schema: $ref: '#/components/schemas/DelegateGroupDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' post: tags: - Delegate Group Tags Resource summary: Add given list of tags to the Delegate group operationId: addTagsToDelegateGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: groupIdentifier in: path description: Delegate Group Identifier required: true schema: type: string requestBody: description: Set of tags content: application/json: schema: $ref: '#/components/schemas/DelegateGroupTags' required: true responses: '200': description: Successfully added tags to delegate group content: application/json: schema: $ref: '#/components/schemas/DelegateGroupDTO' application/yaml: schema: $ref: '#/components/schemas/DelegateGroupDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' delete: tags: - Delegate Group Tags Resource summary: Deletes all tags from the Delegate group operationId: deleteTagsFromDelegateGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: groupIdentifier in: path description: Delegate Group Identifier required: true schema: type: string responses: '200': description: Successfully deleted all tags from delegate group content: application/json: schema: $ref: '#/components/schemas/DelegateGroupDTO' application/yaml: schema: $ref: '#/components/schemas/DelegateGroupDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-group-tags/delegate-groups: post: tags: - Delegate Group Tags Resource summary: List delegate groups that are having mentioned tags. operationId: listDelegateGroupsUsingTags parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Set of tags content: application/json: schema: $ref: '#/components/schemas/DelegateGroupTags' required: true responses: '200': description: Successfully retrieved list of delegate groups with specified tags content: application/json: schema: $ref: '#/components/schemas/DelegateGroupDTO' application/yaml: schema: $ref: '#/components/schemas/DelegateGroupDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-setup/delegate/{delegateIdentifier}: delete: tags: - Delegate Setup Resource summary: Deletes a Delegate by its identifier. operationId: deleteDelegate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: delegateIdentifier in: path description: Identifier for the Entity. required: true schema: type: string responses: '200': description: Successfully deleted delegate content: application/json: schema: $ref: '#/components/schemas/DelegateDeleteResponse' application/yaml: schema: $ref: '#/components/schemas/DelegateDeleteResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-setup/delete-delegate-override: delete: tags: - Delegate Setup Resource summary: Delete delegate image tag override operationId: overrideDelegateImageTag parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: tags in: query schema: uniqueItems: true type: array items: type: string responses: '200': description: Successfully deleted delegate image tag override '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-setup/delegate-terraform-module-file: get: tags: - Delegate Setup Resource summary: Generates delegate terraform example module file from the account operationId: generateTerraformModule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '200': description: Successfully generated terraform module file '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-setup/generate-helm-values: post: tags: - Delegate Setup Resource summary: >- Generates helm values yaml file from the data specified in request body (Delegate setup details). operationId: generateNgHelmValuesYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Delegate setup details, containing data to populate yaml file values. content: application/json: schema: $ref: '#/components/schemas/DelegateSetupDetails' required: true responses: '200': description: Successfully generated helm values yaml file '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-setup/override-delegate-tag: get: tags: - Delegate Setup Resource summary: Lists all delegates overrides in NG filtered by provided conditions operationId: listOverrideDelegateImageTag parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '200': description: Successfully retrieved list of delegate overrides content: application/json: schema: $ref: '#/components/schemas/VersionOverridesResponse' application/yaml: schema: $ref: '#/components/schemas/VersionOverridesResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' put: tags: - Delegate Setup Resource summary: Overrides delegate image tag for account operationId: overrideDelegateImageTag_1 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: tags in: query description: >- if provided, will override the image for all delegates which have all the provided tags schema: uniqueItems: true type: array items: type: string - name: delegateTag in: query required: true schema: type: string - name: validTillNextRelease in: query description: >- If set to true, harness will override your custom tag when new delegate is released schema: type: boolean default: false - name: validForDays in: query description: days after which harness will override your custom tag schema: type: integer format: int32 default: 180 responses: '200': description: Successfully overridden delegate image tag content: application/json: schema: type: string application/yaml: schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-setup/listDelegates: post: tags: - Delegate Setup Resource summary: Lists all delegates in NG filtered by provided conditions operationId: listDelegates parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: all in: query description: >- Filter delegates based on the scope (query param: all), if true will return delegates of underlying orgs/projects and ignore the filters provided as part of the request body schema: type: boolean default: false requestBody: description: Details of the Delegate filter properties to be applied content: application/json: schema: $ref: '#/components/schemas/DelegateFilterPropertiesDTO' responses: '200': description: Successfully retrieved list of delegates content: application/json: schema: $ref: '#/components/schemas/DelegateListResponse' application/yaml: schema: $ref: '#/components/schemas/DelegateListResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-setup/latest-supported-version: get: tags: - Delegate Setup Resource summary: >- Gets the latest supported delegate version. The version has YY.MM.XXXXX format. You can use any version lower than the returned results(upto 3 months old) operationId: publishedDelegateVersion parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '200': description: Successfully retrieved the latest supported delegate version content: application/json: schema: $ref: '#/components/schemas/SupportedDelegateVersion' application/yaml: schema: $ref: '#/components/schemas/SupportedDelegateVersion' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-token-ng: get: tags: - Delegate Token Resource summary: Retrieves Delegate Tokens by Account, Organization, Project and status. operationId: getCgDelegateTokens parameters: - name: name in: query description: Name of Delegate Token (ACTIVE or REVOKED). schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: status in: query description: >- Status of Delegate Token (ACTIVE or REVOKED). If left empty both active and revoked tokens will be retrieved schema: type: string enum: - ACTIVE - REVOKED responses: '200': description: Successfully retrieved list of delegate tokens content: application/json: schema: $ref: '#/components/schemas/DelegateTokenDetails' application/yaml: schema: $ref: '#/components/schemas/DelegateTokenDetails' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' put: tags: - Delegate Token Resource summary: Revokes Delegate Token. operationId: revokeCgDelegateToken parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: tokenName in: query description: Delegate Token name required: true schema: type: string responses: '200': description: Successfully revoked delegate token content: application/json: schema: $ref: '#/components/schemas/DelegateTokenDetails' application/yaml: schema: $ref: '#/components/schemas/DelegateTokenDetails' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' post: tags: - Delegate Token Resource summary: Creates Delegate Token. operationId: createDelegateToken parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: tokenName in: query description: Delegate Token name required: true schema: type: string - name: revokeAfter in: query description: >- Epoch time in milliseconds after which the token will be marked as revoked. There can be a delay of upto one hour from the epoch value provided and actual revoking of the token. schema: type: integer format: int64 responses: '200': description: Successfully created delegate token content: application/json: schema: $ref: '#/components/schemas/DelegateTokenDetails' application/yaml: schema: $ref: '#/components/schemas/DelegateTokenDetails' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' delete: tags: - Delegate Token Resource summary: Deletes a revoked Delegate Token. operationId: deleteNgDelegateToken parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: tokenName in: query description: Delegate Token name required: true schema: type: string responses: '204': description: Successfully deleted delegate token, no content returned '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/delegate-token-ng/delegate-groups: get: tags: - Delegate Token Resource summary: Lists delegate groups that are using the specified delegate token. operationId: getDelegateGroupsUsingToken parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: delegateTokenName in: query description: Delegate Token name schema: type: string responses: '200': description: >- Successfully retrieved list of delegate groups using the specified token content: application/json: schema: $ref: '#/components/schemas/DelegateGroupListing' application/yaml: schema: $ref: '#/components/schemas/DelegateGroupListing' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/environmentsV2/check-allowed-values: post: tags: - Environments summary: Check for allowed-values in the Environments operationId: checkAllowedValuesInEnvs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Environments using allowed-values content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAllowedValuesUsagesInternalDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOAllowedValuesUsagesInternalDTO' /ng/api/environmentsV2: get: tags: - Environments summary: Gets Environment list for a project operationId: getEnvironmentList parameters: - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: envIdentifiers in: query description: List of EnvironmentIds schema: type: array items: type: string - name: sort in: query description: >- Specifies sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Environments for a Project content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseEnvironmentResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseEnvironmentResponse put: tags: - Environments summary: Update an Environment by identifier operationId: updateEnvironmentV2 parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Environment to be updated content: application/json: schema: $ref: '#/components/schemas/EnvironmentRequest' application/yaml: schema: $ref: '#/components/schemas/EnvironmentRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Environment content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' post: tags: - Environments summary: Create an Environment operationId: createEnvironmentV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Environment to be created content: application/json: schema: $ref: '#/components/schemas/EnvironmentRequest' application/yaml: schema: $ref: '#/components/schemas/EnvironmentRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Environment content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' /ng/api/environmentsV2/batch: post: tags: - Environments summary: Create Environments in batch with partial success support operationId: createEnvironmentsV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Details of the Environments to be created, maximum 1000 environments can be created. content: application/json: schema: maxItems: 1000 minItems: 0 type: array items: $ref: '#/components/schemas/EnvironmentRequest' application/yaml: schema: maxItems: 1000 minItems: 0 type: array items: $ref: '#/components/schemas/EnvironmentRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the batch creation result with successful and failed environments content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentBatchResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentBatchResponse' /ng/api/environmentsV2/{environmentIdentifier}: get: tags: - Environments summary: Gets an Environment by identifier operationId: getEnvironmentV2 parameters: - name: environmentIdentifier in: path description: Environment Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: deleted in: query description: Specify whether Environment is deleted or not schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: The saved Environment content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' delete: tags: - Environments summary: Delete an Environment by identifier operationId: deleteEnvironmentV2 parameters: - name: If-Match in: header schema: type: string - name: environmentIdentifier in: path description: Environment Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Environment is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/environmentsV2/serviceOverrides: get: tags: - Environments summary: Gets Service Overrides list operationId: getServiceOverridesList parameters: - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 500 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: Environment Identifier for the Entity. required: true schema: type: string - name: serviceIdentifier in: query description: Service Identifier for the Entity. schema: type: string - name: sort in: query description: >- Specifies the sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the list of Service Overrides for an Environment.serviceIdentifier, if passed, can be used to get the overrides for that particular Service in the Environment content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseServiceOverrideResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseServiceOverrideResponse post: tags: - Environments summary: upsert a Service Override for an Environment operationId: upsertServiceOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Service Override to be upserted content: application/json: schema: $ref: '#/components/schemas/ServiceOverrideRequest' application/yaml: schema: $ref: '#/components/schemas/ServiceOverrideRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Upsert ( Create/Update ) a Service Override in an Environment. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceOverrideResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceOverrideResponse' delete: tags: - Environments summary: Delete a ServiceOverride entity operationId: deleteServiceOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: Environment Identifier for the Entity. schema: type: string - name: serviceIdentifier in: query description: Service Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Service Override is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/environmentsV2/import: post: tags: - Environments summary: Import and Create Environment from Git Repository operationId: importEnvironment parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: Environment Identifier for the entity schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. required: true schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string - name: filePath in: query description: File Path of the Entity. required: true schema: type: string - name: isForceImport in: query description: isForceImport schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Import and Create Environment from Git Repository and saves a record for it in Harness content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOEnvironmentImportResponseDetails application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOEnvironmentImportResponseDetails /ng/api/environmentsV2/list/access: get: tags: - Environments summary: Gets Environment Access list operationId: getEnvironmentAccessList parameters: - name: page in: query description: page schema: type: integer format: int32 default: 0 - name: size in: query description: size schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: envIdentifiers in: query description: List of EnvironmentIds schema: type: array items: type: string - name: envGroupIdentifier in: query description: Environment group identifier schema: type: string - name: type in: query description: Environment type for the entity schema: type: string enum: - PreProduction - Production - name: sort in: query description: >- Specifies sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Environments that are accessible content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListEnvironmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListEnvironmentResponse' /ng/api/environmentsV2/move-config/{environmentIdentifier}: post: tags: - Environments summary: Move environment YAML from inline to remote operationId: moveEnvironmentConfigs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: path description: Environment Identifier for the entity required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean default: false - name: moveConfigType in: query description: >- Tells weather the entity has to be moved from inline to remote or remote to inline required: true schema: type: string enum: - INLINE_TO_REMOTE - REMOTE_TO_INLINE responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Move environment YAML from inline to remote content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentMoveConfigResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentMoveConfigResponse' /ng/api/environmentsV2/{environmentIdentifier}/update-git-metadata: put: tags: - Environments summary: Update git-metadata in remote environment Entity description: >- Update git-metadata in remote environment and returns the identifier of updated environment operationId: updateEnvironmentGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: path description: Environment Identifier for the entity required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns identifier of updated environment content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGitUpdateResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentGitUpdateResponse' /ng/api/environmentsV2/upsert: put: tags: - Environments summary: Upsert an Environment by identifier operationId: upsertEnvironmentV2 parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Environment to be updated content: application/json: schema: $ref: '#/components/schemas/EnvironmentRequest' application/yaml: schema: $ref: '#/components/schemas/EnvironmentRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Environment content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOEnvironmentResponse' /ng/api/infrastructures: get: tags: - Infrastructures summary: Gets Infrastructure list operationId: getInfrastructureList parameters: - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: Environment Identifier for the Entity. required: true schema: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: infraIdentifiers in: query description: List of InfrastructureIds schema: type: array items: type: string - name: deploymentType in: query schema: type: string enum: - Kubernetes - NativeHelm - Ssh - WinRm - ServerlessAwsLambda - AzureWebApp - AzureFunction - CustomDeployment - ECS - Elastigroup - TAS - Asg - GoogleCloudFunctions - AwsLambda - AWS_SAM - SERVICE_YAML_V1_TYPE - GoogleCloudRun - Salesforce - GoogleManagedInstanceGroup - AzureContainerApps - AiAgent - name: deploymentTemplateIdentifier in: query description: >- The Identifier of deployment template if infrastructure is of type custom deployment schema: type: string - name: versionLabel in: query description: >- The version label of deployment template if infrastructure is of type custom deployment schema: type: string - name: sort in: query description: >- Specifies the sorting criteria of the list. Elements in the list should be of the format "property,order" or "property". Order can take values ASC or DESC for alphabetical ascending and descending orders respectively. If the order is not specified, it takes ASC by default schema: type: array items: type: string - name: serviceRefs in: query description: >- list of service refs required to fetch infrastructures scoped to these service refs schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Infrastructure for an Environment content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseInfrastructureResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseInfrastructureResponse put: tags: - Infrastructures summary: Update an Infrastructure by identifier operationId: updateInfrastructure parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Infrastructure to be updated content: application/json: schema: $ref: '#/components/schemas/InfrastructureRequest' examples: Update: summary: Sample Infrastructure update payload description: Sample Infrastructure payload value: name: infrastructure identifier: infrastructureId description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect yaml: | infrastructureDefinition: name: infrastructure identifier: infrastructure description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect spec: connectorRef: connectorId namespace: namespace releaseName: release-<+INFRA_KEY> allowSimultaneousDeployments: false application/yaml: schema: $ref: '#/components/schemas/InfrastructureRequest' examples: Update: summary: Sample Infrastructure update payload description: Sample Infrastructure payload value: name: infrastructure identifier: infrastructureId description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect yaml: | infrastructureDefinition: name: infrastructure identifier: infrastructure description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect spec: connectorRef: connectorId namespace: namespace releaseName: release-<+INFRA_KEY> allowSimultaneousDeployments: false required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Infrastructure content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureResponse' post: tags: - Infrastructures summary: Create an Infrastructure in an Environment operationId: createInfrastructure parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Infrastructure to be created content: application/json: schema: $ref: '#/components/schemas/InfrastructureRequest' examples: Create: summary: Sample Infrastructure create payload description: Sample Infrastructure payload value: name: infrastructure identifier: infrastructureId description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect yaml: | infrastructureDefinition: name: infrastructure identifier: infrastructure description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect spec: connectorRef: connectorId namespace: namespace releaseName: release-<+INFRA_KEY> allowSimultaneousDeployments: false application/yaml: schema: $ref: '#/components/schemas/InfrastructureRequest' examples: Create: summary: Sample Infrastructure create payload description: Sample Infrastructure payload value: name: infrastructure identifier: infrastructureId description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect yaml: | infrastructureDefinition: name: infrastructure identifier: infrastructure description: infrastructure description tags: {} orgIdentifier: default projectIdentifier: projectIdentifier environmentRef: environmentId deploymentType: Kubernetes type: KubernetesDirect spec: connectorRef: connectorId namespace: namespace releaseName: release-<+INFRA_KEY> allowSimultaneousDeployments: false required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Infrastructure content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureResponse' /ng/api/infrastructures/{infraIdentifier}: get: tags: - Infrastructures summary: Gets an Infrastructure by identifier operationId: getInfrastructure parameters: - name: infraIdentifier in: path description: Infrastructure Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: envId required: true schema: type: string - name: deleted in: query description: Specify whether Infrastructure is deleted or not schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: The saved Infrastructure content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureResponse' delete: tags: - Infrastructures summary: Delete an Infrastructure by identifier operationId: deleteInfrastructure parameters: - name: infraIdentifier in: path description: Infrastructure Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: Environment Identifier for the Entity. required: true schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Infrastructure is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/infrastructures/import: post: tags: - Infrastructures summary: Import and Create Infrastructure from Git Repository operationId: importInfrastructure parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: Environment Identifier for the entity required: true schema: type: string - name: infraIdentifier in: query description: Infrastructure Identifier for the entity schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. required: true schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string - name: filePath in: query description: File Path of the Entity. required: true schema: type: string - name: isForceImport in: query description: isForceImport schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Import and Create Infrastructure from Git Repository and saves a record for it in Harness content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureImportResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInfrastructureImportResponse' /ng/api/infrastructures/move-config/{infraIdentifier}: post: tags: - Infrastructures summary: Move infra YAML from inline to remote operationId: moveInfraConfigs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: envId required: true schema: type: string - name: infraIdentifier in: path description: Infrastructure Identifier for the entity required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean default: false - name: moveConfigType in: query description: >- Tells weather the entity has to be moved from inline to remote or remote to inline required: true schema: type: string enum: - INLINE_TO_REMOTE - REMOTE_TO_INLINE responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Move infra YAML from inline to remote content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInfraMoveConfigResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInfraMoveConfigResponse' /ng/api/infrastructures/{infraIdentifier}/update-git-metadata: put: tags: - Infrastructures summary: Update git-metadata in remote infrastructure Entity description: >- Update git-metadata in remote infrastructure and returns the identifier of updated infrastructure operationId: updateInfrastructureGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: envId required: true schema: type: string - name: infraIdentifier in: path description: Infrastructure Identifier for the entity required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns identifier of updated infrastructure content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOInfrastructureGitUpdateResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOInfrastructureGitUpdateResponse /ng/api/invites/{inviteId}: put: tags: - Invite summary: Resend invite description: Resend the invite email operationId: updateInvite parameters: - name: inviteId in: path description: Invite id required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Updated Invite content: application/json: schema: $ref: '#/components/schemas/Invite' text/yaml: schema: $ref: '#/components/schemas/Invite' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the Invite content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOptionalInvite' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOOptionalInvite' delete: tags: - Invite summary: Delete Invite description: Delete an Invite by Identifier operationId: deleteInvite parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: inviteId in: path description: Invite Id required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns either empty value of Deleted Invite content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOptionalInvite' /ng/api/invites/invite: get: tags: - Invite summary: Get Invite description: Gets an Invite by either Invite Id or JwtToken operationId: getInvite parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: inviteId in: query description: Invitation Id schema: type: string - name: jwttoken in: query description: JWT Token schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the Invite having either InviteId or JwtToken as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInvite' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOInvite' /ng/api/invites: get: tags: - Invite summary: List Invites description: List all the Invites for a Project or Organization operationId: getInvites parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Paginated list of Invites content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseInvite' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseInvite' /ng/api/invites/aggregate: post: tags: - Invite summary: Get pending users description: List of all the pending users in a scope operationId: getPendingUsersAggregated parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Search term schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ACLAggregateFilter' text/yaml: schema: $ref: '#/components/schemas/ACLAggregateFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Paginated list of Pending Invites content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseInvite' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseInvite' /ng/api/oidc/access-token/aws/webidentity-session-access: post: tags: - Oidc-Access-Token summary: Generate an OIDC IAM Role Credential for AWS operationId: generateOidcIAMRoleCredentialForAws requestBody: description: Details of AWS WebIdentity credential content: application/json: schema: $ref: '#/components/schemas/AwsOidcCredentialsRequest' application/yaml: schema: $ref: '#/components/schemas/AwsOidcCredentialsRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Generate an OIDC IAM Role Credential for AWS content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAwsOidcCredentialResponseDto' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOAwsOidcCredentialResponseDto' /ng/api/oidc/access-token/gcp/service-account-access: post: tags: - Oidc-Access-Token summary: Generates an OIDC Service Account Access Token for GCP operationId: getOidcServiceAccountAccessTokenForGcp requestBody: description: Details of GCP Workload Identity content: application/json: schema: $ref: '#/components/schemas/GcpOidcAccessTokenRequest' application/yaml: schema: $ref: '#/components/schemas/GcpOidcAccessTokenRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns OIDC Service Account Access Token response content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOGcpOidcServiceAccountAccessTokenResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOGcpOidcServiceAccountAccessTokenResponse /ng/api/oidc/access-token/azure: post: tags: - Oidc-Access-Token summary: Exchanges an OIDC token for Azure credentials operationId: exchangeOidcTokenForAzureCredentials requestBody: description: Azure token exchange request content: application/json: schema: $ref: '#/components/schemas/AzureOidcCredentialExchangeRequestDTO' application/yaml: schema: $ref: '#/components/schemas/AzureOidcCredentialExchangeRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns Azure credentials content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAzureOidcCredentialResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOAzureOidcCredentialResponseDTO' /ng/api/oidc/access-token/gcp/workload-access: post: tags: - Oidc-Access-Token summary: Generates an OIDC Workload Access Token for GCP operationId: OidcWorkloadAccessTokenResponse requestBody: description: Details of GCP Workload Identity content: application/json: schema: $ref: '#/components/schemas/GcpOidcAccessTokenRequest' application/yaml: schema: $ref: '#/components/schemas/GcpOidcAccessTokenRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns OIDC Workload Access Token response content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOOidcWorkloadAccessTokenResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOOidcWorkloadAccessTokenResponse /ng/api/oidc/id-token/azure: post: tags: - Oidc-ID-Token summary: Generates an OIDC ID Token for Azure operationId: generateOidcIdTokenForAzure requestBody: description: contains oidc field for azure content: application/json: schema: $ref: '#/components/schemas/AzureOidcTokenRequestDTO' application/yaml: schema: $ref: '#/components/schemas/AzureOidcTokenRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns OIDC ID Token as a JWT content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/oidc/id-token/gcp: post: tags: - Oidc-ID-Token summary: Generates an OIDC ID Token for GCP operationId: generateOidcIdTokenForGcp requestBody: description: Details of GCP Workload Identity content: application/json: schema: $ref: '#/components/schemas/GcpOidcTokenRequest' application/yaml: schema: $ref: '#/components/schemas/GcpOidcTokenRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns OIDC ID Token as a JWT content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/oidc/id-token/gcp-v2: post: tags: - Oidc-ID-Token summary: Generates an OIDC ID Token for GCP operationId: generateOidcIdTokenForGcp_1 requestBody: description: Details of GCP Workload Identity content: application/json: schema: $ref: '#/components/schemas/GcpOidcTokenRequest' application/yaml: schema: $ref: '#/components/schemas/GcpOidcTokenRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns OIDC ID Token as a JWT content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/oidc/id-token/custom: post: tags: - Oidc-ID-Token summary: Generate a custom OIDC ID Token operationId: generateCustomOidcIdToken requestBody: description: contains oidc fields for custom token content: application/json: schema: $ref: '#/components/schemas/CustomOidcIdTokenRequest' application/yaml: schema: $ref: '#/components/schemas/CustomOidcIdTokenRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns OIDC ID Token as a JWT content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/oidc/id-token/aws: post: tags: - Oidc-ID-Token summary: Generates an OIDC ID Token for AWS operationId: generateOidcIdTokenForAws requestBody: description: contains oidc fields for aws content: application/json: schema: $ref: '#/components/schemas/AwsOidcTokenRequest' application/yaml: schema: $ref: '#/components/schemas/AwsOidcTokenRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns OIDC ID Token as a JWT content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/oidc/account/{accountId}/.wellknown/jwks: get: tags: - OIDC summary: Get the openid configuration for Harness operationId: getHarnessOpenIdConfig parameters: - name: accountId in: path description: >- This is the accountIdentifier for the account for which the JWKS public key needs to be exposed. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This gets the openid configuration for Harness content: application/json: schema: $ref: '#/components/schemas/JwksPublicKeysDTO' application/yaml: schema: $ref: '#/components/schemas/JwksPublicKeysDTO' /ng/api/oidc/account/{accountId}/.well-known/openid-configuration: get: tags: - OIDC summary: Get the openid configuration for Harness operationId: getHarnessOpenIdConfig_1 parameters: - name: accountId in: path description: >- This is the accountIdentifier for the account for which the JWKS public key needs to be exposed. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This gets the openid configuration for Harness content: application/json: schema: $ref: '#/components/schemas/OidcConfiguration' application/yaml: schema: $ref: '#/components/schemas/OidcConfiguration' /ng/api/onboarding/execute: post: tags: - Onboarding summary: >- Provisions secrets, connectors, and a Kubernetes service (with GitHub manifest and DockerHub artifact) in dependency order from a single declarative context operationId: executeOnboarding parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: The onboarding execute request content: application/json: schema: $ref: '#/components/schemas/OnboardingExecuteRequest' application/yaml: schema: $ref: '#/components/schemas/OnboardingExecuteRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Identifiers of the resources created during onboarding content: application/json: schema: $ref: '#/components/schemas/OnboardingExecuteResponse' application/yaml: schema: $ref: '#/components/schemas/OnboardingExecuteResponse' /ng/api/onboarding/kubeconfig/upload: post: tags: - Onboarding summary: Upload and process a kubeconfig file for onboarding operationId: uploadKubeConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string description: The kubeConfig (~/.kube/config) file to upload format: binary responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Per-context connector-creation hints detected from the kubeConfig content: application/json: schema: $ref: '#/components/schemas/KubeconfigUploadResponse' application/yaml: schema: $ref: '#/components/schemas/KubeconfigUploadResponse' /ng/api/provider: get: tags: - Provider summary: Gets Provider list operationId: getProviderList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Services for a Project content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListGetProviderResponse' post: tags: - Provider summary: Create a Provider operationId: createProvider parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Provider to be created content: application/json: schema: $ref: '#/components/schemas/CreateProviderRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Provider content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCreateProviderResponse' /ng/api/provider/{providerIdentifier}: get: tags: - Provider summary: Gets a Provider by identifier operationId: getProvider parameters: - name: providerIdentifier in: path description: Provider Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' default: description: The saved Provider content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGetProviderResponse' put: tags: - Provider summary: Update a Provider by identifier operationId: updateProvider parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: providerIdentifier in: path description: Provider Identifier required: true schema: type: string requestBody: description: Details of the Provider to be updated content: application/json: schema: $ref: '#/components/schemas/UpdateProviderRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Provider content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUpdateProviderResponse' delete: tags: - Provider summary: Delete a Provider by identifier operationId: deleteProvider parameters: - name: providerIdentifier in: path description: Provider Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Provider is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTODeleteProviderResponse' /ng/api/apikey: get: tags: - ApiKey summary: >- Fetches the list of API Keys corresponding to the request's filter criteria. operationId: listApiKeys_1 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: apiKeyType in: query description: >- This is the API Key type like Personal Access Key or Service Account Key. required: true schema: type: string enum: - USER - SERVICE_ACCOUNT - SSH_KEY - PGP_KEY - SCOPED_TOKEN - name: parentIdentifier in: query description: ID of API key's Parent Service Account required: true schema: type: string - name: identifiers in: query description: >- This is the list of API Key IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of API keys. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListApiKey' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListApiKey' text/plain: schema: $ref: '#/components/schemas/ResponseDTOListApiKey' post: tags: - ApiKey summary: Creates an API key operationId: createApiKey parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiKey' application/yaml: schema: $ref: '#/components/schemas/ApiKey' text/plain: schema: $ref: '#/components/schemas/ApiKey' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created API key content: application/json: schema: $ref: '#/components/schemas/ResponseDTOApiKey' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOApiKey' text/plain: schema: $ref: '#/components/schemas/ResponseDTOApiKey' /ng/api/apikey/{identifier}: put: tags: - ApiKey summary: Updates API Key for the provided ID operationId: updateApiKey parameters: - name: identifier in: path description: This is the API key ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiKey' application/yaml: schema: $ref: '#/components/schemas/ApiKey' text/plain: schema: $ref: '#/components/schemas/ApiKey' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated API key content: application/json: schema: $ref: '#/components/schemas/ResponseDTOApiKey' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOApiKey' text/plain: schema: $ref: '#/components/schemas/ResponseDTOApiKey' delete: tags: - ApiKey summary: Deletes the API Key corresponding to the provided ID. operationId: deleteApiKey parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: apiKeyType in: query description: >- This is the API Key type like Personal Access Key or Service Account Key. required: true schema: type: string enum: - USER - SERVICE_ACCOUNT - SSH_KEY - PGP_KEY - SCOPED_TOKEN - name: parentIdentifier in: query description: Id of API key's Parent Service Account required: true schema: type: string - name: identifier in: path description: This is the API key ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns a boolean value. The value is True if the API Key is successfully deleted, else it is False. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/plain: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/apikey/aggregate/{identifier}: get: tags: - ApiKey summary: Fetches the API Keys details corresponding to the provided ID and Scope. operationId: getAggregatedApiKey parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: apiKeyType in: query description: >- This is the API Key type like Personal Access Key or Service Account Key. required: true schema: type: string enum: - USER - SERVICE_ACCOUNT - SSH_KEY - PGP_KEY - SCOPED_TOKEN - name: parentIdentifier in: query description: ID of API key's Parent Service Account required: true schema: type: string - name: identifier in: path description: This is the API key ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the API key content: application/json: schema: $ref: '#/components/schemas/ResponseDTOApiKeyAggregate' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOApiKeyAggregate' text/plain: schema: $ref: '#/components/schemas/ResponseDTOApiKeyAggregate' /ng/api/apikey/aggregate: get: tags: - ApiKey summary: >- Fetches the list of Aggregated API Keys corresponding to the request's filter criteria. operationId: listApiKeys parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: apiKeyType in: query description: >- This is the API Key type like Personal Access Key or Service Account Key. required: true schema: type: string enum: - USER - SERVICE_ACCOUNT - SSH_KEY - PGP_KEY - SCOPED_TOKEN - name: parentIdentifier in: query description: ID of API key's Parent Service Account required: true schema: type: string - name: identifiers in: query description: >- This is the list of API Key IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: searchTerm in: query description: >- This would be used to filter API keys. Any API key having the specified string in its Name, ID and Tag would be filtered. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the Paginated list of Aggregated API keys. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseApiKeyAggregate' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseApiKeyAggregate' text/plain: schema: $ref: '#/components/schemas/ResponseDTOPageResponseApiKeyAggregate' /ng/api/host-validation: post: tags: - ValidateHost summary: Validates hosts connectivity credentials operationId: validateHosts parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query description: Secret Identifier required: true schema: type: string requestBody: description: List of SSH or WinRm hosts to validate, and Delegate tags (optional) content: application/json: schema: $ref: '#/components/schemas/HostValidationParams' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns validation response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListHostValidationDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListHostValidationDTO' deprecated: true /ng/api/keys: get: tags: - Keys summary: List Keys description: >- Lists SSH, PGP, or all Keys based on keyScheme parameter. Supports filtering by fingerprint, subKeyId, usages, and schemes. operationId: ListAggregatedKeys parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: parentIdentifier in: query description: Identifier of the key's Parent Account schema: type: string - name: keyScheme in: query description: 'Key scheme: ssh (default), pgp, or all' schema: type: string - name: fingerprint in: query description: Key fingerprint filter (exact match) schema: type: string - name: subKeyId in: query description: Subkey ID filter (PGP only) schema: type: string - name: usages in: query description: Key usage filter schema: type: array items: type: string enum: - SIGN - ENCRYPT - AUTH - CERTIFY - name: schemes in: query description: Key scheme filter schema: type: array items: type: string enum: - SSH - PGP - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Keys matching the criteria. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseKey' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseKey' text/plain: schema: $ref: '#/components/schemas/ResponseDTOPageResponseKey' post: tags: - Keys summary: Create Key description: >- Creates a SSH or PGP Key. Use query param keyScheme=ssh (default) or keyScheme=pgp. Defaults to SSH when keyScheme is not passed. operationId: createKey parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: keyScheme in: query description: 'Key scheme: ssh (default) or pgp' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Key' application/yaml: schema: $ref: '#/components/schemas/Key' text/plain: schema: $ref: '#/components/schemas/Key' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created Key details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' text/plain: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/keys/{identifier}: put: tags: - Keys summary: Update a Key description: >- Updates a Key's validity period or revocation status. For COMPROMISED revocation of PGP keys, the code-api service is notified first. operationId: updateKey parameters: - name: identifier in: path description: Key identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: parentIdentifier in: query description: Identifier of the key's Parent Account required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePublicKeyRequest' application/yaml: schema: $ref: '#/components/schemas/UpdatePublicKeyRequest' text/plain: schema: $ref: '#/components/schemas/UpdatePublicKeyRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Key details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOKey' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOKey' text/plain: schema: $ref: '#/components/schemas/ResponseDTOKey' delete: tags: - Keys summary: Delete a Key description: >- Deletes a Key (SSH or PGP) by its identifier. For PGP primary keys, all subkeys are also deleted. operationId: deleteKey parameters: - name: identifier in: path description: Key identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: parentIdentifier in: query description: Identifier of the key's Parent Account required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Key is deleted successfully and false if the Key is not deleted. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/plain: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/hosts/filter: post: tags: - Hosts summary: >- Gets the list of hosts filtered by accountIdentifier and connectorIdentifier operationId: filterHostsByConnector parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query description: Connector Identifier schema: type: string requestBody: description: Details of the filters applied content: application/json: schema: $ref: '#/components/schemas/HostFilterDTO' text/yaml: schema: $ref: '#/components/schemas/HostFilterDTO' text/html: schema: $ref: '#/components/schemas/HostFilterDTO' text/plain: schema: $ref: '#/components/schemas/HostFilterDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the list of hosts filtered by accountIdentifier and connectorIdentifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseHostDTO' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseHostDTO' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseHostDTO' /ng/api/hosts/validate: post: tags: - Hosts summary: Validates hosts connectivity credentials operationId: validateHosts_1 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query description: Secret Identifier required: true schema: type: string requestBody: description: List of SSH or WinRm hosts to validate, and Delegate tags (optional) content: application/json: schema: $ref: '#/components/schemas/HostValidationParams' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns validation response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListHostValidationDTO' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOListHostValidationDTO' text/html: schema: $ref: '#/components/schemas/ResponseDTOListHostValidationDTO' /ng/api/secret-managers/meta-data: post: tags: - Secret Managers summary: Gets the metadata of Secret Manager operationId: getMetadata parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details required for the creation of the Secret Manager content: application/json: schema: $ref: '#/components/schemas/SecretManagerMetadataRequest' application/yaml: schema: $ref: '#/components/schemas/SecretManagerMetadataRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the metadata of Secret Manager content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretManagerMetadataDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretManagerMetadataDTO' /ng/api/v2/secrets/count: get: tags: - Secrets operationId: countSecretsForScope parameters: - name: accountIdentifier in: query required: true schema: type: string - name: parentUniqueId in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' /ng/api/v2/secrets: get: tags: - Secrets summary: >- Fetches the list of Secrets corresponding to the request's filter criteria. operationId: listSecretsV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifiers in: query description: >- This is the list of Secret IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: type in: query description: Type of Secret whether it is SecretFile, SecretText or SSH key schema: type: string enum: - SecretFile - SecretText - SSHKey - WinRmCredentials - name: searchTerm in: query description: >- Filter Secrets based on name, Identifier and tags by this search term schema: type: string - name: types in: query description: >- Add multiple secret types like SecretFile, SecretText or SSH key to criteria schema: type: array items: type: string enum: - SecretFile - SecretText - SSHKey - WinRmCredentials - name: source_category in: query description: >- Source Category like CLOUD_PROVIDER, SECRET_MANAGER, CLOUD_COST, ARTIFACTORY, CODE_REPO, MONITORING or TICKETING schema: type: string enum: - CLOUD_PROVIDER - SECRET_MANAGER - CLOUD_COST - ARTIFACTORY - CODE_REPO - MONITORING - TICKETING - DATABASE - COMMUNICATION - DOCUMENTATION - ML_OPS - MCP - AI - CUSTOM - name: includeSecretsFromEverySubScope in: query description: >- Specify whether or not to include secrets from all the sub-scopes of the given Scope schema: type: boolean default: false - name: includeAllSecretsAccessibleAtScope in: query description: >- Specify whether or not to include all the Secrets accessible at the scope. For eg if set as true, at the Project scope we will get org and account Secrets also in the response schema: type: boolean default: false - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: secretManagerIdentifiers in: query description: Specify the secret managers whose secrets should be listed schema: uniqueItems: true type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Secrets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSecretResponse' deprecated: true post: tags: - Secrets summary: Creates a Secret at given Scope operationId: postSecret parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: privateSecret in: query description: >- This is a boolean value to specify if the Secret is Private. The default value is False. schema: type: boolean default: false requestBody: description: Details required to create the Secret content: application/json: schema: $ref: '#/components/schemas/SecretRequestWrapper' application/yaml: schema: $ref: '#/components/schemas/SecretRequestWrapper' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Secret details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' /ng/api/v2/secrets/files: post: tags: - Secrets summary: Creates a Secret File operationId: postSecretFileV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: privateSecret in: query description: >- This is a boolean value to specify if the Secret is Private. The default value is False. schema: type: boolean default: false requestBody: content: multipart/form-data: schema: required: - file type: object properties: file: type: object description: This is the encrypted Secret File that needs to be uploaded. spec: type: string description: Specification of Secret file responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created Secret file content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' /ng/api/v2/secrets/yaml: post: tags: - Secrets summary: Creates a secret via YAML operationId: postSecretViaYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: privateSecret in: query description: >- This is a boolean value to specify if the Secret is Private. The default value is False. schema: type: boolean default: false requestBody: description: Details required to create the Secret content: application/yaml: schema: $ref: '#/components/schemas/SecretRequestWrapper' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Secret details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' deprecated: true /ng/api/v2/secrets/{identifier}: get: tags: - Secrets summary: Get the Secret by ID and Scope operationId: getSecretV2 parameters: - name: identifier in: path description: Secret ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the Secret with the requested ID and Scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' put: tags: - Secrets summary: Updates the Secret by ID and Scope operationId: putSecret parameters: - name: identifier in: path description: Secret ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretRequestWrapper' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Secret content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' delete: tags: - Secrets summary: Deletes Secret by ID and Scope operationId: deleteSecretV2 parameters: - name: identifier in: path description: Secret ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the secret is successfully deleted and false if it is not deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/v2/secrets/list/secrets: post: tags: - Secrets summary: >- Fetches the list of Secrets corresponding to the request's filter criteria. operationId: listSecretsV4 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretFilterProperties' application/yaml: schema: $ref: '#/components/schemas/SecretFilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Secrets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSecretResponse' /ng/api/v2/secrets/list: post: tags: - Secrets summary: >- Fetches the list of Secrets corresponding to the request's filter criteria. operationId: listSecretsV3 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: secretManagerIdentifiers in: query schema: uniqueItems: true type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretResourceFilter' application/yaml: schema: $ref: '#/components/schemas/SecretResourceFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Secrets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSecretResponse' /ng/api/v2/secrets/files/{identifier}: put: tags: - Secrets summary: Updates the Secret file by ID and Scope operationId: putSecretFileV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Secret ID required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: object description: This is the encrypted Secret File that needs to be uploaded. spec: type: string description: Specification of Secret file responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Secret file details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' /ng/api/v2/secrets/{identifier}/yaml: put: tags: - Secrets summary: Updates the Secret by ID and Scope via YAML operationId: putSecretViaYaml parameters: - name: identifier in: path description: Secret ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Details of Secret to create content: application/yaml: schema: $ref: '#/components/schemas/SecretRequestWrapper' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Secret details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretResponse' /ng/api/v2/secrets/validate: post: tags: - Secrets summary: Validates Secret with the provided ID and Scope operationId: validateSecret parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query description: Secret ID schema: type: string requestBody: description: Details of the Secret type content: application/json: schema: $ref: '#/components/schemas/SecretValidationMetaData' application/yaml: schema: $ref: '#/components/schemas/SecretValidationMetaData' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns validation response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSecretValidationResult' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSecretValidationResult' /ng/api/v2/secrets/validateUniqueIdentifier/{identifier}: get: tags: - Secrets summary: Checks whether the identifier is unique or not operationId: validateSecretIdentifierIsUnique parameters: - name: identifier in: path description: Secret Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Identifier is unique and false if the Identifier is not unique. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/organizations: get: tags: - Organization summary: List Organizations by filter description: List all Organizations matching the given search criteria. operationId: getOrganizationList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: identifiers in: query description: >- This is the list of Org Key IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: searchTerm in: query description: >- This would be used to filter Organizations. Any Organization having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns list of Organizations content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseOrganizationResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseOrganizationResponse post: tags: - Organization summary: Create an Organization description: Creates a new Organization. operationId: postOrganization parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Organization to create content: application/json: schema: $ref: '#/components/schemas/OrganizationRequest' application/yaml: schema: $ref: '#/components/schemas/OrganizationRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created Organization details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOrganizationResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOOrganizationResponse' /ng/api/organizations/{identifier}: get: tags: - Organization summary: List Organization details description: Lists Organization details using an Account and Organization ID. operationId: getOrganization parameters: - name: identifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the Organization details with the passed Account Identifier and Org Identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOrganizationResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOOrganizationResponse' put: tags: - Organization summary: Update an Organization description: Updates Organization settings. operationId: putOrganization parameters: - name: If-Match in: header description: Version number of the Organization schema: type: string - name: identifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated Organization. Please provide values for all fields, not just the fields you are updating content: application/json: schema: $ref: '#/components/schemas/OrganizationRequest' application/yaml: schema: $ref: '#/components/schemas/OrganizationRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Organization details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOrganizationResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOOrganizationResponse' delete: tags: - Organization summary: Delete an Organization description: Deletes Organization for the given ID. operationId: deleteOrganization parameters: - name: If-Match in: header description: Version number of the Organization schema: type: string - name: identifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Organization is deleted successfully and false if the Organization is not deleted. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/projects: get: tags: - Project summary: List all Projects for a user description: >- Lists all Projects the user is a member of by using the user's API key token. operationId: getProjectList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: hasModule in: query description: >- This boolean specifies whether to Filter Projects which has the Module of type passed in the module type parameter or to Filter Projects which does not has the Module of type passed in the module type parameter schema: type: boolean default: true - name: identifiers in: query description: >- This is the list of Project IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: moduleType in: query description: Filter Projects by module type schema: type: string enum: - CD - CI - CV - CF - CE - STO - CHAOS - AI_TEST_AUTOMATION - SRM - IACM - CET - IDP - CODE - SSCA - AISRE - CORE - PMS - TEMPLATESERVICE - RMG - GOVERNANCE - PLATFORM - SEI - HAR - DevopsEssentials - FME - DBOPS - AI_AGENT_MLOPS - AASP - AARP - AAST - AISEC - name: searchTerm in: query description: >- This would be used to filter Projects. Any Project having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: onlyFavorites in: query schema: type: boolean default: false - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Paginated list of Projects content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseProjectResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseProjectResponse' post: tags: - Project summary: Create a Project description: Creates a new Harness Project. operationId: postProject parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: >- Organization identifier for the Project. If left empty, the Project is created under Default Organization schema: type: string default: default requestBody: description: Details of the Project to create content: application/json: schema: $ref: '#/components/schemas/ProjectRequest1' application/yaml: schema: $ref: '#/components/schemas/ProjectRequest1' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created Project content: application/json: schema: $ref: '#/components/schemas/ResponseDTOProjectResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOProjectResponse' /ng/api/projects/{identifier}: get: tags: - Project summary: List Project details description: Lists a Project's details for the given ID. operationId: getProject parameters: - name: identifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: >- Organization identifier for the project. If left empty, Default Organization is assumed schema: type: string default: default responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns Project having ID as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOProjectResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOProjectResponse' put: tags: - Project summary: Update a Project description: Updates Project details for the given ID. operationId: putProject parameters: - name: If-Match in: header description: Version number of Project schema: type: string - name: identifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: >- Organization identifier for the Project. If left empty, Default Organization is assumed schema: type: string default: default requestBody: description: >- This is the updated Project. Please provide values for all fields, not just the fields you are updating content: application/json: schema: $ref: '#/components/schemas/ProjectRequest1' application/yaml: schema: $ref: '#/components/schemas/ProjectRequest1' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns updated Project details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOProjectResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOProjectResponse' delete: tags: - Project summary: Delete a Project description: Deletes a Project corresponding to the given ID. operationId: deleteProject parameters: - name: If-Match in: header description: Version number of Project schema: type: string - name: identifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: >- This is the Organization Identifier for the Project. By default, the Default Organization's Identifier is considered. schema: type: string default: default responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Project is deleted successfully and false if the Project is not deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/projects/list: get: tags: - Project summary: List user's project with support to filter by multiple organizations operationId: getProjectListWithMultiOrgFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifiers in: query description: List of Organization Identifiers for the Entities. schema: uniqueItems: true type: array items: type: string - name: hasModule in: query description: >- This boolean specifies whether to Filter Projects which has the Module of type passed in the module type parameter or to Filter Projects which does not has the Module of type passed in the module type parameter schema: type: boolean default: true - name: identifiers in: query description: >- This is the list of Project Identifiers. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: moduleType in: query description: Filter Projects by module type schema: type: string enum: - CD - CI - CV - CF - CE - STO - CHAOS - AI_TEST_AUTOMATION - SRM - IACM - CET - IDP - CODE - SSCA - AISRE - CORE - PMS - TEMPLATESERVICE - RMG - GOVERNANCE - PLATFORM - SEI - HAR - DevopsEssentials - FME - DBOPS - AI_AGENT_MLOPS - AASP - AARP - AAST - AISEC - name: searchTerm in: query description: Filter Projects by searching for this word in Name, Id, and Tag schema: type: string - name: onlyFavorites in: query schema: type: boolean default: false - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: withFavoritesInfo in: query schema: type: boolean default: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Paginated list of Projects content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseProjectResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseProjectResponse' /ng/api/token: post: tags: - Token summary: Create a Token description: Creates a Token for the given API Key Type. operationId: createToken parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Token' application/yaml: schema: $ref: '#/components/schemas/Token' text/plain: schema: $ref: '#/components/schemas/Token' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created Token details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' text/plain: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/token/{identifier}: put: tags: - Token summary: Update a Token description: Updates a Token for the given API Key Type. operationId: updateToken parameters: - name: identifier in: path description: Token ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Token' application/yaml: schema: $ref: '#/components/schemas/Token' text/plain: schema: $ref: '#/components/schemas/Token' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns updated Token details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOToken' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOToken' text/plain: schema: $ref: '#/components/schemas/ResponseDTOToken' delete: tags: - Token summary: Delete a Token description: Deletes a Token for the given API Key Type. operationId: deleteToken parameters: - name: identifier in: path description: Token ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: apiKeyType in: query description: >- This is the API Key type like Personal Access Key or Service Account Key. required: true schema: type: string enum: - USER - SERVICE_ACCOUNT - SSH_KEY - PGP_KEY - SCOPED_TOKEN - name: parentIdentifier in: query description: ID of API key's Parent Service Account required: true schema: type: string - name: apiKeyIdentifier in: query description: API key ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Token is deleted successfully and false if the Token is not deleted. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/plain: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/token/aggregate: get: tags: - Token summary: List all Tokens description: Lists all the Tokens matching the given search criteria. operationId: listAggregatedTokens parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: apiKeyType in: query description: >- This is the API Key type like Personal Access Key or Service Account Key. required: true schema: type: string enum: - USER - SERVICE_ACCOUNT - SSH_KEY - PGP_KEY - SCOPED_TOKEN - name: parentIdentifier in: query description: ID of API key's Parent Service Account schema: type: string - name: apiKeyIdentifier in: query description: API key ID schema: type: string - name: identifiers in: query description: >- This is the list of Token IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: searchTerm in: query description: >- This would be used to filter Tokens. Any Token having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: includeOnlyActiveTokens in: query description: >- Boolean value to indicate whether to list only active tokens or all tokens. By default, all tokens will be listed. schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Aggregated Tokens. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseTokenAggregate' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseTokenAggregate' text/plain: schema: $ref: '#/components/schemas/ResponseDTOPageResponseTokenAggregate' /ng/api/token/rotate/{identifier}: post: tags: - Token summary: Rotate a Token description: Rotates a Token for the given API Key Type. operationId: rotateToken parameters: - name: identifier in: path description: Token Identifier required: true schema: type: string - name: rotateTimestamp in: query description: Time stamp till when the old token will be valid post rotation. schema: type: integer format: int64 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: apiKeyType in: query description: >- This is the API Key type like Personal Access Key or Service Account Key. required: true schema: type: string enum: - USER - SERVICE_ACCOUNT - SSH_KEY - PGP_KEY - SCOPED_TOKEN - name: parentIdentifier in: query description: ID of API key's Parent Service Account required: true schema: type: string - name: apiKeyIdentifier in: query description: API key ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the rotated Token content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' text/plain: schema: $ref: '#/components/schemas/ResponseDTOString' /ng/api/token/validate: post: tags: - Token summary: Validate a Token description: Validate a Token for the given account. operationId: validateToken parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: type: string application/yaml: schema: type: string text/plain: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Validate a Token for the given account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOToken' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOToken' text/plain: schema: $ref: '#/components/schemas/ResponseDTOToken' /ng/api/user-groups/{identifier}/member/{userIdentifier}: get: tags: - User Group summary: Check user membership description: Check if the user is part of the user group in an account/org/project operationId: getMember parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier of the user group required: true schema: type: string - name: userIdentifier in: path description: Identifier of the user required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Return true/false based on whether the user is part of the user group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' put: tags: - User Group summary: Add user to User Group description: Add a user to the user group in an account/org/project operationId: putMember parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier of the user group required: true schema: type: string - name: userIdentifier in: path description: Identifier of the user required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated user group after user addition content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' delete: tags: - User Group summary: Remove user from User Group description: Remove a user from the user group in an account/org/project operationId: deleteMember parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier of the user group required: true schema: type: string - name: userIdentifier in: path description: Identifier of the user required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated user group after user removal content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' /ng/api/user-groups/copy: put: tags: - User Group summary: Copy User Group description: Copy a User Group in an account/org/project operationId: copyUserGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: groupIdentifier in: query description: groupIdentifier required: true schema: type: string requestBody: description: List of scopes content: application/json: schema: type: array items: $ref: '#/components/schemas/Scope1' application/yaml: schema: type: array items: $ref: '#/components/schemas/Scope1' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns whether the copy was successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' deprecated: true /ng/api/user-groups: get: tags: - User Group summary: List the User Groups in an account/org/project description: List User Groups operationId: getUserGroupList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Search filter which matches by user group name/identifier schema: type: string - name: filterType in: query schema: type: string enum: - INCLUDE_INHERITED_GROUPS - EXCLUDE_INHERITED_GROUPS - INCLUDE_CHILD_SCOPE_GROUPS - INCLUDE_PARENT_SCOPE_GROUPS default: EXCLUDE_INHERITED_GROUPS - name: ssoGroupId in: query schema: uniqueItems: true type: array items: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the paginated list of the User Groups. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserGroup' put: tags: - User Group summary: Update User Group description: Update a User Group in an account/org/project operationId: putUserGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: User Group entity with the updates content: application/json: schema: $ref: '#/components/schemas/UserGroup' application/yaml: schema: $ref: '#/components/schemas/UserGroup' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the successfully updated User Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' post: tags: - User Group summary: Create User Group description: Create a User Group in an account/org/project operationId: postUserGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: User Group entity to be created content: application/json: schema: $ref: '#/components/schemas/UserGroup' application/yaml: schema: $ref: '#/components/schemas/UserGroup' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the successfully created User Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' /ng/api/user-groups/{identifier}: get: tags: - User Group summary: Get User Group description: Get a User Group in an account/org/project operationId: getUserGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier of the user group required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the successfully fetched User Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' delete: tags: - User Group summary: Delete a User Group in an account/org/project description: Delete User Group operationId: deleteUserGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier of the user group required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the successfully deleted User Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroup' /ng/api/user-groups/{identifier}/scopes: get: tags: - User Group summary: Get Inheriting Child Scopes description: List the Child Scopes inheriting this User Group operationId: getInheritingChildScopeList parameters: - name: identifier in: path description: Identifier of the user group required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of the child scopes inheriting this User Group. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListScopeName' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListScopeName' /ng/api/user-groups/{identifier}/users: post: tags: - User Group summary: List users in User Group description: List the users in a User Group in an account/org/project operationId: getUserListInUserGroup parameters: - name: identifier in: path description: Identifier of the user group required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: Filter users based on multiple parameters content: application/json: schema: $ref: '#/components/schemas/UserFilter' application/yaml: schema: $ref: '#/components/schemas/UserFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the paginated list of the users in a User Group. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserMetadata' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserMetadata' /ng/api/user-groups/{userGroupId}/link/ldap/{ldapId}: put: tags: - User Group summary: Link LDAP Group to the User Group to an account/org/project operationId: linkUserGroupToLDAP parameters: - name: userGroupId in: path description: Identifier of the user group required: true schema: type: string - name: ldapId in: path description: LDAP entity identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: LDAP Link Group Request content: application/json: schema: $ref: '#/components/schemas/LdapLinkGroupRequest' application/yaml: schema: $ref: '#/components/schemas/LdapLinkGroupRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated User Group after linking LDAP Group content: application/json: schema: $ref: '#/components/schemas/RestResponseUserGroup' application/yaml: schema: $ref: '#/components/schemas/RestResponseUserGroup' /ng/api/user-groups/{userGroupId}/link/oidc/{providerId}: put: tags: - User Group summary: Link OIDC Group to the User Group in an account/org/project operationId: linkUserGroupToOIDC parameters: - name: userGroupId in: path description: Identifier of the user group required: true schema: type: string - name: providerId in: path description: OIDC Group entity identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: OIDC Link Group Request content: application/json: schema: $ref: '#/components/schemas/OidcLinkGroupRequest' application/yaml: schema: $ref: '#/components/schemas/OidcLinkGroupRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated User Group after linking OIDC Group content: application/json: schema: $ref: '#/components/schemas/RestResponseUserGroup' application/yaml: schema: $ref: '#/components/schemas/RestResponseUserGroup' /ng/api/user-groups/{userGroupId}/link/saml/{samlId}: put: tags: - User Group summary: Link SAML Group to the User Group in an account/org/project operationId: linkUserGroupToSAML parameters: - name: userGroupId in: path description: Identifier of the user group required: true schema: type: string - name: samlId in: path description: Saml Group entity identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Saml Link Group Request content: application/json: schema: $ref: '#/components/schemas/SamlLinkGroupRequest' application/yaml: schema: $ref: '#/components/schemas/SamlLinkGroupRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated User Group after linking SAML Group content: application/json: schema: $ref: '#/components/schemas/RestResponseUserGroup' application/yaml: schema: $ref: '#/components/schemas/RestResponseUserGroup' /ng/api/user-groups/batch: post: tags: - User Group summary: List User Groups by filter description: >- List the User Groups selected by a filter in an account/org/project. This api supports maximum of 10K User Group in response. operationId: getBatchUsersGroupList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: User Group Filter content: application/json: schema: $ref: '#/components/schemas/UserGroupFilter' application/yaml: schema: $ref: '#/components/schemas/UserGroupFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the list of the user groups selected by a filter in a User Group. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListUserGroup' /ng/api/user-groups/filter: post: tags: - User Group summary: Get filtered User Groups description: List the User Groups selected by a filter in an account/org/project operationId: getFilteredUserGroupsList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: User Group Filter content: application/json: schema: $ref: '#/components/schemas/UserGroupFilter' application/yaml: schema: $ref: '#/components/schemas/UserGroupFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the list of the user groups selected by a filter in a User Group. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserGroup' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserGroup' /ng/api/user-groups/{userGroupId}/unlink: put: tags: - User Group summary: Unlink SSO Group from the User Group in an account/org/project operationId: unlinkUserGroupfromSSO parameters: - name: userGroupId in: path description: Identifier of the user group required: true schema: type: string - name: retainMembers in: query description: Retain currently synced members of the user group schema: type: boolean - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated User Group after unlinking SSO Group content: application/json: schema: $ref: '#/components/schemas/RestResponseUserGroup' application/yaml: schema: $ref: '#/components/schemas/RestResponseUserGroup' /ng/api/v2/user-groups: put: tags: - User Group summary: Update User Group description: Update a User Group in an account/org/project operationId: putUserGroupV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: User Group entity with the updates content: application/json: schema: $ref: '#/components/schemas/UserGroupRequestV2' application/yaml: schema: $ref: '#/components/schemas/UserGroupRequestV2' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the successfully updated User Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroupResponseV2' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroupResponseV2' post: tags: - User Group summary: Create User Group description: Create a User Group in an account/org/project operationId: postUserGroupV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: User Group entity to be created content: application/json: schema: $ref: '#/components/schemas/UserGroupRequestV2' application/yaml: schema: $ref: '#/components/schemas/UserGroupRequestV2' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the successfully created User Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroupResponseV2' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroupResponseV2' /ng/api/v2/user-groups/{identifier}: get: tags: - User Group summary: Get User Group description: Get a User Group in an account/org/project operationId: getUserGroupV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier of the user group required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the successfully fetched User Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserGroupResponseV2' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserGroupResponseV2' /ng/api/servicesV2/check-allowed-values: post: tags: - Services summary: Check for allowed-values in the Services operationId: checkAllowedValuesInServices parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of services using allowed-values content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAllowedValuesUsagesInternalDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOAllowedValuesUsagesInternalDTO' /ng/api/servicesV2: get: tags: - Services summary: Gets Service list operationId: getServiceList parameters: - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: maximum: 1000 type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: serviceIdentifiers in: query description: List of ServicesIds schema: type: array items: type: string - name: sort in: query description: >- Specifies the sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order schema: type: array items: type: string - name: type in: query schema: type: string enum: - Kubernetes - NativeHelm - Ssh - WinRm - ServerlessAwsLambda - AzureWebApp - AzureFunction - CustomDeployment - ECS - Elastigroup - TAS - Asg - GoogleCloudFunctions - AwsLambda - AWS_SAM - SERVICE_YAML_V1_TYPE - GoogleCloudRun - Salesforce - GoogleManagedInstanceGroup - AzureContainerApps - AiAgent - name: gitOpsEnabled in: query schema: type: boolean - name: tags in: query description: >- Filter services by tags. Each entry is of the form key:value, or key for a key-only match. A service matches if it has any of the supplied tags. schema: type: array items: type: string - name: storeType in: query description: >- Filter services by where the entity is stored. INLINE returns Harness-stored services, REMOTE returns Git-stored services. schema: type: string enum: - INLINE - REMOTE - INLINE_HC - name: deploymentTemplateIdentifier in: query description: >- The Identifier of deployment template if infrastructure is of type custom deployment schema: type: string - name: versionLabel in: query description: >- The version label of deployment template if infrastructure is of type custom deployment schema: type: string - name: includeAllServicesAccessibleAtScope in: query description: Specify true if all accessible Services are to be included schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Services for a Project content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseServiceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseServiceResponse' put: tags: - Services summary: Update a Service by identifier operationId: updateServiceV2 parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: Details of the Service to be updated content: application/json: schema: $ref: '#/components/schemas/ServiceRequest' examples: Create: summary: Sample Service update payload description: Sample Service payload value: name: serviceName identifier: serviceId tags: {} projectIdentifier: s orgIdentifier: default yaml: | service: name: serviceName identifier: serviceId tags: {} serviceDefinition: spec: artifacts: primary: primaryArtifactRef: artifactName sources: - spec: connectorRef: connectorId imagePath: imagePath tag: tagId identifier: artifactName type: DockerRegistry type: Kubernetes application/yaml: schema: $ref: '#/components/schemas/ServiceRequest' examples: Create: summary: Sample Service update payload description: Sample Service payload value: name: serviceName identifier: serviceId tags: {} projectIdentifier: s orgIdentifier: default yaml: | service: name: serviceName identifier: serviceId tags: {} serviceDefinition: spec: artifacts: primary: primaryArtifactRef: artifactName sources: - spec: connectorRef: connectorId imagePath: imagePath tag: tagId identifier: artifactName type: DockerRegistry type: Kubernetes required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Service content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' post: tags: - Services summary: Create a Service operationId: createServiceV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Service to be created content: application/json: schema: $ref: '#/components/schemas/ServiceRequest' examples: Create: summary: Sample Service create payload description: Sample Service payload value: name: serviceName identifier: serviceId tags: {} projectIdentifier: s orgIdentifier: default yaml: | service: name: serviceName identifier: serviceId tags: {} serviceDefinition: spec: artifacts: primary: primaryArtifactRef: artifactName sources: - spec: connectorRef: connectorId imagePath: imagePath tag: tagId identifier: artifactName type: DockerRegistry type: Kubernetes application/yaml: schema: $ref: '#/components/schemas/ServiceRequest' examples: Create: summary: Sample Service create payload description: Sample Service payload value: name: serviceName identifier: serviceId tags: {} projectIdentifier: s orgIdentifier: default yaml: | service: name: serviceName identifier: serviceId tags: {} serviceDefinition: spec: artifacts: primary: primaryArtifactRef: artifactName sources: - spec: connectorRef: connectorId imagePath: imagePath tag: tagId identifier: artifactName type: DockerRegistry type: Kubernetes required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Service content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' /ng/api/servicesV2/batch: post: tags: - Services summary: Create Services operationId: createServicesV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Details of the Services to be created, maximum 1000 services can be created. content: application/json: schema: maxItems: 1000 minItems: 0 type: array items: $ref: '#/components/schemas/ServiceRequest' application/yaml: schema: maxItems: 1000 minItems: 0 type: array items: $ref: '#/components/schemas/ServiceRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Services content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseServiceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseServiceResponse' /ng/api/servicesV2/batch/partial: post: tags: - Services summary: >- Create Services with partial success support - returns both successful and failed services operationId: createServicesPartialBatch parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Details of the Services to be created, maximum 1000 services can be created. content: application/json: schema: maxItems: 1000 minItems: 0 type: array items: $ref: '#/components/schemas/ServiceRequest' application/yaml: schema: maxItems: 1000 minItems: 0 type: array items: $ref: '#/components/schemas/ServiceRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the batch creation result with success and failure details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceBatchResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceBatchResponse' /ng/api/servicesV2/{serviceIdentifier}: get: tags: - Services summary: Gets a Service by identifier operationId: getServiceV2 parameters: - name: serviceIdentifier in: path description: Service Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: deleted in: query description: Specify whether Service is deleted or not schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: The saved Service content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' delete: tags: - Services summary: Delete a Service by identifier operationId: deleteServiceV2 parameters: - name: If-Match in: header schema: type: string - name: serviceIdentifier in: path description: Service Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Service is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/servicesV2/k8s/command-flags: get: tags: - Services summary: Retrieving the list of Kubernetes Command Options operationId: k8sCmdFlags parameters: - name: serviceSpecType in: query required: true schema: type: string - name: stepType in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Kubernetes Command Options content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetK8sCommandFlagType' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSetK8sCommandFlagType' /ng/api/servicesV2/kustomize/command-flags: get: tags: - Services summary: Retrieving the list of Kustomize Command Flags operationId: kustomizeCmdFlags responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Kustomize Command Flags content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetKustomizeCommandFlagType' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSetKustomizeCommandFlagType' /ng/api/servicesV2/plugin-info: get: tags: - Services summary: Get Plugin Info at Service operationId: getPluginInfo responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Runtime and Serverless Version content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPluginInfoResponseDto' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPluginInfoResponseDto' /ng/api/servicesV2/hooks/actions: get: tags: - Services summary: Retrieving the list of actions available for service hooks operationId: hookActions parameters: - name: serviceSpecType in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of actions available for service hooks content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetServiceHookAction' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSetServiceHookAction' /ng/api/servicesV2/import: post: tags: - Services summary: Get Service YAML from Git Repository operationId: importService parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: serviceIdentifier in: query description: Service Identifier for the entity schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. required: true schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string - name: filePath in: query description: File Path of the Entity. required: true schema: type: string - name: isForceImport in: query description: isForceImport schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Fetches Service YAML from Git Repository and saves a record for it in Harness content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceImportResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceImportResponse' /ng/api/servicesV2/list/access: get: tags: - Services summary: Gets Service Access list operationId: getServiceAccessList parameters: - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: serviceIdentifiers in: query description: List of ServicesIds schema: maxItems: 1000 minItems: 0 type: array items: type: string - name: sort in: query description: >- Specifies the sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order schema: type: array items: type: string - name: type in: query schema: type: string enum: - Kubernetes - NativeHelm - Ssh - WinRm - ServerlessAwsLambda - AzureWebApp - AzureFunction - CustomDeployment - ECS - Elastigroup - TAS - Asg - GoogleCloudFunctions - AwsLambda - AWS_SAM - SERVICE_YAML_V1_TYPE - GoogleCloudRun - Salesforce - GoogleManagedInstanceGroup - AzureContainerApps - AiAgent - name: gitOpsEnabled in: query schema: type: boolean - name: deploymentTemplateIdentifier in: query description: >- The Identifier of deployment template if infrastructure is of type custom deployment schema: type: string - name: versionLabel in: query description: >- The version label of deployment template if infrastructure is of type custom deployment schema: type: string - name: deploymentMetadataYaml in: query schema: type: string - name: includeAllServicesAccessibleAtScope in: query description: Specify true if all accessible Services are to be included schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Services for a Project that are accessible content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListServiceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListServiceResponse' /ng/api/servicesV2/move-config/{serviceIdentifier}: post: tags: - Services summary: Move Service YAML from inline to remote operationId: moveServiceConfigs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: serviceIdentifier in: path description: Service Identifier for the entity required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean default: false - name: moveConfigType in: query description: >- Tells weather the entity has to be moved from inline to remote or remote to inline schema: type: string enum: - INLINE_TO_REMOTE - REMOTE_TO_INLINE responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Fetches Service YAML from Harness DB and creates a remote entity content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceMoveConfigResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceMoveConfigResponse' /ng/api/servicesV2/{serviceIdentifier}/update-git-metadata: put: tags: - Services summary: Update git-metadata in remote service Entity description: >- Update git-metadata in remote service and returns the identifier of updated service operationId: updateServiceGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: serviceIdentifier in: path description: Service Identifier for the entity required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns identifier of updated Service content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceGitUpdateResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceGitUpdateResponse' /ng/api/servicesV2/upsert: put: tags: - Services summary: Upsert a Service by identifier operationId: upsertServiceV2 parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Service to be upserted content: application/json: schema: $ref: '#/components/schemas/ServiceRequest' examples: Create: summary: Sample Service upsert payload description: Sample Service payload value: name: serviceName identifier: serviceId tags: {} projectIdentifier: s orgIdentifier: default yaml: | service: name: serviceName identifier: serviceId tags: {} serviceDefinition: spec: artifacts: primary: primaryArtifactRef: artifactName sources: - spec: connectorRef: connectorId imagePath: imagePath tag: tagId identifier: artifactName type: DockerRegistry type: Kubernetes application/yaml: schema: $ref: '#/components/schemas/ServiceRequest' examples: Create: summary: Sample Service upsert payload description: Sample Service payload value: name: serviceName identifier: serviceId tags: {} projectIdentifier: s orgIdentifier: default yaml: | service: name: serviceName identifier: serviceId tags: {} serviceDefinition: spec: artifacts: primary: primaryArtifactRef: artifactName sources: - spec: connectorRef: connectorId imagePath: imagePath tag: tagId identifier: artifactName type: DockerRegistry type: Kubernetes required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Service content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceResponse' /ng/api/overrides: put: tags: - Overrides summary: Update an Override Entity operationId: updateOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Override to be updated content: application/json: schema: $ref: '#/components/schemas/OverrideRequest' examples: Update: summary: Sample Override update request description: Sample Override Request value: orgIdentifier: defaultOrgId projectIdentifier: defaultProjId environmentRef: defaultEnvRef serviceRef: defaultServiceRef infraIdentifier: defaultInfraId type: ENV_SERVICE_OVERRIDE yaml: | overrides: variables: - name: v1 type: String value: val1 manifests: - manifest: identifier: manifest1 type: K8sManifest spec: store: type: Github spec: connectorRef: abcdConnector gitFetchType: Branch paths: - files1 repoName: abcd branch: master skipResourceVersioning: false configFiles: - configFile: identifier: configFile1 spec: store: type: Harness spec: files: - /abcd required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Override content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOverrideResponse' post: tags: - Overrides summary: Create an Override Entity operationId: createOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Override to be updated content: application/json: schema: $ref: '#/components/schemas/OverrideRequest' examples: Create: summary: Sample Override update request description: Sample Override Request value: orgIdentifier: defaultOrgId projectIdentifier: defaultProjId environmentRef: defaultEnvRef serviceRef: defaultServiceRef infraIdentifier: defaultInfraId type: ENV_SERVICE_OVERRIDE yaml: | overrides: variables: - name: v1 type: String value: val1 manifests: - manifest: identifier: manifest1 type: K8sManifest spec: store: type: Github spec: connectorRef: abcdConnector gitFetchType: Branch paths: - files1 repoName: abcd branch: master skipResourceVersioning: false configFiles: - configFile: identifier: configFile1 spec: store: type: Harness spec: files: - /abcd required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Override content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOverrideResponse' /ng/api/overrides/{identifier}: get: tags: - Overrides summary: Gets Overrides by Identifier operationId: getOverridesViaIdentifier parameters: - name: identifier in: path description: Identifier of the Override Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the Override by the identifier and scope derived from accountId, org identifier and project identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOverrideResponse' delete: tags: - Overrides summary: Delete a Override entity operationId: deleteOverride parameters: - name: identifier in: path description: Identifier of the Override Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Override is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/overrides/move-config: post: tags: - Overrides summary: Move Override YAML from inline to remote or remote to inline operationId: OverrideMoveConfigs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean default: false - name: moveConfigType in: query description: >- Tells weather the entity has to be moved from inline to remote or remote to inline schema: type: string enum: - INLINE_TO_REMOTE - REMOTE_TO_INLINE - name: environmentRef in: query description: Environment Reference for the Entity. schema: type: string - name: serviceRef in: query description: Service Reference for Entity schema: type: string - name: infraIdentifier in: query description: infraIdentifier schema: type: string - name: serviceOverridesType in: query description: Type of the override which is based on source of overrides schema: type: string enum: - ENV_GLOBAL_OVERRIDE - ENV_SERVICE_OVERRIDE - INFRA_GLOBAL_OVERRIDE - INFRA_SERVICE_OVERRIDE - CLUSTER_GLOBAL_OVERRIDE - CLUSTER_SERVICE_OVERRIDE - name: identifier in: query description: >- Service Overrides Identifier. Can be user-provided during creation; if omitted, auto-generated from environmentRef, serviceRef, and infraIdentifier based on override type. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Fetches Override YAML from Harness DB and creates a remote entity or Fetches Override YAML from remote repository and creates a inline entity content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOServiceOverrideMoveConfigResponse /ng/api/overrides/update-git-metadata: put: tags: - Overrides summary: Update git-metadata in remote Override Entity description: >- Update git-metadata in remote Override and returns the identifier of updated Override operationId: updateOverrideGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query description: >- Service Overrides Identifier. Can be user-provided during creation; if omitted, auto-generated from environmentRef, serviceRef, and infraIdentifier based on override type. schema: type: string - name: environmentRef in: query description: Environment Reference for the Entity. schema: type: string - name: serviceRef in: query description: Service Reference for Entity schema: type: string - name: infraIdentifier in: query description: infraIdentifier schema: type: string - name: serviceOverridesType in: query description: Type of the override which is based on source of overrides schema: type: string enum: - ENV_GLOBAL_OVERRIDE - ENV_SERVICE_OVERRIDE - INFRA_GLOBAL_OVERRIDE - INFRA_SERVICE_OVERRIDE - CLUSTER_GLOBAL_OVERRIDE - CLUSTER_SERVICE_OVERRIDE - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: $ref: '#/components/schemas/GitMetadataUpdateRequestInfo' - name: repoName in: query description: Name of the repository. schema: $ref: '#/components/schemas/GitMetadataUpdateRequestInfo' - name: filePath in: query description: File Path of the Entity. schema: $ref: '#/components/schemas/GitMetadataUpdateRequestInfo' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns identifier and associated environmentRef, serviceRef and infraIdentifier of updated Override content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOServiceOverrideGitUpdateResponse /ng/api/serviceOverrides: put: tags: - ServiceOverrides summary: Update an ServiceOverride Entity operationId: updateServiceOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Service Override to be updated content: application/json: schema: $ref: '#/components/schemas/ServiceOverrideRequestV2' examples: Update: summary: Sample Service Override update request description: Sample Service Override Request value: orgIdentifier: defaultOrgId projectIdentifier: defaultProjId environmentRef: defaultEnvRef serviceRef: defaultServiceRef infraIdentifier: defaultInfraId type: ENV_SERVICE_OVERRIDE spec: variables: - name: v1 type: String value: val1 manifests: - manifest: identifier: manifest1 type: K8sManifest spec: store: type: Github spec: connectorRef: abcdConnector gitFetchType: Branch paths: - files1 repoName: abcd branch: master skipResourceVersioning: false configFiles: - configFile: identifier: configFile1 spec: store: type: Harness spec: files: - /abcd required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated ServiceOverride content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceOverrideResponseV2' post: tags: - ServiceOverrides summary: Create an ServiceOverride Entity operationId: createServiceOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Service Override to be updated content: application/json: schema: $ref: '#/components/schemas/ServiceOverrideRequestV2' examples: Create: summary: Sample Service Override update request description: Sample Service Override Request value: orgIdentifier: defaultOrgId projectIdentifier: defaultProjId environmentRef: defaultEnvRef serviceRef: defaultServiceRef infraIdentifier: defaultInfraId type: ENV_SERVICE_OVERRIDE spec: variables: - name: v1 type: String value: val1 manifests: - manifest: identifier: manifest1 type: K8sManifest spec: store: type: Github spec: connectorRef: abcdConnector gitFetchType: Branch paths: - files1 repoName: abcd branch: master skipResourceVersioning: false configFiles: - configFile: identifier: configFile1 spec: store: type: Harness spec: files: - /abcd required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created ServiceOverride content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceOverrideResponseV2' /ng/api/serviceOverrides/{identifier}: get: tags: - ServiceOverrides summary: Gets Service Overrides by Identifier description: >- Retrieves a Service Override by its identifier. The identifier can be user-provided during creation, or if not provided, it is auto-generated based on the override type: ENV_GLOBAL_OVERRIDE = environmentRef, ENV_SERVICE_OVERRIDE = environmentRef_serviceRef, INFRA_GLOBAL_OVERRIDE = environmentRef_infraIdentifier, INFRA_SERVICE_OVERRIDE = environmentRef_serviceRef_infraIdentifier. Dots in refs are replaced with underscores. operationId: getServiceOverrides parameters: - name: identifier in: path description: >- Service Overrides Identifier. Can be user-provided during creation; if omitted, auto-generated from environmentRef, serviceRef, and infraIdentifier based on override type. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the Service Override by the identifier and scope derived from accountId, org identifier and project identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceOverrideResponseV2' delete: tags: - ServiceOverrides summary: Delete a ServiceOverride entity operationId: deleteServiceOverride_1 parameters: - name: identifier in: path description: >- Service Overrides Identifier. Can be user-provided during creation; if omitted, auto-generated from environmentRef, serviceRef, and infraIdentifier based on override type. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Service Override is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/serviceOverrides/move-config: post: tags: - ServiceOverrides summary: Move ServiceOverride YAML from inline to remote or remote to inline operationId: serviceOverrideMoveConfigs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean default: false - name: moveConfigType in: query description: >- Tells weather the entity has to be moved from inline to remote or remote to inline schema: type: string enum: - INLINE_TO_REMOTE - REMOTE_TO_INLINE - name: environmentRef in: query description: Environment Reference for the Entity. schema: type: string - name: serviceRef in: query description: Service Reference for Entity schema: type: string - name: infraIdentifier in: query description: infraIdentifier schema: type: string - name: serviceOverridesType in: query description: Type of the override which is based on source of overrides schema: type: string enum: - ENV_GLOBAL_OVERRIDE - ENV_SERVICE_OVERRIDE - INFRA_GLOBAL_OVERRIDE - INFRA_SERVICE_OVERRIDE - CLUSTER_GLOBAL_OVERRIDE - CLUSTER_SERVICE_OVERRIDE - name: identifier in: query description: >- Service Overrides Identifier. Can be user-provided during creation; if omitted, auto-generated from environmentRef, serviceRef, and infraIdentifier based on override type. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Fetches ServiceOverride YAML from Harness DB and creates a remote entity or Fetches ServiceOverride YAML from remote repository and creates a inline entity content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOServiceOverrideMoveConfigResponse /ng/api/serviceOverrides/update-git-metadata: put: tags: - ServiceOverrides summary: Update git-metadata in remote ServiceOverride Entity description: >- Update git-metadata in remote ServiceOverride and returns the identifier of updated ServiceOverride operationId: updateServiceOverrideGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query description: >- Service Overrides Identifier. Can be user-provided during creation; if omitted, auto-generated from environmentRef, serviceRef, and infraIdentifier based on override type. schema: type: string - name: environmentRef in: query description: Environment Reference for the Entity. schema: type: string - name: serviceRef in: query description: Service Reference for Entity schema: type: string - name: infraIdentifier in: query description: infraIdentifier schema: type: string - name: serviceOverridesType in: query description: Type of the override which is based on source of overrides schema: type: string enum: - ENV_GLOBAL_OVERRIDE - ENV_SERVICE_OVERRIDE - INFRA_GLOBAL_OVERRIDE - INFRA_SERVICE_OVERRIDE - CLUSTER_GLOBAL_OVERRIDE - CLUSTER_SERVICE_OVERRIDE - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: $ref: '#/components/schemas/GitMetadataUpdateRequestInfo' - name: repoName in: query description: Name of the repository. schema: $ref: '#/components/schemas/GitMetadataUpdateRequestInfo' - name: filePath in: query description: File Path of the Entity. schema: $ref: '#/components/schemas/GitMetadataUpdateRequestInfo' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns identifier and associated environmentRef, serviceRef and infraIdentifier of updated ServiceOverride content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOServiceOverrideGitUpdateResponse /ng/api/smtpConfig/{identifier}: delete: tags: - SMTP summary: Delete Smtp Config by identifier operationId: deleteSmtpConfig parameters: - name: identifier in: path description: Config identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/smtpConfig: get: tags: - SMTP summary: Gets Smtp config by accountId operationId: getSmtpConfig parameters: - name: accountId in: query description: Account Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: returns the SmtpConfig having accountId as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTONgSmtp' put: tags: - SMTP summary: Updates the Smtp Config operationId: updateSmtp parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NgSmtp' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns updated config content: application/json: schema: $ref: '#/components/schemas/ResponseDTONgSmtp' post: tags: - SMTP summary: Creates SMTP config operationId: createSmtpConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NgSmtp' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns created config content: application/json: schema: $ref: '#/components/schemas/ResponseDTONgSmtp' /ng/api/smtpConfig/validate-connectivity: post: tags: - SMTP summary: Tests the config's connectivity by sending a test email operationId: validateConnectivity parameters: - name: identifier in: query description: Attribute uuid required: true schema: type: string - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: to in: query required: true schema: type: string - name: subject in: query required: true schema: type: string - name: body in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns validation Result content: application/json: schema: $ref: '#/components/schemas/ResponseDTOValidationResult' /ng/api/smtpConfig/validateName: post: tags: - SMTP summary: Checks whether other connectors exist with the same name operationId: validateName parameters: - name: name in: query description: The name of Config schema: type: string - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns validation Result content: application/json: schema: $ref: '#/components/schemas/ResponseDTOValidationResult' /ng/api/tas/organizations: get: tags: - tas summary: Return the Tas organizations operationId: getTasOrganizations parameters: - name: connectorRef in: query description: Identifier for tas connector schema: type: string - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string - name: envId in: query description: Environment Identifier for the Entity. schema: type: string - name: infraDefinitionId in: query description: Infrastructure Definition Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Return the Tas organizations content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListString' /ng/api/tas/space: get: tags: - tas summary: Return the Tas spaces operationId: getTasSpaces parameters: - name: connectorRef in: query description: Identifier for tas connector required: true schema: type: string - name: organization in: query description: organization for tas required: true schema: type: string - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Return the Tas spaces content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListString' /ng/api/tas/v2/space: get: tags: - tas summary: Return the Tas spaces operationId: getTasSpacesV2 parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string - name: organization in: query schema: type: string - name: envId in: query description: Environment Identifier for the Entity. required: true schema: type: string - name: infraDefinitionId in: query description: Infrastructure Definition Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Return the Tas spaces content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListString' /ng/api/user/add-user-to-groups/{userId}: put: tags: - User summary: Add user to user groups description: >- Adds the user to the specified user group IDs passed in the body and removes all other user groups for user except harness managed user groups operationId: addUserToUserGroups parameters: - name: userId in: path description: User Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAddToUserGroupDTO' application/yaml: schema: $ref: '#/components/schemas/UserAddToUserGroupDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Adds the user to specified user group IDs and removes all other user groups for user except harness managed user groups content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/user/users: post: tags: - User summary: Add user(s) to scope operationId: addUsers parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddUsersDTO' application/yaml: schema: $ref: '#/components/schemas/AddUsersDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns list of added users to a given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAddUsersResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOAddUsersResponse' /ng/api/user/password: put: tags: - User summary: Change user password description: Updates the User password operationId: changeUserPassword parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordChange' application/yaml: schema: $ref: '#/components/schemas/PasswordChange' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns whether the operation is successful or not with readable response. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPasswordChangeResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPasswordChangeResponse' /ng/api/user/last-admin: get: tags: - User summary: Check if user is last admin description: Check whether the user is last admin at scope or not operationId: checkIfLastAdmin parameters: - name: userId in: query description: User identifier schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns Boolean status whether the user is last admin at scope or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/user/disable-two-factor-auth: put: tags: - User summary: Disable two factor authentication description: Disables two-factor-auth for an user in an account operationId: disableTTwoFactorAuth parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns user information content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' /ng/api/user/endImpersonation/{userId}: post: tags: - User summary: end impersonation session for user operationId: endImpersonation parameters: - name: userId in: path description: User ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Ends active impersonation session for user, if any. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/user/aggregate/{userId}: get: tags: - User summary: Get detailed user information description: >- Returns the user metadata along with rolesAssignments by userId and scope operationId: getAggregatedUser parameters: - name: userId in: path description: user Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the user metadata along with rolesAssignments by userId and scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserAggregate' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserAggregate' /ng/api/user/aggregate: post: tags: - User summary: Get list of users description: >- List of all the user's metadata along with rolesAssignments who have access to given scope operationId: getAggregatedUsers parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Search term schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ACLAggregateFilter' application/yaml: schema: $ref: '#/components/schemas/ACLAggregateFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns list of all the user's metadata along with rolesAssignments who have access to given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserAggregate' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserAggregate' /ng/api/user/two-factor-auth/{authMechanism}: get: tags: - User summary: Gets Two Factor Auth Settings description: >- Gets two factor authentication settings information of the current logged in user operationId: getTwoFactorAuthSettings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: authMechanism in: path description: >- This is the authentication mechanism for the logged-in User. Two-Factor Authentication settings will be fetched for this mechanism. required: true schema: type: string enum: - TOTP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns current logged in user's two factor authentication info content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTwoFactorAuthSettingsInfo' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTwoFactorAuthSettingsInfo' /ng/api/user/currentUser: get: tags: - User summary: Get Current User Info description: Gets current logged in User information operationId: getCurrentUserInfo parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns current logged in user info content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' /ng/api/user/batch: post: tags: - User summary: Get users list description: Get list of user's for a given scope operationId: getUsers parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserFilter' application/yaml: schema: $ref: '#/components/schemas/UserFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of user's Metadata for a given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserMetadata' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseUserMetadata' /ng/api/user/impersonate/{userId}: post: tags: - User summary: impersonate User operationId: impersonateUser parameters: - name: userId in: path description: User ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ImpersonateDTO' application/yaml: schema: $ref: '#/components/schemas/ImpersonateDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: impersonate User content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/user/{userId}: put: tags: - User summary: Update User description: Updates the User information operationId: updateUserInfo_1 parameters: - name: userId in: path description: User Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserInfoUpdateDTO' application/yaml: schema: $ref: '#/components/schemas/UserInfoUpdateDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the update User information content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' delete: tags: - User summary: Remove user from scope description: Remove user as the collaborator from the scope operationId: removeUser parameters: - name: userId in: path description: user Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/user/reset-two-factor-auth/{userId}: get: tags: - User summary: Reset two factor authorization description: Reset Two-Factor authorization. operationId: reset2fa parameters: - name: userId in: path required: true schema: type: string - name: accountIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Successfully reset two factor authorization for an account content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' application/yaml: schema: $ref: '#/components/schemas/RestResponseBoolean' /ng/api/user/unlock-user/{userId}: put: tags: - User summary: Unlock user description: unlock user in a given scope operationId: unlockUser parameters: - name: userId in: path description: user Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns user information content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' /ng/api/user/enable-two-factor-auth: put: tags: - User summary: Enable two factor authentication description: Enables two-factor-auth for an user in an account operationId: enableTwoFactorAuth parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TwoFactorAuthSettingsInfo' application/yaml: schema: $ref: '#/components/schemas/TwoFactorAuthSettingsInfo' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns user information content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' /ng/api/user: put: tags: - User summary: Update User description: Updates the User information operationId: updateUserInfo parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserInfo' application/yaml: schema: $ref: '#/components/schemas/UserInfo' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the update User information content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOUserInfo' /ng/api/variables: get: tags: - Variables summary: Fetches the list of Variables. operationId: getVariableList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: >- This would be used to filter Variables. Any Variable having the specified string in its Name or ID would be filtered. schema: type: string - name: includeVariablesFromEverySubScope in: query description: >- Specify whether or not to include all the Variables accessible at the scope. For eg if set as true, at the Project scope we will get org and account Variable also in the response. schema: type: boolean default: false - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Variable. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseVariableResponseDTO put: tags: - Variables summary: Updates the Variable. operationId: updateVariable parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the variable to update. content: application/json: schema: $ref: '#/components/schemas/VariableRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Variable. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOVariableResponseDTO' post: tags: - Variables summary: Creates a Variable. operationId: createVariable parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Variable to create. content: application/json: schema: $ref: '#/components/schemas/VariableRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Variable. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOVariableResponseDTO' /ng/api/variables/{identifier}: get: tags: - Variables summary: Get the Variable by scope identifiers and variable identifier. operationId: getVariable parameters: - name: identifier in: path description: Variable ID required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the variable with the requested scope identifiers and variable identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOVariableResponseDTO' delete: tags: - Variables summary: Deletes Variable by ID. operationId: deleteVariable parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Variable ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Variable is deleted successfully and false if the Variable is not deleted. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/variables/list: post: tags: - Variables summary: Get list of Variable by scope identifiers and variable identifiers. operationId: listVariable parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: >- This would be used to filter Variables. Any Variable having the specified string in its Name or ID would be filtered. schema: type: string - name: includeVariablesFromEverySubScope in: query description: >- Specify whether or not to include all the Variables accessible at the scope. For eg if set as true, at the Project scope we will get org and account Variable also in the response. schema: type: boolean default: false - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: Specifies the variables to list content: application/json: schema: $ref: '#/components/schemas/VariableListRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the variable with the requested scope identifiers and variable identifier. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseVariableResponseDTO /ng/api/freeze: post: tags: - Freeze CRUD summary: Create a Freeze operationId: createFreeze parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Freeze YAML content: application/json: schema: type: string examples: Create: summary: Sample Create Freeze YAML description: Sample Freeze YAML value: |- freeze: name: Sample Freeze identifier: Sample_Freeze entityConfigs: - name: Rule 1 entities: - type: Service filterType: All - type: EnvType filterType: All status: Disabled orgIdentifier: org1 projectIdentifier: Project1 windows: - timeZone: Asia/Calcutta startTime: 2023-02-20 11:28 AM duration: 30m application/yaml: schema: type: string examples: Create: summary: Sample Create Freeze YAML description: Sample Freeze YAML value: |- freeze: name: Sample Freeze identifier: Sample_Freeze entityConfigs: - name: Rule 1 entities: - type: Service filterType: All - type: EnvType filterType: All status: Disabled orgIdentifier: org1 projectIdentifier: Project1 windows: - timeZone: Asia/Calcutta startTime: 2023-02-20 11:28 AM duration: 30m required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Freeze Config content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponse' /ng/api/freeze/{freezeIdentifier}: get: tags: - Freeze CRUD summary: Get a Freeze operationId: getFreeze parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: freezeIdentifier in: path description: Freeze Identifier. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Freeze Config content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFreezeDetailedResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFreezeDetailedResponse' put: tags: - Freeze CRUD summary: Updates a Freeze operationId: updateFreeze parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: freezeIdentifier in: path description: Freeze Identifier. required: true schema: type: string requestBody: description: Freeze YAML content: application/json: schema: type: string examples: Update: summary: Sample Update Freeze YAML description: Sample Freeze YAML value: |- freeze: name: Sample Freeze identifier: Sample_Freeze entityConfigs: - name: Rule 1 entities: - type: Service filterType: All - type: EnvType filterType: All status: Disabled orgIdentifier: org1 projectIdentifier: project1 windows: - timeZone: Asia/Calcutta startTime: 2023-02-20 11:28 AM duration: 33m description: "" application/yaml: schema: type: string examples: Update: summary: Sample Update Freeze YAML description: Sample Freeze YAML value: |- freeze: name: Sample Freeze identifier: Sample_Freeze entityConfigs: - name: Rule 1 entities: - type: Service filterType: All - type: EnvType filterType: All status: Disabled orgIdentifier: org1 projectIdentifier: project1 windows: - timeZone: Asia/Calcutta startTime: 2023-02-20 11:28 AM duration: 33m description: "" required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Freeze Config content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponse' delete: tags: - Freeze CRUD summary: Delete a Freeze operationId: deleteFreeze parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: freezeIdentifier in: path description: Freeze Identifier. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Freeze Config /ng/api/freeze/delete: post: tags: - Freeze CRUD summary: Delete many Freezes operationId: deleteManyFreezes parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: List of Freeze Identifiers content: application/json: schema: type: array items: type: string application/yaml: schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Freeze Config content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponseWrapperDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponseWrapperDTO' /ng/api/freeze/list: post: tags: - Freeze CRUD summary: Gets Freeze list operationId: getFreezeList parameters: - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: This contains details of Freeze filters content: application/json: schema: $ref: '#/components/schemas/FreezeFilterPropertiesDTO' application/yaml: schema: $ref: '#/components/schemas/FreezeFilterPropertiesDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Freeze for a Project content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseFreezeSummaryResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseFreezeSummaryResponse /ng/api/freeze/getFrozenExecutionDetails: get: tags: - Freeze CRUD summary: Get list of freeze acted on a frozen execution operationId: getFrozenExecutionDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: planExecutionId in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns list of freeze acted on a frozen execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFrozenExecutionDetails' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFrozenExecutionDetails' /ng/api/freeze/getGlobalFreeze: get: tags: - Freeze CRUD summary: Get Global Freeze Yaml operationId: getGlobalFreeze parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Get Global Freeze Yaml content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFreezeDetailedResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFreezeDetailedResponse' /ng/api/freeze/manageGlobalFreeze: post: tags: - Freeze CRUD summary: Create Global Freeze operationId: createGlobalFreeze parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Freeze YAML content: application/json: schema: type: string application/yaml: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Global Freeze Config content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponse' /ng/api/freeze/updateFreezeStatus: post: tags: - Freeze CRUD summary: Update the status of Freeze to active or inactive operationId: updateFreezeStatus parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: status in: query description: Freeze YAML required: true schema: type: string enum: - Enabled - Disabled requestBody: description: Comma seperated List of Freeze Identifiers content: application/json: schema: type: array items: type: string application/yaml: schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the created Freeze Config content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponseWrapperDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOFreezeResponseWrapperDTO' /ng/api/gitops/clusters/{identifier}: get: tags: - Clusters summary: Get a Cluster linked to an environment by identifier operationId: getCluster parameters: - name: identifier in: path description: Cluster Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: environmentIdentifier required: true schema: type: string - name: agentIdentifier in: query description: agentIdentifier schema: type: string - name: deleted in: query description: Specify whether cluster is deleted or not schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: The saved Cluster content: application/json: schema: $ref: '#/components/schemas/ResponseDTOClusterResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOClusterResponse' delete: tags: - Clusters summary: Unlink a cluster by identifier description: Unlink a cluster from an environment by identifier operationId: deleteCluster parameters: - name: identifier in: path description: Cluster Identifier for the entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: environmentIdentifier required: true schema: type: string - name: agentIdentifier in: query description: agentIdentifier schema: type: string - name: scope in: query description: Scope for the gitops cluster schema: type: string enum: - ACCOUNT - ORGANIZATION - PROJECT responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if the Cluster is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/gitops/clusters: get: tags: - Clusters summary: Gets cluster list description: Gets a list of GitOps clusters linked to an environment operationId: getClusterList parameters: - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: environmentIdentifier in: query description: Environment Identifier of the clusters required: true schema: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: identifiers in: query description: List of cluster identifiers schema: type: array items: type: string - name: sort in: query description: >- Specifies the sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order schema: type: array items: type: string - name: scope in: query description: >- Scope of linked clusters to be returned, ACCOUNT/ORGANIZATION/PROJECT. Returns all by default if this is not specified schema: type: string enum: - ACCOUNT - ORGANIZATION - PROJECT responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of cluster for a Project content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseClusterResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseClusterResponse' post: tags: - Clusters summary: Link a Cluster description: Link a GitOps cluster to an environment by identifier operationId: linkCluster parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the createCluster to be linked content: application/json: schema: $ref: '#/components/schemas/ClusterRequest' application/yaml: schema: $ref: '#/components/schemas/ClusterRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the linked Cluster content: application/json: schema: $ref: '#/components/schemas/ResponseDTOClusterResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOClusterResponse' /ng/api/gitops/clusters/batch: post: tags: - Clusters summary: Link Clusters operationId: linkClusters parameters: - name: accountIdentifier in: query description: Account Identifier of the environment. required: true schema: type: string requestBody: description: >- Request body for linking clusters to an environment. Either provide a list of clusters in the clusters field OR use linkAllClusters=true with searchTerm to link all matching clusters. content: application/json: schema: $ref: '#/components/schemas/ClusterLinkRequest' application/yaml: schema: $ref: '#/components/schemas/ClusterLinkRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the linked Clusters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOClusterBatchResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOClusterBatchResponse' /ng/api/gitops/clusters/batchunlink: post: tags: - Clusters summary: Unlink Clusters operationId: unlinkClustersInBatch parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Request body for unlinking clusters from an environment. Either provide a list of specific clusters OR use unlinkAllClusters=true to unlink all. content: application/json: schema: $ref: '#/components/schemas/ClusterUnlinkRequest' application/yaml: schema: $ref: '#/components/schemas/ClusterUnlinkRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns true if all the Clusters are deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOClusterBatchResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOClusterBatchResponse' /ng/api/dashboard/getPipelineExecutionCount: get: tags: - Service Dashboard summary: >- Get pipeline execution count for a service with grouping support on artifact and deployment status operationId: pipelineExecutionCount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: serviceId in: query description: Service Identifier for the Entity. schema: type: string - name: startTime in: query description: Start Time of the Interval for the Entity. schema: type: integer format: int64 - name: endTime in: query description: End Time of the Interval for the Entity. schema: type: integer format: int64 - name: artifactPath in: query description: Image/ArtifactPath of the Artifact schema: type: string - name: artifactVersion in: query description: Version of the Artifact schema: type: string - name: artifact in: query description: >- Fully Qualified Name of the Artifact (artifactPath:artifactVersion). For eg. in case of docker it would be imagePath:tag schema: type: string - name: status in: query description: Deployment status schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns pipeline execution count for a service with grouping support on artifact and deployment status content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionCountInfo' /ng/api/rollback/check: post: tags: - Rollback summary: Verification for rollback eligibility for service operationId: checkIfInstanceCanBeRolledBack parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostProdRollbackRequestDTO' required: true responses: default: description: Return details on whether rollback is allowed content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPostProdRollbackCheckDTO' /ng/api/rollback/trigger: post: tags: - Rollback summary: Trigger the rollback for specific service operationId: triggerRollback parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostProdRollbackRequestDTO' required: true responses: default: description: Return status of triggered rollback content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPostProdRollbackResponseDTO' /ng/api/rollback/trigger/v2: post: tags: - Rollback summary: Trigger the rollback for specific service to an environment operationId: triggerRollbackV2 parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RollbackRequestDTO' required: true responses: default: description: Return status of triggered rollback content: application/json: schema: $ref: '#/components/schemas/ResponseDTORollbackResponseDTO' /ng/api/rollback/trigger/v3: post: tags: - Rollback summary: >- Trigger rollback for multiple targets using the same semantics as v2 (latest pipeline execution group per target). Failures are reported per target without failing the entire batch. operationId: triggerRollbackV3 parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchRollbackRequestDTO' required: true responses: default: description: Return per-target rollback status content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBatchRollbackResponseDTO' /ng/api/serviceaccount: get: tags: - Service Account summary: Get Service Accounts description: Fetches list of Service Accounts for the given filter criteria. operationId: listServiceAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifiers in: query description: >- This is the list of Service Account IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the list of Service Accounts. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListServiceAccount' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListServiceAccount' text/plain: schema: $ref: '#/components/schemas/ResponseDTOListServiceAccount' post: tags: - Service Account summary: Create a Service Account description: Creates a new Service Account. operationId: createServiceAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Details required to create Service Account content: application/json: schema: $ref: '#/components/schemas/ServiceAccount' application/yaml: schema: $ref: '#/components/schemas/ServiceAccount' text/plain: schema: $ref: '#/components/schemas/ServiceAccount' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns details of the created Service Account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceAccount' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceAccount' text/plain: schema: $ref: '#/components/schemas/ResponseDTOServiceAccount' /ng/api/serviceaccount/{identifier}: put: tags: - Service Account summary: Update a Service Account description: Updates details of the Service Account for the given Service Account ID. operationId: updateServiceAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Service Account ID required: true schema: type: string requestBody: description: Details of the updated Service Account content: application/json: schema: $ref: '#/components/schemas/ServiceAccount' application/yaml: schema: $ref: '#/components/schemas/ServiceAccount' text/plain: schema: $ref: '#/components/schemas/ServiceAccount' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the updated Service Account details. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceAccount' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceAccount' text/plain: schema: $ref: '#/components/schemas/ResponseDTOServiceAccount' delete: tags: - Service Account summary: Delete a Service Account description: Deletes a Service Account corresponding to the given Service Account ID. operationId: deleteServiceAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Service Account ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- It returns true if the Service Account is deleted successfully and false if the Service Account is not deleted. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/plain: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/serviceaccount/aggregate/{identifier}: get: tags: - Service Account summary: Get Service Account In Scope description: Gets the list of Service Accounts in the given scope. operationId: getAggregatedServiceAccount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Service Account IDr required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the Service Account details corresponding to the specified Account Identifier and Service Account Identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceAccountAggregate' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOServiceAccountAggregate' text/plain: schema: $ref: '#/components/schemas/ResponseDTOServiceAccountAggregate' /ng/api/serviceaccount/{identifier}/scopes: get: tags: - Service Account summary: Get Inheriting Child Scopes description: List the Child Scopes inheriting this User Group operationId: getInheritingChildScopeListForServiceAccount parameters: - name: identifier in: path description: Identifier of the Service Account required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Returns the list of the child scopes inheriting this Service Account. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListScopeName' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListScopeName' text/plain: schema: $ref: '#/components/schemas/ResponseDTOListScopeName' /ng/api/serviceaccount/aggregate: get: tags: - Service Account summary: List aggregated Service Accounts description: >- Fetches the list of Aggregated Service Accounts corresponding to the request's filter criteria. operationId: listAggregatedServiceAccounts parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifiers in: query description: >- This is the list of Service Account IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: searchTerm in: query description: >- This would be used to filter Service Accounts. Any Service Account having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: filterType in: query schema: type: string enum: - INCLUDE_INHERITED_SERVICE_ACCOUNTS - EXCLUDE_INHERITED_SERVICE_ACCOUNTS - INCLUDE_CHILD_SCOPE_SERVICE_ACCOUNTS default: EXCLUDE_INHERITED_SERVICE_ACCOUNTS responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the paginated list of Aggregated Service Accounts. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseServiceAccountAggregate application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseServiceAccountAggregate text/plain: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseServiceAccountAggregate /ng/api/serviceaccount/manageable: get: tags: - Service Account summary: List manageable Service Accounts description: >- Fetches the list of Service Accounts for which the user has manage API key permission. operationId: listManageableServiceAccounts parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifiers in: query description: >- This is the list of Service Account IDs. Details specific to these IDs would be fetched. schema: type: array items: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: searchTerm in: query description: >- This would be used to filter Service Accounts. Any Service Account having the specified string in its Name, ID and Tag would be filtered. schema: type: string - name: filterType in: query schema: type: string enum: - INCLUDE_INHERITED_SERVICE_ACCOUNTS - EXCLUDE_INHERITED_SERVICE_ACCOUNTS - INCLUDE_CHILD_SCOPE_SERVICE_ACCOUNTS default: EXCLUDE_INHERITED_SERVICE_ACCOUNTS responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns the paginated list of manageable Service Accounts. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseServiceAccount' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseServiceAccount' text/plain: schema: $ref: '#/components/schemas/ResponseDTOPageResponseServiceAccount' /ng/api/canny/post: post: tags: - Canny summary: create Canny Post for given user operationId: createCannyPost parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: '*/*': schema: required: - boardId - details - email - name - title type: object properties: email: type: string description: emailId for user creating post name: type: string description: name of user creating post title: type: string description: title of the post details: type: string description: details of the post boardId: type: string description: boardId where post must be created responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: create Canny Post for given user content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCannyResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOCannyResponse' /ng/api/canny/postV2: post: tags: - Canny summary: create Canny Post for given user operationId: createCannyPostV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: '*/*': schema: required: - boardId - categoryId - details - email - name - title type: object properties: email: type: string description: emailId for user creating post name: type: string description: name of user creating post title: type: string description: title of the post details: type: string description: details of the post boardId: type: string description: boardId where post must be created categoryId: type: string description: categoryId where post must be created responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: create Canny Post for given user content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCannyResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOCannyResponse' /ng/api/canny/boards: get: tags: - Canny summary: Get a list of boards available on Canny operationId: getCannyBoards parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Get a list of boards available on Canny content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCannyBoardsResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOCannyBoardsResponse' /ng/api/canny/categories: get: tags: - Canny summary: Get a list of categories available for a board in Canny operationId: getCannyBoards_1 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Get a list of categories available for a board in Canny content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCannyCategoriesResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOCannyCategoriesResponse' /ng/api/source-code-manager/{identifier}: put: tags: - Source Code Manager summary: >- Updates Source Code Manager Details with the given Source Code Manager Id operationId: updateSourceCodeManager parameters: - name: identifier in: path description: Source Code manager Identifier required: true schema: type: string requestBody: description: This contains details of Source Code Manager content: '*/*': schema: $ref: '#/components/schemas/SourceCodeManager' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- This contains details of the updated Source Code Manager for the specific Source Code Manager Id content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSourceCodeManager' delete: tags: - Source Code Manager summary: >- Deletes the Source Code Manager corresponding to the specified Source Code Manager Id operationId: deleteSourceCodeManager parameters: - name: identifier in: path description: Source Code manager Identifier required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: >- Successfully deleted Source Code Manager for the given Source Code Manager Id content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ng/api/source-code-manager: get: tags: - Source Code Manager summary: Lists Source Code Managers for the given account operationId: getSourceCodeManagers parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Paginated list of Source Code Managers of given account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSourceCodeManager' post: tags: - Source Code Manager summary: Creates Source Code Manager operationId: createSourceCodeManager requestBody: description: This contains details of Source Code Manager content: '*/*': schema: $ref: '#/components/schemas/SourceCodeManager' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This contains details of the newly created Source Code Manager content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSourceCodeManager' /ng/api/webhook: post: tags: - Webhook Event Handler summary: Process event payload for webhook triggers. operationId: processWebhookEvent parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string - name: webhookIdentifier in: query schema: type: string requestBody: content: application/json: schema: type: string application/yaml: schema: type: string text/plain: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: Returns UUID of newly created webhook processing event. content: application/json: schema: type: object application/yaml: schema: type: object text/plain: schema: type: object application/octet-stream: schema: type: object /ng/api/settings/{identifier}: get: tags: - Setting summary: Get a setting value by identifier operationId: getSettingValue parameters: - name: identifier in: path description: This is the Identifier of the Entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This returns a setting value by the Identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSettingValueResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSettingValueResponseDTO' /ng/api/settings: get: tags: - Setting summary: Get list of settings under the specified category operationId: getSettingsList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: category in: query description: Category of the Setting. required: true schema: type: string enum: - CD - CI - CE - CV - CF - STO - CORE - PMS - TEMPLATESERVICE - GOVERNANCE - CHAOS - SCIM - GIT_EXPERIENCE - CONNECTORS - EULA - NOTIFICATIONS - SUPPLY_CHAIN_ASSURANCE - USER - MODULES_VISIBILITY - DBOPS - IR - AR - name: group in: query description: Group Id of the setting schema: type: string - name: includeParentScopes in: query description: Flag to include the settings which only exist at the parent scopes schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This contains a list of Settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSettingResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListSettingResponseDTO' put: tags: - Setting summary: Update settings operationId: updateSettingValue parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: List of update requests for settings content: application/json: schema: type: array items: $ref: '#/components/schemas/SettingRequestDTO' application/yaml: schema: type: array items: $ref: '#/components/schemas/SettingRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This updates the settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSettingUpdateResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListSettingUpdateResponseDTO' /ng/api/user-settings/{identifier}: get: tags: - UserSetting summary: Get a user setting value by identifier operationId: getUserSettingValue parameters: - name: identifier in: path description: This is the Identifier of the Entity required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This returns a user setting value for given Identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSettingValueResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSettingValueResponseDTO' /ng/api/user-settings: get: tags: - UserSetting summary: Get list of user settings under the specified category operationId: getUserSettingsList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: group in: query description: Group Id of the setting schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This contains a list of user settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListUserSettingResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListUserSettingResponseDTO' put: tags: - UserSetting summary: Update user settings operationId: updateUserSettingValue parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: List of update requests for settings content: application/json: schema: type: array items: $ref: '#/components/schemas/UserSettingRequestDTO' application/yaml: schema: type: array items: $ref: '#/components/schemas/UserSettingRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This updates the user settings content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOListUserSettingUpdateResponseDTO application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOListUserSettingUpdateResponseDTO /ng/api/user-settings/get-user-preferences: get: tags: - UserSetting summary: 'Get list of user preferences ' operationId: getUserPreferencesList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error1' application/yaml: schema: $ref: '#/components/schemas/Error1' default: description: This contains a list of user settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMapStringString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOMapStringString' /pipeline/api/filters: get: tags: - Filter summary: List Filters description: Lists Filters for the given criteria. operationId: PipelinegetFilterList parameters: - name: pageIndex in: query description: >- Page number of navigation. If left empty, default value of 0 is assumed. schema: type: integer format: int32 default: 0 - name: pageSize in: query description: >- Number of entries per page. If left empty, default value of 100 is assumed schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline - name: searchTerm in: query description: Text to search/filter the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the list of Filters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' put: tags: - Filter summary: Update a Filter description: Updates the filter for the given ID. operationId: PipelineupdateFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated Filter. This should have all the fields not just the updated ones content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the updated Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' post: tags: - Filter summary: Create a Filter description: Creates a Filter. operationId: PipelinepostFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Connector to create content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns created Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' /pipeline/api/filters/{identifier}: get: tags: - Filter summary: Return Filter Details description: Returns the settings of a filter for the given ID. operationId: PipelinegetFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns Filter having filterIdentifier as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' delete: tags: - Filter summary: Delete a Filter description: Deletes a filter for the given ID. operationId: PipelinedeleteFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /pipeline/api/triggers/eventHistory/polledResponse/{triggerIdentifier}: get: tags: - TriggersEvents summary: Get all the polled response for a given trigger description: Get all the polled response for a given trigger operationId: polledResponseTriggerIdentifier parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides required: true schema: type: string - name: triggerIdentifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the polled response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPollingInfoForTriggers' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPollingInfoForTriggers' /pipeline/api/triggers/eventHistory/{triggerIdentifier}: get: tags: - TriggersEvents summary: Get event history for a trigger description: Get event history for a trigger operationId: triggerEventHistoryNew parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides required: true schema: type: string - name: triggerIdentifier in: path required: true schema: type: string - name: searchTerm in: query description: >- Search term to filter out pipelines based on pipeline name, identifier, tags. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string - name: shouldSendTriggerPayload in: query schema: type: boolean default: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the Trigger Event History response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' /pipeline/api/triggers/eventHistory/events: get: tags: - TriggersEvents summary: Get event history for a trigger using filters. description: Get event history for a trigger using filters. operationId: triggerEventHistoryUsingFilters parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides required: true schema: type: string - name: triggerIdentifier in: query schema: type: string - name: status in: query schema: type: array items: type: string - name: triggerType in: query schema: type: string enum: - Webhook - Artifact - Manifest - Scheduled - MultiRegionArtifact - SystemEvent - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the Trigger Event History response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventsApiResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventsApiResponse' /pipeline/api/triggers/eventHistory/eventCorrelation/{eventCorrelationId}: get: tags: - TriggersEvents summary: Get Trigger history event correlation description: Get Trigger history event correlation operationId: triggerHistoryEventCorrelation parameters: - name: accountIdentifier in: query required: true schema: type: string - name: eventCorrelationId in: path required: true schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the Trigger catalogue response content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageNGTriggerEventHistoryBaseDTO application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageNGTriggerEventHistoryBaseDTO /pipeline/api/triggers/eventHistory/v2/eventCorrelation/{eventCorrelationId}: get: tags: - TriggersEvents summary: Get Trigger history event correlation V2 description: Get Trigger history event correlation V2 operationId: triggerHistoryEventCorrelationV2 parameters: - name: accountIdentifier in: query required: true schema: type: string - name: eventCorrelationId in: path required: true schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the Trigger catalogue response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' /pipeline/api/triggers/eventHistory/artifact-manifest-info: get: tags: - TriggersEvents summary: >- Get artifact and manifest trigger event history based on build source type description: >- Get artifact and manifest trigger event history based on build source type operationId: triggerEventHistoryBuildSourceType parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides schema: type: string - name: artifactType in: query description: Type of artifact source schema: type: string - name: searchTerm in: query description: >- Search term to filter out pipelines based on pipeline name, identifier, tags. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the Trigger Event History response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' /pipeline/api/triggers: get: tags: - Triggers summary: >- Gets the paginated list of triggers for accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier. operationId: getListForTarget parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline required: true schema: type: string - name: filter in: query schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 25 - name: sort in: query schema: type: array items: type: string - name: searchTerm in: query schema: type: string requestBody: description: >- This contains details of Trigger filters based on Trigger Types and Trigger Names content: application/json: schema: $ref: '#/components/schemas/TriggerFilterProperties' application/yaml: schema: $ref: '#/components/schemas/TriggerFilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns the paginated list of triggers for accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseNGTriggerDetailsResponseDTO application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseNGTriggerDetailsResponseDTO post: tags: - Triggers summary: Creates Trigger for triggering target pipeline identifier. operationId: createTrigger parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline required: true schema: type: string - name: ignoreError in: query schema: type: boolean default: false - name: withServiceV2 in: query schema: type: boolean default: false requestBody: description: Triggers YAML content: application/json: schema: type: string examples: Create: summary: Sample Create Trigger YAML description: Sample Triggers YAML value: |- trigger: name: mytrigger identifier: mytrigger enabled: true ... application/yaml: schema: type: string examples: Create: summary: Sample Create Trigger YAML description: Sample Triggers YAML value: |- trigger: name: mytrigger identifier: mytrigger enabled: true ... required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns details of the created Trigger. content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' /pipeline/api/triggers/v2: post: tags: - Triggers summary: Creates Trigger with executor identity in request body (v2 API). operationId: createTriggerV2 parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline required: true schema: type: string - name: ignoreError in: query schema: type: boolean default: false - name: withServiceV2 in: query schema: type: boolean default: false requestBody: description: >- Trigger YAML with executor identity. When provided, executorInfo requires 'uuid' and 'type' (USER or SERVICE_ACCOUNT). For SERVICE_ACCOUNT, also include accountIdentifier, orgIdentifier, and projectIdentifier. Mandatory on create when enforce_executor_identity_for_triggers setting is on. content: application/json: schema: $ref: '#/components/schemas/NGTriggerYamlRequest' examples: Create: summary: YAML plus optional executor description: Create value: yaml: ... executorInfo: uuid: user-id type: USER required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns details of the created Trigger. content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' /pipeline/api/triggers/{triggerIdentifier}: get: tags: - Triggers summary: >- Gets the trigger by accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier and triggerIdentifier. operationId: getTrigger parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides required: true schema: type: string - name: triggerIdentifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns the trigger with the accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier and triggerIdentifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' put: tags: - Triggers summary: Updates trigger for pipeline with target pipeline identifier. operationId: updateTrigger parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides required: true schema: type: string - name: triggerIdentifier in: path required: true schema: type: string - name: ignoreError in: query schema: type: boolean default: false requestBody: description: Triggers YAML content: application/json: schema: type: string examples: Update: summary: Sample Update Trigger YAML description: Sample Triggers YAML value: |- trigger: name: mytrigger identifier: mytrigger enabled: true ... application/yaml: schema: type: string examples: Update: summary: Sample Update Trigger YAML description: Sample Triggers YAML value: |- trigger: name: mytrigger identifier: mytrigger enabled: true ... required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the updated trigger content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' delete: tags: - Triggers summary: Deletes Trigger by identifier. operationId: deleteTrigger parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides. required: true schema: type: string - name: triggerIdentifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the boolean status. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /pipeline/api/triggers/catalog: get: tags: - Triggers summary: Lists all Triggers description: Lists all the Triggers for the given Account ID. operationId: getTriggerCatalog parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the Trigger catalogue response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTriggerCatalogResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTriggerCatalogResponse' /pipeline/api/triggers/{triggerIdentifier}/details: get: tags: - Triggers summary: >- Fetches Trigger details for a specific accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier, triggerIdentifier. operationId: getTriggerDetails parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: triggerIdentifier in: path description: Identifier of the target pipeline required: true schema: type: string - name: targetIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Fetches Trigger details for a specific accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier, triggerIdentifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGTriggerDetailsResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGTriggerDetailsResponseDTO' /pipeline/api/triggers/{triggerIdentifier}/eventHistory: get: tags: - Triggers summary: Get event history for a trigger description: Get event history for a trigger operationId: triggerEventHistory parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides required: true schema: type: string - name: triggerIdentifier in: path required: true schema: type: string - name: searchTerm in: query description: >- Search term to filter out pipelines based on pipeline name, identifier, tags. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the Trigger catalogue response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageNGTriggerEventHistoryDTO' deprecated: true /pipeline/api/triggers/{triggerIdentifier}/v2: put: tags: - Triggers summary: Updates trigger with executor identity in request body (v2 API). operationId: updateTriggerV2 parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: targetIdentifier in: query description: Identifier of the target pipeline under which trigger resides required: true schema: type: string - name: triggerIdentifier in: path required: true schema: type: string - name: ignoreError in: query schema: type: boolean default: false requestBody: description: >- Trigger YAML with executor identity. When provided, executorInfo requires 'uuid' and 'type' (USER or SERVICE_ACCOUNT). For SERVICE_ACCOUNT, also include accountIdentifier, orgIdentifier, and projectIdentifier. Mandatory on create when enforce_executor_identity_for_triggers setting is on. content: application/json: schema: $ref: '#/components/schemas/NGTriggerYamlRequest' examples: Update: summary: YAML plus optional executor description: Update value: yaml: ... executorInfo: uuid: user-id type: USER required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the updated trigger content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGTriggerResponse' /pipeline/api/webhook/triggerProcessingDetails: get: tags: - Webhook Triggers summary: Gets webhook event processing details for input eventId. operationId: fetchWebhookDetails parameters: - name: accountIdentifier in: query required: true schema: type: string - name: eventId in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns webhook event processing details for input eventId. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOWebhookEventProcessingDetails' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOWebhookEventProcessingDetails' text/plain: schema: $ref: '#/components/schemas/ResponseDTOWebhookEventProcessingDetails' /pipeline/api/webhook/triggerExecutionDetails/{eventId}: get: tags: - Webhook Triggers summary: Gets webhook event processing details for input eventId. operationId: fetchWebhookExecutionDetails parameters: - name: eventId in: path required: true schema: type: string - name: accountIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns webhook event processing details for input eventId. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOWebhookExecutionDetails' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOWebhookExecutionDetails' text/plain: schema: $ref: '#/components/schemas/ResponseDTOWebhookExecutionDetails' /pipeline/api/webhook/triggerExecutionDetailsV2/{eventId}: get: tags: - Webhook Triggers summary: >- Gets webhook event processing details for input eventId when the trigger is queued and has not triggered the pipeline yet. operationId: fetchWebhookExecutionDetailsV2 parameters: - name: eventId in: path required: true schema: type: string - name: accountIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns webhook event processing details for input eventId when the trigger is in queued state. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOWebhookExecutionDetails' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOWebhookExecutionDetails' text/plain: schema: $ref: '#/components/schemas/ResponseDTOWebhookExecutionDetails' /pipeline/api/webhook/trigger: post: tags: - Webhook Triggers summary: Handles event payload for webhook triggers. operationId: PipelineprocessWebhookEvent parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string requestBody: content: application/json: schema: type: string application/yaml: schema: type: string text/plain: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns UUID of newly created webhook processing event. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' text/plain: schema: $ref: '#/components/schemas/ResponseDTOString' /pipeline/api/webhook/custom: post: tags: - Webhook Triggers summary: Handles event payload for custom webhook triggers. operationId: processCustomWebhookEvent parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string - name: pipelineIdentifier in: query schema: type: string - name: triggerIdentifier in: query schema: type: string requestBody: content: application/json: schema: type: string application/yaml: schema: type: string text/plain: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns UUID of newly created custom webhook processing event. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' text/plain: schema: $ref: '#/components/schemas/ResponseDTOString' /pipeline/api/webhook/custom/v2: post: tags: - Webhook Triggers summary: Handles event payload for custom webhook triggers. operationId: processCustomWebhookEventV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier schema: type: string - name: triggerIdentifier in: query description: Trigger Key schema: type: string requestBody: description: Trigger Payload content: application/json: schema: type: string application/yaml: schema: type: string text/plain: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns data about of newly created custom webhook processing event. content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGProcessWebhookResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGProcessWebhookResponse' text/plain: schema: $ref: '#/components/schemas/ResponseDTONGProcessWebhookResponse' /pipeline/api/webhook/custom/{webhookToken}/v3: post: tags: - Webhook Triggers summary: Handles event payload for custom webhook triggers. operationId: processCustomWebhookEventV3 parameters: - name: webhookToken in: path description: Custom Webhook token for custom webhook triggers required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier schema: type: string - name: triggerIdentifier in: query description: Trigger Key schema: type: string requestBody: description: Trigger Payload content: application/json: schema: type: string application/yaml: schema: type: string text/plain: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns data about of newly created custom webhook processing event. content: application/json: schema: $ref: '#/components/schemas/ResponseDTONGProcessWebhookResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONGProcessWebhookResponse' text/plain: schema: $ref: '#/components/schemas/ResponseDTONGProcessWebhookResponse' /pipeline/api/approvals/{approvalInstanceId}/harness/activity: post: tags: - Approvals summary: Approve or Reject a Pipeline Execution operationId: addHarnessApprovalActivity parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: approvalInstanceId in: path description: Approval Identifier for the entity required: true schema: type: string requestBody: description: Details of approval activity content: application/json: schema: $ref: '#/components/schemas/HarnessApprovalActivityRequest' application/yaml: schema: $ref: '#/components/schemas/HarnessApprovalActivityRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns a newly added Harness Approval activity content: application/json: schema: $ref: '#/components/schemas/ResponseDTOApprovalInstanceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOApprovalInstanceResponse' /pipeline/api/pipelines/pipelineExecution: get: tags: - Pipeline Dashboard summary: Fetch Execution Details for an Interval description: >- Returns Pipeline Execution Details for a Given Interval (Presented in Day Wise Format) operationId: getPipelineExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier required: true schema: type: string - name: moduleInfo in: query description: The module from which execution was triggered. required: true schema: type: string - name: startTime in: query description: Start Date Epoch time in ms required: true schema: type: integer format: int64 - name: endTime in: query description: End Date Epoch time in ms required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' default: description: >- Fetches Pipeline Executions details for a given Interval and will be presented in day wise format content: application/json: schema: $ref: '#/components/schemas/ResponseDTODashboardPipelineExecution' deprecated: true /pipeline/api/pipelines/retention/{accountIdentifier}: get: tags: - Pipeline data retention summary: Get retention period for pipeline executions description: Returns the retention period for pipeline executions based on accountId operationId: getRetentionPeriodInMonths parameters: - name: accountIdentifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns the retention period for pipeline executions based on accountId content: application/json: schema: $ref: '#/components/schemas/RestResponseInteger' application/yaml: schema: $ref: '#/components/schemas/RestResponseInteger' /pipeline/api/input-file/download-file: get: tags: - Pipeline summary: Download file from GCS using filePath description: Download file from GCS using filePath operationId: downloadFileUsingFilePath parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: filePath in: query description: filePath required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Download file from GCS using filePath /pipeline/api/input-file/file/{planExecutionId}: get: tags: - Pipeline summary: >- Returns a file uploaded or filtered based on the fileIdentifier provided for a given nodeExecutionId description: >- Returns a file uploaded or filtered based on the fileIdentifier provided for a given nodeExecutionId operationId: PipelinegetFile parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: planExecutionId in: path description: The Pipeline Execution Id required: true schema: type: string - name: nodeExecutionId in: query description: Step execution Id of upload step required: true schema: type: string - name: fileName in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns a file uploaded or filtered based on the fileIdentifier provided for a given planExecutionId /pipeline/api/inputSets: get: tags: - Pipeline Input Set summary: List Input Sets description: Lists all Input Sets for a Pipeline operationId: listInputSet parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline identifier for which we need the Input Sets list. required: true schema: type: string - name: inputSetType in: query description: Type of Input Set. The default value is ALL. schema: type: string enum: - ALL - INPUT_SET - OVERLAY_INPUT_SET default: ALL - name: searchTerm in: query description: >- Search term to filter out Input Sets based on name, identifier, tags. schema: type: string - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Fetch all the Input Sets for a Pipeline, including Overlay Input Sets. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseInputSetSummaryResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseInputSetSummaryResponse post: tags: - Pipeline Input Set summary: Create an Input Set description: Creates an Input Set for a Pipeline operationId: postInputSet parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: pipelineBranch in: query description: >- Github branch of the Pipeline for which the Input Set is to be created schema: type: string - name: pipelineRepoID in: query description: >- Github Repo identifier of the Pipeline for which the Input Set is to be created schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: storeType in: query description: Tells whether the Entity is to be saved on Git or not schema: type: string enum: - INLINE - REMOTE - INLINE_HC - name: repoName in: query description: Name of the repository. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean - name: InputSetVersion in: query description: Input set yaml version, should be one of '0' or '1' schema: type: string default: '0' requestBody: description: >- Input set YAML to be created. The Account, Org, Project, and Pipeline identifiers inside the YAML should match the query parameters. content: application/yaml: schema: type: string examples: Create: summary: Sample Input Set YAML description: Sample Input Set YAML value: | inputSet: name: Sample Input Set tags: {} identifier: Sample_Input_Set orgIdentifier: default projectIdentifier: MISC pipeline: identifier: Sample_Pipeline stages: - stage: identifier: Sample_Stage type: Approval spec: execution: steps: - step: identifier: Approval_Step type: HarnessApproval spec: approvers: userGroups: - account.Admins - step: identifier: Shellscript_Step type: ShellScript spec: source: type: Inline spec: script: echo "ShellScript" - stage: identifier: Sample_Deploy_Stage type: Deployment spec: serviceConfig: serviceRef: Service1 infrastructure: environmentRef: Env1 infrastructureDefinition: type: KubernetesDirect spec: connectorRef: account.harnessciplatform namespace: sample required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- If the YAML is valid, returns created Input Set. If not, it sends what is wrong with the YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' /pipeline/api/inputSets/overlay: post: tags: - Pipeline Input Set summary: Create an Overlay Input Set for a pipeline operationId: postOverlayInputSet parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: storeType in: query description: Tells whether the Entity is to be saved on Git or not schema: type: string enum: - INLINE - REMOTE - INLINE_HC - name: repoName in: query description: Name of the repository. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: >- Overlay Input Set YAML to be created. The Account, Org, Project, and Pipeline identifiers inside the YAML should match the query parameters content: application/json: schema: type: string application/yaml: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- If the YAML is valid, returns created Overlay Input Set. If not, it sends what is wrong with the YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOverlayInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOOverlayInputSetResponse' /pipeline/api/inputSets/{inputSetIdentifier}: get: tags: - Pipeline Input Set summary: Fetch an Input Set description: >- Returns Input Set for a Given Identifier (Throws an Error if no Input Set Exists) operationId: getInputSet parameters: - name: inputSetIdentifier in: path description: Identifier for the Input Set required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: pipelineBranch in: query description: >- Github branch of the Pipeline for which the Input Set is to be fetched schema: type: string - name: pipelineRepoID in: query description: >- Github Repo identifier of the Pipeline for which the Input Set is to be fetched schema: type: string - name: loadFromFallbackBranch in: query schema: type: boolean default: false - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: Load-From-Cache in: header schema: type: string default: 'false' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns Input Set if exists for the given Identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' put: tags: - Pipeline Input Set summary: Update an Input Set description: Updates the Input Set for a Pipeline operationId: putInputSet parameters: - name: If-Match in: header description: Version of Entity to match schema: type: string - name: inputSetIdentifier in: path description: >- Identifier for the Input Set that needs to be updated. An Input Set corresponding to this identifier should already exist. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: pipelineBranch in: query description: >- Github branch of the Pipeline for which the Input Set is to be updated schema: type: string - name: pipelineRepoID in: query description: >- Github Repo Id of the Pipeline for which the Input Set is to be updated schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean - name: InputSetVersion in: query description: Input set yaml version, should be one of '0' or '1' schema: type: string default: '0' requestBody: description: >- Input set YAML to be updated. The query parameters should match the Account, Org, Project, and Pipeline Ids in the YAML. content: application/yaml: schema: type: string examples: Update: summary: Sample Input Set YAML description: Sample Input Set YAML value: | inputSet: name: Sample Input Set tags: {} identifier: Sample_Input_Set orgIdentifier: default projectIdentifier: MISC pipeline: identifier: Sample_Pipeline stages: - stage: identifier: Sample_Stage type: Approval spec: execution: steps: - step: identifier: Approval_Step type: HarnessApproval spec: approvers: userGroups: - account.Admins - step: identifier: Shellscript_Step type: ShellScript spec: source: type: Inline spec: script: echo "ShellScript" - stage: identifier: Sample_Deploy_Stage type: Deployment spec: serviceConfig: serviceRef: Service1 infrastructure: environmentRef: Env1 infrastructureDefinition: type: KubernetesDirect spec: connectorRef: account.harnessciplatform namespace: sample required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- If the YAML is valid, returns the updated Input Set. If not, it sends what is wrong with the YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' delete: tags: - Pipeline Input Set summary: Delete an Input Set description: Deletes the Input Set by Identifier operationId: deleteInputSet parameters: - name: If-Match in: header description: Version of Entity to match schema: type: string - name: inputSetIdentifier in: path description: Identifier of the Input Set that should be deleted. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: Last Object Id schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return the Deleted Input Set content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /pipeline/api/inputSets/get/batch-input-sets-metadata: post: tags: - Pipeline Input Set summary: >- List regular Input Sets for multiple pipelines (excludes overlay input sets) description: >- Lists regular Input Sets for multiple pipelines (excludes overlay input sets). If pipeline identifiers are not provided, fetches all accessible input sets based on RBAC permissions. operationId: getBatchInputSetsMetadata parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 20 - name: searchTerm in: query description: >- Search term to filter out Input Sets based on name, identifier, tags. schema: type: string requestBody: description: >- Optional request containing pipeline identifiers to fetch regular input sets for. If not provided or empty, fetches all accessible input sets based on RBAC permissions. content: application/json: schema: $ref: '#/components/schemas/BatchInputSetsAPIRequest' application/yaml: schema: $ref: '#/components/schemas/BatchInputSetsAPIRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Fetch regular Input Sets for the specified pipelines (excludes overlay input sets). If no pipeline identifiers provided, returns all accessible input sets based on RBAC. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseInputSetListResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseInputSetListResponse /pipeline/api/inputSets/get/bulk: post: tags: - Pipeline Input Set summary: Get multiple input sets by identifiers (non-deleted only) description: >- Gets multiple input sets by their identifiers for a specific pipeline. Only returns non-deleted input sets. operationId: getBulkInputSets parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier required: true schema: type: string requestBody: description: Request containing input set identifiers to fetch content: application/json: schema: $ref: '#/components/schemas/BulkInputSetsAPIRequest' application/yaml: schema: $ref: '#/components/schemas/BulkInputSetsAPIRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Fetch multiple non-deleted input sets by their identifiers. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBulkInputSetsAPIResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBulkInputSetsAPIResponse' /pipeline/api/inputSets/merge: post: tags: - Pipeline Input Set summary: Merge given Input Sets into a single Runtime Input YAML operationId: mergeInputSets parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: pipelineBranch in: query description: Github branch of the Pipeline to which the Input Sets belong schema: type: string - name: pipelineRepoID in: query description: >- Github Repo identifier of the Pipeline to which the Input Sets belong schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: Load-From-Cache in: header schema: type: string default: 'false' requestBody: content: application/json: schema: $ref: '#/components/schemas/MergeInputSetRequest' application/yaml: schema: $ref: '#/components/schemas/MergeInputSetRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Merge given Input Sets into A single Runtime Input YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMergeInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOMergeInputSetResponse' /pipeline/api/inputSets/overlay/{inputSetIdentifier}: get: tags: - Pipeline Input Set summary: Gets an Overlay Input Set by identifier operationId: getOverlayInputSet parameters: - name: inputSetIdentifier in: path description: Identifier for the Overlay Input Set required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: pipelineBranch in: query description: >- Github branch of the Pipeline for which the Input Set is to be fetched schema: type: string - name: pipelineRepoID in: query description: >- Github Repo identifier of the Pipeline for which the Input Set is to be fetched schema: type: string - name: loadFromFallbackBranch in: query schema: type: boolean default: false - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: Load-From-Cache in: header schema: type: string default: 'false' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- The Overlay Input Set that corresponds to the given Overlay Input Set Identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOverlayInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOOverlayInputSetResponse' put: tags: - Pipeline Input Set summary: Update an Overlay Input Set for a pipeline operationId: putOverlayInputSet parameters: - name: If-Match in: header description: Version of Entity to match schema: type: string - name: inputSetIdentifier in: path description: Identifier for the Overlay Input Set that needs to be updated. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: >- Overlay Input Set YAML to be updated. The Account, Org, Project, and Pipeline identifiers inside the YAML should match the query parameters, and the Overlay Input Set identifier cannot be changed. content: application/json: schema: type: string application/yaml: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- If the YAML is valid, returns the updated Overlay Input Set. If not, it sends what is wrong with the YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOverlayInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOOverlayInputSetResponse' /pipeline/api/inputSets/template: post: tags: - Pipeline Input Set summary: Fetch Runtime Input Template description: Returns Runtime Input Template for a Pipeline operationId: runtimeInputTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline identifier for which we need the Runtime Input Template. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: Load-From-Cache in: header schema: type: string default: 'false' requestBody: content: application/json: schema: $ref: '#/components/schemas/InputSetTemplateRequest' application/yaml: schema: $ref: '#/components/schemas/InputSetTemplateRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Fetch Runtime Input Template for a Pipeline, along with any expressions whose value is needed for running specific Stages content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOInputSetTemplateWithReplacedExpressionsResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOInputSetTemplateWithReplacedExpressionsResponse /pipeline/api/inputSets/refresh-and-get/{inputSetIdentifier}: get: tags: - Pipeline Input Set summary: Refresh cache and fetch an Input Set description: >- Force-refreshes the git file cache for a remote Input Set and returns the freshly fetched entity. Requires the git branch query parameter — repo default branch is not inferred when branch is omitted. Behind the PIPE_GITX_FORCE_REFRESH feature flag. operationId: refreshAndGetInputSet parameters: - name: inputSetIdentifier in: path description: Identifier for the Input Set required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns Input Set YAML fetched fresh from git content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInputSetResponse' /pipeline/api/inputSets/{inputSetIdentifier}/update-git-metadata: put: tags: - Pipeline Input Set summary: Update git-metadata in remote input-set description: Update git-metadata in remote input-set and return the updated input-set operationId: updateInputSetGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier for the entity. required: true schema: type: string - name: inputSetIdentifier in: path description: Identifier for the Input Set required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns identifier of updated input-set content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInputSetGitUpdateResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInputSetGitUpdateResponse' /pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences/branch: delete: tags: - Branch Sequences summary: Delete Branch Sequence description: >- Deletes the branch sequence record for a specific branch and repository combination. The repository URL will be normalized internally. operationId: deleteBranchSequence parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: repoUrl in: query description: Repository URL (will be normalized) required: true schema: type: string - name: branch in: query description: Branch name required: true schema: type: string responses: '200': description: Successfully deleted branch sequence '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Branch sequence not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' /pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences: get: tags: - Branch Sequences summary: List Branch Sequences description: >- Returns all branch sequence records for the specified pipeline, showing the current build number for each branch/repo combination. operationId: listBranchSequences parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string responses: '200': description: Successfully retrieved branch sequences '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' delete: tags: - Branch Sequences summary: Delete Branch Sequences description: >- Deletes all branch sequence records for the specified pipeline. This resets the build counters for all branches. operationId: deleteBranchSequences parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string responses: '200': description: Successfully deleted branch sequences '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' /pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences/current: get: tags: - Branch Sequences summary: Get Branch Sequence description: >- Returns the current sequence ID for a specific branch and repository combination. operationId: getBranchSequence parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: repoUrl in: query description: Repository URL (will be normalized) required: true schema: type: string - name: branch in: query description: Branch name required: true schema: type: string responses: '200': description: Successfully retrieved branch sequence '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Branch sequence not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' /pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences/set: put: tags: - Branch Sequences summary: Set Branch Sequence description: >- Sets the branch sequence counter to a specific value for the given branch and repository. The repository URL will be normalized internally. If no record exists, a new one is created. operationId: setBranchSequence parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: repoUrl in: query description: Repository URL (will be normalized) required: true schema: type: string - name: branch in: query description: Branch name required: true schema: type: string - name: sequenceId in: query description: The sequence value to set required: true schema: minimum: 0 type: integer format: int64 responses: '200': description: Successfully set branch sequence '400': description: Invalid parameters (e.g., invalid repo URL or branch) '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' /pipeline/api/pipelines/annotations: post: tags: - Pipeline summary: Create/Update Pipeline Annotations description: >- Creates or updates annotations for a pipeline execution. Called by lite-engine after step execution. operationId: createPipelineExecutionAnnotations parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: planExecutionId in: query description: Plan Execution ID for the pipeline run required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAnnotationsRequest' application/yaml: schema: $ref: '#/components/schemas/CreateAnnotationsRequest' required: true responses: '200': description: Annotations successfully created/updated '400': description: Invalid request body or validation errors '401': description: Unauthorized - invalid or missing delegate token '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' /pipeline/api/pipelines/{pipelineIdentifier}/convert-to-dag: post: tags: - Pipeline summary: Convert existing pipeline to DAG format description: >- Converts an existing sequential pipeline to DAG format by adding depends_on fields to stages operationId: convertPipelineToDAG parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns the converted pipeline response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineResponse' /pipeline/api/pipelines: post: tags: - Pipeline summary: Create a Pipeline description: Creates a Pipeline operationId: postPipeline parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: enableDAG in: query description: Enable DAG execution for pipeline schema: type: boolean default: false - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: storeType in: query description: Tells whether the Entity is to be saved on Git or not schema: type: string enum: - INLINE - REMOTE - INLINE_HC - name: repoName in: query description: Name of the repository. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: Pipeline YAML content: application/json: schema: type: string application/yaml: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns created pipeline content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' deprecated: true /pipeline/api/pipelines/v2: post: tags: - Pipeline summary: Create a Pipeline description: Creates a Pipeline operationId: postPipelineV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: storeType in: query description: Tells whether the Entity is to be saved on Git or not schema: type: string enum: - INLINE - REMOTE - INLINE_HC - name: repoName in: query description: Name of the repository. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean - name: allowDynamicExecutions in: query description: Allow Dynamic Executions for the Pipeline schema: type: boolean - name: enableDAG in: query description: Enable DAG execution for pipeline schema: type: boolean default: false - name: public in: query schema: type: boolean default: false requestBody: description: Pipeline YAML content: application/yaml: schema: type: string examples: Create: summary: Sample Create Pipeline YAML description: Sample Pipeline YAML with One Build Stage and One Deploy Stage value: | pipeline: name: Sample Pipeline identifier: Sample_Pipeline allowStageExecutions: false projectIdentifier: Temp orgIdentifier: default tags: {} stages: - stage: name: Sample Stage identifier: Sample_Stage description: "" type: Approval spec: execution: steps: - step: name: Approval Step identifier: Approval_Step type: HarnessApproval timeout: 1d spec: approvalMessage: |- Please review the following information and approve the pipeline progression includePipelineExecutionHistory: true approvers: minimumCount: 1 disallowPipelineExecutor: false userGroups: <+input> approverInputs: [] - step: type: ShellScript name: ShellScript Step identifier: ShellScript_Step spec: shell: Bash onDelegate: true source: type: Inline spec: script: <+input> environmentVariables: [] outputVariables: [] executionTarget: {} timeout: 10m tags: {} - stage: name: Sample Deploy Stage identifier: Sample_Deploy_Stage description: "" type: Deployment spec: serviceConfig: serviceRef: <+input> serviceDefinition: spec: variables: [] type: Kubernetes infrastructure: environmentRef: <+input> infrastructureDefinition: type: KubernetesDirect spec: connectorRef: <+input> namespace: <+input> releaseName: release-<+INFRA_KEY> allowSimultaneousDeployments: false execution: steps: - step: name: Rollout Deployment identifier: rolloutDeployment type: K8sRollingDeploy timeout: 10m spec: skipDryRun: false rollbackSteps: - step: name: Rollback Rollout Deployment identifier: rollbackRolloutDeployment type: K8sRollingRollback timeout: 10m spec: {} tags: {} failureStrategies: - onFailure: errors: - AllErrors action: type: StageRollback required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns created pipeline with metadata content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' /pipeline/api/pipelines/{pipelineIdentifier}: get: tags: - Pipeline summary: Fetch a Pipeline description: Returns a Pipeline by Identifier operationId: getPipeline parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: getTemplatesResolvedPipeline in: query description: >- This is a boolean value. If true, returns Templates resolved Pipeline YAML in the response else returns null. schema: type: boolean default: false - name: loadFromFallbackBranch in: query schema: type: boolean default: false - name: validateAsync in: query schema: type: boolean default: false - name: Load-From-Cache in: header schema: type: string default: 'false' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns pipeline YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineResponse' put: tags: - Pipeline summary: Update a Pipeline description: Updates a Pipeline by Identifier operationId: updatePipeline parameters: - name: If-Match in: header description: Version of Entity to match schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: description: Pipeline YAML to be updated content: application/json: schema: type: string application/yaml: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns updated pipeline content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' deprecated: true delete: tags: - Pipeline summary: Delete a Pipeline description: Deletes a Pipeline by Identifier operationId: deletePipeline parameters: - name: If-Match in: header description: Version of Entity to match schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: Last Object Id schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /pipeline/api/pipelines/list: post: tags: - Pipeline summary: List Pipelines description: Returns List of Pipelines in the Given Project operationId: getPipelineList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page (max 200) schema: type: integer format: int32 default: 25 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string - name: searchTerm in: query description: >- Search term to filter out pipelines based on pipeline name, identifier, tags. schema: type: string - name: module in: query schema: type: string - name: filterIdentifier in: query schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: getDistinctFromBranches in: query description: Boolean flag to get distinct pipelines from all branches. schema: type: boolean requestBody: description: This is the body for the filter properties for listing pipelines. content: application/json: schema: $ref: '#/components/schemas/PipelineFilterProperties' examples: List: summary: Sample List Pipeline JSON description: Sample List Pipeline JSON Payload value: filterType: PipelineSetup responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Paginated list of pipelines. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPagePMSPipelineSummaryResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPagePMSPipelineSummaryResponse' /pipeline/api/pipelines/summary/{pipelineIdentifier}: get: tags: - Pipeline summary: Fetch Pipeline Summary description: Returns Pipeline Summary by Identifier operationId: getPipelineSummary parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: loadFromFallbackBranch in: query schema: type: boolean default: false - name: Load-From-Cache in: header schema: type: string default: 'false' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns Pipeline Summary having pipelineIdentifier as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineSummaryResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineSummaryResponse' /pipeline/api/pipelines/import: post: tags: - Pipeline summary: Import and Create Pipeline from Git Repository operationId: importPipeline parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. required: true schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string - name: filePath in: query description: File Path of the Entity. required: true schema: type: string - name: isForceImport in: query description: isForceImport schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineImportRequest' application/yaml: schema: $ref: '#/components/schemas/PipelineImportRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Import and Create Pipeline from Git Repository and saves a record for it in Harness content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' /pipeline/api/pipelines/import/{pipelineIdentifier}: post: tags: - Pipeline summary: Import and Create Pipeline from Git Repository operationId: importPipeline_1 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. required: true schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string - name: filePath in: query description: File Path of the Entity. required: true schema: type: string - name: isForceImport in: query description: isForceImport schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineImportRequest' application/yaml: schema: $ref: '#/components/schemas/PipelineImportRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Import and Create Pipeline from Git Repository and saves a record for it in Harness content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' deprecated: true /pipeline/api/pipelines/refresh-and-get/{pipelineIdentifier}: get: tags: - Pipeline summary: Refresh cache and fetch a Pipeline description: >- Force-refreshes the git file cache for a remote pipeline and returns the freshly fetched Pipeline. Requires the git branch query parameter — repo default branch is not inferred when branch is omitted. Intended for customer-facing recovery when the git-to-Harness sync is stale (webhook lost, race condition, etc.). Behind the PIPE_GITX_FORCE_REFRESH feature flag. operationId: refreshAndGetPipeline parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns pipeline YAML fetched fresh from git content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPMSPipelineResponse' /pipeline/api/pipelines/{pipelineIdentifier}/update-git-metadata: put: tags: - Pipeline summary: Update git-metadata in remote pipeline Entity description: >- Update git-metadata in remote pipeline and returns the identifier of updated pipeline operationId: updatePipelineGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns identifier of updated pipeline content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPMSGitUpdateResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPMSGitUpdateResponse' /pipeline/api/pipelines/v2/{pipelineIdentifier}: put: tags: - Pipeline summary: Update a Pipeline description: Updates a Pipeline by Identifier operationId: updatePipelineV2 parameters: - name: If-Match in: header description: Version of Entity to match schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: path description: Pipeline Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean - name: allowDynamicExecutions in: query description: Allow Dynamic Executions for the Pipeline schema: type: boolean - name: public in: query schema: type: boolean default: false requestBody: description: Pipeline YAML to be updated content: application/yaml: schema: type: string examples: Update: summary: Sample Update Pipeline YAML description: Sample Pipeline YAML with One Build Stage and One Deploy Stage value: | pipeline: name: Sample Pipeline identifier: Sample_Pipeline allowStageExecutions: false projectIdentifier: Temp orgIdentifier: default tags: {} stages: - stage: name: Sample Stage identifier: Sample_Stage description: "" type: Approval spec: execution: steps: - step: name: Approval Step identifier: Approval_Step type: HarnessApproval timeout: 1d spec: approvalMessage: |- Please review the following information and approve the pipeline progression includePipelineExecutionHistory: true approvers: minimumCount: 1 disallowPipelineExecutor: false userGroups: <+input> approverInputs: [] - step: type: ShellScript name: ShellScript Step identifier: ShellScript_Step spec: shell: Bash onDelegate: true source: type: Inline spec: script: <+input> environmentVariables: [] outputVariables: [] executionTarget: {} timeout: 10m tags: {} - stage: name: Sample Deploy Stage identifier: Sample_Deploy_Stage description: "" type: Deployment spec: serviceConfig: serviceRef: <+input> serviceDefinition: spec: variables: [] type: Kubernetes infrastructure: environmentRef: <+input> infrastructureDefinition: type: KubernetesDirect spec: connectorRef: <+input> namespace: <+input> releaseName: release-<+INFRA_KEY> allowSimultaneousDeployments: false execution: steps: - step: name: Rollout Deployment identifier: rolloutDeployment type: K8sRollingDeploy timeout: 10m spec: skipDryRun: false rollbackSteps: - step: name: Rollback Rollout Deployment identifier: rollbackRolloutDeployment type: K8sRollingRollback timeout: 10m spec: {} tags: {} failureStrategies: - onFailure: errors: - AllErrors action: type: StageRollback required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns updated pipeline with metadata content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineSaveResponse' /pipeline/api/pipeline/execution-input/{nodeExecutionId}: get: tags: - Execution Input summary: Get the template for Execution time inputs for any stage/step operationId: getExecutionInputTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: nodeExecutionId in: path description: The runtime Id of the step/stage required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return the template for Execution time inputs for any Stage/Step content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExecutionInputDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOExecutionInputDTO' post: tags: - Execution Input summary: Submit the Execution Input for a Stage/Step and continue execution operationId: submitExecutionInput parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: nodeExecutionId in: path description: The runtime Id of the step/stage required: true schema: type: string requestBody: description: Execution Input for the provided nodeExecutionId content: application/json: schema: type: string application/yaml: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns if Execution Input is valid or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExecutionInputStatus' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOExecutionInputStatus' /pipeline/api/pipeline/execution-input/variables: post: tags: - Execution Input summary: >- Get all the Variables which can be used as expression in the Pipeline at execution time. operationId: createVariablesForPipelineExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: planExecutionId in: query description: The Pipeline Execution Id required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns all Variables used that are valid to be used as expression in pipeline at execution time. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOExecutionInputVariablesResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOExecutionInputVariablesResponse /pipeline/api/pipelines/execution/canRetry/{planExecutionId}: get: tags: - Pipeline Execution Details summary: Validate if Execution can be retried description: Validates if an execution can be retried for a Given PlanExecution ID operationId: canRetryExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: planExecutionId in: path description: Plan Execution Id for which we want to check if it can be retried required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return true if the provided execution can be retried content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /pipeline/api/pipelines/execution/{planExecutionId}/annotations/{contextId}/content: get: tags: - Pipeline Execution Details summary: Fetch Full Annotation Content description: Returns full annotation content for a specific context from GCS operationId: getAnnotationFullContent parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier required: true schema: type: string - name: planExecutionId in: path description: Plan Execution ID for the pipeline run required: true schema: type: string - name: contextId in: path description: Context ID for the annotation required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns full content for the specified annotation content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnnotationContentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOAnnotationContentResponse' /pipeline/api/pipelines/execution/{planExecutionId}: get: tags: - Pipeline Execution Details summary: Fetch Execution Details description: Returns the Pipeline Execution Details for a Given PlanExecution ID operationId: getExecutionDetail parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: stageNodeId in: query description: Stage Node Identifier for which Stage Graph needs to be Rendered schema: type: string - name: stageNodeExecutionId in: query description: >- Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field) schema: type: string - name: planExecutionId in: path description: Plan Execution Id for which we want to get the Execution details required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return the Pipeline Execution details for given PlanExecution Id content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionDetail' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionDetail' deprecated: true /pipeline/api/pipelines/execution/v2/{planExecutionId}: get: tags: - Pipeline Execution Details summary: Fetch Execution Details description: Returns the Pipeline Execution Details for a Given PlanExecution ID operationId: getExecutionDetailV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: stageNodeId in: query description: Stage Node Identifier for which Stage Graph needs to be Rendered schema: type: string - name: stageNodeExecutionId in: query description: >- Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field) schema: type: string - name: childStageNodeId in: query description: >- Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field) schema: type: string - name: childStageNodeExecutionId in: query description: >- Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field) schema: type: string - name: renderFullBottomGraph in: query description: Generate Graph for all the Stages including Steps in each Stage schema: type: boolean - name: planExecutionId in: path description: Plan Execution Id for which we want to get the Execution details required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Return the Pipeline Execution details for given PlanExecution Id without full graph if stageNodeId is null content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionDetail' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionDetail' /pipeline/api/pipelines/execution/getExecutionGraph/{planExecutionId}: get: tags: - Pipeline Execution Details summary: Fetch Execution Graph description: Returns the Pipeline Execution Graph for a Given PlanExecution ID operationId: getExecutionGraph parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: planExecutionId in: path description: Plan Execution Id for which we want to get the Execution details required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return the Pipeline Execution graph for given PlanExecution Id content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExecutionGraph' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOExecutionGraph' /pipeline/api/pipelines/execution/subGraph/{planExecutionId}/{nodeExecutionId}: get: tags: - Pipeline Execution Details summary: Fetch Execution SubGraph for a Given Retried StepGroup NodeExecution ID description: >- Returns the Pipeline Execution SubGraph for a Given Retried StepGroup NodeExecution ID operationId: getExecutionSubGraphForNodeExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: nodeExecutionId in: path description: Node Execution Id for which we want to get the Execution SubGraph required: true schema: type: string - name: planExecutionId in: path description: Plan Execution Id for which we want to get the Execution details required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Return Execution subGraph for a Given Retried StepGroup NodeExecution ID content: application/json: schema: $ref: '#/components/schemas/ResponseDTONodeExecutionDetails' application/yaml: schema: $ref: '#/components/schemas/ResponseDTONodeExecutionDetails' /pipeline/api/pipelines/execution/url: post: tags: - Pipeline Execution Details summary: Fetch Execution Url description: Returns the Pipeline Execution Url for a Given PlanExecution ID operationId: getExecutionURL parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Id for which we want to get the Execution url required: true schema: type: string - name: planExecutionId in: query description: Plan Execution Id for which we want to get the Execution url required: true schema: type: string - name: modules in: query description: Modules schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Return the Pipeline Execution url for given Pipeline and PlanExecution Id content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /pipeline/api/pipelines/execution/{planExecutionId}/metadata: get: tags: - Pipeline Execution Details summary: Get execution metadata of a pipeline execution operationId: getExecutionData parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: planExecutionId in: path description: ExecutionId of the execution for which we want to get Metadata required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns metadata of a execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExecutionDataResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOExecutionDataResponse' /pipeline/api/pipelines/execution/{planExecutionId}/inputsetV2: get: tags: - Pipeline Execution Details summary: Get the Input Set YAML used for given Plan Execution operationId: getInputsetYamlV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: resolveExpressions in: query description: >- A boolean that indicates whether or not expressions should be resolved in input set yaml schema: type: boolean default: false - name: resolveExpressionsType in: query description: >- Resolve Expressions Type indicates what kind of expressions should be resolved in input set yaml. The default value is UNKNOWN in which case no expressions will be resolvedChoose a value from the enum list: [RESOLVE_ALL_EXPRESSIONS, RESOLVE_TRIGGER_EXPRESSIONS, UNKNOWN] schema: type: string enum: - RESOLVE_ALL_EXPRESSIONS - RESOLVE_TRIGGER_EXPRESSIONS - UNKNOWN default: UNKNOWN - name: planExecutionId in: path description: Plan Execution Id for which we want to get the Input Set YAML required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return the Input Set YAML used for given Plan Execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInputSetTemplateResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInputSetTemplateResponse' /pipeline/api/pipelines/execution/{planExecutionId}/policy-evaluation: get: tags: - Pipeline Execution Details summary: Gets the policy evaluated used for given Plan Execution operationId: getPpolicyEvaluation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 - name: planExecutionId in: path description: Plan Execution Id for which we want to get the Input Set YAML required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return policy evaluation details for given Plan Execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageGovernanceMetadata' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageGovernanceMetadata' /pipeline/api/pipelines/execution/executionSummary: post: tags: - Pipeline Execution Details summary: List Execution Identifier description: Returns a List of Pipeline Executions Identifier with Specific Filter operationId: getListOfExecutionIdentifier parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier filter if exact pipelines needs to be filtered. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: filterIdentifier in: query schema: type: string requestBody: description: Returns a List of Pipeline Executions with Specific Filters content: application/json: schema: $ref: '#/components/schemas/FilterProperties' examples: List: summary: Sample List Pipeline Executions description: Sample List Pipeline Executions JSON Payload value: filterType: PipelineExecution pipelineTags: - key: tag1 value: value1 - key: tag2 value: value2 status: - Success - Failed - Running pipelineName: My Pipeline timeRange: timeRangeFilterType: LAST_30_DAYS moduleProperties: cd: serviceIdentifiers: - service1 - service2 envIdentifiers: - dev - prod artifactDisplayNames: - library/nginx:stable - stable serviceDefinitionTypes: - Kubernetes - NativeHelm helmChartVersions: - chartV1 - chartV2 gitOpsAppIdentifiers: - app1 - app2 ci: ciExecutionInfoDTO: event: pullRequest pullRequest: sourceBranch: source-branch targetBranch: target-branch triggerTypes: - MANUAL - WEBHOOK triggerIdentifiers: - trigger1 - trigger2 pipelineIdentifiers: - pipeline1 - pipeline2 myDeployments: true branchName: main repo: my-repo inputSetIdentifiers: - inputSet1 - inputSet2 planExecutionIds: - exec1 - exec2 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns all the Executions Identifier of pipelines for given filter content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPagePipelineExecutionIdentifierSummary application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPagePipelineExecutionIdentifierSummary /pipeline/api/pipelines/execution/summary: post: tags: - Pipeline Execution Details summary: List Executions description: Returns a List of Pipeline Executions with Specific Filter operationId: getListOfExecutions parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: searchTerm in: query description: >- Search term to filter out pipelines based on pipeline name, identifier, tags. schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier filter if exact pipelines needs to be filtered. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string - name: filterIdentifier in: query description: >- Identifier of a saved filter to apply. Cannot be used together with the request body filter properties. If both are provided, the saved filter takes precedence. schema: type: string - name: showAllExecutions in: query description: >- Whether to show all executions accessible to the user, not just those in the specified project. Defaults to false. schema: type: boolean default: false - name: module in: query description: >- Harness module which triggered the execution. Examples: CD, CI, CE, etc. schema: type: string - name: status in: query description: >- Filter by execution status. Accepts multiple values. Valid values: Running, AsyncWaiting, TaskWaiting, TimedWaiting, Failed, Errored, IgnoreFailed, NotStarted, Expired, Aborted, Discontinuing, Queued, Paused, ResourceWaiting, InterventionWaiting, ApprovalWaiting, WaitStepRunning, QueuedLicenseLimitReached, QueuedExecutionConcurrencyReached, Success, Suspended, Skipped, Pausing, ApprovalRejected, InputWaiting, AbortedByFreeze, UploadWaiting, QueuedGlobalInfraCapacityReached, QUEUED_PLAN_CREATION schema: type: array items: type: string description: >- Execution Status of the entity. Valid values (PascalCase): Running, AsyncWaiting, TaskWaiting, TimedWaiting, Failed, Errored, IgnoreFailed, NotStarted, Expired, Aborted, Discontinuing, Queued, Paused, ResourceWaiting, InterventionWaiting, ApprovalWaiting, WaitStepRunning, QueuedLicenseLimitReached, QueuedExecutionConcurrencyReached, Success, Suspended, Skipped, Pausing, ApprovalRejected, InputWaiting, AbortedByFreeze, UploadWaiting, QueuedGlobalInfraCapacityReached, QUEUED_PLAN_CREATION. enum: - Running - AsyncWaiting - TaskWaiting - TimedWaiting - Failed - Errored - IgnoreFailed - NotStarted - Expired - Aborted - Discontinuing - Queued - Paused - ResourceWaiting - InterventionWaiting - ApprovalWaiting - WaitStepRunning - QueuedLicenseLimitReached - QueuedExecutionConcurrencyReached - Success - Suspended - Skipped - Pausing - ApprovalRejected - InputWaiting - AbortedByFreeze - UploadWaiting - QueuedGlobalInfraCapacityReached - QUEUED_PLAN_CREATION - NOT_STARTED - INTERVENTION_WAITING - APPROVAL_WAITING - APPROVAL_REJECTED - Waiting - Queued - Queued - Queued - name: myDeployments in: query description: Whether to filter executions triggered by the current user only schema: type: boolean - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean requestBody: description: >- Filter properties for listing pipeline executions. The `filterType` field is required and must be set to `PipelineExecution`. The `branchName` field in this body filters executions by the codebase/repository branch used during execution. This is different from the `branch` query parameter (from Git Experience) which filters by the Git branch where the pipeline YAML definition is stored. If both are provided, they filter independently. content: application/json: schema: $ref: '#/components/schemas/PipelineExecutionFilterProperties' examples: List: summary: Sample List Pipeline Executions description: Sample List Pipeline Executions JSON Payload value: filterType: PipelineExecution pipelineTags: - key: tag1 value: value1 - key: tag2 value: value2 status: - Success - Failed - Running pipelineName: My Pipeline timeRange: timeRangeFilterType: LAST_30_DAYS moduleProperties: cd: serviceIdentifiers: - service1 - service2 envIdentifiers: - dev - prod artifactDisplayNames: - library/nginx:stable - stable serviceDefinitionTypes: - Kubernetes - NativeHelm helmChartVersions: - chartV1 - chartV2 gitOpsAppIdentifiers: - app1 - app2 ci: ciExecutionInfoDTO: event: pullRequest pullRequest: sourceBranch: source-branch targetBranch: target-branch triggerTypes: - MANUAL - WEBHOOK triggerIdentifiers: - trigger1 - trigger2 pipelineIdentifiers: - pipeline1 - pipeline2 myDeployments: true branchName: main repo: my-repo inputSetIdentifiers: - inputSet1 - inputSet2 planExecutionIds: - exec1 - exec2 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns all the Executions of pipelines for given filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPagePipelineExecutionSummary' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPagePipelineExecutionSummary' /pipeline/api/pipelines/execution/summary/outline: post: tags: - Pipeline Execution Details summary: List Executions Outline description: >- Returns a List of Pipeline Executions Outline given pipelineId or a list of executionIds operationId: getListOfExecutionsOutline parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: lastSeenExecutionId in: query description: lastSeenExecutionId from previous response schema: type: string - name: lastSeenStartTime in: query description: lastSeenStartTime from previous response schema: type: integer format: int64 - name: size in: query description: Results per page schema: type: integer format: int32 default: 10 requestBody: description: Filters for fetching executions outline content: application/json: schema: $ref: '#/components/schemas/PipelineExecutionOutlineFilterDTO' examples: List executions outline: summary: Sample List Pipeline Executions outline description: Sample List Pipeline Executions outline JSON Payload value: timeRange: startTime: '1702443600000' endTime: '1718810039288' pipelineIdentifier: test status: - Success planExecutionIds: - executionId1 - executionId2 - executionId3 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns all the Executions outline given pipelineId or a list of executionIds content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOCustomPagePipelineExecutionOutline application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOCustomPagePipelineExecutionOutline /pipeline/api/pipelines/execution/{planExecutionId}/notes: get: tags: - Pipeline Execution Details summary: Get Notes for a pipelineExecution operationId: getNotesForExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: planExecutionId in: path description: ExecutionId of the execution for which we want to get notes required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns Notes of a pipelineExecution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionNotes' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionNotes' put: tags: - Pipeline Execution Details summary: Updates Notes for a pipelineExecution operationId: updateNotesForExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: notesForPipelineExecution in: query description: Notes of a Pipeline Execution required: true schema: type: string - name: planExecutionId in: path description: ExecutionId of the execution for which we want to update notes required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns Notes of a pipelineExecution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionNotes' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineExecutionNotes' /pipeline/api/pipelines/execution/{planExecutionId}/annotations: get: tags: - Pipeline Execution Details summary: Fetch Pipeline Execution Annotations description: Returns annotations for a specific pipeline execution operationId: getPipelineExecutionAnnotations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier required: true schema: type: string - name: planExecutionId in: path description: Plan Execution ID for the pipeline run required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns annotations for the specified pipeline execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPipelineAnnotationsResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPipelineAnnotationsResponseDTO' /pipeline/api/pipelines/execution/{planExecutionId}/workflow-graph: get: tags: - Pipeline Execution Details summary: Get workflow graph for visualization description: Returns the workflow graph for visualization operationId: getWorkflowGraph parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: nodeExecutionId in: query description: Node Execution Id from which to start graph traversal schema: type: string - name: depth in: query description: Maximum depth to traverse from the starting node schema: type: integer format: int32 default: 10 - name: planExecutionId in: path description: Plan Execution Id for which we want to get the workflow graph required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Return the workflow graph for visualization content: application/json: schema: $ref: '#/components/schemas/ResponseDTOWorkflowGraph' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOWorkflowGraph' /pipeline/api/pipelines/queue-management/bulk-abort: post: tags: - Queued Pipeline Executions summary: Bulk Abort Queued Pipelines description: Aborts multiple queued pipeline executions at account level operationId: bulkAbortQueuedPipelines parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueuedPipelineBulkAbortRequest' application/yaml: schema: $ref: '#/components/schemas/QueuedPipelineBulkAbortRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns per-execution abort results content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOQueuedPipelineBulkAbortResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOQueuedPipelineBulkAbortResponse /pipeline/api/pipelines/queue-management/queued-pipelines: post: tags: - Queued Pipeline Executions summary: List Queued/Running Pipelines description: >- Lists queued and/or running pipeline executions at account level. Queued rows carry a global queue position; running rows do not. Use the 'mode' parameter to switch between QUEUED, RUNNING and BOTH. operationId: listQueuedPipelines parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: page in: query description: Page index (0-based) schema: type: integer format: int32 default: 0 - name: size in: query description: Page size (max 100) schema: type: integer format: int32 default: 20 - name: searchTerm in: query description: Free-text search on pipeline name or identifier schema: type: string - name: filterIdentifier in: query description: >- Identifier of a saved filter of type 'QueuedPipeline' to apply. Cannot be used together with the request body filter properties. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueuedPipelineFilter' application/yaml: schema: $ref: '#/components/schemas/QueuedPipelineFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns pipeline executions with metadata content: application/json: schema: $ref: '#/components/schemas/ResponseDTOQueuedPipelineListResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOQueuedPipelineListResponse' /pipeline/api/pipeline/execute/retryHistory/{planExecutionId}: get: tags: - Pipeline Execute summary: Retry History for a given execution operationId: retryHistory parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: pipelineIdentifier in: query description: Pipeline Identifier required: true schema: type: string - name: planExecutionId in: path description: >- planExecutionId of the execution of whose we need to find the retry history required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns retry history execution details content: application/json: schema: $ref: '#/components/schemas/ResponseDTORetryHistoryResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORetryHistoryResponse' /pipeline/api/pipeline/execute/interrupt/{planExecutionId}: put: tags: - Pipeline Execute summary: Execute an Interrupt description: Executes an Interrupt on a Given Execution operationId: putHandleInterrupt parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: interruptType in: query description: >- The Interrupt type needed to be applied to the execution. Choose a value from the enum list. required: true schema: type: string enum: - AbortAll - UserMarkedFailure - name: planExecutionId in: path description: >- The Pipeline Execution Id on which the Interrupt needs to be applied. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Takes a possible Interrupt value and applies it onto the execution referred by the planExecutionId content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInterruptResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInterruptResponse' /pipeline/api/pipeline/execute/manual-execution/{nodeExecutionId}: post: tags: - Pipeline Execute summary: Marks the Manual Execution as fail or resume operationId: markManualExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: nodeExecutionId in: path description: Node execution id on which the manual execution action is required required: true schema: type: string requestBody: description: Details of the manual execution action that needs to be taken content: application/json: schema: $ref: '#/components/schemas/ManualExecutionRequest' application/yaml: schema: $ref: '#/components/schemas/ManualExecutionRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns status of api request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOManualExecutionResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOManualExecutionResponse' /pipeline/api/pipeline/execute/interrupt/{planExecutionId}/{nodeExecutionId}: put: tags: - Pipeline Execute summary: Handles the interrupt for a given stage in a pipeline operationId: handleStageInterrupt parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: interruptType in: query description: >- The Interrupt type needed to be applied to the execution. Choose a value from the enum list. required: true schema: type: string enum: - AbortAll - UserMarkedFailure - name: planExecutionId in: path description: >- The Pipeline Execution Id on which the Interrupt needs to be applied. required: true schema: type: string - name: nodeExecutionId in: path description: >- The runtime Id of the step/stage on which the Interrupt needs to be applied. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Takes a possible Interrupt value and applies it onto the given stage in the execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInterruptResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOInterruptResponse' /pipeline/api/pipeline/execute/retry/{identifier}: post: tags: - Pipeline Execute summary: Retry a executed pipeline with inputSet pipeline yaml operationId: retryPipeline parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: moduleType in: query description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI schema: type: string - name: planExecutionId in: query description: >- This param contains the previous execution execution id. This is basically when we are rerunning a Pipeline. required: true schema: type: string - name: retryStages in: query description: >- This param contains the identifier of stages from where to resume. It will be a list if we want to retry from parallel group required: true schema: type: array items: type: string - name: runAllStages in: query description: >- This param provides an option to run only the failed stages when Pipeline fails at parallel group. By default, it will run all the stages in the failed parallel group. schema: type: boolean default: true - name: identifier in: path description: Pipeline Identifier required: true schema: type: string - name: notesForPipelineExecution in: query description: Notes of a pipeline execution schema: type: string default: '' - name: asyncPlanCreation in: query schema: type: boolean default: false requestBody: description: Retry a executed pipeline with inputSet pipeline yaml content: application/yaml: schema: type: string examples: Retry a executed pipeline with Runtime Input YAML: summary: Retry a executed pipeline with Runtime Input YAML description: Retry a executed pipeline with Runtime Input YAML value: | pipeline: identifier: "Sample_Pipeline" stages: - stage: identifier: "Sample_Stage" type: "Approval" spec: execution: steps: - step: identifier: "Approval_Step" type: "HarnessApproval" spec: approvers: userGroups: - account._account_all_users: - step: identifier: "Shellscript_Step" type: "ShellScript" spec: source: type: "Inline" spec: script: "exit 0" - stage: identifier: "Sample_Deploy_Stage" type: "Deployment" spec: serviceConfig: serviceRef: "service1" infrastructure: environmentRef: "env1" infrastructureDefinition: type: "KubernetesDirect" spec: connectorRef: "KubernetesConnector>" namespace: "default" responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns execution details content: application/json: schema: $ref: '#/components/schemas/PlanExecutionResponse' application/yaml: schema: $ref: '#/components/schemas/PlanExecutionResponse' /pipeline/api/pipeline/execute/retry/v2/{identifier}: post: tags: - Pipeline Execute summary: Retry a executed pipeline with Runtime Input YAML V2 description: >- Retry a executed pipeline with Runtime Input YAML and Expression Values V2 operationId: retryPipelineV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: moduleType in: query description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI schema: type: string - name: planExecutionId in: query description: >- This param contains the previous execution execution id. This is basically when we are rerunning a Pipeline. required: true schema: type: string - name: retryStages in: query description: >- This param contains the identifier of stages from where to resume. It will be a list if we want to retry from parallel group required: true schema: type: array items: type: string - name: runAllStages in: query description: >- This param provides an option to run only the failed stages when Pipeline fails at parallel group. By default, it will run all the stages in the failed parallel group. schema: type: boolean default: true - name: identifier in: path description: Pipeline Identifier required: true schema: type: string - name: notesForPipelineExecution in: query description: Notes of a pipeline execution schema: type: string default: '' - name: asyncPlanCreation in: query schema: type: boolean default: false requestBody: description: >- Request body containing Runtime Input YAML and Expression Values for retry execution content: application/json: schema: $ref: '#/components/schemas/RetryPipelineRequest' application/yaml: schema: $ref: '#/components/schemas/RetryPipelineRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns pipeline execution details content: application/json: schema: $ref: '#/components/schemas/PlanExecutionResponse' application/yaml: schema: $ref: '#/components/schemas/PlanExecutionResponse' /pipeline/api/pipeline/execute/{identifier}/inputSetList: post: tags: - Pipeline Execute summary: Execute a Pipeline with Input Set References description: Execute a Pipeline with Input Set References operationId: postPipelineExecuteWithInputSetList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: moduleType in: query description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI schema: type: string - name: identifier in: path description: >- Pipeline identifier for the entity. Identifier of the Pipeline to be executed required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: useFQNIfError in: query schema: type: boolean default: false - name: notesForPipelineExecution in: query description: Notes of a pipeline execution schema: type: string default: '' - name: asyncPlanCreation in: query schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/MergeInputSetRequest' application/yaml: schema: $ref: '#/components/schemas/MergeInputSetRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns pipeline execution details V2 content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPlanExecutionResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPlanExecutionResponse' /pipeline/api/pipeline/execute/{identifier}: post: tags: - Pipeline Execute summary: Execute a Pipeline with Runtime Input YAML description: Execute a Pipeline with Runtime Input YAML operationId: postPipelineExecuteWithInputSetYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: moduleType in: query description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI schema: type: string - name: identifier in: path description: >- Pipeline identifier for the entity. Identifier of the Pipeline to be executed required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: useFQNIfError in: query schema: type: boolean default: false - name: notifyOnlyUser in: query schema: type: boolean default: false - name: notesForPipelineExecution in: query description: Notes of a pipeline execution schema: type: string default: '' - name: inputSetIdentifiers in: query description: >- Input set identifiers for tracking and filtering pipeline executions. A list of input set identifiers to apply. schema: type: array items: type: string - name: asyncPlanCreation in: query schema: type: boolean default: false - name: shouldRunAsV1 in: query description: Execute V0 pipeline using unified mode for enhanced features schema: type: boolean default: false requestBody: description: >- Enter Runtime Input YAML if the Pipeline contains Runtime Inputs. Template for this can be Fetched from /inputSets/template API. content: application/yaml: schema: type: string examples: Execute Runtime Input YAML: summary: Execute Pipeline with Runtime Input YAML description: Execute Runtime Input YAML value: | pipeline: identifier: "Sample_Pipeline" stages: - stage: identifier: "Sample_Stage" type: "Approval" spec: execution: steps: - step: identifier: "Approval_Step" type: "HarnessApproval" spec: approvers: userGroups: - account._account_all_users: - step: identifier: "Shellscript_Step" type: "ShellScript" spec: source: type: "Inline" spec: script: "exit 0" - stage: identifier: "Sample_Deploy_Stage" type: "Deployment" spec: serviceConfig: serviceRef: "service1" infrastructure: environmentRef: "env1" infrastructureDefinition: type: "KubernetesDirect" spec: connectorRef: "KubernetesConnector>" namespace: "default" responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Returns pipeline execution details content: application/json: schema: $ref: '#/components/schemas/PlanExecutionResponse' application/yaml: schema: $ref: '#/components/schemas/PlanExecutionResponse' /pipeline/api/pipeline/execute/{identifier}/stages: post: tags: - Pipeline Execute summary: Execute given Stages of a Pipeline operationId: postExecuteStages parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: moduleType in: query description: >- Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI schema: type: string - name: identifier in: path description: Pipeline Identifier required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: useFQNIfError in: query schema: type: boolean default: false - name: notesForPipelineExecution in: query description: Notes of a pipeline execution schema: type: string default: '' - name: inputSetIdentifiers in: query description: >- Input set identifiers for tracking and filtering pipeline executions. A list of input set identifiers to apply. schema: type: array items: type: string - name: asyncPlanCreation in: query schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/RunStageRequest' application/yaml: schema: $ref: '#/components/schemas/RunStageRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: Execute given Stages of a Pipeline with Runtime Input Yaml content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPlanExecutionResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPlanExecutionResponse' /pipeline/api/refresh-template/refresh-all: post: tags: - Pipeline Refresh summary: This recursively refresh and update template inputs in pipeline description: This recursively refresh and update template inputs in pipeline operationId: refreshAllTemplatesInputsInPipeline parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query schema: type: string - name: Load-From-Cache in: header schema: type: string default: 'false' - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: This recursively refresh and update template inputs in pipeline content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /pipeline/api/refresh-template/validate-template-inputs: get: tags: - Pipeline Refresh summary: Validates template inputs in a pipeline's YAML specification. description: >- Validates the template inputs in a pipeline's YAML specification. If the template inputs are invalid, the operation returns an error summary. operationId: validateTemplateInputs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: query schema: type: string - name: Load-From-Cache in: header schema: type: string default: 'false' - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/PipelineError' application/yaml: schema: $ref: '#/components/schemas/PipelineError' default: description: >- Returns a validation result for template inputs present in a pipeline's YAML specification. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOValidateTemplateInputsResponseDTO application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOValidateTemplateInputsResponseDTO /authz/api/acl: post: tags: - Access Control List summary: Check Permission description: Check for permission on resource(s) for a principal operationId: getAccessControlList requestBody: description: These are the checks to perform for Access Control. content: application/json: schema: $ref: '#/components/schemas/AccessCheckRequest' application/yaml: schema: $ref: '#/components/schemas/AccessCheckRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Result of the access check request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAccessCheckResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOAccessCheckResponse' /authz/api/acl/get-acl-count: get: tags: - Access Control List summary: Get ACL Count description: Returns the total number of ACL entries for the given scope operationId: getAclCount parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Count of ACLs for given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOLong' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOLong' /authz/api/permissions: get: tags: - Permissions summary: List Permissions description: Get all permissions in a scope or all permissions in the system operationId: getPermissionList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: scopeFilterDisabled in: query description: >- This is to enable or disable filtering by scope. The default value is false. If the value is true, all the permissions in the system are fetched. schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: List of all permissions content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListPermissionResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListPermissionResponse' /authz/api/permissions/resourcetypes: get: tags: - Permissions summary: List Resource Types description: Get all resource types for permissions in a scope or in the system. operationId: getPermissionResourceTypesList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: scopeFilterDisabled in: query description: >- This is to enable or disable filtering by scope. The default value is false. If the value is true, all the permissions in the system are fetched. schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: List of resource types content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSetString' /authz/api/roleassignments/delete/batch: post: tags: - Role Assignments summary: Bulk Delete Role Assignment description: Bulk delete role assignments by identifiers operationId: bulkDeleteRoleAssignment parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: List of role assigment identifiers to be deleted content: application/json: schema: maxItems: 100 minItems: 0 uniqueItems: true type: array items: type: string application/yaml: schema: maxItems: 100 minItems: 0 uniqueItems: true type: array items: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Returns successfully/failed deleted roleassignment. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTORoleAssignmentDeleteResponseDTO application/yaml: schema: $ref: >- #/components/schemas/ResponseDTORoleAssignmentDeleteResponseDTO /authz/api/roleassignments/multi: post: tags: - Role Assignments summary: Create Role Assignments description: >- Create multiple role assignments in a scope. Returns all successfully created role assignments. Ignores failures and duplicates. operationId: postRoleAssignments parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: List of role assignments to create content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentCreateRequest' application/yaml: schema: $ref: '#/components/schemas/RoleAssignmentCreateRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Successfully created role assignments content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListRoleAssignmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListRoleAssignmentResponse' /authz/api/roleassignments: get: tags: - Role Assignments summary: List Role Assignments description: List role assignments in the given scope operationId: getRoleAssignmentList parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Paginated list of role assignments in the given scope content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleAssignmentResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleAssignmentResponse post: tags: - Role Assignments summary: Create Role Assignment description: Creates role assignment within the specified scope. operationId: postRoleAssignment parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: These are details for the role assignment to create. content: application/json: schema: $ref: '#/components/schemas/AuthzRoleAssignment' application/yaml: schema: $ref: '#/components/schemas/AuthzRoleAssignment' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: These are details of the created role assignment. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORoleAssignmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORoleAssignmentResponse' /authz/api/roleassignments/{identifier}: get: tags: - Role Assignments summary: Get Role Assignment description: Get an existing role assignment by identifier operationId: getRoleAssignment parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier for role assignment required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Get an existing role assignment by identifier in the given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTORoleAssignmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORoleAssignmentResponse' delete: tags: - Role Assignments summary: Delete Role Assignment description: Delete an existing role assignment by identifier operationId: deleteRoleAssignment parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier for role assignment required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Deleted role assignment content: application/json: schema: $ref: '#/components/schemas/ResponseDTORoleAssignmentResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORoleAssignmentResponse' /authz/api/roleassignments/filter: post: tags: - Role Assignments summary: List Role Assignments by filter description: List role assignments in the scope according to the given filter operationId: getFilteredRoleAssignmentList parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Filter role assignments based on multiple parameters. content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentFilter' application/yaml: schema: $ref: '#/components/schemas/RoleAssignmentFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: >- Paginated list of role assignments in the scope according to the given filter content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleAssignmentResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleAssignmentResponse /authz/api/roleassignments/aggregate: post: tags: - Role Assignments summary: List Aggregated Role Assignments by filter description: >- List role assignments in the scope according to the given filter with added metadata operationId: getRoleAssignmentAggregateList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Filter role assignments based on multiple parameters. content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentFilter' application/yaml: schema: $ref: '#/components/schemas/RoleAssignmentFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: >- Paginated list of role assignments in the scope according to the given filter with added metadata. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTORoleAssignmentAggregateResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTORoleAssignmentAggregateResponse /authz/api/roleassignments/v2/filter: post: tags: - Role Assignments summary: List Role Assignments by scope filter description: List role assignments in the scope according to the given filter operationId: getFilteredRoleAssignmentByScopeList parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentFilterV2' application/yaml: schema: $ref: '#/components/schemas/RoleAssignmentFilterV2' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: >- Paginated list of role assignments in the scope according to the given filter content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleAssignmentAggregate application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleAssignmentAggregate /authz/api/roleassignments/validate: post: tags: - Role Assignments summary: Validate Role Assignment description: Check whether a proposed role assignment is valid. operationId: validateRoleAssignment parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: This is the details of the role assignment for validation. content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentValidationRequest' application/yaml: schema: $ref: '#/components/schemas/RoleAssignmentValidationRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: This is the result of the role assignment validation request. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTORoleAssignmentValidationResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTORoleAssignmentValidationResponse /authz/api/roles: get: tags: - Roles summary: List Roles description: List roles in the given scope operationId: getRoleList parameters: - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Search roles by name/identifier schema: type: string - name: harnessManaged in: query description: Filter role by being harness managed schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Paginated list of roles in the given scope content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleWithPrincipalCountResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseRoleWithPrincipalCountResponse post: tags: - Roles summary: Create Role description: Create a Custom Role in a scope operationId: postRole parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Role entity content: application/json: schema: $ref: '#/components/schemas/Role' application/yaml: schema: $ref: '#/components/schemas/Role' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Created Role content: application/json: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' /authz/api/roles/{identifier}: get: tags: - Roles summary: Get Role description: Get a Role by identifier operationId: getRole parameters: - name: identifier in: path description: Identifier of the Role required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Queried Role content: application/json: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' put: tags: - Roles summary: Update Role description: Update a Custom Role by identifier operationId: putRole parameters: - name: identifier in: path description: Identifier of the Role required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: Updated Role entity content: application/json: schema: $ref: '#/components/schemas/Role' application/yaml: schema: $ref: '#/components/schemas/Role' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Updated Role content: application/json: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' delete: tags: - Roles summary: Delete Role description: Delete a Custom Role in a scope operationId: deleteRole parameters: - name: identifier in: path description: Identifier of the Role required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/AccessDeniedError' application/yaml: schema: $ref: '#/components/schemas/AccessDeniedError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Deleted Role content: application/json: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORoleResponse' /authz/api/resourcetype: get: tags: - Harness Resource Type summary: Gets all resource types available at this scope operationId: getResourceTypes parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Returns all resource types available at this scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOResourceType' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOResourceType' /authz/api/zendesk: post: tags: - Zendesk summary: create zendesk ticket for given user operationId: createZendeskTicket parameters: - name: ticketType in: query description: 'type of the ticket ' required: true schema: type: string enum: - QUESTION - PROBLEM - FEATURE_REQUEST - OTHER - name: priority in: query description: priority of the ticket required: true schema: type: string enum: - LOW - NORMAL - HIGH - URGENT - name: subject in: query description: subject of the ticket required: true schema: type: string - name: regression in: query description: regression of the ticket schema: type: boolean requestBody: content: multipart/form-data: schema: type: object properties: message: type: string url: type: string region: type: string enum: - NO_PREFERENCE - AMERICAS_EASTERN - AMERICAS_PACIFIC - ASIA_PACIFIC - INDIA_STANDARD_TIME - EUROPE userBrowser: type: string userOS: type: string website: type: string userName: type: string accountId: type: string module: type: string browserResolution: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: create zendesk ticket for given user content: application/json: schema: $ref: '#/components/schemas/ResponseDTOZendeskResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOZendeskResponseDTO' /authz/api/zendesk/token: get: tags: - Zendesk summary: get short live token for Coveo operationId: getCoveoToken responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: get short live token for Coveo content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCoveoResponseDTO' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOCoveoResponseDTO' /authz/api/v2/resourcegroup: get: tags: - Harness Resource Group summary: List Resource Groups description: Get list of resource groups operationId: getResourceGroupListV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: >- Details of all the resource groups having this string in their name or identifier will be returned. schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: This contains a list of Resource Groups content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseResourceGroupV2Response application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseResourceGroupV2Response post: tags: - Harness Resource Group summary: Create Resource Group description: Create a resource group operationId: createResourceGroupV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: This contains the details required to create a Resource Group content: application/json: schema: $ref: '#/components/schemas/ResourceGroupV2Request' application/yaml: schema: $ref: '#/components/schemas/ResourceGroupV2Request' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Successfully created a Resource Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOResourceGroupV2Response' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOResourceGroupV2Response' /authz/api/v2/resourcegroup/{identifier}: get: tags: - Harness Resource Group summary: Get Resource Group description: Get a resource group by identifier operationId: getResourceGroupV2 parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: This returns a Resource Group specific to the Identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOResourceGroupV2Response' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOResourceGroupV2Response' put: tags: - Harness Resource Group summary: Update Resource Group description: Update a resource group operationId: updateResourceGroupV2 parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string requestBody: description: This contains the details required to create a Resource Group content: application/json: schema: $ref: '#/components/schemas/ResourceGroupV2Request' application/yaml: schema: $ref: '#/components/schemas/ResourceGroupV2Request' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Successfully updated a Resource Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOResourceGroupV2Response' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOResourceGroupV2Response' delete: tags: - Harness Resource Group summary: Delete Resource Group description: Delete a resource group operationId: deleteResourceGroupV2 parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: Successfully deleted a Resource Group content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /authz/api/v2/resourcegroup/filter: post: tags: - Harness Resource Group summary: List Resource Groups by filter description: This fetches a filtered list of Resource Groups operationId: getFilterResourceGroupListV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: Filter Resource Groups based on multiple parameters content: application/json: schema: $ref: '#/components/schemas/ResourceGroupFilter' application/yaml: schema: $ref: '#/components/schemas/ResourceGroupFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/AuthzError' application/yaml: schema: $ref: '#/components/schemas/AuthzError' default: description: >- This fetches the list of Resource Groups filtered by multiple fields. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseResourceGroupV2Response application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseResourceGroupV2Response /ccm/api/anomalies/ignoreListRule: post: tags: - Anomalies Ignorelist Rule summary: Create a new anomalies ignorelist rule description: Create a new anomalies ignorelist rule operationId: CreateNewAnomaliesIgnorelistRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing anomalies ignorelist rule object content: application/json: schema: $ref: '#/components/schemas/AnomaliesWhitelistRule' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns newly created anomalies ignorelist rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnomaliesWhitelistRule' /ccm/api/anomalies/ignoreListRule/{id}: get: tags: - Anomalies Ignorelist Rule summary: Get anomalies ignorelist rule description: Get anomalies ignorelist rule operationId: GetAnomaliesIgnorelistRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns anomalies ignorelist rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnomaliesWhitelistRule' put: tags: - Anomalies Ignorelist Rule summary: Update anomalies ignorelist rule description: Update anomalies ignorelist rule operationId: UpdateAnomaliesIgnorelistRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: description: Request body containing anomalies ignorelist rule object content: application/json: schema: $ref: '#/components/schemas/AnomaliesWhitelistRule' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns updated anomalies ignorelist rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnomaliesWhitelistRule' delete: tags: - Anomalies Ignorelist Rule summary: Delete anomalies ignorelist rule description: Delete anomalies ignorelist rule operationId: DeleteAnomaliesIgnorelistRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns true if anomalies ignorelist rule is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/anomalies/ignoreListRule/filter-values/azure-subscriptions: get: tags: - Anomalies Ignorelist Rule summary: Fetch Azure subscriptions (ID and name) for the given account description: Get Azure subscription IDs and names operationId: listAzureSubscriptions parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns Azure subscriptions with their IDs and names content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/anomalies/ignoreListRule/list: post: tags: - Anomalies Ignorelist Rule summary: List anomalies ignorelist rule description: List anomalies ignorelist rule operationId: ListAnomaliesIgnorelistRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request object to filter and list anomalies ignorelist rules content: application/json: schema: $ref: '#/components/schemas/RuleExecutionFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of anomalies ignorelist rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAnomaliesWhitelistRule' /ccm/api/anomalies/ignoreListRule/{id}/toggle: put: tags: - Anomalies Ignorelist Rule summary: Toggle anomalies ignorelist rule description: Toggle anomalies ignorelist rule operationId: ToggleAnomaliesIgnorelistRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns toggled anomalies ignorelist rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnomaliesWhitelistRule' /ccm/api/anomaly/summary: post: tags: - Anomalies summary: List Anomalies description: Fetch the result of anomaly query operationId: getAnomaliesSummary parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Anomaly Filter Properties content: application/json: schema: $ref: '#/components/schemas/AnomalyFilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Anomaly Query result content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAnomalySummary' /ccm/api/anomaly/filter-values: post: tags: - Anomalies summary: >- Returns the list of distinct values for all the specified Anomaly fields. description: >- Returns the list of distinct values for all the specified Anomaly fields. operationId: anomalyFilterValues parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: showWhitelistedAnomalies in: query description: Show whitelisted anomalies along with all anomalies required: true schema: type: boolean requestBody: description: List of Anomaly columns whose unique values will be fetched content: application/json: schema: type: array items: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns the list of distinct values for all the specified Anomaly fields. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListFilterStats' /ccm/api/anomaly: post: tags: - Anomalies summary: List Anomalies description: Fetch the list of anomalies reported according to the filters applied operationId: listAnomalies parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query schema: type: string requestBody: description: Perspective & Anomaly Filter Properties content: application/json: schema: $ref: '#/components/schemas/AnomalyRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: List of Anomalies content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAnomalyData' /ccm/api/anomaly/listIgnoredAnomalies: post: tags: - Anomalies summary: List ignore list anomalies description: >- Fetch the list of anomalies present in the ignore list according to the filters applied operationId: listIgnoredAnomalies parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Anomaly Filter Properties content: application/json: schema: $ref: '#/components/schemas/AnomalyFilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: List of anomalies present in ignore list content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAnomalyData' /ccm/api/anomaly/perspective/{perspectiveId}: post: tags: - Anomalies summary: List Anomalies for Perspective description: Fetch anomalies for perspective operationId: listPerspectiveAnomalies parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: path description: Unique identifier for perspective required: true schema: type: string - name: showWhitelistedAnomalies in: query description: Show whitelisted anomalies along with all anomalies required: true schema: type: boolean requestBody: description: Perspective Query content: application/json: schema: $ref: '#/components/schemas/PerspectiveQueryDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: List of Anomalies for Perspective with supported filters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPerspectiveAnomalyResponse' /ccm/api/anomaly/feedback: put: tags: - Anomalies summary: Report Anomaly feedback description: Mark an anomaly as true/false anomaly operationId: reportAnomalyFeedback parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query description: Unique identifier for perspective required: true schema: type: string requestBody: description: Feedback content: application/json: schema: $ref: '#/components/schemas/AnomalyFeedback' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Report Anomaly Feedback content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/bi-dashboards: get: tags: - BI Dashboards summary: List all the BI Dashboards for CACM description: List all the BI Dashboards. operationId: listBIDashboards parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of all BI Dashboards content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListBIDashboardSummary' /ccm/api/budgets/bulk/adjust-budget-amount: post: tags: - Budgets summary: Adjust Budget Amount in bulk description: Change the budget amount for the budgets in bulk operationId: adjustBudgetAmountOperation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Bulk operation details content: application/json: schema: $ref: '#/components/schemas/AdjustBudgetAmountRequest' required: true responses: '202': description: Bulk operation accepted content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/bulk/clone: post: tags: - Budgets summary: Clone Budgets in bulk description: Clone budgets in bulk with customizable alert handling options operationId: cloneBudgetsBulkOperation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Bulk clone operation details content: application/json: schema: $ref: '#/components/schemas/CloneBudgetRequest' required: true responses: '202': description: Bulk clone operation accepted content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/bulk/create-cost-bucket-budgets: post: tags: - Budgets summary: Bulk create Cost Bucket Budgets description: Create budgets for multiple cost buckets within a cost category operationId: createCostBucketBudgetsBulk parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Bulk create cost bucket budgets request content: application/json: schema: $ref: '#/components/schemas/CreateCostBucketBudgetsRequest' required: true responses: '202': description: Bulk create operation accepted content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/bulk/delete: post: tags: - Budgets summary: Delete Budgets in bulk description: Delete budgets in bulk. operationId: deleteBudgetsBulkOperation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Bulk delete operation details content: application/json: schema: $ref: '#/components/schemas/DeleteBudgetRequest' required: true responses: '202': description: Bulk delete operation accepted content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/bulk/check-job-status: get: tags: - Budgets summary: Check bulk budget update job status description: >- Checks the current status (RUNNING, COMPLETED, FAILED) of a bulk budget update job by jobId. operationId: checkBulkBudgetJobStatus parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '200': description: >- Returns the status string of the bulk update job (RUNNING, COMPLETED, FAILED) content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/bulk/manage-alerts: post: tags: - Budgets summary: Manage Budget Alerts in bulk description: Manage alerts for budgets in bulk (delete, add, add/remove recipients) operationId: manageBudgetAlertsBulkOperation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Bulk manage alerts operation details content: application/json: schema: $ref: '#/components/schemas/ManageBudgetAlertsRequest' required: true responses: '202': description: Bulk manage alerts operation accepted content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgetGroups/{id}: get: tags: - Budget Groups summary: Fetch Budget group details description: Fetch details of a Budget group for the given Budget group ID. operationId: getBudgetGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get a Budget group by it's identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBudgetGroup' put: tags: - Budget Groups summary: Update an existing budget group description: Update an existing Budget group for the given Budget group ID. operationId: updateBudgetGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget group required: true schema: type: string requestBody: description: The Budget object content: application/json: schema: $ref: '#/components/schemas/BudgetGroup' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a generic string message when the operation is successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' delete: tags: - Budget Groups summary: Delete a budget group description: Delete a Budget group for the given Budget group ID. operationId: deleteBudgetGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a boolean whether the operation was successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/budgetGroups/v2/list: post: tags: - Budget Groups summary: Filter budget groups and return hierarchical structure description: >- Returns a hierarchical list of budget groups based on the filter criteria. operationId: getAccessibleBudgetGroupSummaries parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: sortType in: query description: Field to sort results by schema: type: string enum: - BUDGET_GROUP_AMOUNT - BUDGET_GROUP_NAME - BUDGET_GROUP_ACTUAL_COST - BUDGET_GROUP_FORECASTED_COST - name: sortOrder in: query description: Sort order (ASCENDING or DESCENDING) schema: type: string enum: - ASCENDING - DESCENDING requestBody: description: Filter properties for budget groups content: application/json: schema: $ref: '#/components/schemas/BudgetFilterPropertiesDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a hierarchical list of budget group summaries where child entities are nested within parent budget groups content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListBudgetSummary' /ccm/api/budgetGroups/aggregatedAmount: post: tags: - Budget Groups summary: Get aggregated amount for given budget groups/budgets description: Returns list of value dataPoints specifying aggregated amount operationId: getLastPeriodCost parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: areChildEntitiesBudgets in: query required: true schema: type: boolean requestBody: description: List of child budgets/budget groups content: application/json: schema: type: array items: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of value dataPoints specifying aggregated amount content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListValueDataPoint' /ccm/api/budgetGroups/summary: get: tags: - Budget Groups summary: Get list of budget and budget group summaries description: Returns list of budgetSummary operationId: getBudgetAndBudgetGroupsList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: budgetGroupId in: query schema: type: string - name: showAllEntities in: query required: true schema: type: boolean - name: budgetGroupSortType in: query description: Budget Group List Sort Type schema: type: string enum: - BUDGET_GROUP_AMOUNT - BUDGET_GROUP_NAME - BUDGET_GROUP_ACTUAL_COST - BUDGET_GROUP_FORECASTED_COST - name: sortOrder in: query description: Budget Group List Sort Order schema: type: string enum: - ASCENDING - DESCENDING responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of value dataPoints specifying cost content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListBudgetSummary' /ccm/api/budgetGroups: get: tags: - Budget Groups summary: List all the Budget groups description: List all the Budget Groups for an account. operationId: listBudgetGroups parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: budgetGroupSortType in: query description: Budget Group List Sort Type schema: type: string enum: - BUDGET_GROUP_AMOUNT - BUDGET_GROUP_NAME - BUDGET_GROUP_ACTUAL_COST - BUDGET_GROUP_FORECASTED_COST - name: sortOrder in: query description: Budget Group List Sort Order schema: type: string enum: - ASCENDING - DESCENDING responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of all Budget groups content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListBudgetGroup' post: tags: - Budget Groups summary: Create a Budget Group description: >- Create a Budget group to set and receive alerts when your costs exceed (or are forecasted to exceed) your budget group amount. operationId: createBudgetGroup parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Budget Group definition content: application/json: schema: $ref: '#/components/schemas/BudgetGroup' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the ID string of the new Budget group created content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/budgets/{id}: get: tags: - Budgets summary: Fetch Budget details description: Fetch details of a Budget for the given Budget ID. operationId: getBudget parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get a Budget by it's identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBudget' put: tags: - Budgets summary: Update an existing budget description: Update an existing Budget for the given Budget ID. operationId: updateBudget parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget required: true schema: type: string requestBody: description: The Budget object content: application/json: schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a generic string message when the operation is successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' post: tags: - Budgets summary: Clone a budget description: Clone a Budget using the given Budget ID. operationId: cloneBudget parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget required: true schema: type: string - name: cloneName in: query description: Name of the new budget required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns the identifier string of the new Budget created using clone operation content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' delete: tags: - Budgets summary: Delete a budget description: Delete a Budget for the given Budget ID. operationId: deleteBudget parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a text message whether the operation was successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/budgets/filter-values: post: tags: - Budgets summary: Return the list of filter values for the Budgets description: Returns the list of filter values for all the specified filters. operationId: budgetFilterValues parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Budget Filter Values Body. content: application/json: schema: $ref: '#/components/schemas/BudgetFilterValues' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/v2/list: post: tags: - Budgets summary: Filter budgets with RBAC checks description: >- Returns a list of budgets based on filter criteria with folder-based RBAC checks operationId: getAccessibleBudgetSummaries parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: sortType in: query description: Field to sort results by schema: type: string enum: - BUDGET_AMOUNT - NAME - ACTUAL_COST - FORECASTED_COST - name: sortOrder in: query description: Sort order (ASCENDING or DESCENDING) schema: type: string enum: - ASCENDING - DESCENDING requestBody: description: Filter properties for budgets content: application/json: schema: $ref: '#/components/schemas/CCMBudgetFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/v2/metrics: post: tags: - Budgets summary: Budget count metrics with RBAC checks description: >- Returns the total budget count (ignoring any budgetStatus selection) and the over-budget count for the given filter, with folder-based RBAC checks operationId: getBudgetSummaryMetrics parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Filter properties for budgets content: application/json: schema: $ref: '#/components/schemas/CCMBudgetFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/budgets/{id}/costDetails: get: tags: - Budgets summary: Fetch the cost details of a Budget description: Fetch the cost details of a Budget for the given Budget ID. operationId: getCostDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the Budget required: true schema: type: string - name: breakdown in: query description: MONTHLY/YEARLY breakdown. The default value is YEARLY schema: type: string description: Whether the Yearly budget breakdown is yearly or monthly enum: - YEARLY - MONTHLY responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the cost data of a Budget content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBudgetData' /ccm/api/budgets/perspectiveBudgets: get: tags: - Budgets summary: List all the Budgets associated with a Perspective description: List all the Budgets associated for the given Perspective ID. operationId: listBudgetsForPerspective parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: Unique identifier for the Perspective required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of Budgets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListBudget' /ccm/api/budgets: get: tags: - Budgets summary: List all the Budgets description: List all the Budgets. operationId: listBudgets parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: budgetSortType in: query description: Budget List Sort Type schema: type: string enum: - BUDGET_AMOUNT - NAME - ACTUAL_COST - FORECASTED_COST - name: sortOrder in: query description: Budget List Sort Order schema: type: string enum: - ASCENDING - DESCENDING responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of all Budgets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListBudget' post: tags: - Budgets summary: Create a Budget description: >- Create a Budget to set and receive alerts when your costs exceed (or are forecasted to exceed) your budget amount. operationId: createBudget parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Budget definition content: application/json: schema: $ref: '#/components/schemas/Budget' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the ID string of the new Budget created content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/budgets/subscribe/list: get: tags: - Budgets summary: List alert thresholds for a budget description: >- List all the alert thresholds that have been set for the given Budget ID. operationId: listBudgetAlertThresholds parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: budgetId in: query description: Unique identifier for the budget required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of alert thresholds for the budget content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAlertThreshold' /ccm/api/budgets/moveBudgets: post: tags: - Budgets summary: Move budgets to a folder description: >- Move budgets to a different folder, overriding perspective folder inheritance. operationId: moveBudgets parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing budgetIds and newFolderId content: application/json: schema: $ref: '#/components/schemas/MoveBudgetsDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns number of budgets moved content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInteger' /ccm/api/budgets/subscribe: post: tags: - Budgets summary: Update alert thresholds for a budget description: >- Update the alert thresholds for the given Budget ID with the provided list of alert thresholds. operationId: updateBudgetAlertThresholds parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: budgetId in: query description: Unique identifier for the budget required: true schema: type: string requestBody: description: List of alert thresholds to set for the budget content: application/json: schema: type: array items: $ref: '#/components/schemas/AlertThreshold' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a success message when the alert thresholds are updated successfully content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/business-mapping/{id}: get: tags: - Cost Categories summary: Fetch details of a Cost category description: >- Retrieve a specific Cost Category by its unique identifier. Returns the complete Cost Category configuration including all cost buckets, shared costs, and rule definitions. operationId: getBusinessMapping parameters: - name: accountIdentifier in: query schema: type: string - name: id in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a Cost category object with all the cost and shared buckets, returns null if no Cost category exists for that particular identifier content: application/json: schema: $ref: '#/components/schemas/RestResponseBusinessMapping' x-order: '2' delete: tags: - Cost Categories summary: Delete a Cost category description: >- Delete a Cost Category by its unique identifier. The deletion will fail if the Cost Category is currently used in any Perspectives. Returns a list of linked Perspectives if deletion is blocked. operationId: deleteBusinessMapping parameters: - name: accountIdentifier in: query required: true schema: type: string - name: id in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- A string text message whether the delete was successful or not. If the cost category is used in the perspective, the deletion will fail and it will send you the IDs of all the linked perspectives content: application/json: schema: $ref: '#/components/schemas/RestResponseCostCategoryDeleteDTO' x-order: '5' /ccm/api/business-mapping/filter-panel: get: tags: - Cost Categories summary: Get (cost-categories)/(cost buckets) for recommendation filter panel description: Get (cost-categories)/(cost buckets) for recommendation filter panel operationId: getBusinessMappingForFilterPanel parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: costCategory in: query schema: type: string - name: search in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of cost-category/cost-buckets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/business-mapping: get: tags: - Cost Categories summary: Return details of all the Cost categories description: >- List all Cost Categories for your account with support for search, sorting, and pagination. Use this endpoint to browse and discover existing Cost Categories and their configurations. operationId: getBusinessMappingList parameters: - name: accountIdentifier in: query schema: type: string - name: searchKey in: query schema: type: string - name: sortType in: query schema: type: string enum: - NAME - LAST_EDIT - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING - name: limit in: query schema: type: integer format: int32 - name: offset in: query schema: type: integer format: int32 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a List of Cost Categories content: application/json: schema: $ref: '#/components/schemas/RestResponseBusinessMappingListDTO' x-order: '3' put: tags: - Cost Categories summary: Update a Cost category description: >- Update an existing Cost Category configuration. Modify cost buckets, shared costs, rules, or rename the Cost Category. The update is identified by the UUID in the request body. operationId: updateBusinessMapping parameters: - name: accountIdentifier in: query schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BusinessMapping' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Successfully updated the Business Mapping content: application/json: schema: $ref: '#/components/schemas/RestResponseString' x-order: '4' post: tags: - Cost Categories summary: Create a Cost Category description: >- Create a Cost Category to organize and allocate cloud and AI costs based on your business structure. Define custom rules and cost buckets to automatically categorize expenses by teams, projects, environments, or any business dimension. Cost Categories enable accurate cost allocation, chargeback, and financial reporting across your organization. operationId: createBusinessMapping parameters: - name: accountIdentifier in: query schema: type: string requestBody: description: Cost Category definition with rules and cost buckets content: application/json: schema: $ref: '#/components/schemas/BusinessMapping' examples: Basic Cost Category: summary: Simple Cost Category by teams description: >- Create a Cost Category to organize costs by engineering teams using labels value: name: Engineering Teams accountId: acc_xyz789 costBuckets: - name: Backend Team rules: - conditions: - type: LABEL key: team value: backend - name: Frontend Team rules: - conditions: - type: LABEL key: team value: frontend sharedCosts: [] required: true responses: '200': description: >- Successfully created Cost Category with all cost buckets and shared costs content: application/json: schema: $ref: '#/components/schemas/BusinessMapping' '400': description: Bad Request - Invalid Cost Category definition '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' x-order: '1' /ccm/api/cloud-account: get: tags: - Cloud Accounts summary: List cloud accounts by cloud provider description: List all cloud accounts for a given cloud provider operationId: listCloudAccounts parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud provider type required: true schema: type: string enum: - AWS - AZURE - GCP - CLUSTER - EXTERNAL_DATA - OPENAI - ANTHROPIC - IBM - ON_PREM - UNKNOWN responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of cloud accounts content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCCMCloudAccount' /ccm/api/ccmK8sMeta: post: tags: - K8S Connectors Metadata summary: Get CACM K8S Metadata description: 'Get CACM K8S Metadata ' operationId: ccmK8sMeta parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Cost Access K8s connector identifiers content: application/json: schema: $ref: '#/components/schemas/CcmK8sMetaDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of connector identifiers with their health metadata content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCcmK8sMetaInfoResponseDTO' /ccm/api/notificationSetting/v2: get: tags: - Notification Settings v2 summary: List notification settings description: List notification settings for the given account id. operationId: listNotificationSettingsV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of notification setting object for given account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListNotificationSetting' put: tags: - Notification Settings v2 summary: Update an existing notification setting description: Update an existing notification setting for the given perspective id. operationId: updateNotificationSettingV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query description: Unique identifier for the notification setting required: true schema: type: string requestBody: description: Notification setting definition content: application/json: schema: $ref: '#/components/schemas/NotificationSetting' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the updated notification setting object content: application/json: schema: $ref: '#/components/schemas/ResponseDTONotificationSetting' post: tags: - Notification Settings v2 summary: Create a notification setting description: >- Create a notification setting for a perspective to receive cloud and AI cost anomaly alerts. operationId: createNotificationSettingV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Notification Setting definition content: application/json: schema: $ref: '#/components/schemas/NotificationSetting' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the Notification Setting object created content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' delete: tags: - Notification Settings v2 summary: Delete notification settings description: Delete notification settings for the given perspective id. operationId: deleteNotificationSettingsV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query description: Unique identifier for the Perspective required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns boolean indicating whether deletion of notification settings for a perspective was successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/overview: get: tags: - Overview summary: Fetch high level overview details about CACM feature. description: Fetch high level overview details about CACM feature. operationId: getCCMOverview parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: startTime in: query description: Start time of the period required: true schema: type: integer format: int64 - name: endTime in: query description: End time of the period required: true schema: type: integer format: int64 - name: groupBy in: query description: Group by period required: true schema: type: string enum: - HOUR - DAY - MONTH - WEEK - QUARTER - YEAR responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a CEView object containing CACM Overview details(Total cost, cost breakdown by day, and total number of recommendations for a give time range) content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCCMOverview' /ccm/api/cost-settings: get: tags: - CACM global cost settings summary: Get cost settings for a CACM feature description: Get cost settings for a CACM feature operationId: getCostSettings parameters: - name: accountIdentifier in: query schema: type: string - name: feature in: query description: The CACM feature to get settings for required: true schema: type: string enum: - ANOMALIES - RECOMMENDATIONS responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get cost settings for a CACM feature content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCostSettings' put: tags: - CACM global cost settings summary: Update cost settings for a CACM feature description: Update cost settings for a CACM feature operationId: updateCostSettings parameters: - name: accountIdentifier in: query schema: type: string requestBody: description: Cost setting definition content: application/json: schema: $ref: '#/components/schemas/CostSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Update cost settings for a CACM feature content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCostSettings' /ccm/api/data-job-status/job-statuses: get: tags: - Data Job Status summary: Get all job statuses description: Retrieve all available job status values from the JobStatus enum. operationId: getAllJobStatuses responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of all job statuses content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListJobStatus' /ccm/api/data-job-status/history/billing-periods: get: tags: - Data Job Status summary: Get distinct billing periods for a connector description: >- Retrieve distinct billing periods for a connector and job kind in YYYY-MM format, sorted in descending order. operationId: getDistinctBillingPeriods parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: connectorId in: query description: Connector identifier required: true schema: type: string - name: jobKind in: query description: Job kind (INGESTION, PDT, INVENTORY, OTHER) required: true schema: type: string enum: - INGESTION - PDT - INVENTORY - OTHER - name: azureCostType in: query description: Azure cost type filter (ACTUAL, AMORTIZED) schema: type: string enum: - ACTUAL - AMORTIZED - LIST_ACTUAL - LIST_AMORTIZED responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of distinct billing periods (e.g., 2026-03) content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/data-job-status/history/execution-months: get: tags: - Data Job Status summary: Get distinct execution months for a connector description: >- Retrieve distinct execution months for a connector and job kind in YYYY-MM format, sorted in descending order. operationId: getDistinctExecutionMonths parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: connectorId in: query description: Connector identifier required: true schema: type: string - name: jobKind in: query description: Job kind (INGESTION, PDT, INVENTORY, OTHER) required: true schema: type: string enum: - INGESTION - PDT - INVENTORY - OTHER - name: azureCostType in: query description: Azure cost type filter (ACTUAL, AMORTIZED) schema: type: string enum: - ACTUAL - AMORTIZED - LIST_ACTUAL - LIST_AMORTIZED responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of distinct execution months (e.g., 2026-03) content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/data-job-status/job-kinds: get: tags: - Data Job Status summary: Get distinct job kinds description: Retrieve distinct job kind values available for the account. operationId: getDistinctJobKinds parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of distinct job kinds content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListJobKind' /ccm/api/data-job-status/history: get: tags: - Data Job Status summary: Fetch data job history details description: >- Retrieve the execution history details filtered by connector, job kind, billing period, and execution month. Returns all history records sorted by execution date in descending order. operationId: getDataJobHistoryDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: connectorId in: query description: Connector identifier required: true schema: type: string - name: jobKind in: query description: Job kind (INGESTION, PDT, INVENTORY, OTHER) required: true schema: type: string enum: - INGESTION - PDT - INVENTORY - OTHER - name: billingPeriodMonth in: query description: 'Billing period month filter (format: YYYY-MM, e.g., 2026-04)' schema: type: string - name: executionMonth in: query description: 'Execution month filter (format: YYYY-MM, e.g., 2026-05)' required: true schema: type: string - name: azureCostType in: query description: Azure cost type filter (ACTUAL, AMORTIZED) schema: type: string enum: - ACTUAL - AMORTIZED - LIST_ACTUAL - LIST_AMORTIZED responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a list of DataJobHistoryDTO objects representing execution history details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListDataJobHistoryDTO' /ccm/api/data-job-status/details/{jobId}: get: tags: - Data Job Status summary: Fetch details of a data job with latest billing period description: >- Retrieve the details for a specific data job with the latest billing period. Returns the most recent execution attempt with detailed state transitions, timestamps, and execution metadata. Useful for debugging, auditing, and analyzing job performance. operationId: getDataJobDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: jobId in: path description: Unique identifier of the data job required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a DataJobHistoryDTO object representing the latest execution attempt for the specified job ID based on billing period start date content: application/json: schema: $ref: '#/components/schemas/ResponseDTODataJobHistoryDTO' /ccm/api/data-job-status/overview: get: tags: - Data Job Status summary: Fetch dashboard statistics for data jobs description: >- Retrieve dashboard statistics for data jobs including active jobs count, jobs requiring attention, and completed jobs today with average duration. Provides a high-level overview of the data pipeline health and performance. operationId: getDataJobsDashboard parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns dashboard statistics including active jobs, jobs requiring attention, and completed jobs today content: application/json: schema: $ref: '#/components/schemas/ResponseDTODataJobStatusOverviewDTO' /ccm/api/data-job-status/list: post: tags: - Data Job Status summary: List data jobs with filters description: >- Retrieve a paginated list of data jobs with optional filters including connector, job kind, status, and date range. operationId: listDataJobs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Filter criteria for listing data jobs content: application/json: schema: $ref: '#/components/schemas/DataJobFilterDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a paginated list of data jobs matching the filter criteria content: application/json: schema: $ref: '#/components/schemas/ResponseDTODataJobStatusResponseDTO' /ccm/api/recommendation-cost-settings: get: tags: - Recommendation cost settings summary: Get recommendation cost settings description: Get recommendation cost settings for an account operationId: getRecommendationCostSettings parameters: - name: accountIdentifier in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get recommendation cost settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationCostSettings' put: tags: - Recommendation cost settings summary: Update recommendation cost settings description: Update recommendation cost settings for an account operationId: updateRecommendationCostSettings parameters: - name: accountIdentifier in: query schema: type: string requestBody: description: Recommendation cost settings content: application/json: schema: $ref: '#/components/schemas/RecommendationCostSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Update recommendation cost settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationCostSettings' /ccm/api/unit-metric: get: tags: - Unit Metric summary: Get Unit Metric description: >- Get a Unit Metric by identifier with records for the specified time range. operationId: getUnitMetric parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: metricIdentifier in: query description: Unit Metric identifier required: true schema: type: string - name: startTime in: query description: >- Start time in ISO 8601 format (e.g., 2020-03-03T15:32:44Z or 2020-03-03T15:32:44%2B00:00) required: true schema: type: string - name: endTime in: query description: >- End time in ISO 8601 format (e.g., 2020-03-03T15:32:44Z or 2020-03-03T15:32:44%2B00:00) required: true schema: type: string - name: timeTruncGroupBy in: query description: >- Calendar bucket for grouping samples before aggregation (DAY, WEEK, MONTH). Each bucket is aggregated in BigQuery using the metric's defaultAggregation (AVG, MIN, MAX, or SUM; see Unit Metric create/update). schema: type: string description: >- Groups unit metric samples into calendar buckets (DAY, WEEK, or MONTH) before applying the metric's default aggregation in BigQuery. default: DAY enum: - DAY - WEEK - MONTH responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns Unit Metric metadata and records for the specified time range content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUnitMetricResponseDTO' put: tags: - Unit Metric summary: Update Unit Metric description: Update an existing Unit Metric. operationId: updateUnitMetric parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Unit Metric object content: application/json: schema: $ref: '#/components/schemas/UnitMetricRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns an updated Unit Metric Object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUnitMetricResponseDTO' post: tags: - Unit Metric summary: Create Unit Metric description: Create a Unit Metric. operationId: createUnitMetric parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Unit Metric object content: application/json: schema: $ref: '#/components/schemas/UnitMetricRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a created Unit Metric Object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUnitMetricResponseDTO' delete: tags: - Unit Metric summary: Delete Unit Metric records or the entire metric. description: >- Delete Unit Metric records within a specified time range, or pass deleteCompleteMetric=true to remove the metric definition along with all of its records (startTime/endTime are ignored in that case). A complete delete is rejected when the metric is still referenced by any Perspective. operationId: deleteUnitMetric parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: identifier in: query description: Unit Metric identifier required: true schema: type: string - name: startTime in: query description: >- Start time in ISO 8601 format (e.g., 2020-03-03T15:32:44Z or 2020-03-03T15:32:44%2B00:00). Required when deleteCompleteMetric=false; ignored otherwise. schema: type: string - name: endTime in: query description: >- End time in ISO 8601 format (e.g., 2020-03-03T15:32:44Z or 2020-03-03T15:32:44%2B00:00). Required when deleteCompleteMetric=false; ignored otherwise. schema: type: string - name: deleteCompleteMetric in: query description: >- When true, deletes the entire Unit Metric (definition + all records) and ignores startTime/endTime. The deletion is rejected if the metric is referenced by any Perspective. schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns success status content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/unit-metric/perspective/{perspectiveId}: post: tags: - Unit Metric summary: Get Column Metric for Perspective description: >- Query a DERIVED-type unit metric with perspective filters applied, optionally with additional filters on top of the perspective's saved rules. operationId: getColumnUnitMetricForPerspective parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: path description: Perspective ID whose filters will be applied required: true schema: type: string - name: metricIdentifier in: query description: DERIVED-type unit metric identifier required: true schema: type: string - name: startTime in: query description: Start time in ISO 8601 format (e.g., 2020-03-03T15:32:44Z) required: true schema: type: string - name: endTime in: query description: End time in ISO 8601 format (e.g., 2020-03-03T15:32:44Z) required: true schema: type: string - name: timeTruncGroupBy in: query description: Calendar bucket for time grouping (DAY, WEEK, MONTH). schema: type: string description: >- Groups unit metric samples into calendar buckets (DAY, WEEK, or MONTH) before applying the metric's default aggregation in BigQuery. default: DAY enum: - DAY - WEEK - MONTH - name: overrideFilter in: query description: >- When false (default), body filters are applied on top of the perspective's saved rules. When true, the perspective's saved rules are ignored and only the body filters are applied — used to preview an edited/removed filter set before saving. schema: type: boolean default: false requestBody: description: >- Filters applied on top of the perspective's saved rules, or standalone when overrideFilter is true content: application/json: schema: type: array items: $ref: '#/components/schemas/QLCEViewFilterWrapper' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns time-bucketed metric values with perspective filters applied content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUnitMetricResponseDTO' /ccm/api/unit-metric/list: get: tags: - Unit Metric summary: List All Unit Metrics description: Get all Unit Metrics for an account (metadata only, no records). operationId: listAllUnitMetrics parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: pageSize in: query description: Number of unit metrics to be shown (max 100) required: true schema: maximum: 100 type: integer format: int32 default: 20 - name: pageNo in: query description: Number of records to be skipped required: true schema: type: integer format: int32 default: 0 - name: searchKey in: query description: Search key to filter unit metrics by name (case-insensitive) schema: type: string - name: sortType in: query description: Sort field for the list schema: type: string default: LAST_UPDATED_AT enum: - METRIC_NAME - LAST_UPDATED_AT - name: sortOrder in: query description: Sort order (ASCENDING or DESCENDING) schema: type: string enum: - ASCENDING - DESCENDING responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of all Unit Metrics for the account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOUnitMetricListResponseDTO' /ccm/api/anomaly/v2/comment: get: tags: - Anomaly Comments summary: List anomaly comments description: List comments for the given anomaly operationId: listAnomalyComments parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query required: true schema: type: string responses: default: description: List anomaly comments content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAnomalyComment' post: tags: - Anomaly Comments summary: Save anomaly comment description: Save comment for the given anomaly operationId: saveAnomalyComment parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Comment details content: application/json: schema: $ref: '#/components/schemas/AnomalyComment' required: true responses: default: description: Save anomaly comment content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/anomaly/v2/drill-down/cost/time-series: get: tags: - Cloud and AI cost anomaly details summary: Get anomaly cost time-series data description: Get actual cost time-series data for given anomaly. operationId: getAnomalyCostTimeSeriesData parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query required: true schema: type: string - name: startTime in: query schema: type: integer format: int64 - name: endTime in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get anomaly cost time-series data content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAnomalyCostTimeSeries' /ccm/api/anomaly/v2/drill-down: get: tags: - Cloud and AI cost anomaly details summary: Get anomaly details description: Get details about the given cloud and AI cost anomaly operationId: getAnomalyDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get anomaly details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnomalyData' /ccm/api/anomaly/v2/drill-down/resource/cost/time-series: get: tags: - Cloud and AI cost anomaly details summary: Get anomaly resource cost time-series data description: Get actual cost time-series data for given resource. operationId: getAnomalyResourceCostTimeSeriesData parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query required: true schema: type: string - name: resource in: query schema: type: string - name: startTime in: query schema: type: integer format: int64 - name: endTime in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get anomaly resource cost time-series data content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOListAnomalyResourceCostTimeSeries /ccm/api/anomaly/v2/drill-down/list: get: tags: - Cloud and AI cost anomaly details summary: Get anomaly resource list description: >- Get details about the top contributing resources for the given cloud and AI cost anomaly. Returns either a list of resource details (AnomalyResourceDetails) when drill-down is successful, or a list of anomaly data (AnomalyData) when drill-down results are insufficient or empty. The response type depends on whether the drill-down query returns meaningful results and whether the drill-down cost impact is at least 50% of the total cost impact. operationId: getAnomalyResourceList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query required: true schema: type: string responses: '200': description: >- Returns either a list of AnomalyResourceDetails (when drill-down is successful) or a list of AnomalyData (when drill-down is insufficient). content: application/json: schema: type: string description: >- Response containing either List or List based on drill-down results and feature flag configuration '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/anomaly/v2/list: post: tags: - Cloud and AI cost anomalies v2 summary: Get anomalies list description: Get anomalies list operationId: getAnomaliesList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Anomaly request body content: application/json: schema: $ref: '#/components/schemas/AnomalyRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get anomalies list content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListAnomalyData' /ccm/api/anomaly/v2/metrics: post: tags: - Cloud and AI cost anomalies v2 summary: Get anomaly metrics description: Get metrics for different types of anomalies operationId: getAnomalyMetrics parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Anomaly request body content: application/json: schema: $ref: '#/components/schemas/AnomalyRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get anomaly metrics content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnomalyOverview' /ccm/api/anomaly/v2/summary: post: tags: - Cloud and AI cost anomalies v2 summary: Get anomaly metrics summary description: Get summary of anomaly metrics operationId: getAnomalyMetricsSummary parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Anomaly request body content: application/json: schema: $ref: '#/components/schemas/AnomalyRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get anomaly metrics content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAnomalyMetrics' /ccm/api/anomaly/v2/metrics/time-series: post: tags: - Cloud and AI cost anomalies v2 summary: Get anomaly metrics time-series description: Get metrics for different types of anomalies per day operationId: getAnomalyMetricsTimeSeries parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Anomaly request body content: application/json: schema: $ref: '#/components/schemas/AnomalyRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get anomaly metrics time-series content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTreeMapLongAnomalyOverview' /ccm/api/anomaly/v2/mean-resolution-time: post: tags: - Cloud and AI cost anomalies v2 summary: Get mean resolution time description: Get mean resolution time operationId: getMeanResolutionTime parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Anomaly request body content: application/json: schema: $ref: '#/components/schemas/AnomalyRequestDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Get mean resolution time content: application/json: schema: $ref: '#/components/schemas/ResponseDTODouble' /ccm/api/anomaly/v2/update/feedback: put: tags: - Cloud and AI cost anomalies v2 summary: Update feedback for given anomaly description: Update feedback for given anomaly operationId: updateAnomalyFeedback parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query schema: type: string - name: feedback in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Update feedback for given anomaly content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/anomaly/v2/update/status: put: tags: - Cloud and AI cost anomalies v2 summary: Update status for given anomaly description: Update status for given anomaly operationId: updateAnomalyStatus parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: anomalyId in: query schema: type: string - name: status in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Update status for given anomaly content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/costdetails/overview/iacm: post: tags: - Cost Details summary: Returns cost overview for IaCM resources description: >- Returns cost details for IaCM-managed resources based on cloud-native identifiers and Terraform provider/type metadata. operationId: iacmResourceCostOverview parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: IaCM resource cost request content: application/json: schema: $ref: '#/components/schemas/IacmResourceCostRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns cost details for specified IaCM resources. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOIacmResourceCosts' /ccm/api/costdetails/overview: post: tags: - Cost Details summary: Returns an overview of the cost description: >- Returns total cost, cost trend, and the time period based on the specified query parameters. operationId: costdetailoverview parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: Perspective identifier of the cost details required: true schema: type: string - name: startTime in: query description: >- Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days schema: type: string - name: endTime in: query description: >- End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today schema: type: string - name: isClusterHourlyData in: query description: >- To fetch cluster hourly data in case of cluster perspective. Defaults to false schema: type: boolean - name: useCostCategoryStampedData in: query schema: type: boolean default: false requestBody: description: Cost details query parameters. content: application/json: schema: $ref: '#/components/schemas/CostDetailsQueryParams' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns total cost, cost trend, and the time period based on the specified query parameters. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCostOverview' /ccm/api/costdetails/clusterData: post: tags: - Cost Details summary: Returns cluster data in a tabular format description: Returns cluster data based on the specified query parameters. operationId: clusterData parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: startTime in: query description: >- Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days schema: type: string - name: endTime in: query description: >- End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today schema: type: string - name: isClusterHourlyData in: query description: >- To fetch cluster hourly data in case of cluster perspective. Defaults to false schema: type: boolean - name: useCostCategoryStampedData in: query schema: type: boolean default: false requestBody: description: Cost details query parameters. content: application/json: schema: $ref: '#/components/schemas/ClusterCostDetailsQueryParams' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns cluster data in a tabular format based on the specified query parameters. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListClusterCostDetails' /ccm/api/costdetails/tabularformat: post: tags: - Cost Details summary: Returns cost details in a tabular format description: >- Returns cost details in a tabular format based on the specified query parameters. operationId: costdetailtabular parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: Perspective identifier of the cost details required: true schema: type: string - name: startTime in: query description: >- Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days schema: type: string - name: endTime in: query description: >- End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today schema: type: string - name: isClusterHourlyData in: query description: >- To fetch cluster hourly data in case of cluster perspective. Defaults to false schema: type: boolean - name: useCostCategoryStampedData in: query schema: type: boolean default: false requestBody: description: Cost details query parameters. content: application/json: schema: $ref: '#/components/schemas/CostDetailsQueryParams' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns cost details in a tabular format based on the specified query parameters. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPerspectiveEntityStatsData' /ccm/api/costdetails/timeseriesformat: post: tags: - Cost Details summary: Returns cost details in a time series format description: >- Returns cost details in a time series format based on the specified query parameters. operationId: costdetailttimeseries parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: Perspective identifier of the cost details required: true schema: type: string - name: startTime in: query description: >- Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days schema: type: string - name: endTime in: query description: >- End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today schema: type: string - name: isClusterHourlyData in: query description: >- To fetch cluster hourly data in case of cluster perspective. Defaults to false schema: type: boolean - name: useCostCategoryStampedData in: query schema: type: boolean default: false requestBody: description: Cost details query parameters. content: application/json: schema: $ref: '#/components/schemas/CostDetailsQueryParams' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns cost details in a time series format based on the specified query parameters. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPerspectiveTimeSeriesData' /ccm/api/externaldata/filesinfo: post: tags: - External Data Provider summary: Add a new external data file metadata description: Add a new external data file metadata operationId: AddNewExternalDataFileMetadata parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing external data object content: application/json: schema: $ref: '#/components/schemas/CreateExternalDataFilesDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns newly added external data file metadata information content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExternalDataFiles' /ccm/api/externaldata/provider: post: tags: - External Data Provider summary: Create External Data Provider description: Create External Data Provider operationId: createExternalDataProvider parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Create External Data Provider Request content: application/json: schema: $ref: '#/components/schemas/CreateExternalDataProviderDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns created External Data Provider content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExternalDataProvider' /ccm/api/externaldata/dataingestion: post: tags: - External Data Provider summary: Trigger data ingestion description: Trigger data ingestion operationId: triggerDataIngestion parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing list of invoice months for a provider content: application/json: schema: $ref: '#/components/schemas/ExternalDataIngestionRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: 'Data ingestion submission response ' content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExternalDataFiles' /ccm/api/externaldata/provider/{providerId}: delete: tags: - External Data Provider summary: Delete a provider description: Delete a external data provider given a idD. operationId: CcmdeleteProvider parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: providerId in: path description: Unique identifier for the rule required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: A boolean whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/externaldata/filesinfo/{fileId}: put: tags: - External Data Provider summary: Update file metadata description: Update file metadata operationId: updateFileMetaData parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: fileId in: path description: Unique identifier for the rule required: true schema: type: string requestBody: description: Request body containing fileMetaData object content: application/json: schema: $ref: '#/components/schemas/CreateExternalDataFilesDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Updated Rule. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOExternalDataFiles' delete: tags: - External Data Provider summary: Delete data file and related metadata description: Delete data file and related metadata given an id. operationId: deleteDatafileAndMetadata parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: fileId in: path description: Unique identifier for the data file required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: A boolean whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/externaldata/signedurl: get: tags: - External Data Provider summary: Get a signed url description: Get a signed url to upload external cost data. operationId: getSignedUrl parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: providerId in: query description: Unique identifier for the provider required: true schema: type: string - name: invoicePeriod in: query description: Invoice period in format YYYYMMDD-YYYYMMDD required: true schema: type: string - name: objectName in: query description: Name of the object to upload required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Successful retrieval of signed URL content: application/json: schema: $ref: '#/components/schemas/ResponseDTO' /ccm/api/externaldata/provider/list: post: tags: - External Data Provider summary: get all external data providers description: 'get providers ' operationId: get providers parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of external data providers content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListExternalDataProvider' /ccm/api/externaldata/provider/filesinfo: post: tags: - External Data Provider summary: get all files info for list of providers description: listProvidersFileInfo operationId: listProvidersFileInfo parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing external data object content: application/json: schema: $ref: '#/components/schemas/ExternalDataProviderList' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns all files info for list of providers content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMapStringListExternalDataFiles' /ccm/api/genai-traces/{traceId}/spans: get: tags: - GenAI Traces summary: Get GenAI trace spans description: Get spans for a GenAI trace. operationId: getGenAITraceSpans parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: traceId in: path required: true schema: type: string - name: limit in: query schema: type: integer format: int32 - name: offset in: query schema: type: integer format: int32 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns GenAI trace spans content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListGenAITraceSpanDTO' /ccm/api/genai-traces/services: get: tags: - GenAI Traces summary: List GenAI services description: >- List unique GenAI services observed in the last year, with their last activity timestamp and active/inactive status. operationId: listGenAITraceServices parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns unique GenAI services with last activity and status content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListGenAIServiceDTO' /ccm/api/genai-traces: post: tags: - GenAI Traces summary: List GenAI trace summaries description: List GenAI trace summaries. operationId: listGenAITraceSummaries parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: limit in: query schema: type: integer format: int32 - name: offset in: query schema: type: integer format: int32 requestBody: description: GenAI trace filters content: application/json: schema: $ref: '#/components/schemas/GenAITraceFilterRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns GenAI trace summaries content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGenAITraceListResponse' /ccm/api/governance/promptResources: get: tags: - AiEngine summary: Get supported prompt resources description: Get supported prompt resources for a given cloud provider operationId: getPromptResources parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider required: true schema: type: string enum: - AWS - AZURE - GCP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Get supported prompt resources for a given cloud provider content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetString' /ccm/api/governance/promptRules: get: tags: - AiEngine summary: Get sample prompt governance rules description: Get sample prompt rules for given cloud provider and resource type operationId: getPromptRules parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider required: true schema: type: string enum: - AWS - AZURE - GCP - name: resourceType in: query description: Resource Type schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Get sample prompt rules for given cloud provider and resource type content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListGovernancePromptRule' /ccm/api/governance/cost-settings: get: tags: - CACM governance cost settings summary: Get governance cost settings description: Get governance cost settings for an account operationId: getGovernanceCostSettings parameters: - name: accountIdentifier in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns governance cost settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGovernanceCostSettings' put: tags: - CACM governance cost settings summary: Update governance cost settings description: Update governance cost settings for an account operationId: updateGovernanceCostSettings parameters: - name: accountIdentifier in: query schema: type: string requestBody: description: Governance cost settings content: application/json: schema: $ref: '#/components/schemas/GovernanceCostSettings' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns updated governance cost settings content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGovernanceCostSettings' /ccm/api/governance/enforcementRecommendation/accept: put: tags: - Governance Enforcement Recommendation APIs summary: >- Accept governance rule enforcement recommendations for given enforcement recommendation ids. description: Accept governance rule enforcement recommendations. operationId: acceptEnforcementRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enforcementRecommendationIds in: query description: Enforcement Recommendation Ids schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: >- True/false if governance rule enforcement recommendations are successfully accepted. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/governance/enforcementRecommendation/dismiss: put: tags: - Governance Enforcement Recommendation APIs summary: >- Dismiss governance rule enforcement recommendations for given enforcement recommendation ids. description: Dismiss governance rule enforcement recommendations. operationId: dismissEnforcementRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enforcementRecommendationIds in: query description: Enforcement Recommendation Ids schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: >- True/false if governance rule enforcement recommendations are successfully dismissed. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/governance/enforcementRecommendation/details: get: tags: - Governance Enforcement Recommendation APIs summary: >- Get governance rule enforcement recommendation details for given enforcement recommendation id. description: Get governance rule enforcement recommendation details. operationId: enforcementRecommendationDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enforcementRecommendationId in: query description: Enforcement Recommendation Id schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns Enforcement details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnforcementDetails' /ccm/api/governance/enforcementRecommendation/list: get: tags: - Governance Enforcement Recommendation APIs summary: List governance rule enforcement recommendations for given accountId. description: List governance rule enforcement recommendations. operationId: ruleEnforcementRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: searchKey in: query schema: type: string - name: page in: query description: Page number schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Number of items per page schema: type: integer format: int32 example: 20 - name: sortType in: query schema: type: string enum: - NAME - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return list of governance enforcement recommendations. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTORuleEnforcementRecommendationList deprecated: true post: tags: - Governance Enforcement Recommendation APIs summary: List governance rule enforcement recommendations for given accountId. description: List governance rule enforcement recommendations. operationId: listRuleEnforcementRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing RuleEnforcementRecommendationFilter object content: application/json: schema: $ref: '#/components/schemas/RuleEnforcementRecommendationsFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return list of governance enforcement recommendations. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTORuleEnforcementRecommendationList /ccm/api/governance/enforcementRecommendation/update: put: tags: - Governance Enforcement Recommendation APIs summary: Update a governance rule enforcement recommendation. description: Update a governance rule enforcement recommendation. operationId: updateEnforcementRecommendation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing rule enforcement recommendation object content: application/json: schema: $ref: '#/components/schemas/RuleEnforcementRecommendation' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Updated governance rule enforcement recommendation. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleEnforcementRecommendation' /ccm/api/governance/alert/clone: post: tags: - Governance Alert summary: Clone a governance alert rule with the given id description: Clone a governance alert rule with the given id operationId: CloneGovernanceAlertRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Newly created cloned governance alert rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGovernanceNotification' /ccm/api/governance/alert: put: tags: - Governance Alert summary: Update a existing governance alert rule description: Update a existing governance alert rule operationId: UpdateGovernanceAlertRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query required: true schema: type: string requestBody: description: Request body containing governance alert rule object content: application/json: schema: $ref: '#/components/schemas/GovernanceNotification' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Updated governance alert rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGovernanceNotification' post: tags: - Governance Alert summary: Create a new governance alert rule description: Create a new governance alert rule operationId: CreateNewGovernanceAlertRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing governance alert rule object content: application/json: schema: $ref: '#/components/schemas/GovernanceNotification' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns newly created governance alert rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGovernanceNotification' /ccm/api/governance/alert/{id}: delete: tags: - Governance Alert summary: Delete a governance alert rule with the given id description: Delete a governance alert rule with the given id operationId: DeleteGovernanceAlertRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: A boolean whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/governance/alert/list: get: tags: - Governance Alert summary: List all governance alert rule(s) description: List all governance alert rule(s) operationId: GovernanceAlertRules parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: List of all governance alert rule(s) content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListGovernanceNotification' /ccm/api/governance/alert/resourceTypes: get: tags: - Governance Alert summary: List all governance supported resource types description: List all governance supported resource types operationId: GovernanceResourceTypes parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider required: true schema: type: string enum: - AWS - AZURE - GCP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: List of all governance supported resource types content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetString' /ccm/api/governance/alert/toggle: put: tags: - Governance Alert summary: Toggle a governance alert rule with the given id description: Toggle a governance alert rule with the given id operationId: ToggleGovernanceAlertRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query required: true schema: type: string - name: enableGovernanceAlertRule in: query description: Enable Governance Alert Rule required: true schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Updated governance alert rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGovernanceNotification' /ccm/api/governance/overview/dayWiseTotalEvaluations: post: tags: - Governance Overview summary: Return day wise total evaluations grouped by evaluation status. operationId: dayWiseTotalEvaluations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider schema: type: array items: type: string enum: - AWS - AZURE - GCP requestBody: description: Request body with time filters content: application/json: schema: type: array items: $ref: '#/components/schemas/CCMTimeFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return day wise total evaluations grouped by evaluation status. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMapStringMapStringInteger' /ccm/api/governance/overview/totalNewEnforcementRecommendations: get: tags: - Governance Overview summary: Return total number of new enforcement recommendations. operationId: totalNewEnforcementRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider schema: type: array items: type: string enum: - AWS - AZURE - GCP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return total number of new enforcement recommendations. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOLong' /ccm/api/governance/overview/totalActiveEnforcements: get: tags: - Governance Overview summary: Return total number of active enforcements. operationId: totalActiveEnforcements parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider schema: type: array items: type: string enum: - AWS - AZURE - GCP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return total number of active enforcements. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOLong' /ccm/api/governance/overview/totalEvaluations: get: tags: - Governance Overview summary: Return total number of evaluations. operationId: totalEvaluations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider schema: type: array items: type: string enum: - AWS - AZURE - GCP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return total number of evaluations. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOLong' /ccm/api/governance/overview/totalRealisedSavingsV2: post: tags: - Governance Overview summary: Return total realised Savings. operationId: totalRealisedSavingsV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider schema: type: array items: type: string enum: - AWS - AZURE - GCP requestBody: description: Request body with time filters content: application/json: schema: type: array items: $ref: '#/components/schemas/CCMTimeFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return total realised Savings. content: application/json: schema: $ref: '#/components/schemas/ResponseDTODouble' /ccm/api/governance/overview/totalRealisedSavingsGrouped: get: tags: - Governance Overview summary: Return total realised Savings grouped by cloud provider/resource type. operationId: totalRealisedSavingsGrouped parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider schema: type: array items: type: string enum: - AWS - AZURE - GCP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: >- Return total realised Savings grouped by cloud provider/resource type. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMapStringDouble' /ccm/api/governance/recommendationHealth: get: tags: - Governance Recommendation APIs summary: Return governance rule recommendation health summary. operationId: recommendationHealth parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleId in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return governance rule recommendation health summary. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleRecommendationSummary' /ccm/api/governance/recommendation/{recommendationId}: get: tags: - Governance Recommendation APIs summary: Governance recommendation details operationId: getRuleRecommendation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: recommendationId in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns governance recommendation details. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleExecutionInternalList' /ccm/api/governance/recommendationHealth/list: post: tags: - Governance Recommendation APIs summary: Return list of governance rule recommendation health summary. operationId: listGovernanceRecommendationHealth parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Body to retrieve rule recommendation health content: application/json: schema: $ref: '#/components/schemas/RuleRecommendationHealthSummaryFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return list of governance rule recommendation health summary. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleRecommendationSummaryList' /ccm/api/governance/enforcement: put: tags: - RuleEnforcement summary: Update a Rule enforcement description: Update a Rule enforcement operationId: updateEnforcement parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing rule enforcement object content: application/json: schema: $ref: '#/components/schemas/CreateRuleEnforcementDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Updated Rule enforcement. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleEnforcement' post: tags: - RuleEnforcement summary: 'Add a new rule Enforcement ' operationId: addRuleEnforcement parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Rule Enforcement object content: application/json: schema: $ref: '#/components/schemas/CreateRuleEnforcementDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns newly created rule enforcement. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleEnforcement' text/yaml: schema: $ref: '#/components/schemas/ResponseDTORuleEnforcement' /ccm/api/governance/enforcement/{enforcementID}: delete: tags: - RuleEnforcement summary: Delete a rule enforcement description: Delete a Rule enforcement for the given a ID. operationId: deleteRuleEnforcement parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enforcementID in: path description: Unique identifier for the rule enforcement required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: A boolean whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/governance/enforcement/count: post: tags: - RuleEnforcement summary: Fetch Rule Enforcements for given RuleIds/RuleSetIds description: Fetch Rule Enforcements for given RuleIds/RuleSetIds operationId: getRuleEnforcementCount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing enforcementCount object content: application/json: schema: $ref: '#/components/schemas/EnforcementCountDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of Rule Enforcements wrt given RuleIds/RuleSetIds content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnforcementCount' /ccm/api/governance/enforcement/details: get: tags: - RuleEnforcement summary: Get Rule Enforcement details for given Enforcement Id description: Get Rule Enforcement details operationId: enforcementDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enforcementId in: query description: Enforcement Id schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Enforcement not found content: application/json: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns Enforcement details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEnforcementDetails' /ccm/api/governance/enforcement/savings: post: tags: - RuleEnforcement summary: Get Rule Enforcement savings for given Enforcement Id description: Get Rule Enforcement savings operationId: enforcementSavings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enforcementId in: query description: Enforcement Id schema: type: string requestBody: description: Request body with time filters content: application/json: schema: type: array items: $ref: '#/components/schemas/CCMTimeFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns Enforcement savings content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMapStringDouble' /ccm/api/governance/enforcement/list: get: tags: - RuleEnforcement summary: Fetch Rule Enforcements for account description: 'Fetch Rule Enforcement ' operationId: getRuleEnforcement parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: searchKey in: query schema: type: string - name: page in: query description: Page number schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Number of items per page schema: type: integer format: int32 example: 20 - name: sortType in: query schema: type: string enum: - NAME - SAVINGS - LAST_UPDATED_AT - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of rules Enforcement content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleEnforcementList' deprecated: true post: tags: - RuleEnforcement summary: Fetch Rule Enforcements for account with filters description: Fetch Rule Enforcements for account with filters operationId: listRuleEnforcements parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing RuleEnforcementFilter object content: application/json: schema: $ref: '#/components/schemas/RuleEnforcementFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of rules Enforcement content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleEnforcementList' /ccm/api/governance/enforcement/toggle: put: tags: - RuleEnforcement summary: Enable/Disable a Rule Enforcement for given Enforcement Id description: Toggle a Rule Enforcement operationId: toggleEnforcement parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: enforcementId in: query description: Enforcement Id schema: type: string - name: enableEnforcement in: query description: Enable Enforcement schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: True/false if Rule Enforcement successfully toggled content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/governance/execution/export: post: tags: - Rule Executions summary: Export evaluations data description: Export evaluations data operationId: exportEvaluations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing evaluationIds list content: application/json: schema: $ref: '#/components/schemas/EvaluationExportRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns signed URL for download content: application/json: schema: $ref: '#/components/schemas/ResponseDTOEvaluationExportResponseDTO' /ccm/api/governance/execution/list: post: tags: - Rule Executions summary: Fetch RuleExecutions for account description: Fetch RuleExecutions operationId: getRuleExecutions parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing CreateRuleExecutionFilterDTO object content: application/json: schema: $ref: '#/components/schemas/CreateRuleExecutionFilterDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of RuleExecution content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleExecutionList' /ccm/api/governance/execution/filter-value: get: tags: - Rule Executions summary: Rule Execution Filter Values description: Rule Execution Filter Values operationId: getRuleExecutionsFilterValues parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns filter values for Rule Execution. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilterValues' /ccm/api/governance/execution/{ruleExecutionId}: get: tags: - Rule Executions summary: Get rule execution operationId: getRuleExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string - name: executionType in: query schema: type: string enum: - INTERNAL - EXTERNAL - INVENTORY_INTERNAL responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return rule execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleExecution' /ccm/api/governance/actionedResources/{ruleExecutionId}: get: tags: - Rule Executions summary: Return actioned resources for a rule execution operationId: getRuleExecutionActionedResources parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return actioned resources for a rule execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSubRuleResponseDetails' deprecated: true /ccm/api/governance/execution/details/{ruleExecutionId}: get: tags: - Rule Executions summary: 'Resources/logs for a rule execution ' operationId: getRuleExecutionDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string - name: fileType in: query description: Select filetype, by default RESOURCE file will be selected schema: type: string enum: - RESOURCE - LOG - RULE_YAML - ACTIONED_RESOURCE - GRANULAR_RESOURCE - RESOURCE_CSV - name: resourceId in: query schema: type: string - name: subRuleName in: query schema: type: string - name: executionType in: query schema: type: string enum: - INTERNAL - EXTERNAL - INVENTORY_INTERNAL responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return resources/logs for a rule execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSubRuleResponseDetails' /ccm/api/governance/granularStatus/{ruleExecutionId}: get: tags: - Rule Executions summary: Return resource for a rule execution operationId: getRuleExecutionGranularStatus parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string - name: resourceId in: query schema: type: string - name: subRuleName in: query schema: type: string - name: executionType in: query schema: type: string enum: - INTERNAL - EXTERNAL - INVENTORY_INTERNAL responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return resource for a rule execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSubRuleResponseDetails' deprecated: true /ccm/api/governance/logs/{ruleExecutionId}: get: tags: - Rule Executions summary: Return logs for a rule execution operationId: getRuleExecutionLogs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string - name: executionType in: query schema: type: string enum: - INTERNAL - EXTERNAL - INVENTORY_INTERNAL responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return logs for a rule execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSubRuleResponseDetails' deprecated: true /ccm/api/governance/ruleYaml/{ruleExecutionId}: get: tags: - Rule Executions summary: Return governance rule yaml for a rule execution operationId: getRuleExecutionRuleYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string - name: executionType in: query schema: type: string enum: - INTERNAL - EXTERNAL - INVENTORY_INTERNAL responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return governance rule yaml for a rule execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSubRuleResponseDetails' deprecated: true /ccm/api/governance/status/{ruleExecutionId}: get: tags: - Rule Executions summary: Return resources for a rule execution operationId: getRuleExecutionStatus parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string - name: executionType in: query schema: type: string enum: - INTERNAL - EXTERNAL - INVENTORY_INTERNAL responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return resources for a rule execution content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListSubRuleResponseDetails' deprecated: true /ccm/api/governance/execution/ruleLastExecution: post: tags: - Rule Executions summary: Find last execution given rules list description: Find last execution given rules list operationId: getRuleLastExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing list of rule ids content: application/json: schema: type: array items: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of RuleExecutions. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListRuleExecution' /ccm/api/governance/execution/refreshCost/{ruleExecutionId}: get: tags: - Rule Executions summary: Refresh cost for a rule execution operationId: refreshCostForRuleExecution parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleExecutionId in: path required: true schema: type: string - name: executionType in: query schema: type: string enum: - INTERNAL - EXTERNAL - INVENTORY_INTERNAL responses: '202': description: Job enqueued to refresh cost for a rule execution content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' /ccm/api/governance/execution/filter-value/tags: post: tags: - Rule Executions summary: Rule Execution Tag Filter Values description: Rule Execution Tag Filter Values operationId: getRuleExecutionTagFilterValues parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing RuleExecutionTagsFilter object content: application/json: schema: $ref: '#/components/schemas/RuleExecutionTagsFilter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns tag filter values for Rule Execution. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/governance/ruleClone: post: tags: - Rule summary: Clone a rule description: Clone a Rule with the given ID. operationId: CloneRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Rule uuid content: application/json: schema: $ref: '#/components/schemas/CloneRuleDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Newly Created Cloned Rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTORule' /ccm/api/governance/rule: put: tags: - Rule summary: Update a Rule description: Update a Rule operationId: updateRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing rule object content: application/json: schema: $ref: '#/components/schemas/CreateRuleDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Updated Rule. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORule' post: tags: - Rule summary: Add a rule description: Create a new governance rule. operationId: CreateNewRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Rule object content: application/json: schema: $ref: '#/components/schemas/CreateRuleDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns newly created rule content: application/json: schema: $ref: '#/components/schemas/ResponseDTORule' /ccm/api/governance/rule/{ruleID}: get: tags: - Rule summary: Get a governance rule description: Get a governance rule with the given ID. operationId: getGovernanceRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleID in: path description: Unique identifier for the rule required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns governance rule. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORule' delete: tags: - Rule summary: Delete a rule description: Delete a Rule with the given ID. operationId: deleteRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleID in: path description: Unique identifier for the rule required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: A boolean whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/governance/enqueue: post: tags: - Rule summary: Enqueue jobs for evaluation. description: Enqueue jobs for evaluation. operationId: enqueueGovernanceJob parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string requestBody: description: Request body for queuing the governance job content: application/json: schema: $ref: '#/components/schemas/GovernanceJobEnqueueDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns evaluation id of jobs which are enqueued. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOGovernanceEnqueueResponseDTO' /ccm/api/governance/enqueueAdhocV2: post: tags: - Rule summary: Simple Request to enqueue rule for execution description: Simple Request to enqueue rule for execution operationId: simpleEnqueueAdhocGovernanceRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string requestBody: description: Request body for queuing the governance rule for execution content: application/json: schema: $ref: '#/components/schemas/GovernanceAdhocEnqueueDTOV2' required: true responses: '202': description: >- Enqueued governance rule for evaluation and return list evaluation ids content: application/json: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' /ccm/api/governance/rule/costCoRelationSupportedResources: get: tags: - Rule summary: List resources for which cost co-relation is supported. description: List resources for which cost co-relation is supported. operationId: costCoRelationSupportedResources parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return List of resources for which cost co-relation is supported. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSetString' /ccm/api/governance/ruleSchema: get: tags: - Rule summary: Custodian Schema description: Get custodian schema for governance rule validation operationId: governanceRuleSchema parameters: - name: accountIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query schema: type: string - name: orgIdentifier in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Custodian Governance Rule Schema content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/governance/rule/potentialRulesForRecommendation: get: tags: - Rule summary: Fetch potential rules that can be enabled for recommendation for account description: Fetch potential rules that can be enabled for recommendation for account operationId: getPotentialRulesForRecommendation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns potential rules that can be enabled for recommendation for account content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListRule' /ccm/api/governance/rule/list: post: tags: - Rule summary: Fetch rules for account description: 'Fetch rules ' operationId: getPolicies parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: RuleNamePattern in: query description: Search by Rule name pattern schema: type: string requestBody: description: Request body containing rule object content: application/json: schema: $ref: '#/components/schemas/ListDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of rules content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleList' /ccm/api/governance/governanceTargetList: get: tags: - Rule summary: Governance Targets description: Get targets with governance enabled and valid permission operationId: governanceTargetList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: view in: query description: View governance target list schema: type: boolean - name: cloudProvider in: query description: Cloud Provider required: true schema: type: string enum: - AWS - AZURE - GCP - name: onlyTargetIds in: query description: Only Target ids schema: type: boolean - name: isDryRun in: query description: Dry Run schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: List of Governance Targets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMapStringString' /ccm/api/governance/regions: get: tags: - Rule summary: List of Regions for Aws/Azure description: List Aws/Azure Regions for filtering resources. operationId: regions parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: cloudProvider in: query description: Cloud Provider required: true schema: type: string enum: - AWS - AZURE - GCP responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Return List of Aws/Azure Regions content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/governance/rule/toggleForRecommendation: put: tags: - Rule summary: Enable/Disable a custom Rule to be considered for recommendation description: Toggle a Rule for Recommendation operationId: toggleForRecommendation parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleId in: query description: Rule Id schema: type: string - name: enableRuleForRecommendation in: query description: Enable rule for Recommendation schema: type: boolean requestBody: description: List of target IDs to be associated with the rule content: application/json: schema: $ref: '#/components/schemas/ToggleForRecommendationRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: True/false if toggle is successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTORule' /ccm/api/governance/ruleValidate: post: tags: - Rule summary: Validate Governance Rule description: Validate governance rule for syntactical errors. operationId: validateGovernanceRule parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Rule with set rulesYaml to validate content: application/json: schema: $ref: '#/components/schemas/CreateRuleDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: content: application/json: {} /ccm/api/governance/ruleSet: put: tags: - Rule Sets summary: Update a Rule set description: Update a Rule set operationId: updateRuleSet parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Rule Set object content: application/json: schema: $ref: '#/components/schemas/CreateRuleSetDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: update a existing Rule Set content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleSet' post: tags: - Rule Sets summary: 'Add a rule Set ' operationId: addRuleSet parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing rule Set object content: application/json: schema: $ref: '#/components/schemas/CreateRuleSetDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns newly created rule Set content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleSet' /ccm/api/governance/ruleSet/{ruleSetId}: delete: tags: - Rule Sets summary: Delete a rule set description: Delete a Rule set for the given a ID. operationId: deleteRuleSet parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: ruleSetId in: path description: Unique identifier for the rule required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: A boolean whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/governance/ruleSet/list: post: tags: - Rule Sets summary: Fetch rule sets for account description: List all rule sets operationId: listRuleSets parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing rule set object content: application/json: schema: $ref: '#/components/schemas/CreateRuleSetFilterDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of rule sets content: application/json: schema: $ref: '#/components/schemas/ResponseDTORuleSetList' /ccm/api/perspectiveFolders/create: post: tags: - Perspectives Folders summary: Create a Perspective folder description: Create a Perspective Folder. operationId: createPerspectiveFolder parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing Perspective's CEViewFolder object content: application/json: schema: $ref: '#/components/schemas/CreatePerspectiveFolderDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a created CEViewFolder object with all its details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCEViewFolder' /ccm/api/perspectiveFolders/{folderId}: delete: tags: - Perspectives Folders summary: Delete a folder description: Delete a Folder for the given Folder ID. operationId: deleteFolder parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: folderId in: path description: Unique identifier for the Perspective folder required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: A boolean whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/perspectiveFolders: get: tags: - Perspectives Folders summary: Fetch folders for an account description: Fetch folders given an accountId operationId: getFolders parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: folderNamePattern in: query description: Search by folder name pattern schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of CEViewFolders content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCEViewFolder' put: tags: - Perspectives Folders summary: Update a folder description: Update a folder operationId: updateFolder parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing ceViewFolder object content: application/json: schema: $ref: '#/components/schemas/CEViewFolder' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: CEViewFolder object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCEViewFolder' /ccm/api/perspectiveFolders/{folderId}/perspectives: get: tags: - Perspectives Folders summary: Return details of all the Perspectives description: >- Return details of all the Perspectives for the given account ID and folder operationId: getAllFolderPerspectives parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: folderId in: path description: Unique identifier for folder required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a List of Perspectives content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListPerspective' /ccm/api/perspectiveFolders/movePerspectives: post: tags: - Perspectives Folders summary: Move a Perspective description: Move a perspective from a folder to another. operationId: movePerspectives parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing perspectiveIds to be moved and newFolderId content: application/json: schema: $ref: '#/components/schemas/MovePerspectiveDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the new CEView object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCEView' /ccm/api/perspectiveReport/{accountIdentifier}: get: tags: - Perspective Reports summary: Fetch details of a cost Report description: Fetch cost Report details for the given Report ID or a Perspective ID. operationId: getReportSetting parameters: - name: perspectiveId in: query description: Unique identifier for the Perspective schema: type: string - name: reportId in: query description: Unique identifier for the Report schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of Report Schedules content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCEReportSchedule' put: tags: - Perspective Reports summary: Update a cost Perspective Report description: Update cost Perspective Reports. operationId: updateReportSetting parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: CEReportSchedule object to be updated content: application/json: schema: $ref: '#/components/schemas/CEReportSchedule' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of Report Schedules content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCEReportSchedule' post: tags: - Perspective Reports summary: Create a schedule for a Report description: Create a report schedule for the given Report ID or a Perspective ID. operationId: createReportSetting parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: CEReportSchedule object to be saved content: application/json: schema: $ref: '#/components/schemas/CEReportSchedule' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of Report Schedules content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCEReportSchedule' delete: tags: - Perspective Reports summary: Delete cost Perspective report description: >- Delete cost Perspective Report for the given Report ID or a Perspective ID. operationId: deleteReportSetting parameters: - name: reportId in: query description: Unique identifier for the Report schema: type: string - name: perspectiveId in: query description: Unique identifier for the Perspective schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a generic string message when the operation is successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/perspectiveReport/getAllReports: post: tags: - Perspective Reports summary: Fetch cost Report details accessible to a user description: Fetch cost Report details accessible to a user. operationId: getAllReports parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Filters for perspective reports content: application/json: schema: $ref: '#/components/schemas/PerspectiveReportsFiltersDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a list of Report Schedules content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCEReportScheduleResponseDTO' /ccm/api/perspectiveReport/sendMail: post: tags: - Perspective Reports summary: Send mail based on reportId description: Send mail based on reportId. operationId: sendMail parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Send Mail Request content: application/json: schema: $ref: '#/components/schemas/SendMailRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a boolean indicating if the mail was sent or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/perspective: get: tags: - Perspectives summary: Fetch details of a Perspective description: Fetch details of a Perspective for the given Perspective ID. operationId: getPerspective parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: Unique identifier for the Perspective required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a CEView object with all the rules and filters, returns null if no Perspective exists for that particular identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCEView' put: tags: - Perspectives summary: Update a Perspective description: >- Update a Perspective. It accepts a CEView object and upserts it using the uuid mentioned in the definition. operationId: updatePerspective parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Perspective's CEView object content: application/json: schema: $ref: '#/components/schemas/CEView' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Upserted CEView object with all the rules and filters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCEView' post: tags: - Perspectives summary: Create a Perspective description: >- Create a Perspective. You can set the clone parameter as true to clone a Perspective. operationId: createPerspective parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: clone in: query description: Set the clone parameter as true to clone a Perspective. required: true schema: type: boolean requestBody: description: Request body containing Perspective's CEView object content: application/json: schema: $ref: '#/components/schemas/CEView' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a created CEView object with all the rules and filters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCEView' delete: tags: - Perspectives summary: Delete a Perspective description: Delete a Perspective for the given Perspective ID. operationId: deletePerspective parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: Unique identifier for the Perspective required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: A string text message whether the delete was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/perspective/getAllPerspectives: get: tags: - Perspectives summary: Return details of all the Perspectives description: Return details of all the Perspectives for the given account ID. operationId: getAllPerspectives parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: pageSize in: query description: Number of perspectives to be shown required: true schema: type: integer format: int32 default: 20 - name: pageNo in: query description: Number of records to be skipped required: true schema: type: integer format: int32 default: 0 - name: searchKey in: query description: Characters in search bar schema: type: string - name: sortType in: query description: ' sorting filters in UI' schema: type: string default: TIME enum: - TIME - COST - CLUSTER_COST - NAME - LAST_UPDATED - name: sortOrder in: query description: sorting order schema: type: string default: DESCENDING enum: - ASCENDING - DESCENDING - name: cloudFilters in: query description: filters for clouds and clusters schema: type: array items: type: string enum: - AWS - AZURE - GCP - CLUSTER - DEFAULT - name: viewState in: query description: filter by perspective state schema: type: string enum: - DRAFT - COMPLETED - name: viewIds in: query description: filter by perspective ids schema: type: array items: type: string - name: viewType in: query description: filter by view type schema: type: string enum: - SAMPLE - CUSTOMER - DEFAULT responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a List of Perspectives content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPerspectiveData' /ccm/api/perspective/lastPeriodCost: get: tags: - Perspectives summary: Get the last period cost for a Perspective description: Get last period cost for a Perspective operationId: getLastPeriodCost_1 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: The Perspective identifier for which we want the cost required: true schema: type: string - name: startTime in: query description: The Start time (timestamp in millis) for the current period required: true schema: type: integer format: int64 - name: period in: query description: >- The period (DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY) for which we want the cost required: true schema: type: string enum: - DAILY - WEEKLY - MONTHLY - QUARTERLY - YEARLY responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a number having the cost of last period content: application/json: schema: $ref: '#/components/schemas/ResponseDTODouble' /ccm/api/perspective/lastYearMonthlyCost: get: tags: - Perspectives summary: Get the last twelve month cost for a Perspective description: Get last twelve month cost for a Perspective operationId: getLastYearMonthlyCost parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: perspectiveId in: query description: The Perspective identifier for which we want the cost required: true schema: type: string - name: startTime in: query description: The Start time (timestamp in millis) for the current period required: true schema: type: integer format: int64 - name: period in: query description: Only support for YEARLY budget period required: true schema: type: string enum: - DAILY - WEEKLY - MONTHLY - QUARTERLY - YEARLY - name: type in: query description: Only support for PREVIOUS_PERIOD_SPEND budget type required: true schema: type: string description: >- Whether the Budget is based on a specified amount or based on previous month's actual spend enum: - SPECIFIED_AMOUNT - PREVIOUS_MONTH_SPEND - PREVIOUS_PERIOD_SPEND - name: breakdown in: query description: Only support for MONTHLY breakdown required: true schema: type: string description: Whether the Yearly budget breakdown is yearly or monthly enum: - YEARLY - MONTHLY responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Return list of actual monthly budget cost and respective month in epoch content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListValueDataPoint' /ccm/api/recommendation/cost-category/jira-mapping/bulk: put: tags: - Cost Category Jira Project Mapping summary: Bulk sync cost category jira project mappings description: >- Bulk sync cost category jira project mappings. This syncs the database to match the provided list by creating new mappings, updating existing ones, and deleting mappings not in the list. operationId: bulkSyncCostCategoryJiraMappings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Complete list of cost category jira mappings (final state from UI) content: application/json: schema: type: array items: $ref: '#/components/schemas/CostCategoryJiraMapping' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of all mappings after sync content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCostCategoryJiraMapping' /ccm/api/recommendation/cost-category/jira-mapping: get: tags: - Cost Category Jira Project Mapping summary: List all cost category jira project mapping description: List all cost category jira project mapping operationId: listCostCategoryJiraMapping parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of cost category jira project mapping content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCostCategoryJiraMapping' post: tags: - Cost Category Jira Project Mapping summary: Create cost category jira project mapping description: Create cost category jira project mapping operationId: createCostCategoryJiraMapping parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing cost category jira mapping details content: application/json: schema: $ref: '#/components/schemas/CostCategoryJiraMapping' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the created cost category jira mapping id content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /ccm/api/recommendation/cost-category/jira-mapping/{mappingId}: get: tags: - Cost Category Jira Project Mapping summary: Get cost category jira project preference by ID description: Get cost category jira project preference by ID operationId: getCostCategoryJiraMapping parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: mappingId in: path description: Mapping ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the cost category jira project preference content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCostCategoryJiraMapping' put: tags: - Cost Category Jira Project Mapping summary: Update cost category jira project mapping description: Update cost category jira project mapping operationId: updateCostCategoryJiraMapping parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: mappingId in: path description: Mapping ID required: true schema: type: string requestBody: description: >- Request body containing cost category jira project mapping update details content: application/json: schema: $ref: '#/components/schemas/CostCategoryJiraMapping' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the updated cost category jira project mapping content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCostCategoryJiraMapping' delete: tags: - Cost Category Jira Project Mapping summary: Delete cost category jira project mapping description: Delete cost category jira project mapping operationId: deleteCostCategoryJiraMapping parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: mappingId in: path description: Preference ID required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns true if deleted successfully content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/details/azure-vm: get: tags: - Recommendations Details summary: Return Azure VM Recommendation description: >- Returns Azure VM Recommendation details for the given Recommendation identifier. operationId: azureVmRecommendationDetail parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query description: Azure VM Recommendation identifier. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the Azure VM Recommendation for the given identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOAzureVmRecommendation' /ccm/api/recommendation/details/ec2-instance: get: tags: - Recommendations Details summary: Return EC2 Recommendation description: >- Returns EC2 or AWS Passthrough V2 Recommendation details for the given Recommendation identifier. operationId: ec2RecommendationDetail parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query description: EC2 Recommendation identifier. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the EC2 Recommendation for the given identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationDetailsDTO' /ccm/api/recommendation/details/ecs-service: get: tags: - Recommendations Details summary: Return ECS Recommendation description: >- Returns ECS Recommendation details for the given Recommendation identifier. operationId: ecsRecommendationDetail parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query description: ECS Recommendation identifier. required: true schema: type: string - name: from in: query description: >- Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z' Defaults to Today-7days schema: type: string - name: to in: query description: >- Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z' Defaults to Today schema: type: string - name: bufferPercentage in: query description: Buffer Percentage defaults to zero schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the ECS Recommendation for the given identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOECSRecommendationDTO' /ccm/api/recommendation/details/node-pool: get: tags: - Recommendations Details summary: Return node pool Recommendation description: Returns node pool Recommendation details for the given identifier. operationId: nodeRecommendationDetail parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query description: Node pool Recommendation identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns node pool Recommendation details for the given identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTONodeRecommendationDTO' /ccm/api/recommendation/details/workload: get: tags: - Recommendations Details summary: Return workload Recommendation description: >- Returns workload Recommendation details for the given Recommendation identifier. operationId: workloadRecommendationDetail parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: query description: Workload Recommendation identifier. required: true schema: type: string - name: from in: query description: >- Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z' Defaults to Today-7days schema: type: string - name: to in: query description: >- Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z' Defaults to Today schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the workload Recommendation for the given identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOWorkloadRecommendationDTO' /ccm/api/recommendation/overview/stats/applied: post: tags: - Recommendations summary: >- Returns Applied Recommendations statistics grouped by Resource type with total savings description: >- Returns the Applied Recommendations statistics grouped by resource type with total savings. operationId: appliedRecommendationResourceStats parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Recommendations filter body. content: application/json: schema: $ref: '#/components/schemas/CCMRecommendationFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the statistics of applied Recommendations. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOListAppliedRecommendationResourceStatsDTO /ccm/api/recommendation/overview/change-inference-status: post: tags: - Recommendations summary: Return void description: Mark recommendation as inferred verified/rejected operationId: changeInferenceState parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRecommendationInferenceStatusDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns void. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOVoid' /ccm/api/recommendation/overview/change-state: post: tags: - Recommendations summary: Return void description: Mark recommendation as applied/open operationId: changeRecommendationState parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: recommendationId in: query required: true schema: type: string - name: state in: query required: true schema: type: string enum: - OPEN - APPLIED - IGNORED - TEMPORARILY_IGNORED requestBody: content: application/json: schema: $ref: '#/components/schemas/RecommendationChangeStateDTO' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns void. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOVoid' /ccm/api/recommendation/overview/count: post: tags: - Recommendations summary: Return the number of Recommendations description: >- Returns the total number of Recommendations based on the specified filters. operationId: recommendationsCount parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Recommendations filter body. content: application/json: schema: $ref: '#/components/schemas/CCMRecommendationFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the count of all Recommendations available. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOInteger' /ccm/api/recommendation/overview/filter-values: post: tags: - Recommendations summary: Return the list of filter values for the Recommendations description: Returns the list of filter values for all the specified filters. operationId: recommendationFilterValues parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Recommendation Filter Values Body. content: application/json: schema: $ref: '#/components/schemas/FilterValues' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the values available for a filter. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListFilterStats' /ccm/api/recommendation/overview/supported-filters: get: tags: - Recommendations summary: Return list of supported recommendation filters description: Returns the list of supported filter field IDs for recommendations. operationId: getSupportedRecommendationFilters parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of supported filter field IDs. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/recommendation/overview/iacm: post: tags: - Recommendations summary: Return Recommendations for IaCM Resources description: >- Returns complete Recommendations for IaCM-managed resources based on cloud-native identifiers (ARNs, FQNs, GRNs) and Terraform provider/type metadata. operationId: iacmResourceRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: IaCM resource recommendation request content: application/json: schema: $ref: '#/components/schemas/IacmResourceRecommendationRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the Recommendations for specified IaCM resources. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOIacmResourceRecommendations' /ccm/api/recommendation/overview/list: post: tags: - Recommendations summary: Return the list of Recommendations description: Returns the list of Recommendations for the specified filters. operationId: listRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Recommendations filter body. content: application/json: schema: $ref: '#/components/schemas/CCMRecommendationFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of Recommendations available. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendations' /ccm/api/recommendation/overview/override-savings: put: tags: - Recommendations summary: Return boolean description: Override savings for recommendation operationId: overrideRecommendationSavings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: recommendationId in: query required: true schema: type: string - name: overriddenSavings in: query required: true schema: type: number format: double responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns boolean content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/overview/realized-savings: post: tags: - Recommendations summary: Return time series statistics for realized savings with date information description: >- Returns the time series statistics for realized savings from applied recommendations. operationId: realizedSavingsTimeSeries parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: timeAggregation in: query description: Time aggregation (daily, weekly, monthly, yearly). schema: type: string enum: - DAILY - WEEKLY - MONTHLY - YEARLY requestBody: description: Recommendations filter body. content: application/json: schema: $ref: '#/components/schemas/CCMRecommendationFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns the time series statistics for realized savings from applied recommendations. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOListRecommendationRealizedSavingStatsDTO /ccm/api/recommendation/overview/resource-type/stats: post: tags: - Recommendations summary: Return Recommendations statistics Grouped on Resource Type description: >- Returns the Recommendations statistics for the specified filters Grouped on Resource Type. operationId: recommendationResourceTypeStats parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Recommendations filter body. content: application/json: schema: $ref: '#/components/schemas/CCMRecommendationFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns the statistics of all Recommendations available Grouped on Resource Type. content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOListRecommendationResourceTypeStats /ccm/api/recommendation/overview/stats: post: tags: - Recommendations summary: Return Recommendations statistics description: Returns the Recommendations statistics for the specified filters. operationId: recommendationStats parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Recommendations filter body. content: application/json: schema: $ref: '#/components/schemas/CCMRecommendationFilterProperties' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the statistics of all Recommendations available. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationOverviewStats' /ccm/api/recommendation/jira/create: post: tags: - Recommendation Jira summary: Create jira for recommendation description: Create jira for recommendation operationId: createRecommendationJira parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing CACMJiraDetails content: application/json: schema: $ref: '#/components/schemas/CCMJiraCreateDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a created CACMJiraDetails object with all the jira details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCCMJiraDetails' /ccm/api/recommendation/jira/field-mapping: get: tags: - Recommendation Jira summary: Get all Jira field mappings description: Get all Jira field mappings for account operationId: getJiraFieldMappings parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns all field mappings content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOMapStringMapStringJiraFieldMappingValue post: tags: - Recommendation Jira summary: Replace Jira field mappings for a field type description: >- Replaces all Jira field mappings for the given fieldType (savings or variance) with the provided set operationId: upsertJiraFieldMapping parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: fieldType in: query description: 'Field type to set: ''savings'' or ''variance''' required: true schema: type: string requestBody: description: >- Complete set of field mappings for this fieldType. Replaces all existing mappings for this fieldType. content: application/json: schema: type: array items: $ref: '#/components/schemas/JiraFieldMappingRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns updated field mappings content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOMapStringMapStringJiraFieldMappingValue delete: tags: - Recommendation Jira summary: Delete Jira field mapping description: >- Delete Jira field mapping for a project, optionally for a specific issue type operationId: deleteJiraFieldMapping parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: projectKey in: query required: true schema: type: string - name: issueType in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns remaining field mappings content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOMapStringMapStringJiraFieldMappingValue /ccm/api/recommendation/jira/delete: post: tags: - Recommendation Jira summary: Delete Jira from recommendations description: Delete Jira details from recommendations operationId: deleteJiraFromRecommendations parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: application/json: schema: type: array description: List of recommendation ids to perform jira cleanup on. items: type: string description: List of recommendation ids to perform jira cleanup on. required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Deletes Jira details from recommendations content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/jira/statuses: get: tags: - Recommendation Jira summary: Get all jira statuses description: Get all jira statuses operationId: getJiraStatuses parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns applied preferences content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/recommendation/jira/common-fields: post: tags: - Recommendation Jira summary: Get common Jira fields across projects and issue types description: Get intersection of fields across multiple projects and issue types operationId: getCommonJiraFields parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- Request body containing connector ref, project keys, issue types, and optional field type content: application/json: schema: $ref: '#/components/schemas/CCMJiraFieldsRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns list of common fields across the specified projects and issue types content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListCCMJiraFieldDTO' /ccm/api/recommendation/jira/common-issue-types: post: tags: - Recommendation Jira summary: Get common Jira issue types across projects description: Get intersection of issue types across multiple Jira projects operationId: getCommonJiraIssueTypes parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing connector ref and project keys content: application/json: schema: $ref: '#/components/schemas/CCMJiraIssueTypesRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of common issue types across the specified projects content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/recommendation/jira/mapped-projects: get: tags: - Recommendation Jira summary: Get mapped jira projects for given recommendation description: Get mapped jira projects for given recommendation operationId: getMappedProjects parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: recommendationId in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns jira project details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListJiraProjectDetails' /ccm/api/recommendation/jira/resolution-code: get: tags: - Recommendation Jira summary: Get all jira resolution codes description: Get all jira resolution codes operationId: getResolutionCodes parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns jira resolution codes content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/recommendation/preference/cloud-account-override/{uuid}: put: tags: - Recommendation Preferences summary: Update a cloud account override description: Update the cloud accounts for an existing override identified by its ID operationId: updateCloudAccountOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: uuid in: path description: Unique identifier for the override required: true schema: type: string requestBody: description: Updated list of cloud accounts content: application/json: schema: type: array items: $ref: '#/components/schemas/CCMCloudAccount' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns true if the override was updated successfully content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' delete: tags: - Recommendation Preferences summary: Delete a cloud account override description: Delete a cloud account level preset override by its ID operationId: deleteCloudAccountOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: uuid in: path description: Unique identifier for the override required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns true if the override was deleted successfully content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/preference: get: tags: - Recommendation Preferences summary: Get applied preferences for given account description: Get applied preferences for given account operationId: getRecommendationPreferences parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns applied preferences content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationPreferenceDTO' put: tags: - Recommendation Preferences summary: Update preference description: update preferences for your recommendations operationId: updatePreset parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Preference definition content: application/json: schema: $ref: '#/components/schemas/RecommendationPreference' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns true or false content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/preference/cloud-account-override/overview: get: tags: - Recommendation Preferences summary: Get cloud account override overview description: >- Get an overview of cloud provider recommendation preferences with default presets and override counts per resource type operationId: getCloudAccountOverrideOverview parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns overview of preferences per resource type content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOListCloudProviderPreferenceOverviewDTO /ccm/api/recommendation/preference/cloud-account-override: get: tags: - Recommendation Preferences summary: List cloud account overrides by resource type description: List all cloud account level preset overrides for a given resource type operationId: listCloudAccountOverridesByResourceType parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: resourceType in: query description: Resource type to list overrides for required: true schema: type: string enum: - WORKLOAD - NODE_POOL - ECS_SERVICE - EC2_INSTANCE - EC2_INSTANCE_V2 - GOVERNANCE - AZURE_INSTANCE - AZURE_VM - AZURE_VMSS - AZURE_DATABASE - AZURE_STORAGE - AZURE_FILES - AZURE_APP_SERVICE - EC2_AUTO_SCALING_GROUP - EBS_VOLUME - RDS_DB_INSTANCE - RDS_DB_INSTANCE_STORAGE responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns list of cloud account overrides content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOListCloudProviderRecommendationPreferenceDTO post: tags: - Recommendation Preferences summary: Create a cloud account override description: >- Create a cloud account level preset override for recommendations. If an override already exists for the same resource type and preset, the cloud accounts will be merged into the existing record. operationId: createCloudAccountOverride parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Cloud account override definition content: application/json: schema: $ref: '#/components/schemas/CloudProviderRecommendationPreference' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns true if the override was created or updated successfully content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/preset/{id}: put: tags: - Recommendation Presets summary: Update an existing preset description: Update an existing Recommendation Preset for the given Preset ID. operationId: updatePreset_1 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the budget required: true schema: type: string requestBody: description: The preset object content: application/json: schema: $ref: '#/components/schemas/RecommendationPreset' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a generic string message when the operation is successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' delete: tags: - Recommendation Presets summary: Delete a preset description: Delete a Recommendation preset for the given preset ID. operationId: deletePreset parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: id in: path description: Unique identifier for the preset required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a text message whether the operation was successful content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/preset: get: tags: - Recommendation Presets summary: Get all presets for given account description: Get all presets for given account operationId: getRecommendationPresets parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: resourceType in: query schema: type: string enum: - WORKLOAD - NODE_POOL - ECS_SERVICE - EC2_INSTANCE - EC2_INSTANCE_V2 - GOVERNANCE - AZURE_INSTANCE - AZURE_VM - AZURE_VMSS - AZURE_DATABASE - AZURE_STORAGE - AZURE_FILES - AZURE_APP_SERVICE - EC2_AUTO_SCALING_GROUP - EBS_VOLUME - RDS_DB_INSTANCE - RDS_DB_INSTANCE_STORAGE responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns presets content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListRecommendationPreset' post: tags: - Recommendation Presets summary: Create a Preset description: Create a Preset to set preferences for your recommendations operationId: createPreset parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Preset definition content: application/json: schema: $ref: '#/components/schemas/RecommendationPreset' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns true or false content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/recommendation/servicenow/create: post: tags: - Recommendation Servicenow summary: Create servicenow ticket for recommendation description: Create Servicenow ticket for recommendation operationId: createRecommendationServicenowTicket parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing CACMServiceNowDetails content: application/json: schema: $ref: '#/components/schemas/CCMServiceNowCreateDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: >- Returns a created CACMServiceNowDetails object with all the servicenow ticket details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOCCMServiceNowDetails' /ccm/api/recommendation/servicenow/serviceRequestFields: get: tags: - Recommendation Servicenow operationId: getServiceNowServiceRequestFields parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: connectorRef in: query description: ServiceNow connector reference required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' /ccm/api/recommendation/tags: get: tags: - Recommendation Tags summary: Get tags for given recommendation description: Get tags key value pairs for given recommendation operationId: getRecommendationTags parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: recommendationId in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns tags content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationTagDTO' /ccm/api/recommendation/tags/filter-panel: get: tags: - Recommendation Tags summary: >- Get tag (keys)/(values for a particular tag key) for recommendation filter panel description: >- Get tag (keys)/(values for a particular tag key) for recommendation filter panel operationId: getTagsForFilterPanel parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: tagKey in: query schema: type: string - name: search in: query schema: type: string - name: limit in: query schema: type: integer format: int32 - name: offset in: query schema: type: integer format: int32 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns List of tagKeys/tagValues content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListString' /ccm/api/recommendation/ignore-list/add: post: tags: - Recommendation Ignore List summary: Add resources to recommendations ignore list description: Add resources to recommendations ignore list operationId: addRecommendationsIgnoreList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing IgnoreList content: application/json: schema: $ref: '#/components/schemas/RecommendationsIgnoreResourcesDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns ignore list content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationsIgnoreList' /ccm/api/recommendation/ignore-list: get: tags: - Recommendation Ignore List summary: Get resources in recommendations ignore list description: Get resources in recommendations ignore list operationId: getRecommendationsIgnoreList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns ignore list content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationsIgnoreList' /ccm/api/recommendation/ignore-list/remove: post: tags: - Recommendation Ignore List summary: Remove resources from recommendations ignore list description: Remove resources from recommendations ignore list operationId: removeRecommendationsIgnoreList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Request body containing IgnoreList content: application/json: schema: $ref: '#/components/schemas/RecommendationsIgnoreResourcesDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' default: description: Returns ignore list content: application/json: schema: $ref: '#/components/schemas/ResponseDTORecommendationsIgnoreList' /ccm/api/filters: get: tags: - Filter summary: List Filters description: Lists Filters for the given criteria. operationId: CcmgetFilterList parameters: - name: pageIndex in: query description: >- Page number of navigation. If left empty, default value of 0 is assumed. schema: type: integer format: int32 default: 0 - name: pageSize in: query description: >- Number of entries per page. If left empty, default value of 100 is assumed schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline - name: searchTerm in: query description: Text to search/filter the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the list of Filters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' put: tags: - Filter summary: Update a Filter description: Updates the filter for the given ID. operationId: CcmupdateFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated Filter. This should have all the fields not just the updated ones content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns the updated Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' post: tags: - Filter summary: Create a Filter description: Creates a Filter. operationId: CcmpostFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Connector to create content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns created Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' /ccm/api/filters/{identifier}: get: tags: - Filter summary: Return Filter Details description: Returns the settings of a filter for the given ID. operationId: CcmgetFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns Filter having filterIdentifier as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' delete: tags: - Filter summary: Delete a Filter description: Deletes a filter for the given ID. operationId: CcmdeleteFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /ccm/api/usage/cd/active-services/csv/download: get: tags: - Usage summary: Download CSV Active Services report operationId: CcmdownloadActiveServiceCSVReport parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: timestamp in: query schema: type: integer format: int64 default: 0 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Download CSV Active Services report /ccm/api/usage/CD/serviceInstancesLicense: get: tags: - Usage summary: Gets License Usage By Module, Timestamp, and Account Identifier operationId: CcmgetCDLicenseUsageForServiceInstances parameters: - name: accountIdentifier in: query description: Account id to get the license usage. schema: type: string - name: timestamp in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a license usage object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceInstanceUsageDTO' /ccm/api/usage/CD/servicesLicense: get: tags: - Usage summary: Gets License Usage By Module, Timestamp, and Account Identifier operationId: CcmgetCDLicenseUsageForServices parameters: - name: accountIdentifier in: query description: Account id to get the license usage. schema: type: string - name: timestamp in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a license usage object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOServiceUsageDTO' /ccm/api/usage/{module}: get: tags: - Usage summary: Gets License Usage By Module, Timestamp, and Account Identifier operationId: CcmgetLicenseUsage parameters: - name: accountIdentifier in: query description: Account id to get the license usage. schema: type: string - name: module in: path description: A Harness platform module. required: true schema: type: string - name: timestamp in: query schema: type: integer format: int64 - name: CDLicenseType in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/CcmError' application/yaml: schema: $ref: '#/components/schemas/CcmError' default: description: Returns a license usage object content: application/json: schema: $ref: '#/components/schemas/ResponseDTOLicenseUsage' /cf/admin/anomalies/{identifier}/dismiss: put: description: >- Dismisses A CCM Anomaly, which essentially sets it as acknowledged in the database operationId: DismissAnomaly parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '200': description: Anomaly Dismissed. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Dismisses an Anomaly tags: - Anomalies /cf/admin/apikey: get: description: Returns all the API Keys for an Environment operationId: GetAllAPIKeys parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' responses: '200': $ref: '#/components/responses/APIKeysResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns API Keys for an Environment tags: - API Keys post: description: Creates an API key for the given Environment operationId: AddAPIKey parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/projectQueryParam' requestBody: $ref: '#/components/requestBodies/APIKeyRequest' responses: '201': $ref: '#/components/responses/APIKeyResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Creates an API key for the given Environment tags: - API Keys /cf/admin/apikey/{identifier}: delete: description: Deletes an API key for the given identifier operationId: DeleteAPIKey parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' responses: '204': description: No content '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Deletes an API Key tags: - API Keys get: description: Returns all the API Keys for the given identifier operationId: GetAPIKey parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' responses: '200': $ref: '#/components/responses/APIKeyResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns API keys tags: - API Keys put: description: Updates an API key for the given identifier operationId: UpdateAPIKey parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' requestBody: $ref: '#/components/requestBodies/APIKeyUpdateRequest' responses: '200': description: Updated '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Updates an API Key tags: - API Keys /cf/admin/attributes: get: description: Returns all the custom attributes the given environment operationId: GetAttributes parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/customAttributeQueryParam' - $ref: '#/components/parameters/attributeCounts' responses: '200': $ref: '#/components/responses/AttributesResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns all custom attributes for the project tags: - Attributes post: description: Creates a custom attribute for given environment operationId: CreateAttribute parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' requestBody: $ref: '#/components/requestBodies/AttributeRequest' responses: '201': $ref: '#/components/responses/AttributeEditResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Creates a custom Attribute tags: - Attributes /cf/admin/attributes/{key}: delete: description: Delete an Attribute for the given key and environmentID operationId: DeleteAttribute parameters: - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '204': description: No content '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Delete an Attribute tags: - Attributes get: description: Returns Attribute operationId: GetAttribute parameters: - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '200': $ref: '#/components/responses/AttributeResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns an Attribute tags: - Attributes patch: description: Updates Attribute key details for the given environment operationId: PatchAttribute parameters: - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' requestBody: $ref: '#/components/requestBodies/AttributePatchRequest' responses: '200': $ref: '#/components/responses/AttributeEditResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Update Attribute for the environment tags: - Attributes /cf/admin/environments/perspectives: delete: description: >- Deletes a perspective from an environment. An Environment can only have one Perspective operationId: DeletePerspective parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '204': description: No content '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Delete a Perspective - Environment link. tags: - Environment Perspectives put: description: >- Adds a perspective to an environment, or updates an existing. An Environment can only have one Perspective operationId: UpsertPerspective parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' requestBody: $ref: '#/components/requestBodies/EnvironmentPerspectiveUpsertRequest' responses: '200': $ref: '#/components/responses/EnvironmentPerspectiveResponse' '201': $ref: '#/components/responses/EnvironmentPerspectiveResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Upsert a Perspective to an Environment. tags: - Environment Perspectives /cf/admin/features: get: description: Returns all the Feature Flag details for the given project operationId: GetAllFeatures parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentOptionalQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/sortByField' - $ref: '#/components/parameters/nameQueryParam' - $ref: '#/components/parameters/identifierQueryParam' - $ref: '#/components/parameters/archivedQueryParam' - $ref: '#/components/parameters/kindQueryParam' - $ref: '#/components/parameters/targetOptionalParam' - $ref: '#/components/parameters/targetFilterOptionalParam' - $ref: '#/components/parameters/featuresOptionalParam' - $ref: '#/components/parameters/excludedFeaturesOptionalParam' - $ref: '#/components/parameters/flagStatus' - $ref: '#/components/parameters/flagLifetime' - $ref: '#/components/parameters/flagEnabled' - $ref: '#/components/parameters/flagCounts' - $ref: '#/components/parameters/flagSummary' - $ref: '#/components/parameters/flagTags' responses: '200': $ref: '#/components/responses/FeaturesResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns all Feature Flags for the project tags: - Feature Flags post: description: Creates a Feature Flag in the Project operationId: CreateFeatureFlag parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' requestBody: $ref: '#/components/requestBodies/FeatureFlagRequest' responses: '201': $ref: '#/components/responses/FeatureEditResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Creates a Feature Flag tags: - Feature Flags /cf/admin/features/{identifier}: delete: description: Delete Feature Flag for the given identifier and account ID operationId: DeleteFeatureFlag parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/commitMsgQueryParam' - $ref: '#/components/parameters/forceDeleteQueryParam' responses: '204': description: No content '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Delete a Feature Flag tags: - Feature Flags get: description: >- Returns details such as Variation name, identifier etc for the given Feature Flag operationId: GetFeatureFlag parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentOptionalQueryParam' - $ref: '#/components/parameters/archivedQueryParam' responses: '200': $ref: '#/components/responses/FeatureResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns a Feature Flag tags: - Feature Flags patch: description: > This operation is used to modify a Feature Flag. The request body can include one or more instructions that can modify flag attributes such as the state (off|on), the variations that are returned and serving rules. For example if you want to turn a flag off you can use this opeartion and send the setFeatureFlagState { "kind": "setFeatureFlagState", "parameters": { "state": "off" } } operationId: PatchFeature parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentOptionalQueryParam' requestBody: $ref: '#/components/requestBodies/FeaturePatchRequest' responses: '200': $ref: '#/components/responses/FeatureEditResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Updates a Feature Flag tags: - Feature Flags put: description: Updates a Feature Flag in the Project operationId: PutFeatureFlag parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' requestBody: $ref: '#/components/requestBodies/FeatureFlagPutRequest' responses: '200': $ref: '#/components/responses/FeatureEditResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Updates a Feature Flag tags: - Feature Flags /cf/admin/features/{identifier}/dependants: get: description: Given identifier return list all the flags which depend on it. operationId: GetDependentFeatures parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentOptionalQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/sortByField' - $ref: '#/components/parameters/nameQueryParam' - $ref: '#/components/parameters/archivedQueryParam' - $ref: '#/components/parameters/kindQueryParam' - $ref: '#/components/parameters/targetOptionalParam' - $ref: '#/components/parameters/targetFilterOptionalParam' - $ref: '#/components/parameters/metricsOptionalParam' - $ref: '#/components/parameters/featuresOptionalParam' - $ref: '#/components/parameters/excludedFeaturesOptionalParam' - $ref: '#/components/parameters/flagStatus' - $ref: '#/components/parameters/flagLifetime' - $ref: '#/components/parameters/flagEnabled' - $ref: '#/components/parameters/flagCounts' - $ref: '#/components/parameters/flagSummary' - $ref: '#/components/parameters/flagTags' responses: '200': $ref: '#/components/responses/FeaturesResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Return a list of dependant flags tags: - Feature Flags /cf/admin/features/{identifier}/restore: post: description: Restore Feature Flag for the given identifier and account ID operationId: RestoreFeatureFlag parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/commitMsgQueryParam' responses: '204': description: No content '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Restore a Feature Flag tags: - Feature Flags /cf/admin/proxy/keys: get: description: Returns all the Proxy keys in an account operationId: GetProxyKeys parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/nameQueryParam' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/proxyKeySortByField' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' responses: '200': $ref: '#/components/responses/ProxyKeysResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns all Proxy keys in an account tags: - Proxy post: description: Creates a Proxy Key in the account & org operationId: CreateProxyKey parameters: - $ref: '#/components/parameters/accountQueryParam' requestBody: $ref: '#/components/requestBodies/ProxyKeysPostRequest' responses: '201': $ref: '#/components/responses/ProxyKeysCreateResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Creates a Proxy Key in the account & org tags: - Proxy /cf/admin/proxy/keys/{identifier}: delete: description: Deletes a ProxyKey operationId: DeleteProxyKey parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/identifier' responses: '204': description: No content '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Deletes a ProxyKey tags: - Proxy get: description: Returns a ProxyKey operationId: GetProxyKey parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/identifier' responses: '200': $ref: '#/components/responses/ProxyKeyResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns a ProxyKey tags: - Proxy patch: description: > This operation is used to modify which environments a ProxyKey has access to. The request body can include one or more instructions that can assign or unassign environmnets to the ProxyKey operationId: PatchProxyKey parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' requestBody: $ref: '#/components/requestBodies/ProxyKeysPatchRequest' responses: '200': $ref: '#/components/responses/ProxyKeysCreateResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Updates a Proxy Key in the account & org tags: - Proxy /cf/admin/segments: get: description: Returns Target Group details for the given account operationId: GetAllSegments parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/sortByField' - $ref: '#/components/parameters/nameQueryParam' - $ref: '#/components/parameters/identifierQueryParam' - $ref: '#/components/parameters/segmentRulesV2QueryParam' responses: '200': $ref: '#/components/responses/SegmentsResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' summary: Returns all Target Groups tags: - Target Groups post: description: Creates a Target Group in the given Project operationId: CreateSegment parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' requestBody: $ref: '#/components/requestBodies/SegmentRequest' responses: '201': description: Created '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Creates a Target Group tags: - Target Groups /cf/admin/segments/{identifier}: delete: description: Deletes a Target Group for the given ID operationId: DeleteSegment parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '204': description: No content '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Deletes a Target Group tags: - Target Groups get: description: Returns Target Group details for the given ID operationId: GetSegment parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/segmentRulesV2QueryParam' responses: '200': $ref: '#/components/responses/SegmentResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns Target Group details for the given identifier tags: - Target Groups patch: description: Updates a Target Group for the given identifier operationId: PatchSegment parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/identifier' requestBody: $ref: '#/components/requestBodies/SegmentPatchRequest' responses: '200': $ref: '#/components/responses/SegmentResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Updates a Target Group tags: - Target Groups /cf/admin/segments/{identifier}/available_flags: get: description: >- Returns the list of Feature Flags that the Target Group can be added to. This list will exclude any Feature Flag that the Target Group is already part of. operationId: GetAvailableFlagsForSegment parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/safSortOrder' - $ref: '#/components/parameters/safSortByField' - $ref: '#/components/parameters/flagNameQueryParam' responses: '200': $ref: '#/components/responses/AvailableFlagResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: >- Returns Feature Flags that are available to be added to the given Target Group tags: - Target Groups /cf/admin/segments/{identifier}/flags: get: description: >- Returns the details of a Feature Flag in a Target Group for the given identifier operationId: GetSegmentFlags parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '200': $ref: '#/components/responses/SegmentFlagsResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns Feature Flags in a Target Group tags: - Target Groups /cf/admin/tags: get: description: Returns all the Tags for the given Account ID operationId: GetAllTags parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/sortByField' - $ref: '#/components/parameters/tagFilterOptionalParam' responses: '200': $ref: '#/components/responses/TagsResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns all Tags tags: - Tags post: description: Create Tags for the given identifier operationId: CreateTag parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' requestBody: $ref: '#/components/requestBodies/TagRequest' responses: '201': $ref: '#/components/responses/TagEditResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Creates a Tag tags: - Tags /cf/admin/tags/{identifier}: delete: description: Delete Tag for the given identifier and account ID operationId: DeleteTag parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/commitMsgQueryParam' - $ref: '#/components/parameters/forceDeleteQueryParam' responses: '204': description: No content '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '424': $ref: '#/components/responses/GitSyncError' '500': $ref: '#/components/responses/InternalServerError' summary: Delete a Tag tags: - Tags get: description: >- Returns details such as identifier,Associated Feature Flag etc for the given Tag operationId: GetTag parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentOptionalQueryParam' - $ref: '#/components/parameters/metricsOptionalParam' - $ref: '#/components/parameters/archivedQueryParam' responses: '200': $ref: '#/components/responses/FeatureResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns a Tag tags: - Tags /cf/admin/targets: get: description: Returns all the Targets for the given Account ID operationId: GetAllTargets parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/targetSortOrder' - $ref: '#/components/parameters/targetSortByField' - $ref: '#/components/parameters/targetNameQueryParam' - $ref: '#/components/parameters/targetIdentifierQueryParam' responses: '200': $ref: '#/components/responses/TargetsResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns all Targets tags: - Targets post: description: Create Targets for the given identifier operationId: CreateTarget parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' requestBody: $ref: '#/components/requestBodies/TargetRequest' responses: '201': description: Created '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Creates a Target tags: - Targets /cf/admin/targets/upload: post: description: Add targets by uploading a CSV file operationId: UploadTargets parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' requestBody: content: multipart/form-data: schema: properties: fileName: format: binary type: string type: object responses: '200': description: Created '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Add Target details tags: - Targets /cf/admin/targets/{identifier}: delete: description: Deletes a Target for the given identifier operationId: DeleteTarget parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '204': description: No content '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Deletes a Target tags: - Targets get: description: Returns details of a Target for the given identifier operationId: GetTarget parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '200': $ref: '#/components/responses/TargetResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns details of a Target tags: - Targets patch: description: Updates a Target for the given identifier operationId: PatchTarget parameters: - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' - $ref: '#/components/parameters/identifier' requestBody: $ref: '#/components/requestBodies/TargetPatchRequest' responses: '200': $ref: '#/components/responses/TargetResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Updates a Target tags: - Targets put: description: Modifies a Target for the given account identifier operationId: ModifyTarget parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' requestBody: $ref: '#/components/requestBodies/TargetRequest' responses: '200': $ref: '#/components/responses/TargetResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' summary: Modifies a Target tags: - Targets /cf/admin/targets/{identifier}/segments: get: description: Returns the Target Groups that the specified Target belongs to. operationId: GetTargetSegments parameters: - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/accountQueryParam' - $ref: '#/components/parameters/orgQueryParam' - $ref: '#/components/parameters/projectQueryParam' - $ref: '#/components/parameters/environmentQueryParam' responses: '200': $ref: '#/components/responses/TargetDetailResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' summary: Returns Target Groups for the given Target tags: - Targets /gateway/lw/api/accounts/{account_id}/autostopping/rules: get: tags: - AutoStopping Rules summary: List AutoStopping Rules description: >- Retrieves a list of all AutoStopping Rules configured in your account. AutoStopping Rules help optimize cloud costs by automatically stopping idle resources and starting them on-demand when accessed. operationId: ListAutoStoppingRules parameters: - name: account_id description: >- Unique identifier of the Harness account. This is used to scope the API request to a specific account. in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: accountIdentifier description: 'Account Identifier for authentication and authorization. ' in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: dry_run description: >- When set to true, filters the results to show only rules in dry-run mode. Dry-run rules monitor resource usage and calculate potential savings without actually stopping resources, allowing you to test rule configurations safely before enabling them. in: query schema: type: boolean default: false responses: '200': description: Successfully retrieved the list of AutoStopping Rules content: application/json: schema: $ref: '#/components/schemas/ServicesResponse' '400': description: Invalid status value content: {} post: tags: - AutoStopping Rules summary: Create an AutoStopping Rule description: >- Creates a new AutoStopping Rule to automatically manage cloud resources and reduce costs. The rule monitors resource activity and automatically stops resources during idle periods, then restarts them when traffic is detected. You can configure idle time thresholds, access methods (HTTP/HTTPS, SSH, RDP), custom domains, and schedules. operationId: UpdateAutoStoppingRule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7xd_BFRC requestBody: description: >- Complete service definition for the AutoStopping Rule including resource configuration, idle time settings, access control details, and optional schedules. The request body should specify the cloud resources to manage, the idle time threshold before stopping, and how users will access the resources. content: '*/*': schema: $ref: '#/components/schemas/SaveServiceRequestWithoutDisabled' required: true responses: '200': description: AutoStopping Rule created successfully content: application/json: schema: $ref: '#/components/schemas/ServiceResponseWithoutDisabled' '400': description: Bad Request - Invalid rule configuration or missing required fields content: application/json: examples: error: summary: Invalid configuration value: status: ERROR message: >- Invalid resource configuration: missing required field 'resources' x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}: get: tags: - AutoStopping Rules summary: Return AutoStopping Rule details description: >- Retrieves details of a specific AutoStopping Rule including its configuration, associated resources, idle time settings, etc. operationId: AutoStoppingRuleDetails parameters: - name: account_id in: path description: Account Identifier for the Entity required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: >- Unique numeric identifier of the AutoStopping Rule. This ID is returned when creating a rule or can be obtained from the list rules endpoint. in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: Successfully retrieved AutoStopping Rule details content: application/json: schema: type: object properties: response: $ref: '#/components/schemas/SaveServiceRequest' '400': description: Invalid status value content: {} delete: tags: - AutoStopping Rules summary: Delete an AutoStopping Rule description: >- Permanently deletes an AutoStopping Rule from your account. **⚠️ CAUTION:** This action is irreversible. Once deleted, the rule configuration cannot be recovered. Resources that were managed by this rule will no longer be automatically stopped, which may result in increased cloud costs. operationId: DeleteAutoStoppingRule parameters: - name: rule_id description: Unique identifier of the AutoStopping Rule to be deleted. in: path required: true schema: type: number example: 12345 - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7xd_BFRCi responses: '200': description: >- AutoStopping Rule deleted successfully. Returns the deleted rule details. content: application/json: schema: $ref: '#/components/schemas/LwServiceResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/health: get: tags: - AutoStopping Rules summary: Return health status of an AutoStopping Rule description: >- Retrieves the current health and operational status of an AutoStopping Rule. operationId: HealthOfAutoStoppingRule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: >- Unique identifier of the AutoStopping Rule for which you need to fetch the health status in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: Successfully retrieved health status content: application/json: schema: $ref: '#/components/schemas/ServiceHealthResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/savings: get: tags: - AutoStopping Rules summary: Return savings details for an AutoStopping Rule description: >- Retrieves detailed cost savings data for a specific AutoStopping Rule grouped by day over the specified time period. operationId: SavingsFromAutoStoppingRule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: >- Unique identifier of the AutoStopping Rule for which you want to fetch savings details in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: from description: >- Start date for the savings calculation period. Accepts YYYY-MM-DD format (e.g., 2024-01-01) or ISO 8601/RFC3339 format (e.g., 2024-01-01T00:00:00Z). in: query schema: type: string example: '2024-01-01' - name: to description: >- End date for the savings calculation period. Accepts YYYY-MM-DD format (e.g., 2024-01-31) or ISO 8601/RFC3339 format (e.g., 2024-01-31T23:59:59Z). in: query schema: type: string example: '2024-01-31' - name: group_by description: >- Optional parameter to group savings data by specific dimensions such as 'day', 'week', or 'month'. in: query schema: type: string example: day responses: '200': description: Successfully retrieved savings details content: application/json: schema: type: object '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/resources: get: tags: - AutoStopping Rules summary: List all the resources for an AutoStopping Rule description: >- Lists all the resources for an AutoStopping Rule for the given identifier. operationId: AllAutoStoppingResources parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: cloud_account_id description: >- Unique identifier of the cloud connector (AWS, Azure, or GCP) configured in Harness. in: query required: true schema: type: string example: lightwing_nonprod - name: region description: >- Cloud provider region where the resources are located (e.g., 'us-east-1' for AWS, 'eastus' for Azure). in: query required: true schema: type: string example: us-east-1 - name: rule_id description: >- Unique identifier of the AutoStopping Rule for which you need to list the resources in: path required: true schema: type: number format: int64 example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: Successfully retrieved list of resources content: application/json: schema: $ref: '#/components/schemas/AllResourcesOfAccountResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/diagnostics: get: tags: - AutoStopping Rules summary: Return diagnostics result of an AutoStopping Rule description: >- Retrieves diagnostic information for an AutoStopping Rule to help troubleshoot issues. operationId: GetAutoStoppingDiagnostics parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: >- Unique identifier of the AutoStopping Rule for which you need to fetch diagnostics details in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: Successfully retrieved diagnostics information content: application/json: schema: $ref: '#/components/schemas/ServiceDiagnosticsResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/warmup: post: tags: - AutoStopping Rules summary: Warm up an AutoStopping Rule description: >- Manually starts (warms up) the resources managed by an AutoStopping Rule, bringing them online immediately. operationId: WarmUpAutostoppingRule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: Unique identifier of the AutoStopping Rule to warm up in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr requestBody: description: Warm Up Options content: '*/*': schema: $ref: '#/components/schemas/WarmUpOption' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/WarmUpResponse' '500': description: Internal error content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown: post: tags: - AutoStopping Rules summary: Cool down an AutoStopping Rule description: >- Manually stops (cools down) the resources managed by an AutoStopping Rule, shutting them down immediately to save costs. operationId: CoolDownAutostoppingRule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: Unique identifier of the AutoStopping Rule to cool down in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr requestBody: description: Cool Down Options content: '*/*': schema: $ref: '#/components/schemas/CoolDownOption' required: true responses: '200': description: successful operation content: application/json: schema: type: string '500': description: Internal error content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown_meta: get: tags: - AutoStopping Rules summary: Return metadata of cool down of an AutoStopping Rule description: >- Retrieves metadata about the cooldown configuration and status of an AutoStopping Rule. operationId: GetAutoStoppingCoolDownMeta parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: Unique identifier of the AutoStopping Rule in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CoolDownMetaSuccessResponse' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/CoolDownMetaFailureResponse' /gateway/lw/api/accounts/{account_id}/autostopping/rules/savings/cumulative: get: tags: - AutoStopping Rules summary: Return cumulative savings for all the AutoStopping Rules description: >- Retrieves the total cumulative cost savings achieved across all AutoStopping Rules in the account. operationId: CumulativeAutoStoppingSavings parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CumulativeSavingsResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/toggle_state: put: tags: - AutoStopping Rules summary: Disable/Enable an Autostopping Rule description: >- Enables or disables an AutoStopping Rule. When disabled, the rule will not automatically stop resources during idle periods. operationId: ToggleAutostoppingRule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: Unique identifier of the AutoStopping Rule to enable or disable in: path required: true schema: type: string example: '12345' - name: disable description: Set to true to disable the rule, false to enable it. in: query required: true schema: type: boolean example: false - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ServicesResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/v2/rules: post: tags: - AutoStopping Rules V2 summary: Create an AutoStopping Rule description: >- Creates a new AutoStopping Rule using the V2 API format with enhanced proxy support. operationId: CreateAutoStoppingRuleV2 parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr requestBody: description: Service definition of an AutoStopping rule content: '*/*': schema: $ref: '#/components/schemas/SaveServiceRequestV2WithoutDisabled' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceResponseWithoutDisabled' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/autostopping/v2/rules/{rule_id}: get: tags: - AutoStopping Rules V2 summary: Return AutoStopping Rule details in V2 format description: >- Retrieves details of an AutoStopping Rule in V2 format with enhanced proxy configuration details. operationId: GetAutoStoppingRuleV2 parameters: - name: account_id in: path description: Account Identifier for the Entity required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: Unique identifier of the AutoStopping Rule in: path required: true schema: type: number example: 12345 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr responses: '200': description: successful operation content: application/json: schema: type: object properties: response: $ref: '#/components/schemas/SaveServiceRequestV2' '400': description: Invalid status value content: {} put: tags: - AutoStopping Rules V2 summary: Update an existing AutoStopping Rule description: >- Updates an existing AutoStopping Rule configuration using the V2 API format. operationId: UpdateAutoStoppingRuleV2 parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: rule_id description: Unique identifier of the AutoStopping Rule to update in: path required: true schema: type: string example: '12345' - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr requestBody: description: Service definition of an AutoStopping rule content: '*/*': schema: $ref: '#/components/schemas/SaveServiceRequestV2WithoutDisabled' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceResponseWithoutDisabled' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers: get: tags: - AutoStopping Load Balancers summary: Return all the load balancers description: >- Retrieves a list of all AutoStopping load balancers configured in your account. Load balancers act as proxy entry points that route traffic to your AutoStopping Rules. operationId: ListLoadBalancers parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: vpc description: >- VPC (Virtual Private Cloud) is the cloud resource where the load balancer is deployed. in: query schema: type: string example: vpc-12345678 - name: region description: >- Optional filter to list load balancers in a specific cloud region (e.g., 'us-east-1' for AWS, 'eastus' for Azure). in: query schema: type: string example: us-east-1 - name: cloud_account_id description: >- Unique identifier of the cloud connector (AWS, Azure, or GCP) configured in CACM. in: query required: true schema: type: string example: lightwing_nonprod - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7xd responses: '200': description: Successfully retrieved list of load balancers content: application/json: schema: $ref: '#/components/schemas/ListAccessPointResponse' '400': description: Invalid status value content: {} put: tags: - AutoStopping Load Balancers summary: Update a load balancer description: Updates the configuration of an existing AutoStopping load balancer. operationId: EditLoadBalancer parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: px7xd_ - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7xd_ requestBody: content: '*/*': schema: $ref: '#/components/schemas/AccessPoint' required: true responses: '200': description: Load balancer updated successfully content: application/json: schema: $ref: '#/components/schemas/CreateAccessPointResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: accessPoint post: tags: - AutoStopping Load Balancers summary: Create a load balancer description: >- Creates a new AutoStopping load balancer to act as a proxy entry point for routing traffic to AutoStopping Rules. operationId: CreateLoadBalancer parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: px7xd_ - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7xd_ requestBody: content: '*/*': schema: $ref: '#/components/schemas/AccessPoint' required: true responses: '200': description: Load balancer created successfully content: application/json: schema: $ref: '#/components/schemas/CreateAccessPointResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: accessPoint delete: tags: - AutoStopping Load Balancers summary: Delete load balancers and the associated resources description: >- Permanently deletes one or more AutoStopping load balancers and their associated resources. **⚠️ CAUTION:** This action is irreversible. Once deleted, the load balancer configuration cannot be recovered. Any AutoStopping Rules using this load balancer will lose their access point and may become inaccessible. operationId: DeleteLoadBalancer parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: pxXVjvw - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7xdw requestBody: content: '*/*': schema: $ref: '#/components/schemas/DeleteAccessPointPayload' required: true responses: '200': description: OK content: {} x-codegen-request-body-name: accessPoint /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}: get: tags: - AutoStopping Load Balancers summary: Return details of a load balancer description: >- Retrieves detailed configuration and status information for a specific AutoStopping load balancer. operationId: DescribeLoadBalancer parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: px7xdXVjvw - name: lb_id description: Unique identifier of the load balancer in: path required: true schema: type: string example: lb-abc123 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7xpfWPYXVjvw responses: '200': description: Successfully retrieved load balancer details content: application/json: schema: $ref: '#/components/schemas/GetAccessPointResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}/rules: get: tags: - AutoStopping Load Balancers summary: Return all the AutoStopping Rules in a load balancer description: >- Retrieves a list of all AutoStopping Rules that are configured to route traffic through a specific load balancer. operationId: AccessPointRules parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: lb_id description: Unique identifier of the load balancer in: path required: true schema: type: string example: lb-abc123 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: px7WPYXVjvw responses: '200': description: Successfully retrieved list of AutoStopping Rules content: application/json: schema: $ref: '#/components/schemas/ServicesResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}/last_active_at: get: tags: - AutoStopping Load Balancers summary: Return last activity details of a load balancer description: >- Retrieves the timestamp of the most recent activity (traffic) through the load balancer. operationId: LoadBalancerActivity parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: pfWPYXVjvw - name: lb_id description: Unique identifier of the load balancer in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: pxWPYXVjvw responses: '200': description: Successfully retrieved last activity timestamp content: application/json: schema: $ref: '#/components/schemas/AccessPointActivityResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/schedules: get: tags: - AutoStopping Fixed Schedules summary: Return all the AutoStopping Rule fixed schedules description: >- Retrieves all fixed schedules configured for an AutoStopping Rule. Fixed schedules define specific times when resources should be automatically started or stopped. operationId: listAutoStoppingSchedules parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: px7xpfWPYXVjvw - name: cloud_account_id description: >- Unique identifier of the cloud connector (AWS, Azure, or GCP) configured in CACM. in: query required: true schema: type: string example: lightwing_nonprod - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: res_id description: Resource ID for which to fetch schedules. in: query required: true schema: type: string example: '12345' - name: res_type description: Type of resource to which schedules are attached. in: query required: true schema: type: string enum: - autostop_rule example: autostop_rule responses: '200': description: Successfully retrieved list of fixed schedules content: application/json: schema: $ref: '#/components/schemas/FixedSchedulesListResponse' '400': description: Invalid content: {} post: tags: - AutoStopping Fixed Schedules summary: Create a fixed schedule for an AutoStopping Rule description: >- Creates a new fixed schedule for an AutoStopping Rule to automatically start or stop resources at specific times. operationId: createAutoStoppingSchedules parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr - name: cloud_account_id description: >- Unique identifier of the cloud connector (AWS, Azure, or GCP) configured in CACM. in: query required: true schema: type: string example: lightwing_nonprod - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: abc12_DEFgh-ijkLMNOPqr requestBody: description: Fixed schedule payload content: '*/*': schema: $ref: '#/components/schemas/SaveStaticSchedulesRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/FixedSchedule' '400': description: Invalid content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/schedules/{schedule_id}: delete: tags: - AutoStopping Fixed Schedules summary: Delete a fixed schedule for AutoStopping Rule description: >- Permanently deletes a fixed schedule from an AutoStopping Rule. The rule will no longer start or stop resources based on this schedule. operationId: deleteAutoStoppingSchedule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string example: px7-pfWPYXVjvw - name: schedule_id description: Unique identifier of the fixed schedule to delete in: path required: true schema: type: number example: 123 - name: accountIdentifier description: Account Identifier for authentication and authorization. in: query required: true schema: type: string example: pxCi-pfWPYXVjvw responses: '200': description: Fixed schedule deleted successfully content: application/json: schema: type: object properties: response: type: string /gateway/lw/api/accounts/{account_id}/clusters: get: tags: - Cluster Orchestrator summary: Return all connected clusters to Harness CACM description: >- Return all connected clusters to Harness CACM, the ones onboarded to cluster orchestrator will have the id field populated operationId: listConnectedKubernetesClusters parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectedKubernetesClustersListResponse' '400': description: Invalid content: {} /gateway/lw/api/accounts/{account_id}/clusters/orchestrator: post: tags: - Cluster Orchestrator summary: >- Onboard a kubernetes cluster with an existing CACM Kubernetes Connector to Cluster Orchestrator description: >- Onboard a kubernetes cluster with an existing CACM Kubernetes Connector to Cluster Orchestrator operationId: onboardToClusterOrchestrator parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string requestBody: description: Onboard to Cluster Orchestrator Payload content: '*/*': schema: $ref: '#/components/schemas/OnboardToClusterOrchestratorRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectedKubernetesClustersGetResponse' '400': description: Invalid content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/clusters/orchestrator/{orchestrator_id}: get: tags: - Cluster Orchestrator summary: Get Details of a connected clusters by orchestrator id description: >- Fetches the details of the cluster connected to the orchestrator by orchestrator's ID operationId: getConnectedClusterDetails parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: orchestrator_id description: >- Identifier of the Orchestrator of the cluster, available in list response and onboard response in: path required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectedKubernetesClustersGetResponse' '400': description: Invalid content: {} /gateway/lw/api/accounts/{account_id}/clusters/orchestrator/{orchestrator_id}/config: put: tags: - Cluster Orchestrator summary: Update a Cluster Orchestrator Config description: Updates the config for a given cluster orchestrator operationId: updateClusterOrchestratorConfig parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: orchestrator_id description: >- Identifier of the Orchestrator of the cluster, available in list response and onboard response in: path required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/AccessPoint' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CreateAccessPointResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: accessPoint /gateway/lw/api/accounts/{account_id}/alerts: post: tags: - AutoStopping Alerts summary: Create Alert description: >- Creates a new alert configuration for AutoStopping events. Alerts can notify users via email or Slack when specific events occur, such as warmup failures, cooldown failures, or rule lifecycle changes. operationId: CreateAlert parameters: - name: account_id description: Unique identifier of the Harness account in: path required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw - name: accountIdentifier description: Account Identifier for authentication and authorization in: query required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw requestBody: description: Alert configuration to create content: application/json: schema: $ref: '#/components/schemas/AlertRequest' examples: all_rules: summary: Alert for all AutoStopping rules description: >- Creates an alert that applies to all AutoStopping rules in the account value: name: demo-alert-all-rules enabled: true entity_type: autostopping_rule recipients: - type: email ids: - user@example.com events: - id: event-created event: autostopping_rule_created - id: event-updated event: autostopping_rule_updated - id: event-deleted event: autostopping_rule_deleted - id: event-warmup-failed event: autostopping_warmup_failed - id: event-cooldown-failed event: autostopping_cooldown_failed associated_entities: - relation_type: all specific_rules: summary: Alert for specific AutoStopping rules description: >- Creates an alert that targets specific AutoStopping rules by their IDs value: name: specific-rules-alert-demo enabled: true entity_type: autostopping_rule recipients: - type: email ids: - user@example.com events: - id: event-updated event: autostopping_rule_updated - id: event-deleted event: autostopping_rule_deleted associated_entities: - relation_type: specific entity_id: '4519' - relation_type: specific entity_id: '4487' required: true responses: '200': description: Alert created successfully content: application/json: schema: $ref: '#/components/schemas/AlertCreateResponse' '400': description: Invalid request - validation failed content: {} x-codegen-request-body-name: body put: tags: - AutoStopping Alerts summary: Update Alert description: >- Updates an existing alert configuration. The alert ID must be provided in the request body. operationId: UpdateAlert parameters: - name: account_id description: Unique identifier of the Harness account in: path required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw - name: accountIdentifier description: Account Identifier for authentication and authorization in: query required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw requestBody: description: Alert configuration to update. The alert ID is required. content: application/json: schema: $ref: '#/components/schemas/AlertUpdateRequest' examples: all_rules: summary: Update alert for all AutoStopping rules description: >- Updates an alert to apply to all AutoStopping rules in the account value: id: 550e8400-e29b-41d4-a716-446655440000 name: updated-alert-all-rules enabled: true entity_type: autostopping_rule recipients: - type: email ids: - user@example.com events: - id: event-created event: autostopping_rule_created - id: event-warmup-failed event: autostopping_warmup_failed - id: event-cooldown-failed event: autostopping_cooldown_failed associated_entities: - relation_type: all specific_rules: summary: Update alert for specific AutoStopping rules description: >- Updates an alert to target specific AutoStopping rules by their IDs value: id: 550e8400-e29b-41d4-a716-446655440000 name: updated-specific-rules-alert enabled: true entity_type: autostopping_rule recipients: - type: email ids: - user@example.com events: - id: event-updated event: autostopping_rule_updated - id: event-deleted event: autostopping_rule_deleted associated_entities: - relation_type: specific entity_id: '4519' - relation_type: specific entity_id: '4487' required: true responses: '200': description: Alert updated successfully content: application/json: schema: $ref: '#/components/schemas/AlertMessageResponse' '400': description: Invalid request - validation failed or alert not found content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/alerts/list: post: tags: - AutoStopping Alerts summary: List Alerts description: >- Retrieves a paginated list of alerts matching the specified search criteria. Supports filtering by entity type, entity IDs, enabled status, events, and name search. operationId: ListAlerts parameters: - name: account_id description: Unique identifier of the Harness account in: path required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw - name: accountIdentifier description: Account Identifier for authentication and authorization in: query required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw requestBody: description: Search criteria for filtering alerts content: application/json: schema: $ref: '#/components/schemas/AlertSearchRequest' required: true responses: '200': description: Successfully retrieved list of alerts content: application/json: schema: $ref: '#/components/schemas/AlertListResponse' '400': description: Invalid request - validation failed content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/alerts/{alert_id}: get: tags: - AutoStopping Alerts summary: Get Alert description: Retrieves the details of a specific alert by its ID. operationId: GetAlert parameters: - name: account_id description: Unique identifier of the Harness account in: path required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw - name: alert_id description: Unique identifier of the alert to retrieve in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for authentication and authorization in: query required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw responses: '200': description: Successfully retrieved alert details content: application/json: schema: $ref: '#/components/schemas/AlertResponse' '400': description: Invalid request - alert_id is required content: {} '404': description: Alert not found content: {} delete: tags: - AutoStopping Alerts summary: Delete Alert description: Deletes an alert by its ID. This is a soft delete operation. operationId: DeleteAlert parameters: - name: account_id description: Unique identifier of the Harness account in: path required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw - name: alert_id description: Unique identifier of the alert to delete in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for authentication and authorization in: query required: true schema: type: string example: px7xd_BFRCi-pfWPYXVjvw responses: '200': description: Alert deleted successfully content: application/json: schema: $ref: '#/components/schemas/AlertMessageResponse' '400': description: Invalid request - alert_id is required content: {} '404': description: Alert not found content: {} /gateway/lw/api/accounts/{account_id}/v1/events/logs: post: tags: - Commitment Orchestrator APIs summary: List event logs description: Obtains list of event logs generated as part of commitment orchestration operationId: EventLogs parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: cloud_account_id description: Cloud Account Identifier in: query required: false schema: type: string - name: start_date in: query required: false schema: type: string description: Start date of the period in YYYY-MM-DD format example: '2023-11-07' - name: end_date in: query required: false schema: type: string description: >- End date of the period in YYYY-MM-DD format (will be adjusted to end of day) example: '2023-11-07' - name: event_type description: Type of event to filter by in: query required: false schema: type: string - name: service description: AWS Service type in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service default: Amazon Elastic Compute Cloud - Compute requestBody: description: Input for Pagination and Filters content: '*/*': schema: $ref: '#/components/schemas/EventLogsRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/EventLogsSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/events/chart: post: tags: - Commitment Orchestrator Events APIs summary: List event logs description: Obtains list of events and the count of their occurences grouped by date operationId: EventsChart parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string - name: start_date in: query required: true schema: type: string description: Start time of the period example: '2021-10-19' - name: end_date in: query required: true schema: type: string description: End time of the period example: '2021-10-19' requestBody: description: Optional filters content: '*/*': schema: $ref: '#/components/schemas/EventsFilter' responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/EventsChartsSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/events/renewal_events: post: tags: - Commitment Orchestrator Events APIs summary: List auto-renewal events description: >- Returns auto-renewal activities (upcoming and completed) for the account, filtered by date range and optional cloud account, regions, and AWS service. Used to annotate charts such as Compute Coverage when savings or coverage dip around RI/SP renewals. If start_date and end_date are omitted, the server defaults to the last 30 days (UTC). operationId: RenewalEvents parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string requestBody: description: Date range and optional filters content: application/json: schema: $ref: '#/components/schemas/RenewalEventsRequest' '*/*': schema: $ref: '#/components/schemas/RenewalEventsRequest' required: false responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RenewalEventsSuccessResponse' '400': description: >- Invalid request (e.g. invalid date format or end_date before start_date) content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/events/ri_recommendation_schedule: get: tags: - Commitment Orchestrator Events APIs summary: RI recommendation cooldown schedule description: >- Returns the configured minimum interval between RI recommendation engine runs and when the next run becomes eligible, based on the latest completed approval transaction for the account and service. operationId: RIRecommendationSchedule parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: service description: AWS Service type in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service - Amazon ElastiCache default: Amazon Elastic Compute Cloud - Compute responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RIRecommendationScheduleSuccessResponse' '400': description: Invalid parameters content: {} /gateway/lw/api/accounts/{account_id}/v1/setup: post: tags: - Commitment Orchestrator Setup APIs summary: Create commitment orchestration setup description: >- Creates a new commitment orchestration setup configuration for a cloud account, including optional notification settings operationId: SetupConfiguration parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string requestBody: description: Setup configuration details content: application/json: schema: type: object properties: cloud_account_id: type: string description: >- Cloud Account ID for which to create the commitment orchestration setup cloud_account_name: type: string description: Name of the cloud account enabled: type: boolean description: Whether the commitment orchestration is enabled default: true dry_run_mode: type: boolean description: Whether to run in dry run mode default: false approval_mode: type: string description: Mode of approval for commitment actions enum: - auto - manual - semiAutomated default: manual service: type: string description: Service for which to set up commitment orchestration enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service default: Amazon Elastic Compute Cloud - Compute config: type: object description: Configuration details for the commitment orchestration properties: exclusion_list: type: array description: >- List of instance types to exclude from commitment orchestration items: $ref: '#/components/schemas/ExclusionEntry' excluded_cloud_accounts: type: array description: >- List of cloud account IDs to exclude from commitment orchestration items: type: string excluded_regions: type: array description: List of regions to exclude from commitment orchestration items: type: string savings_plans_coverage: type: number format: float description: Target coverage percentage for savings plans (0-1) minimum: 0 maximum: 1 reserved_instances_coverage: type: number format: float description: Target coverage percentage for reserved instances (0-1) minimum: 0 maximum: 1 total_coverage: type: number format: float description: Total target coverage percentage (0-1) minimum: 0 maximum: 1 seed_config: type: object description: Configuration for seed instances properties: start_with: type: string description: Strategy for starting with seed instances enum: - seed_auto_discovery - purchase_new_seed default: seed_auto_discovery monthly_purchase_enabled: type: boolean description: >- Whether monthly purchase of seed instances is enabled default: false purchase_terms: type: array description: Purchase terms for seed instances in seconds items: type: integer enum: - 31536000 - 94608000 description: >- Purchase term in seconds (1 year = 31536000, 3 years = 94608000) payment_option: type: string description: Payment option for commitments enum: - No Upfront - Partial Upfront - All Upfront savings_plan_renewal_rate: type: number format: float description: >- Renewal rate for savings plans (0-1), required for semiAutomated approval mode minimum: 0 maximum: 1 savings_plan_layering: type: object description: Savings Plan laddering configuration properties: enabled: type: boolean description: Whether Savings Plan laddering is enabled default: false max_sp_hourly_commitment: type: number format: double description: >- Maximum hourly commitment for a net-new Savings Plan purchase in USD/hour; 0 or omitted means no ceiling minimum: 0 preferred_commitment_mode: type: string description: >- Commitment type that receives the shared coverage budget first enum: - ri_preferred - sp_preferred default: ri_preferred required: - total_coverage notification: type: object description: >- Optional notification configuration for commitment orchestration alerts properties: email_list: type: array items: type: string format: email description: List of email addresses to receive notifications example: - user1@example.com - user2@example.com timezone: type: string description: >- Timezone for scheduling notifications (IANA timezone format) example: America/New_York sp_notif_range: type: integer format: int64 description: >- Number of days before Savings Plan expiry to send notifications example: 30 minimum: 1 maximum: 365 schedule_time: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$ description: Time to send notifications in HH:MM format (24-hour) example: '09:00' purchase_notifications_enabled: type: boolean description: Whether to enable notifications for completed purchases example: true recommendations_notifications_enabled: type: boolean description: Whether to enable notifications for new recommendations example: true required: - email_list - timezone - schedule_time required: - cloud_account_id - config - service required: true responses: '200': description: Successful operation content: application/json: schema: type: object properties: ts: type: integer format: int64 description: Timestamp of the response success: type: boolean description: Whether the operation was successful response: type: object description: Empty object as no content is expected in the response additionalProperties: false '400': description: Bad request content: application/json: schema: type: object properties: ts: type: integer format: int64 success: type: boolean enum: - false errors: type: array items: type: string /gateway/lw/api/accounts/{account_id}/v1/setup/validate: post: tags: - Commitment Orchestrator Setup APIs summary: Validate commitment Setup description: >- Obtains maximum allowed configuration values for Savings Plans given a target total coverage operationId: SetupValidate parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string - name: cloud_account_id in: query required: true schema: type: string description: >- Account Identifier for which Commitment Orchestration Setup is being performed requestBody: description: Configured setup values content: '*/*': schema: $ref: '#/components/schemas/AutoCUDConfig' responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/SetupValidateSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/setup/{cloud_account_id}/instance_types: post: tags: - Commitment Orchestrator Setup APIs summary: Instance types in usage to support configuring exclusions description: Lists all instance types by region in usage for the given master account operationId: SetupInstanceTypes parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: cloud_account_id description: Cloud Account ID of the master account in Harness in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string - name: cloud_account_id in: query required: true schema: type: string description: >- Account Identifier for which Commitment Orchestration Setup is being performed requestBody: description: Configured setup values content: '*/*': schema: $ref: '#/components/schemas/InstanceTypesPayload' responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/SetupInstanceTypesSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/setup/{cloudAccountID}: delete: tags: - Commitment Orchestrator Setup APIs summary: Delete commitment orchestration setup description: >- Deletes a commitment orchestration setup configuration for a specific cloud account, including any associated notification settings operationId: DeleteSetupConfiguration parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: cloudAccountID description: >- Cloud Account ID for which to delete the commitment orchestration setup in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string - name: service description: Service for which to delete the commitment orchestration setup in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service - RDS default: Amazon Elastic Compute Cloud - Compute responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/GenericSuccessResponse' '400': description: Invalid request or setup not found content: {} get: tags: - Commitment Orchestrator Setup APIs summary: Get commitment orchestration setup description: >- Retrieves the commitment orchestration setup configuration for a specific cloud account, including notification settings if configured operationId: GetSetupConfiguration parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: cloudAccountID description: >- Cloud Account ID for which to retrieve the commitment orchestration setup in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string - name: service description: Service for which to retrieve the commitment orchestration setup in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service default: Amazon Elastic Compute Cloud - Compute - name: routingId description: Routing identifier for the request in: query required: false schema: type: string responses: '200': description: Successful retrieval of the commitment orchestration setup content: application/json: schema: type: object properties: ts: type: integer description: Unix timestamp of the response example: 1758063197 success: type: boolean description: Indicates whether the request was successful example: true errors: type: array description: List of errors if the request failed items: type: string nullable: true example: null response: type: object description: The setup configuration details properties: id: type: integer example: 0 account_id: type: string description: Account Identifier example: account_identifier cloud_account_id: type: string description: Cloud Account Identifier example: cloud_account_id cloud_account_name: type: string description: Name of the cloud account example: '' config: type: object description: Configuration details properties: exclusion_list: type: array description: List of excluded instance types items: $ref: '#/components/schemas/ExclusionEntry' excluded_cloud_accounts: type: array description: List of excluded cloud accounts items: type: string excluded_regions: type: array description: List of excluded regions items: type: string savings_plans_coverage: type: number format: float example: 0 reserved_instances_coverage: type: number format: float example: 0 total_coverage: type: number format: float example: 0.4 payment_option: type: string description: Payment option for the setup example: No Upfront savings_plan_renewal_rate: type: number format: float description: Renewal rate for savings plans (0-1) example: 0.91 savings_plan_layering: type: object description: Savings Plan laddering configuration properties: enabled: type: boolean description: Whether Savings Plan laddering is enabled example: true max_sp_hourly_commitment: type: number format: double description: >- Maximum hourly commitment for a net-new Savings Plan purchase in USD/hour; 0 or omitted means no ceiling example: 25 preferred_commitment_mode: type: string description: >- Commitment type that receives the shared coverage budget first enum: - ri_preferred - sp_preferred example: ri_preferred seed_config: type: object description: Configuration for seed instances properties: start_with: type: string description: Strategy for starting with seed instances enum: - seed_auto_discovery - purchase_new_seed example: seed_auto_discovery monthly_purchase_enabled: type: boolean description: >- Whether monthly purchase of seed instances is enabled example: false purchase_terms: type: array description: Purchase terms for seed instances in seconds items: type: integer enum: - 31536000 - 94608000 description: >- Purchase term in seconds (1 year = 31536000, 3 years = 94608000) example: - 31536000 enabled: type: boolean description: Whether the setup is enabled example: false dry_run_mode: type: boolean description: Whether the setup is running in dry-run mode example: false updated_at: type: string format: date-time example: '2025-09-23T23:29:08.731554Z' created_at: type: string format: date-time example: '2025-09-23T23:25:53.925238Z' approval_mode: type: string description: Mode of approval for operations enum: - auto - manual - semiAutomated example: semiAutomated service: type: string description: The associated service example: Amazon Elastic Compute Cloud - Compute notification: type: object description: >- Notification configuration for commitment orchestration alerts nullable: true properties: email_list: type: array items: type: string format: email description: List of email addresses to receive notifications timezone: type: string description: Timezone for scheduling notifications sp_notif_range: type: integer format: int64 description: >- Number of days before Savings Plan expiry to send notifications schedule_time: type: string description: Time to send notifications in HH:MM format purchase_notifications_enabled: type: boolean description: >- Whether notifications for completed purchases are enabled recommendations_notifications_enabled: type: boolean description: >- Whether notifications for new recommendations are enabled '400': description: Invalid request or setup not found content: {} put: tags: - Commitment Orchestrator Setup APIs summary: Update commitment orchestration setup description: >- Updates an existing commitment orchestration setup configuration for a specific cloud account, including notification settings operationId: UpdateSetupConfiguration parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: cloudAccountID description: >- Cloud Account ID for which to update the commitment orchestration setup in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string requestBody: description: Setup configuration details content: application/json: schema: type: object properties: cloud_account_id: type: string description: >- Cloud Account ID for which to update the commitment orchestration setup cloud_account_name: type: string description: Name of the cloud account enabled: type: boolean description: Whether the commitment orchestration is enabled default: true dry_run_mode: type: boolean description: Whether to run in dry run mode default: false approval_mode: type: string description: Mode of approval for commitment actions enum: - auto - manual - semiAutomated default: manual service: type: string description: Service for which to set up commitment orchestration enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service default: Amazon Elastic Compute Cloud - Compute config: type: object description: Configuration details for the commitment orchestration properties: exclusion_list: type: array description: >- List of instance types to exclude from commitment orchestration items: $ref: '#/components/schemas/ExclusionEntry' excluded_cloud_accounts: type: array description: >- List of cloud account IDs to exclude from commitment orchestration items: type: string excluded_regions: type: array description: List of regions to exclude from commitment orchestration items: type: string savings_plans_coverage: type: number format: float description: Target coverage percentage for savings plans (0-1) minimum: 0 maximum: 1 reserved_instances_coverage: type: number format: float description: Target coverage percentage for reserved instances (0-1) minimum: 0 maximum: 1 total_coverage: type: number format: float description: Total target coverage percentage (0-1) minimum: 0 maximum: 1 seed_config: type: object description: Configuration for seed instances properties: start_with: type: string description: Strategy for starting with seed instances enum: - seed_auto_discovery - purchase_new_seed default: seed_auto_discovery monthly_purchase_enabled: type: boolean description: >- Whether monthly purchase of seed instances is enabled default: false purchase_terms: type: array description: Purchase terms for seed instances in seconds items: type: integer enum: - 31536000 - 94608000 description: >- Purchase term in seconds (1 year = 31536000, 3 years = 94608000) payment_option: type: string description: Payment option for commitments enum: - No Upfront - Partial Upfront - All Upfront savings_plan_renewal_rate: type: number format: float description: >- Renewal rate for savings plans (0-1), required for semiAutomated approval mode minimum: 0 maximum: 1 savings_plan_layering: type: object description: Savings Plan laddering configuration properties: enabled: type: boolean description: Whether Savings Plan laddering is enabled default: false max_sp_hourly_commitment: type: number format: double description: >- Maximum hourly commitment for a net-new Savings Plan purchase in USD/hour; 0 or omitted means no ceiling minimum: 0 preferred_commitment_mode: type: string description: >- Commitment type that receives the shared coverage budget first enum: - ri_preferred - sp_preferred default: ri_preferred required: - total_coverage notification: type: object description: >- Optional notification configuration for commitment orchestration alerts properties: email_list: type: array items: type: string format: email description: List of email addresses to receive notifications example: - user1@example.com - user2@example.com timezone: type: string description: >- Timezone for scheduling notifications (IANA timezone format) example: America/New_York sp_notif_range: type: integer format: int64 description: >- Number of days before Savings Plan expiry to send notifications example: 30 minimum: 1 maximum: 365 schedule_time: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$ description: Time to send notifications in HH:MM format (24-hour) example: '09:00' purchase_notifications_enabled: type: boolean description: Whether to enable notifications for completed purchases example: true recommendations_notifications_enabled: type: boolean description: Whether to enable notifications for new recommendations example: true required: - email_list - timezone - schedule_time required: - cloud_account_id - config - service required: true responses: '200': description: Setup configuration updated successfully content: application/json: schema: $ref: '#/components/schemas/GenericSuccessResponse' '400': description: Invalid request or setup not found content: {} /gateway/lw/api/accounts/{account_id}/v2/setup/{cloudAccountID}/estimated_savings: post: tags: - Commitment Orchestrator Setup APIs summary: Get estimated savings for a target coverage description: Returns estimated savings data based on a target coverage percentage operationId: GetEstimatedSavingsForSetup parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: cloudAccountID in: path required: true schema: type: string description: Cloud Account ID for which to retrieve estimated savings data requestBody: description: Parameters for estimated savings calculation content: application/json: schema: type: object properties: instance_types: type: array items: type: string description: >- List of instance types to filter by. Empty array means all instance types. regions: type: array items: type: string description: List of regions to filter by. Empty array means all regions. linked_accounts: type: array items: type: string description: >- List of linked accounts to filter by. Empty array means all linked accounts. service: type: string description: >- Service name to filter by, e.g., 'Amazon Elastic Compute Cloud - Compute'. Defaults to EC2 if not specified. target_coverage: type: number format: float description: Target coverage percentage (between 0 and 100) minimum: 0 maximum: 100 required: - target_coverage required: true responses: '200': description: Successful operation content: application/json: schema: type: object properties: ts: type: integer format: int64 description: Timestamp of the response success: type: boolean description: Whether the operation was successful response: type: object properties: current_coverage: type: number format: float description: Current coverage percentage target_coverage: type: number format: float description: Target coverage percentage current_savings: type: number format: float description: Current savings amount estimated_savings: type: number format: float description: Estimated savings amount at target coverage '400': description: Bad request content: application/json: schema: type: object properties: ts: type: integer format: int64 success: type: boolean enum: - false errors: type: array items: type: string /gateway/lw/api/accounts/{account_id}/v2/setup/{cloudAccountID}/cost_coverage: post: tags: - Commitment Orchestrator Setup APIs summary: Get cost coverage data for setup description: >- Returns cost breakdown and coverage data for EC2 instances, grouped by instance type, region, or account operationId: GetCostCoverageForSetup parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: cloudAccountID in: path required: true schema: type: string description: Cloud Account ID for which to retrieve cost coverage data requestBody: description: Cost coverage filter parameters content: application/json: schema: type: object properties: instance_types: type: array items: type: string description: >- List of instance types to filter by. Empty array means all instance types. regions: type: array items: type: string description: List of regions to filter by. Empty array means all regions. linked_accounts: type: array items: type: string description: >- List of linked accounts to filter by. Empty array means all linked accounts. service: type: string description: >- Service name to filter by, e.g., 'Amazon Elastic Compute Cloud - Compute' required: true responses: '200': description: Successful operation content: application/json: schema: type: object properties: ts: type: integer format: int64 description: Timestamp of the response success: type: boolean description: Whether the operation was successful response: type: array items: type: object properties: start_date: type: string format: date description: Start date of the cost data period end_date: type: string format: date description: End date of the cost data period costs: type: object additionalProperties: type: number description: >- Map of purchase types to costs. For instance type breakdown, this contains region as keys. total_cost: type: number description: Total cost for the period committed_cost: type: number description: Committed cost for the period coverage: type: number description: >- Coverage percentage (committed_cost/total_cost * 100) breakdown_type: type: string description: >- Type of breakdown used (instance_type_breakdown, region_breakdown, or account_breakdown) region_breakdown: type: object additionalProperties: type: object properties: costs: type: object additionalProperties: type: number description: Map of purchase types to costs total_cost: type: number description: Total cost for this region committed_cost: type: number description: Committed cost for this region coverage: type: number description: Coverage percentage for this region description: Breakdown of costs by region instance_type_breakdown: type: object additionalProperties: type: object properties: costs: type: object additionalProperties: type: number description: Map of purchase types to costs total_cost: type: number description: Total cost for this instance type committed_cost: type: number description: Committed cost for this instance type coverage: type: number description: Coverage percentage for this instance type region: type: string description: Region for this instance type description: Breakdown of costs by instance type account_breakdown: type: object additionalProperties: type: object properties: costs: type: object additionalProperties: type: number description: Map of purchase types to costs total_cost: type: number description: Total cost for this account committed_cost: type: number description: Committed cost for this account coverage: type: number description: Coverage percentage for this account account_name: type: string description: Name of the account description: Breakdown of costs by account '400': description: Bad request content: application/json: schema: type: object properties: ts: type: integer format: int64 success: type: boolean example: false error: type: string /gateway/lw/api/accounts/{account_id}/v1/setup/listMasterAccounts: post: tags: - Commitment Orchestrator Setup APIs summary: List master accounts for commitment Setup description: Lists master accounts available for commitment orchestrator setup operationId: ListMasters parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ListMasterSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/setup/{cloud_account_id}/child_accounts: get: tags: - Commitment Orchestrator Setup APIs summary: List child accounts for a given master account description: Lists child accounts with their name and id for a given master account operationId: ListAccounts parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: cloud_account_id description: Cloud Account ID of the master account in Harness in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ListChildAccountsSuccessResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/v1/setup/list: get: tags: - Commitment Orchestrator Setup APIs summary: List of commitment Setups description: Lists setups available for commitment orchestrator operationId: ListSetups parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ListSetupsSuccessResponse' '400': description: Invalid status value content: {} /gateway/lw/api/accounts/{account_id}/v2/approvals/list: post: tags: - Commitment Orchestrator User Approval APIs summary: List of Commitment transactions with filtering options description: List of commitment related transactions with advanced filtering options operationId: ApprovalsListV2 parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: routingId description: Routing Identifier for the request in: query required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string - name: start_date in: query schema: type: string format: date description: Start date for the approval period. - name: end_date in: query schema: type: string format: date description: End date for the approval period. requestBody: description: Input for filtering and pagination content: application/json: schema: $ref: '#/components/schemas/ApprovalsListRequestV2' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ApprovalsListResponseV2' '400': description: Invalid request content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/approvals/list: post: tags: - Commitment Orchestrator User Approval APIs summary: List of Commitment transactions awaiting user approvals description: List of commitment related transactions waiting for user approvals operationId: ApprovalsList parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string requestBody: description: Input for Pagination content: '*/*': schema: $ref: '#/components/schemas/PaginationInput' responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ApprovalEventsSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v1/approvals/update: post: tags: - Commitment Orchestrator User Approval APIs summary: Approve/Reject commitment transactions description: Approve or Reject commitment transactions operationId: ApprovalsUpdate parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string requestBody: description: Actions and their approval or rejection status content: '*/*': schema: $ref: '#/components/schemas/ApprovalPayload' responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/GenericSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v2/approvals/overview: post: tags: - Commitment Orchestrator User Approval APIs summary: Overview API with summary for different types of approval events description: >- Overview API with summary of event types with the status and potential savings opportunities operationId: ApprovalsOverview parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity in: query required: true schema: type: string requestBody: description: Input for Supported optional filters content: '*/*': schema: $ref: '#/components/schemas/ApprovalsOverviewRequestFilters' responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ApprovalOverviewSuccessResponse' '400': description: Invalid status value content: {} x-codegen-request-body-name: body /gateway/lw/api/accounts/{account_id}/v2/savings/overview: post: tags: - Savings Overview summary: Get Savings Overview description: >- Fetches the overall savings, managed, and unmanaged savings for the provided account. operationId: GetSavingsOverview parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: start_date in: query required: true schema: type: string format: date description: Start date for the savings period. - name: end_date in: query required: true schema: type: string format: date description: End date for the savings period. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. requestBody: required: false content: application/json: schema: type: object properties: service: type: string enum: - Amazon Relational Database Service - Amazon Elastic Compute Cloud - Compute default: Amazon Elastic Compute Cloud - Compute responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SavingsOverviewResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{accountId}/v2/savings/detail: post: tags: - Savings Detail summary: Fetch savings details parameters: - name: accountId in: path required: true schema: type: string description: The account ID - name: routingId in: query required: true schema: type: string description: Routing ID - name: start_date in: query required: true schema: type: string format: date description: Start date for the savings query - name: end_date in: query required: true schema: type: string format: date description: End date for the savings query - name: accountIdentifier in: query required: true schema: type: string description: Account identifier requestBody: required: true content: application/json: schema: type: object properties: group_by: type: string enum: - Regions - Commitment Type - Instance family description: The dimension to group savings by is_harness_managed: type: boolean description: Indicates whether the savings are managed by Harness service: type: string enum: - Amazon Relational Database Service - Amazon Elastic Compute Cloud - Compute default: Amazon Elastic Compute Cloud - Compute required: - group_by - is_harness_managed responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SavingsDetailResponse' /gateway/lw/api/accounts/{account_id}/v1/detail/commitment_utilisation: get: tags: - Commitment Utilization summary: Get commitment utilization details description: >- Retrieves detailed utilization data for savings plans and reserved instances with charts and trends operationId: GetCommitmentUtilizationDetails parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: accountIdentifier in: query required: true schema: type: string description: Account identifier - name: start_date in: query required: true schema: type: string format: date example: '2025-01-01' description: Start date for the utilization data period - name: end_date in: query required: true schema: type: string format: date example: '2025-01-31' description: End date for the utilization data period - name: regions in: query required: false schema: type: array items: type: string description: >- Filter by regions (Note: Regional filtering has limitations for savings plans) style: form explode: true - name: cloud_account_ids in: query required: false schema: type: array items: type: string description: Filter by cloud account IDs style: form explode: true - name: service in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service description: Filter by AWS service responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CommitmentUtilizationDetailResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/savings/savings-rate: post: tags: - Savings Rate summary: Get Effective Savings Rate description: >- Fetches the effective savings rate and total spend percentage for the given account within the specified date range. operationId: GetSavingsRate parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. - name: start_date in: query required: true schema: type: string example: '2021-10-19' description: Start date for the savings calculation period. - name: end_date in: query required: true schema: type: string example: '2021-10-19' description: End date for the savings calculation period. requestBody: content: application/json: schema: $ref: '#/components/schemas/UtilizationOverviewRequestFilters' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SavingsRateResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{accountId}/v2/utilisation/overview: post: tags: - Utilization Overview summary: Get Utilization Overview parameters: - in: path name: accountId required: true schema: type: string description: The unique identifier of the account - in: query name: routingId required: true schema: type: string description: The routing ID for the account - in: query name: start_date required: true schema: type: string format: date description: The start date for the utilization data - in: query name: end_date required: true schema: type: string format: date description: The end date for the utilization data - in: query name: accountIdentifier required: true schema: type: string description: The identifier of the account for context requestBody: content: application/json: schema: type: object properties: service: type: string enum: - Amazon Relational Database Service - Amazon Elastic Compute Cloud - Compute default: Amazon Elastic Compute Cloud - Compute description: Service to fetch the details for. responses: '200': description: Successful response with utilization overview content: application/json: schema: $ref: '#/components/schemas/UtilizationOverviewResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/spend/overview: post: tags: - Spend Overview summary: Get overall spend breakdown across RI, SP and Ondemand cost description: >- Fetches spend breakdown across RI, SP and Ondemand cost in terms of cost incurred for the given account within the specified date range. operationId: SpendOverview parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. - name: start_date in: query required: true schema: type: string example: '2021-10-19' description: Start date for the spend calculation period. - name: end_date in: query required: true schema: type: string example: '2021-10-19' description: End date for the spend calculation period. requestBody: required: false description: Filters for Spend Overview content: '*/*': schema: $ref: '#/components/schemas/SpendBreakdownFilter' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SpendBreakdownResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/spend/detail: post: tags: - Spend Details summary: >- Get detailed breakdown of spend across RI, SP and Ondemand cost with charts and tabular data description: Get detailed breakdown of spend across RI, SP and Ondemand cost operationId: SpendDetails parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. - name: start_date in: query required: true schema: type: string example: '2021-10-19' description: Start date for the spend calculation period. - name: end_date in: query required: true schema: type: string example: '2021-10-19' description: End date for the spend calculation period. requestBody: required: false description: Supported filters for Spends content: '*/*': schema: $ref: '#/components/schemas/SpendBreakdownFilter' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SpendBreakdownResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/coverage/overview: post: tags: - Coverage Overview summary: Get overall coverage across RI, SP and Ondemand description: >- Fetches coverage across RI, SP and Ondemand cost in terms of cost incurred for the given account within the specified date range. operationId: CoverageOverview parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. - name: start_date in: query required: true schema: type: string example: '2021-10-19' description: Start date for the compute coverage calculation period. - name: end_date in: query required: true schema: type: string example: '2021-10-19' description: End date for the compute coverage calculation period. requestBody: required: false description: Service definition content: '*/*': schema: $ref: '#/components/schemas/CopmputeCoverageFilter' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ComputeCoverageResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/coverage/detail: post: tags: - Coverage Detail summary: Get detailed coverage breakdown by specified grouping description: >- Fetches detailed coverage breakdown for specific dimensions like Instance Family, Region, etc. within the specified date range. operationId: CoverageDetail parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: start_date in: query required: true schema: type: string format: date example: '2025-01-01' description: Start date for the coverage calculation period. - name: end_date in: query required: true schema: type: string format: date example: '2025-01-31' description: End date for the coverage calculation period. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. requestBody: required: true content: application/json: schema: type: object properties: group_by: type: string enum: - Instance Family - Region - Machine Type description: Dimension to group coverage data by service: type: string enum: - Amazon Relational Database Service - Amazon Elastic Compute Cloud - Compute default: Amazon Elastic Compute Cloud - Compute description: Service to fetch the details for. required: - group_by responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ComputeCoveragesDetailResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/coverage/details/savingsplans: post: tags: - Coverage Details summary: Get Savings Plans coverage details description: >- Returns SP coverage detail rows grouped by (service, instance_family, region). Each row contains SP-covered spend, on-demand spend and coverage percentage for the given date range. operationId: SPCoverageDetails parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. - name: start_date in: query required: true schema: type: string format: date example: '2025-01-01' description: Start date for the coverage calculation period. - name: end_date in: query required: true schema: type: string format: date example: '2025-01-31' description: End date for the coverage calculation period. requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CopmputeCoverageFilter' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SPCoverageDetailsResponse' '400': description: Invalid request parameters '500': description: Internal server error /gateway/lw/api/accounts/{account_id}/v2/coverage/details/reservedinstances: post: tags: - Coverage Details summary: Get Reserved Instances coverage details description: >- Returns RI coverage detail rows grouped by (instance_type, platform, tenancy, region). Each row contains reservation covered hours, on-demand hours, total running hours, on-demand cost and average coverage percentage for the given date range. operationId: RICoverageDetails parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity. - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing. - name: accountIdentifier in: query required: true schema: type: string description: Identifier of the account. - name: start_date in: query required: true schema: type: string format: date example: '2025-01-01' description: Start date for the coverage calculation period. - name: end_date in: query required: true schema: type: string format: date example: '2025-01-31' description: End date for the coverage calculation period. requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CopmputeCoverageFilter' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RICoverageDetailsResponse' '400': description: Invalid request parameters '500': description: Internal server error /gateway/lw/api/accounts/{account_id}/v2/inventory/ri/overview: post: tags: - RI Inventory Overview summary: Get Reserved Instance Inventory Overview description: >- Fetches overview of Reserved Instance inventory including total counts, distribution, status, and pending actions operationId: GetRIInventoryOverview parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2022-01-01' description: Start date for the inventory period - name: end_date in: query required: false schema: type: string format: date example: '2025-08-30' description: End date for the inventory period requestBody: description: Optional filters for the RI inventory content: application/json: schema: $ref: '#/components/schemas/InventoryRIAPIFilter' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RIInventoryOverviewResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/inventory/sp/overview: post: tags: - SP Inventory Overview summary: Get Savings Plans Inventory Overview description: >- Fetches overview of Savings Plans inventory including total counts, distribution, status, and pending actions operationId: GetSPInventoryOverview parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2024-01-01' description: Start date for the inventory period - name: end_date in: query required: false schema: type: string format: date example: '2025-08-30' description: End date for the inventory period requestBody: description: Optional filters for the SP inventory content: application/json: schema: $ref: '#/components/schemas/InventorySPAPIFilter' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SPInventoryOverviewResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/inventory/ri/list: post: tags: - RI Inventory APIs summary: List Reserved Instances description: Retrieves a paginated list of Reserved Instances with optional filtering operationId: ListReservedInstances parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2020-01-01' description: Start date for filtering Reserved Instances - name: end_date in: query required: false schema: type: string format: date example: '2025-08-30' description: End date for filtering Reserved Instances requestBody: description: Pagination and filtering options required: true content: application/json: schema: $ref: '#/components/schemas/ListReservedInstancesRequest' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ListReservedInstancesResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/inventory/sp/list: post: tags: - SP Inventory APIs summary: List Savings Plans description: Retrieves a paginated list of Savings Plans with optional filtering operationId: ListSavingsPlans parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2020-01-01' description: Start date for filtering Savings Plans - name: end_date in: query required: false schema: type: string format: date example: '2025-08-30' description: End date for filtering Savings Plans requestBody: description: Pagination and filtering options required: true content: application/json: schema: $ref: '#/components/schemas/ListSavingsPlansRequest' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ListSavingsPlansResponse' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/inventory/ri/{riId}/detail: get: tags: - RI Inventory APIs summary: Get Reserved Instance Details description: Retrieves detailed information about a specific Reserved Instance operationId: GetReservedInstanceDetails parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: riId in: path required: true schema: type: string description: Unique identifier of the Reserved Instance - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ReservedInstanceDetailsResponse' '400': description: Invalid request parameters '404': description: Reserved Instance not found /gateway/lw/api/accounts/{account_id}/v2/inventory/sp/{spId}/detail: get: tags: - SP Inventory APIs summary: Get Savings Plan Details description: Retrieves detailed information about a specific Savings Plan operationId: GetSavingsPlanDetails parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: spId in: path required: true schema: type: string description: Unique identifier of the Savings Plan - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SavingsPlanDetailsResponse' '400': description: Invalid request parameters '404': description: Savings Plan not found /gateway/lw/api/accounts/{account_id}/v2/filters/ri: get: tags: - RI Inventory APIs summary: Get Reserved Instance Filter Options description: >- Retrieves available filter options for Reserved Instances including account IDs, instance types, platforms, etc. operationId: GetRIFilterOptions parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: service in: query required: false schema: type: string enum: - Amazon Relational Database Service - Amazon Elastic Compute Cloud - Compute description: Service to fetch filters for responses: '200': description: Successful operation content: application/json: schema: type: object properties: ts: type: integer description: Response timestamp success: type: boolean description: Indicates if the request was successful errors: type: string nullable: true description: Error details, if any response: $ref: '#/components/schemas/InventoryRIAPIFilter' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v2/filters/sp: get: tags: - SP Inventory APIs summary: Get Savings Plans Filter Options description: >- Retrieves available filter options for Savings Plans including account IDs, instance families, payment options, etc. operationId: GetSPFilterOptions parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the Entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing responses: '200': description: Successful operation content: application/json: schema: type: object properties: ts: type: integer description: Response timestamp success: type: boolean description: Indicates if the request was successful errors: type: string nullable: true description: Error details, if any response: $ref: '#/components/schemas/InventorySPAPIFilter' '400': description: Invalid request parameters /gateway/lw/api/accounts/{account_id}/v1/filters: post: tags: - Filter APIs summary: Get all filter options description: >- Retrieves all available filter options including regions, instance families, and provider account IDs for the specified account and optional date range. operationId: GetFilters parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2021-10-19' description: Start date for filtering data (YYYY-MM-DD format) - name: end_date in: query required: false schema: type: string format: date example: '2021-10-19' description: End date for filtering data (YYYY-MM-DD format) - name: service in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service description: AWS service type for filtering. Supported services are EC2 and RDS responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/FilterResponse' '400': description: Invalid request parameters or unsupported service /gateway/lw/api/accounts/{account_id}/v1/filters/regions: post: tags: - Filter APIs summary: Get available regions description: >- Retrieves all available AWS regions for the specified account and optional date range. operationId: GetRegionFilters parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2021-10-19' description: Start date for filtering data (YYYY-MM-DD format) - name: end_date in: query required: false schema: type: string format: date example: '2021-10-19' description: End date for filtering data (YYYY-MM-DD format) - name: service in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service description: AWS service type for filtering. Supported services are EC2 and RDS responses: '200': description: Successful operation content: application/json: schema: type: array items: type: string example: - us-east-1 - us-west-2 - eu-west-1 '400': description: Invalid request parameters or unsupported service /gateway/lw/api/accounts/{account_id}/v1/filters/instancefamilies: post: tags: - Filter APIs summary: Get available instance families description: >- Retrieves all available instance families for the specified account and optional date range. operationId: GetInstanceFamilyFilters parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2021-10-19' description: Start date for filtering data (YYYY-MM-DD format) - name: end_date in: query required: false schema: type: string format: date example: '2021-10-19' description: End date for filtering data (YYYY-MM-DD format) - name: service in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service description: AWS service type for filtering. Supported services are EC2 and RDS responses: '200': description: Successful operation content: application/json: schema: type: array items: type: string example: - m5 - c5 - r5 - db.t3 - db.r5 '400': description: Invalid request parameters or unsupported service /gateway/lw/api/accounts/{account_id}/v1/filters/provideraccounts: post: tags: - Filter APIs summary: Get available provider account IDs description: >- Retrieves all available cloud provider account IDs for the specified account and optional date range. operationId: GetProviderAccountFilters parameters: - name: account_id in: path required: true schema: type: string description: Account Identifier for the entity - name: routingId in: query required: true schema: type: string description: Routing identifier for request processing - name: start_date in: query required: false schema: type: string format: date example: '2021-10-19' description: Start date for filtering data (YYYY-MM-DD format) - name: end_date in: query required: false schema: type: string format: date example: '2021-10-19' description: End date for filtering data (YYYY-MM-DD format) - name: service in: query required: false schema: type: string enum: - Amazon Elastic Compute Cloud - Compute - Amazon Relational Database Service description: AWS service type for filtering. Supported services are EC2 and RDS responses: '200': description: Successful operation content: application/json: schema: type: array items: type: string example: - '123456789012' - '987654321098' '400': description: Invalid request parameters or unsupported service /gateway/lw/api/accounts/{account_id}/v2/landing: get: tags: - Commitment Orchestrator Landing Page summary: Get commitment landing page data description: >- Obtains list of cloud account connectors with their commitment status, coverage, and savings information operationId: LandingPageHandler parameters: - name: account_id description: Account Identifier for the Entity in: path required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/LandingPageResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Internal Server Error /audit/api/auditFilters: get: tags: - AuditFilters summary: >- Get the list of Filters of type Audit satisfying the criteria (if any) in the request operationId: getAuditFilterList parameters: - name: pageIndex in: query description: >- Page number of navigation. If left empty, default value of 0 is assumed schema: type: integer format: int32 default: 0 - name: pageSize in: query description: >- Number of entries per page. If left empty, default value of 100 is assumed schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: searchTerm in: query description: Text to search/filter the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuditError' application/yaml: schema: $ref: '#/components/schemas/AuditError' default: description: Returns the list of Filters of type Audit content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' put: tags: - AuditFilters summary: Updates the Filter of type Audit operationId: updateAuditFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated Filter. This should have all the fields not just the updated ones content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuditError' application/yaml: schema: $ref: '#/components/schemas/AuditError' default: description: Returns the updated Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' post: tags: - AuditFilters summary: Creates a Filter operationId: postAuditFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Filter to create content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuditError' application/yaml: schema: $ref: '#/components/schemas/AuditError' default: description: Returns created Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' /audit/api/auditFilters/{identifier}: get: tags: - AuditFilters summary: Gets a Filter of type Audit by identifier operationId: getAuditFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuditError' application/yaml: schema: $ref: '#/components/schemas/AuditError' default: description: >- Returns Filter of type Audit and having filterIdentifier as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' delete: tags: - AuditFilters summary: Delete a Filter of type Audit by identifier operationId: deleteAuditFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuditError' application/yaml: schema: $ref: '#/components/schemas/AuditError' default: description: Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /audit/api/audits/list: post: tags: - Audit summary: List Audit Events operationId: getAuditEventList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: This has the filter attributes for listing Audit Events content: application/json: schema: $ref: '#/components/schemas/AuditFilterProperties' application/yaml: schema: $ref: '#/components/schemas/AuditFilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuditError' application/yaml: schema: $ref: '#/components/schemas/AuditError' default: description: This has a paginated list of Audit Events. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseAuditEvent' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseAuditEvent' /audit/api/audits/listV2: post: tags: - Audit summary: List Audit Events operationId: getAuditEventListV2 parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: pageIndex in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: 'Results per page(max 100)Default Value: 50' schema: maximum: 100 type: integer format: int32 default: 50 - name: sortOrders in: query description: Sort criteria for the elements. schema: type: array items: $ref: '#/components/schemas/SortOrder' - name: pageToken in: query description: 'Page Token of the next results to fetch.Default Value: ''''' schema: type: string requestBody: description: This has the filter attributes for listing Audit Events content: application/json: schema: $ref: '#/components/schemas/AuditFilterProperties' application/yaml: schema: $ref: '#/components/schemas/AuditFilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/AuditError' application/yaml: schema: $ref: '#/components/schemas/AuditError' default: description: This has a paginated list of Audit Events. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSliceResponseAuditEvent' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOSliceResponseAuditEvent' /audit/api/auditYaml: get: tags: - AuditYaml summary: Gets the YamlDiff of the Audit. operationId: getYamlDiff parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: auditId in: query required: true schema: type: string responses: default: description: Returns the old Yaml and new Yaml. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOYamlDiffRecord' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOYamlDiffRecord' /audit/api/auditYaml/diffs: post: tags: - AuditYaml summary: Get YAML Diffs for Audit Events description: >- Computes field-level YAML diffs for the given audit event IDs in RFC 6902 JSON Patch format. Maximum 20 event IDs per request. Only whitelisted resource types return a diff entry; non-whitelisted events are silently omitted from the response. operationId: getAuditYamlDiffs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: List of audit event IDs to compute YAML diffs for (max 20). content: application/json: schema: $ref: '#/components/schemas/YamlDiffRequest' application/yaml: schema: $ref: '#/components/schemas/YamlDiffRequest' required: true responses: default: description: >- Returns a list of per-event diff results. Events with no yamlDiff record or unsupported resource types are absent. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOYamlDiffResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOYamlDiffResponse' /template/api/filters: get: tags: - Filter summary: List Filters description: Lists Filters for the given criteria. operationId: TemplategetFilterList parameters: - name: pageIndex in: query description: >- Page number of navigation. If left empty, default value of 0 is assumed. schema: type: integer format: int32 default: 0 - name: pageSize in: query description: >- Number of entries per page. If left empty, default value of 100 is assumed schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline - name: searchTerm in: query description: Text to search/filter the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns the list of Filters content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOPageResponseFilter' put: tags: - Filter summary: Update a Filter description: Updates the filter for the given ID. operationId: TemplateupdateFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: >- This is the updated Filter. This should have all the fields not just the updated ones content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns the updated Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' post: tags: - Filter summary: Create a Filter description: Creates a Filter. operationId: TemplatepostFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Connector to create content: application/json: schema: $ref: '#/components/schemas/Filter' text/yaml: schema: $ref: '#/components/schemas/Filter' text/html: schema: $ref: '#/components/schemas/Filter' text/plain: schema: $ref: '#/components/schemas/Filter' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns created Filter content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' /template/api/filters/{identifier}: get: tags: - Filter summary: Return Filter Details description: Returns the settings of a filter for the given ID. operationId: TemplategetFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns Filter having filterIdentifier as specified in request content: application/json: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOFilter' text/html: schema: $ref: '#/components/schemas/ResponseDTOFilter' delete: tags: - Filter summary: Delete a Filter description: Deletes a filter for the given ID. operationId: TemplatedeleteFilter parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Filter Identifier required: true schema: type: string - name: type in: query description: Type of Filter required: true schema: type: string enum: - Connector - Secret - DelegateProfile - Delegate - PipelineSetup - PipelineExecution - Deployment - Audit - Template - Trigger - EnvironmentGroup - FileStore - CCMRecommendation - Anomaly - RIInventory - SPInventory - Autocud - CCMConnector - CCMK8sConnector - Environment - RuleExecution - Override - InputSet - Webhook - CCMBudget - Service - QueuedPipeline responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Boolean status whether request was successful or not content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' text/html: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /template/api/refresh-template/refreshed-yaml: post: tags: - Templates summary: Get YAML with updated Template Inputs description: Returns YAML with updated Template Inputs for a given YAML operationId: getRefreshedYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: Load-From-Cache in: header schema: type: string default: 'false' - name: harnessYamlVersion in: query description: Harness YAML Version schema: type: string default: '0' requestBody: description: YAML content: application/json: schema: $ref: '#/components/schemas/RefreshRequestDTO' application/yaml: schema: $ref: '#/components/schemas/RefreshRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: >- Returns YAML with updated Template Inputs, when an underlying Template has been updated and a reconciliation is pending in a given YAML. content: application/json: schema: $ref: '#/components/schemas/ResponseDTORefreshResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTORefreshResponse' /template/api/refresh-template/validate-template-inputs: get: tags: - Templates summary: Validate Template Inputs in a YAML description: >- Validates the Template Inputs in a pipeline's YAML specification. If the Template Inputs are invalid, the operation returns an error summary. operationId: TemplatevalidateTemplateInputs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: query description: Template Identifier for the entity required: true schema: type: string - name: versionLabel in: query description: Template version required: true schema: type: string - name: Load-From-Cache in: header schema: type: string default: 'false' - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: >- Returns a validation result for Template Inputs present in a YAML specification. content: application/json: schema: $ref: >- #/components/schemas/TemplateResponseDTOValidateTemplateInputsResponseDTO application/yaml: schema: $ref: >- #/components/schemas/TemplateResponseDTOValidateTemplateInputsResponseDTO /template/api/templates/v2/applyTemplates: post: tags: - Templates summary: Gets complete yaml with templateRefs resolved operationId: getYamlWithTemplateRefsResolvedV2 parameters: - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query schema: type: string - name: projectIdentifier in: query schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: Load-From-Cache in: header schema: type: string default: 'false' - name: AppendInputSetValidator in: query schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplateApplyRequestDTO' application/yaml: schema: $ref: '#/components/schemas/TemplateApplyRequestDTO' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Gets complete yaml with templateRefs resolved content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTemplateMergeResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTemplateMergeResponse' /template/api/templates: post: tags: - Templates summary: Create a Template operationId: createTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: label in: query description: >- Optional labels for this version (repeat). Requires template labels FF. schema: type: array items: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: File Path of the Entity. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: storeType in: query description: Tells whether the Entity is to be saved on Git or not schema: type: string enum: - INLINE - REMOTE - INLINE_HC - name: repoName in: query description: Name of the repository. schema: type: string - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean - name: setDefaultTemplate in: query description: Specify true if Default Template is to be set schema: type: boolean default: false - name: comments in: query description: Comments schema: type: string - name: isNewTemplate in: query description: >- When isNewTemplate flag is set user will not be able to create a new version for an existing template schema: type: boolean default: false - name: enableDAG in: query description: >- Set to true for Pipeline templates with DAG (Directed Acyclic Graph) execution schema: type: boolean default: false requestBody: description: Template YAML content: application/json: schema: type: string examples: Create: summary: Sample Create Template YAML description: Sample Template YAML value: | template: name: pipelineTemplate identifier: pipelineTemplate versionLabel: v1 type: Pipeline projectIdentifier: TemplateDemo orgIdentifier: default tags: {} spec: stages: - stage: name: stage1 identifier: stage1 description: "" type: Deployment spec: deploymentType: Kubernetes service: serviceRef: <+input> serviceInputs: <+input> environment: environmentRef: <+input> deployToAll: false environmentInputs: <+input> infrastructureDefinitions: <+input> execution: steps: - step: type: ShellScript name: Shell Script_1 identifier: ShellScript_1 spec: shell: Bash onDelegate: true source: type: Inline spec: script: <+input> environmentVariables: [] outputVariables: [] timeout: 10m rollbackSteps: [] tags: {} failureStrategies: - onFailure: errors: - AllErrors action: type: StageRollback application/yaml: schema: type: string examples: Create: summary: Sample Create Template YAML description: Sample Template YAML value: | template: name: pipelineTemplate identifier: pipelineTemplate versionLabel: v1 type: Pipeline projectIdentifier: TemplateDemo orgIdentifier: default tags: {} spec: stages: - stage: name: stage1 identifier: stage1 description: "" type: Deployment spec: deploymentType: Kubernetes service: serviceRef: <+input> serviceInputs: <+input> environment: environmentRef: <+input> deployToAll: false environmentInputs: <+input> infrastructureDefinitions: <+input> execution: steps: - step: type: ShellScript name: Shell Script_1 identifier: ShellScript_1 spec: shell: Bash onDelegate: true source: type: Inline spec: script: <+input> environmentVariables: [] outputVariables: [] timeout: 10m rollbackSteps: [] tags: {} failureStrategies: - onFailure: errors: - AllErrors action: type: StageRollback required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns the created Template content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTemplateWrapperResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTemplateWrapperResponse' /template/api/templates/{templateIdentifier}/{versionLabel}: delete: tags: - Templates summary: Delete Template Version operationId: deleteTemplateVersion parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: versionLabel in: path description: Version Label required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: Last Object Id schema: type: string - name: comments in: query schema: type: string - name: forceDelete in: query description: >- If true, the Entity will be forced delete, without checking any references/usages schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns true if the Template is deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /template/api/templates/{templateIdentifier}: get: tags: - Templates summary: Get Template operationId: getTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: label in: query description: Label schema: type: string - name: versionLabel in: query description: Version Label schema: type: string - name: deleted in: query description: Specifies whether Template is deleted or not schema: type: boolean default: false - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: Load-From-Cache in: header schema: type: string default: 'false' - name: loadFromFallbackBranch in: query schema: type: boolean default: false responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns the saved Template content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTemplateResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTemplateResponse' /template/api/templates/templateInputs/{templateIdentifier}: get: tags: - Templates summary: Gets Template Input Set YAML operationId: getTemplateInputSetYaml parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: label in: query description: Template Label schema: type: string - name: versionLabel in: query description: Template Version Label schema: type: string - name: Load-From-Cache in: header schema: type: string default: 'false' - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns the Template Input Set YAML content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /template/api/templates/{templateIdentifier}/labels: get: tags: - Templates summary: Get custom labels per template version description: Per-version labels; optional version filter. operationId: getTemplateLabelsMap parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: versionLabel in: query description: Optional. Repeat to limit which versions are included. schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: >- account, org, project, identifier, versionToLabelsMapping, stableVersionLabel content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTemplateLabelMapResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTemplateLabelMapResponse' /template/api/templates/entitySetupUsage/{templateIdentifier}: get: tags: - Templates summary: Get Entities referring this template operationId: listTemplateUsage parameters: - name: pageIndex in: query schema: type: integer format: int32 default: 0 - name: pageSize in: query schema: type: integer format: int32 default: 100 - name: accountIdentifier in: query required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: versionLabel in: query description: Version Label schema: type: string - name: isStableTemplate in: query description: Is Stable Template schema: type: boolean - name: searchTerm in: query schema: type: string - name: allVersions in: query schema: type: string default: 'false' - name: templateEntityType in: query schema: type: string enum: - Step - Stage - Pipeline - CustomDeployment - MonitoredService - SecretManager - ArtifactSource - StepGroup - Workspace - Notification - Agent responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns Entities list referring this template content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseEntitySetupUsage' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOPageResponseEntitySetupUsage' /template/api/templates/list-metadata: post: tags: - Templates summary: Gets all metadata of template list operationId: getTemplateMetadataList parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: type: integer format: int32 default: 25 - name: sort in: query description: >- Specifies sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order schema: type: array items: type: string - name: searchTerm in: query description: The word to be searched and included in the list response schema: type: string - name: filterIdentifier in: query description: Filter Identifier schema: type: string - name: templateListType in: query description: Template List Type required: true schema: type: string enum: - Stable - LastUpdated - All - name: includeAllTemplatesAvailableAtScope in: query description: Specify true if all accessible Templates are to be included schema: type: boolean - name: checkReferenced in: query description: Specify true to check whether template is referenced schema: type: boolean default: false - name: getDistinctFromBranches in: query schema: type: boolean - name: isGlobal in: query schema: type: boolean default: false requestBody: description: >- This contains details of Template filters based on Template Types and Template Names content: application/json: schema: $ref: '#/components/schemas/TemplateFilterProperties' application/yaml: schema: $ref: '#/components/schemas/TemplateFilterProperties' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns a list of all the metadata of all Templates content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageTemplateMetadataSummaryResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOPageTemplateMetadataSummaryResponse /template/api/templates/move-config/{templateIdentifier}: post: tags: - Templates summary: Move Template YAML from inline to remote operationId: moveTemplateConfigs parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: repoName in: query description: Name of the repository. schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: moveConfigType in: query description: >- Tells weather the entity has to be moved from inline to remote or remote to inline schema: type: string enum: - INLINE_TO_REMOTE - name: versionLabel in: query description: Version Label required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Fetches Template YAML from Harness DB and creates a remote entity content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTemplateMoveConfigResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTemplateMoveConfigResponse' /template/api/templates/refresh-and-get/{templateIdentifier}: get: tags: - Templates summary: Refresh cache and fetch a Template description: >- Force-refreshes the git file cache for a remote Template and returns the freshly fetched entity. Requires the git branch query parameter — repo default branch is not inferred when branch is omitted. Behind the PIPE_GITX_FORCE_REFRESH feature flag. operationId: refreshAndGetTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: label in: query description: Label schema: type: string - name: versionLabel in: query description: Version Label schema: type: string - name: branch in: query description: Name of the branch. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns Template YAML fetched fresh from git content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTemplateResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTemplateResponse' /template/api/templates/{templateIdentifier}/labels/replace: post: tags: - Templates summary: Replace custom labels for one template version description: >- Replace labels for one version. Invalid label tokens or other errors throw 4xx. operationId: replaceLabelsForTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string requestBody: description: Labels and target template versionLabel content: application/json: schema: $ref: '#/components/schemas/TemplateLabelsReplaceRequest' application/yaml: schema: $ref: '#/components/schemas/TemplateLabelsReplaceRequest' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' /template/api/templates/update/{templateIdentifier}/{versionLabel}: put: tags: - Templates summary: Update Template Version operationId: updateExistingTemplateVersion parameters: - name: If-Match in: header schema: type: string - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: versionLabel in: path description: Version Label required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: rootFolder in: query description: >- Path to the root folder of the Entity. [Applicable for Old Git Sync only] schema: type: string - name: filePath in: query description: File Path of the Entity. schema: type: string - name: commitMsg in: query description: Commit Message to use for the merge commit. schema: type: string - name: lastObjectId in: query description: >- Its required field during update call request. It can be fetched from the response of GET API call for the entity schema: type: string - name: resolvedConflictCommitId in: query description: >- If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved schema: type: string - name: baseBranch in: query description: Name of the default branch. schema: type: string - name: connectorRef in: query description: >- Identifier of Connector needed for CRUD operations on the respective Entity schema: type: string - name: lastCommitId in: query description: last commit id of the file schema: type: string - name: isNewBranch in: query description: Checks the new branch schema: type: boolean default: false - name: isHarnessCodeRepo in: query description: Is Harness code repo enabled schema: type: boolean - name: setDefaultTemplate in: query description: Specify true if Default Template is to be set schema: type: boolean default: false - name: comments in: query description: Comments schema: type: string requestBody: description: Template YAML content: application/json: schema: type: string examples: Update: summary: Sample Update Template YAML description: Sample Template YAML value: | template: name: pipelineTemplate identifier: pipelineTemplate versionLabel: v1 type: Pipeline projectIdentifier: TemplateDemo orgIdentifier: default tags: {} spec: stages: - stage: name: stage1 identifier: stage1 description: "" type: Deployment spec: deploymentType: Kubernetes service: serviceRef: <+input> serviceInputs: <+input> environment: environmentRef: <+input> deployToAll: false environmentInputs: <+input> infrastructureDefinitions: <+input> execution: steps: - step: type: ShellScript name: Shell Script_1 identifier: ShellScript_1 spec: shell: Bash onDelegate: true source: type: Inline spec: script: <+input> environmentVariables: [] outputVariables: [] timeout: 10m rollbackSteps: [] tags: {} failureStrategies: - onFailure: errors: - AllErrors action: type: StageRollback application/yaml: schema: type: string examples: Update: summary: Sample Update Template YAML description: Sample Template YAML value: | template: name: pipelineTemplate identifier: pipelineTemplate versionLabel: v1 type: Pipeline projectIdentifier: TemplateDemo orgIdentifier: default tags: {} spec: stages: - stage: name: stage1 identifier: stage1 description: "" type: Deployment spec: deploymentType: Kubernetes service: serviceRef: <+input> serviceInputs: <+input> environment: environmentRef: <+input> deployToAll: false environmentInputs: <+input> infrastructureDefinitions: <+input> execution: steps: - step: type: ShellScript name: Shell Script_1 identifier: ShellScript_1 spec: shell: Bash onDelegate: true source: type: Inline spec: script: <+input> environmentVariables: [] outputVariables: [] timeout: 10m rollbackSteps: [] tags: {} failureStrategies: - onFailure: errors: - AllErrors action: type: StageRollback required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns the updated Template Version content: application/json: schema: $ref: '#/components/schemas/ResponseDTOTemplateWrapperResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOTemplateWrapperResponse' /template/api/templates/update/git-metadata/{templateIdentifier}/{versionLabel}: post: tags: - Templates summary: Update git metadata details for a remote template operationId: updateGitDetails parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: versionLabel in: path description: Version Label required: true schema: type: string requestBody: description: This contains details of Git Entity like Git Branch info to be updated content: application/json: schema: $ref: '#/components/schemas/TemplateUpdateGitDetailsRequest' application/yaml: schema: $ref: '#/components/schemas/TemplateUpdateGitDetailsRequest' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Update git metadata details for a remote template content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOTemplateUpdateGitDetailsResponse application/yaml: schema: $ref: >- #/components/schemas/ResponseDTOTemplateUpdateGitDetailsResponse /template/api/templates/updateStableTemplate/{templateIdentifier}/{versionLabel}: put: tags: - Templates summary: Update Stable Template Version operationId: updateStableTemplate parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: path description: Template Identifier for the entity required: true schema: type: string - name: versionLabel in: path description: Version Label required: true schema: type: string - name: branch in: query description: Name of the branch. schema: type: string - name: repoIdentifier in: query description: Git Sync Config Id. [Applicable for Old Git Sync only] schema: type: string - name: getDefaultFromOtherRepo in: query description: if true, return all the default entities schema: type: boolean - name: comments in: query description: Comments schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/TemplateError' application/yaml: schema: $ref: '#/components/schemas/TemplateError' default: description: Returns the updated Template Version content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOString' /cv/api/monitored-service/create-default: post: tags: - Monitored Services operationId: createDefaultMonitoredService parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: environmentIdentifier in: query required: true schema: type: string - name: serviceIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{identifier}: get: tags: - Monitored Services summary: Get monitored service data operationId: getMonitoredService parameters: - name: identifier in: path required: true schema: type: string - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Get monitored service data content: application/json: schema: $ref: '#/components/schemas/ResponseDTOMonitoredServiceResponse' put: tags: - Monitored Services summary: Updates monitored service data operationId: updateMonitoredService parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/MonitoredService' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Updates monitored service data content: application/json: schema: $ref: '#/components/schemas/RestResponseMonitoredServiceResponse' delete: tags: - Monitored Services summary: Delete monitored service data operationId: deleteMonitoredService parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Delete monitored service data content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /cv/api/monitored-service/{identifier}/detach-template: put: tags: - Monitored Services summary: delete template reference from monitored service operationId: detachMonitoredServiceFromTemplate parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: delete template reference from monitored service content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /cv/api/monitored-service/all/time-series-health-sources: get: tags: - Monitored Services operationId: getAllMonitoredServicesWithHealthSources parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{identifier}/anomaliesCount: get: tags: - Monitored Services operationId: CvgetAnomaliesSummary parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: startTime in: query required: true schema: type: integer format: int64 - name: endTime in: query required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/count-of-services: get: tags: - Monitored Services operationId: getCountOfServices parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: environmentIdentifier in: query schema: type: string - name: filter in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/environments: get: tags: - Monitored Services operationId: getEnvironments parameters: - name: accountId in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/health-sources: get: tags: - Monitored Services operationId: getHealthSources parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: serviceIdentifier in: query required: true schema: type: string - name: environmentIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{monitoredServiceIdentifier}/health-sources: get: tags: - Monitored Services operationId: getHealthSourcesForMonitoredServiceIdentifier parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: monitoredServiceIdentifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/list: get: tags: - Monitored Services operationId: getList parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: environmentIdentifier in: query schema: type: string - name: environmentIdentifiers in: query schema: type: array items: type: string - name: offset in: query required: true schema: type: integer format: int32 - name: pageSize in: query required: true schema: type: integer format: int32 - name: filter in: query schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/platform/list: get: tags: - Monitored Services operationId: getListV2 parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: environmentIdentifiers in: query schema: type: array items: type: string - name: offset in: query required: true schema: type: integer format: int32 - name: pageSize in: query required: true schema: type: integer format: int32 - name: filter in: query schema: type: string - name: monitoredServiceType in: query schema: type: string enum: - Application - Infrastructure - name: hideNotConfiguredServices in: query schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{identifier}/secondary-events: get: tags: - Monitored Services operationId: getMSSecondaryEvents parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path required: true schema: type: string - name: startTime in: query required: true schema: type: integer format: int64 - name: endTime in: query required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/secondary-events-details: get: tags: - Monitored Services operationId: getMSSecondaryEventsDetails parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: secondaryEventType in: query required: true schema: type: string enum: - Downtime - DataCollectionFailure - Annotation - ErrorBudgetReset - SrmAnalysisImpact - name: identifiers in: query required: true schema: maxItems: 2147483647 minItems: 1 type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{monitoredServiceIdentifier}/change-details: get: tags: - Monitored Services operationId: getMonitoredServiceChangeDetails parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: monitoredServiceIdentifier in: path required: true schema: type: string - name: sloIdentifiers in: query schema: type: array items: type: string - name: startTime in: query schema: type: integer format: int64 - name: endTime in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{monitoredServiceIdentifier}/service-details: get: tags: - Monitored Services operationId: getMonitoredServiceDetails parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: monitoredServiceIdentifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/service-details: get: tags: - Monitored Services operationId: getMonitoredServiceDetails_1 parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: serviceIdentifier in: query required: true schema: type: string - name: environmentIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' deprecated: true /cv/api/monitored-service/service-environment: get: tags: - Monitored Services operationId: getMonitoredServiceFromServiceAndEnvironment parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: serviceIdentifier in: query required: true schema: type: string - name: environmentIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{monitoredServiceIdentifier}/logs: get: tags: - Monitored Services operationId: getMonitoredServiceLogs parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: monitoredServiceIdentifier in: path required: true schema: type: string - name: logType in: query required: true schema: type: string enum: - ApiCallLog - ExecutionLog - name: errorLogsOnly in: query schema: type: boolean - name: startTime in: query required: true schema: type: integer format: int64 - name: endTime in: query required: true schema: type: integer format: int64 - name: healthSources in: query schema: type: array items: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/reconciliation-status: get: tags: - Monitored Services summary: fetch reconciliation status for template referenced monitored services operationId: getMonitoredServiceReconciliationStatuses parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: templateIdentifier in: query description: Scoped template identifier used to create the monitored service required: true schema: type: string - name: versionLabel in: query description: Template version Label required: true schema: type: string - name: branch in: query description: Git branch of the template schema: type: string - name: repoIdentifier in: query description: Git repo identifier of the template schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: >- fetch reconciliation status for template referenced monitored services content: application/json: schema: $ref: >- #/components/schemas/RestResponsePageResponseMonitoredServiceReference /cv/api/monitored-service/{identifier}/resolved-template-inputs: get: tags: - Monitored Services summary: get monitored service resolved template inputs operationId: getMonitoredServiceResolvedTemplateInputs parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: templateIdentifier in: query description: Scoped template identifier used to create the monitored service required: true schema: type: string - name: versionLabel in: query description: Template version Label required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: get monitored service resolved template inputs content: application/json: schema: $ref: '#/components/schemas/ResponseDTOString' /cv/api/monitored-service/{identifier}/scores: get: tags: - Monitored Services operationId: getMonitoredServiceScore parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{identifier}/notification-rules: get: tags: - Monitored Services summary: Get notification rules for MonitoredService operationId: getNotificationRulesForMonitoredService parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Get notification rules for MonitoredService content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseNotificationRuleResponse /cv/api/monitored-service/{identifier}/overall-health-score: get: tags: - Monitored Services operationId: getOverAllHealthScore parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: duration in: query schema: type: string enum: - FOUR_HOURS - TWENTY_FOUR_HOURS - THREE_DAYS - SEVEN_DAYS - THIRTY_DAYS - name: endTime in: query required: true schema: type: integer format: int64 - name: startTime in: query schema: type: integer format: int64 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/services: get: tags: - Monitored Services operationId: getServices parameters: - name: accountId in: query required: true schema: type: string - name: orgIdentifier in: query required: true schema: type: string - name: projectIdentifier in: query required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{monitoredServiceIdentifier}/health-source/{healthSourceIdentifier}/slo-metrics: get: tags: - Monitored Services operationId: getSloMetrics parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: monitoredServiceIdentifier in: path required: true schema: type: string - name: healthSourceIdentifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/reconciliation-required: get: tags: - Monitored Services summary: >- check if a template referenced monitored service(s) require reconciliation operationId: isReconciliationRequiredForMonitoredServices parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: templateIdentifier in: query description: Scoped template identifier used to create the monitored service required: true schema: type: string - name: versionLabel in: query description: Template version Label required: true schema: type: string - name: monitoredServiceIdentifier in: query description: >- filter to check if reconciliation required for a particular monitored service schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: >- check if a template referenced monitored service(s) require reconciliation content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /cv/api/monitored-service: get: tags: - Monitored Services operationId: list parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: environmentIdentifier in: query schema: type: string - name: environmentIdentifiers in: query schema: type: array items: type: string - name: serviceIdentifier in: query schema: type: string - name: offset in: query required: true schema: type: integer format: int32 - name: pageSize in: query required: true schema: type: integer format: int32 - name: filter in: query schema: type: string - name: monitoredServiceType in: query schema: type: string enum: - Application - Infrastructure - name: servicesAtRiskFilter in: query required: true schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' post: tags: - Monitored Services summary: Saves monitored service data operationId: saveMonitoredService parameters: - name: accountId in: query required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/MonitoredService' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Saves monitored service data content: application/json: schema: $ref: '#/components/schemas/RestResponseMonitoredServiceResponse' /cv/api/monitored-service/move-config/{identifier}: post: tags: - Monitored Services summary: Move MonitoredService YAML from inline to remote operationId: moveMonitoredServiceConfig parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: moveConfigType in: query required: true schema: type: string enum: - INLINE_TO_REMOTE - REMOTE_TO_INLINE responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: >- Fetches MonitoredService YAML from Harness DB and creates a remote entity content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOMonitoredServiceMoveConfigResponse /cv/api/monitored-service/template-input: post: tags: - Monitored Services summary: Saves monitored service from template input operationId: saveMonitoredServiceFromTemplateInput parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string requestBody: description: >- Template input yaml for the monitored service creation from given template content: '*/*': schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Saves monitored service from template input content: application/json: schema: $ref: '#/components/schemas/RestResponseMonitoredServiceResponse' /cv/api/monitored-service/yaml: post: tags: - Monitored Services operationId: saveMonitoredServiceFromYaml parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string requestBody: content: '*/*': schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{identifier}/health-monitoring-flag: put: tags: - Monitored Services operationId: setHealthMonitoringFlag parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: enable in: query required: true schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/{identifier}/template-input: put: tags: - Monitored Services summary: Update monitored service from yaml or template operationId: updateMonitoredServiceFromTemplateInput parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string requestBody: description: >- Template input yaml for the monitored service creation from given template content: '*/*': schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Update monitored service from yaml or template content: application/json: schema: $ref: '#/components/schemas/RestResponseMonitoredServiceResponse' /cv/api/monitored-service/{identifier}/yaml: put: tags: - Monitored Services operationId: updateMonitoredServiceFromYaml parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: identifier in: path required: true schema: type: string requestBody: content: '*/*': schema: type: string required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/monitored-service/yaml-template: get: tags: - Monitored Services operationId: yamlTemplate parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. required: true schema: type: string - name: type in: query schema: type: string enum: - Application - Infrastructure responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}: get: tags: - Downtime operationId: getDowntime parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' put: tags: - Downtime operationId: updateDowntimeData parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Downtime to be updated content: application/json: schema: $ref: '#/components/schemas/Downtime' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' delete: tags: - Downtime operationId: deleteDowntimeData parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services/{identifier}: get: tags: - Downtime operationId: getAssociatedMonitoredServices parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services: get: tags: - Downtime operationId: getDowntimeAssociatedMonitoredServices parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/history: get: tags: - Downtime operationId: getHistory parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 - name: monitoredServiceIdentifier in: query description: For filtering on the basis of monitored services' identifiers schema: type: string - name: filter in: query description: For filtering on the basis of name schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/list: get: tags: - Downtime operationId: listDowntimes parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 - name: monitoredServiceIdentifier in: query description: For filtering on the basis of monitored services' identifiers schema: type: string - name: filter in: query description: For filtering on the basis of name schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime: post: tags: - Downtime operationId: saveDowntime parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the Downtime to be saved content: application/json: schema: $ref: '#/components/schemas/Downtime' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/flag/{identifier}: put: tags: - Downtime operationId: updateDowntimeEnabled parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: enable in: query required: true schema: type: boolean responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/notification-rule/{identifier}: get: tags: - Srm Notification operationId: getNotificationRuleData parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' put: tags: - Srm Notification operationId: updateNotificationRuleData parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/NotificationRule' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' delete: tags: - Srm Notification operationId: deleteNotificationRuleData parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/notification-rule: get: tags: - Srm Notification operationId: getNotificationRuleData_1 parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: notificationRuleIdentifiers in: query schema: type: array items: type: string - name: pageNumber in: query required: true schema: type: integer format: int32 - name: pageSize in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' post: tags: - Srm Notification operationId: saveNotificationRuleData parameters: - name: accountId in: query required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/NotificationRule' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/slo-dashboard/environment-identifiers: get: tags: - SLOs dashboard operationId: getSLOAssociatedEnvironmentIdentifiers parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/slo-dashboard/monitored-services: get: tags: - SLOs dashboard operationId: getSLOAssociatedMonitoredServices parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/slo-dashboard/secondary-events-details: get: tags: - SLOs dashboard operationId: getSecondaryEventDetails parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: secondaryEventType in: query required: true schema: type: string enum: - Downtime - DataCollectionFailure - Annotation - ErrorBudgetReset - SrmAnalysisImpact - name: identifiers in: query required: true schema: maxItems: 2147483647 minItems: 1 type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/slo-dashboard/secondary-events/{identifier}: get: tags: - SLOs dashboard operationId: getSecondaryEvents parameters: - name: identifier in: path description: SLO identifier for the entity required: true schema: type: string - name: startTime in: query required: true schema: type: integer format: int64 - name: endTime in: query required: true schema: type: integer format: int64 - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' /cv/api/slo-dashboard/risk-count: get: tags: - SLOs dashboard summary: Get all SLOs count by risk operationId: getServiceLevelObjectivesRiskCount parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: userJourneyIdentifiers in: query description: For filtering on the basis of user journeys' identifiers schema: type: array items: type: string - name: monitoredServiceIdentifier in: query description: For filtering on the basis of monitored services' identifiers schema: type: string - name: targetTypes in: query description: For filtering on the basis of target types schema: type: array items: type: string enum: - Rolling - Calender - name: errorBudgetRisks in: query description: For filtering on the basis of error budget risks schema: type: array items: type: string enum: - EXHAUSTED - UNHEALTHY - NEED_ATTENTION - OBSERVE - HEALTHY - name: filter in: query description: For filtering on the basis of name schema: type: string - name: sloType in: query description: For filtering on the basis of SLO type schema: type: string enum: - Simple - Composite - name: evaluationType in: query description: For filtering on the basis of SLI Evaluation type schema: type: string enum: - Window - Request - MetricLess - name: evaluationTypes in: query description: For filtering on the basis of SLI Evaluation types schema: type: array items: type: string enum: - Window - Request - MetricLess - name: envIdentifiers in: query description: For Filtering on the basis of environment identifiers schema: type: array items: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Get the risk count for all SLOs content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSLORiskCountResponse' /cv/api/slo-dashboard/widget/{identifier}/consumption: get: tags: - SLOs dashboard summary: Get SLO consumption breakdown operationId: getSloConsumptionBreakdownView parameters: - name: identifier in: path description: SLO identifier for the entity required: true schema: type: string - name: startTime in: query required: true schema: type: integer format: int64 - name: endTime in: query required: true schema: type: integer format: int64 - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLO's details content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseSLOConsumptionBreakdown /cv/api/slo-dashboard/widget/{identifier}: get: tags: - SLOs dashboard summary: Get SLO dashboard details operationId: getSLODetails parameters: - name: identifier in: path description: SLO identifier for the entity required: true schema: type: string - name: startTime in: query schema: type: integer format: int64 - name: endTime in: query schema: type: integer format: int64 - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLO's details content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSLODashboardDetail' /cv/api/slo-dashboard/widgets/list: get: tags: - SLOs dashboard summary: Get SLO list view operationId: getSLOHealthListView parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: userJourneyIdentifiers in: query description: For filtering on the basis of user journeys' identifiers schema: type: array items: type: string - name: monitoredServiceIdentifier in: query description: For filtering on the basis of monitored services' identifiers schema: type: string - name: targetTypes in: query description: For filtering on the basis of target types schema: type: array items: type: string enum: - Rolling - Calender - name: errorBudgetRisks in: query description: For filtering on the basis of error budget risks schema: type: array items: type: string enum: - EXHAUSTED - UNHEALTHY - NEED_ATTENTION - OBSERVE - HEALTHY - name: filter in: query description: For filtering on the basis of name schema: type: string - name: sloType in: query description: For filtering on the basis of SLO type schema: type: string enum: - Simple - Composite - name: evaluationType in: query description: For filtering on the basis of SLI Evaluation type schema: type: string enum: - Window - Request - MetricLess - name: evaluationTypes in: query description: For filtering on the basis of SLI Evaluation types schema: type: array items: type: string enum: - Window - Request - MetricLess - name: envIdentifiers in: query description: For Filtering on the basis of environment identifiers schema: type: array items: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLOs for list view content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSLOHealthListView' post: tags: - SLOs dashboard summary: Get SLO list view operationId: getSLOHealthListViewV2 parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 requestBody: content: '*/*': schema: $ref: '#/components/schemas/SLODashboardApiFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLOs for list view content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSLOHealthListView' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier}: get: tags: - NG SLOs summary: Get SLO data operationId: getServiceLevelObjectiveNg parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLO's data content: application/json: schema: $ref: >- #/components/schemas/RestResponseServiceLevelObjectiveV2Response put: tags: - NG SLOs summary: Update SLO data operationId: updateSLODataNg parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the SLO to be updated content: application/json: schema: $ref: '#/components/schemas/AbstractServiceLevelObjective' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the updated SLO content: application/json: schema: $ref: >- #/components/schemas/RestResponseServiceLevelObjectiveV2Response delete: tags: - NG SLOs summary: Delete SLO data operationId: deleteSLODataNg parameters: - name: identifier in: path description: Identifier for the Entity. required: true schema: type: string - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Returns true if the SLO is deleted content: application/json: schema: $ref: '#/components/schemas/RestResponseBoolean' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/composite-slo/onboarding-graph: post: tags: - NG SLOs summary: Get onBoarding graph for composite slo operationId: getOnboardingGraphNg parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string requestBody: description: Composite SLO spec which consists of list of SLO details content: '*/*': schema: $ref: '#/components/schemas/CompositeServiceLevelObjectiveSpec' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the time series data points for composite slo onBoarding graph content: application/json: schema: $ref: '#/components/schemas/RestResponseTimeGraphResponse' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/status-list: post: tags: - NG SLOs summary: Get SLO list view operationId: getSLOHealthListViewNg parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 requestBody: content: '*/*': schema: $ref: '#/components/schemas/SLODashboardApiFilter' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLOs for list view content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageResponseSLOHealthListView' /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2: get: tags: - NG SLOs summary: Get all SLOs operationId: getServiceLevelObjectivesNg parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string - name: offset in: query description: 'Page Index of the results to fetch.Default Value: 0' required: true schema: type: integer format: int32 - name: pageSize in: query description: Results per page required: true schema: type: integer format: int32 - name: userJourneys in: query schema: type: array items: type: string - name: identifiers in: query schema: type: array items: type: string - name: targetTypes in: query schema: type: array items: type: string enum: - Rolling - Calender - name: errorBudgetRisks in: query schema: type: array items: type: string enum: - EXHAUSTED - UNHEALTHY - NEED_ATTENTION - OBSERVE - HEALTHY responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLOs content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseServiceLevelObjectiveV2Response post: tags: - NG SLOs summary: Saves SLO data operationId: saveSLODataNg parameters: - name: accountIdentifier in: path description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: path description: Organization Identifier for the Entity. required: true schema: type: string - name: projectIdentifier in: path description: Project Identifier for the Entity. required: true schema: type: string requestBody: description: Details of the SLO to be saved content: application/json: schema: $ref: '#/components/schemas/AbstractServiceLevelObjective' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the saved SLO content: application/json: schema: $ref: >- #/components/schemas/RestResponseServiceLevelObjectiveV2Response /cv/api/slo/{identifier}/errorBudgetResetHistory: get: tags: - SLOs summary: Get Error budget reset history operationId: getErrorBudgetResetHistory parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: SLO identifier for the entity required: true schema: type: string responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the error budget reset history content: application/json: schema: $ref: '#/components/schemas/RestResponseListSLOErrorBudgetReset' /cv/api/slo/{identifier}/notification-rules: get: tags: - SLOs summary: Get notification rules for SLO operationId: getNotificationRulesForSLO parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: SLO identifier for the entity required: true schema: type: string - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the notification rules for SLO content: application/json: schema: $ref: >- #/components/schemas/ResponseDTOPageResponseNotificationRuleResponse /cv/api/slo/{identifier}/logs: get: tags: - SLOs summary: Get SLO logs operationId: getServiceLevelObjectiveLogs parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: SLO identifier for the entity required: true schema: type: string - name: logType in: query required: true schema: type: string enum: - ApiCallLog - ExecutionLog - name: errorLogsOnly in: query schema: type: boolean - name: startTime in: query required: true schema: type: integer format: int64 - name: endTime in: query required: true schema: type: integer format: int64 - name: pageNumber in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: pageSize in: query description: Results per page schema: type: integer format: int32 default: 10 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Gets the SLO's logs content: application/json: schema: $ref: '#/components/schemas/RestResponsePageResponseCVNGLog' /cv/api/slo/{identifier}/resetErrorBudget: post: tags: - SLOs summary: Reset Error budget history operationId: resetErrorBudget parameters: - name: accountId in: query description: Account Identifier for the Entity. required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier for the Entity. schema: type: string - name: projectIdentifier in: query description: Project Identifier for the Entity. schema: type: string - name: identifier in: path description: SLO identifier for the entity required: true schema: type: string requestBody: description: Details needed to reset error budget content: '*/*': schema: $ref: '#/components/schemas/SLOErrorBudgetReset' required: true responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Failure' application/yaml: schema: $ref: '#/components/schemas/Failure' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CvError' application/yaml: schema: $ref: '#/components/schemas/CvError' default: description: Reset Error budget history content: application/json: schema: $ref: '#/components/schemas/RestResponseSLOErrorBudgetReset' /cv/api/v1/orgs/{org}/projects/{project}/metric-graph/{slo-identifier}: get: tags: - ServiceLevelObjective - SLOs summary: Get Metric Graph For SLO description: Get Underlying Metrics Graph for SLO operationId: getMetricGraphForSLO parameters: - name: org in: path description: Organization identifier required: true schema: type: string - name: project in: path description: Project identifier required: true schema: type: string - name: slo-identifier in: path description: SLO identifier. required: true schema: type: string - name: start_time in: query description: 'Start Time for the metric graphs. ' schema: type: integer format: int64 - name: end_time in: query description: End Time for the metric graphs. schema: type: integer format: int64 - name: Harness-Account in: header description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. schema: type: string responses: '200': description: Metric Graph response content: application/json: schema: type: array items: $ref: '#/components/schemas/MetricGraph' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Internal Server Error '502': description: Bad Gateway security: - x-api-key: [] /cv/api/v1/orgs/{org}/projects/{project}/slo: get: tags: - ServiceLevelObjective - SLOs summary: List SLOs description: Returns a list of Service Level Objectives operationId: listSlo parameters: - name: org in: path description: Organization identifier required: true schema: type: string - name: project in: path description: Project identifier required: true schema: type: string - name: Harness-Account in: header description: >- Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. schema: type: string - name: page in: query description: >- Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page. schema: type: integer format: int32 default: 0 - name: limit in: query description: 'Pagination: Number of items to return.' schema: maximum: 100 type: integer format: int32 default: 20 - name: composite_slo_identifier in: query description: >- Identifier for the Composite SLO for which underlying SLOs needs to be listed. schema: type: string - name: monitored_service_identifier in: query description: For filtering on the basis of monitored service identifier schema: type: string - name: user_journey_identifiers in: query description: >- List of User Journey identifiers on the basis of which the SLOs are filtered. schema: type: array items: type: string - name: filter in: query description: SLO Name on the basis of which the SLOs are filtered. schema: pattern: ^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$ type: string - name: slo_type in: query description: SLO Types on the basis of which the SLOs are filtered. schema: maxLength: 1024 minLength: 0 type: string - name: env_identifiers in: query description: >- Identifiers of Environments on the basis of which the SLOs are filtered. schema: maxItems: 128 minItems: 0 type: array items: type: string - name: target_types in: query description: Target Types on the basis of which the SLOs are filtered. schema: type: array items: type: string - name: error_budget_risks in: query description: Error Budgets on the basis of which the SLOs are filtered. schema: type: array items: type: string - name: evaluation_type in: query description: Evaluation Type on the basis of which the SLOs are filtered. schema: type: string - name: child_resource in: query description: >- For filtering the simple slo's on the basis of accountId. Set it to true for Account Level SLOs. schema: type: boolean default: false responses: '200': description: SLO List Response body content: application/json: schema: type: array items: $ref: '#/components/schemas/SLOHealthListView' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Internal Server Error '502': description: Bad Gateway security: - x-api-key: [] /cv/api/health-sources: get: tags: - Healthsources summary: List Health Sources operationId: listHealthSources parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier schema: type: string - name: projectIdentifier in: query description: Project Identifier schema: type: string responses: default: description: Lists all Health Sources for the given scope content: application/json: schema: $ref: '#/components/schemas/ResponseDTOListHealthSourceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOListHealthSourceResponse' put: tags: - Healthsources summary: Update a Health Source operationId: updateHealthSource parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier schema: type: string - name: projectIdentifier in: query description: Project Identifier schema: type: string requestBody: description: Health Source configuration content: application/json: schema: $ref: '#/components/schemas/HealthSource' application/yaml: schema: $ref: '#/components/schemas/HealthSource' required: true responses: default: description: Updates an existing Health Source configuration content: application/json: schema: $ref: '#/components/schemas/ResponseDTOHealthSourceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOHealthSourceResponse' post: tags: - Healthsources summary: Create a Health Source operationId: createHealthSource parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier schema: type: string - name: projectIdentifier in: query description: Project Identifier schema: type: string requestBody: description: Health Source configuration content: application/json: schema: $ref: '#/components/schemas/HealthSource' application/yaml: schema: $ref: '#/components/schemas/HealthSource' required: true responses: default: description: Creates a new Health Source for verifying metrics or logs content: application/json: schema: $ref: '#/components/schemas/ResponseDTOHealthSourceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOHealthSourceResponse' /cv/api/health-sources/{identifier}: get: tags: - Healthsources summary: Get a Health Source operationId: getHealthSource parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier schema: type: string - name: projectIdentifier in: query description: Project Identifier schema: type: string - name: identifier in: path description: Health Source Identifier required: true schema: type: string responses: default: description: Retrieves a Health Source by its identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOOptionalHealthSourceResponse' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOOptionalHealthSourceResponse' delete: tags: - Healthsources summary: Delete a Health Source operationId: deleteHealthSource parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier schema: type: string - name: projectIdentifier in: query description: Project Identifier schema: type: string - name: identifier in: path description: Health Source Identifier required: true schema: type: string responses: default: description: Deletes a Health Source by its identifier content: application/json: schema: $ref: '#/components/schemas/ResponseDTOBoolean' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOBoolean' /cv/api/health-sources/{identifier}/runtime-inputs: get: tags: - Healthsources summary: Get runtime inputs for a Health Source operationId: getHealthSourceRuntimeInputs parameters: - name: accountIdentifier in: query description: Account Identifier required: true schema: type: string - name: orgIdentifier in: query description: Organization Identifier schema: type: string - name: projectIdentifier in: query description: Project Identifier schema: type: string - name: identifier in: path description: Health Source Identifier required: true schema: type: string responses: default: description: >- Returns only the fields marked as <+input> on the saved HealthSource. Embed runtimeInputYaml directly as healthSourceInputs in the AI Verify step YAML. content: application/json: schema: $ref: '#/components/schemas/ResponseDTOHealthSourceRuntimeInputs' application/yaml: schema: $ref: '#/components/schemas/ResponseDTOHealthSourceRuntimeInputs' /cv/api/usage/SRM/active-monitored-services/csv/download: get: tags: - Usage summary: Download CSV Active Monitored Services report operationId: downloadActiveMonitoredServiceCSVReport parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: timestamp in: query schema: type: integer format: int64 default: 0 responses: default: description: Download CSV Active Monitored Services report /cv/api/usage/SRM/active-services-monitored/csv/download: get: tags: - Usage summary: Download CSV Active Services Monitored report operationId: downloadActiveServiceMonitoredCSVReport parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: timestamp in: query schema: type: integer format: int64 default: 0 responses: default: description: Download CSV Active Services Monitored report /cv/api/usage/CV: get: tags: - Usage operationId: CvgetLicenseUsage parameters: - name: accountIdentifier in: query required: true schema: type: string - name: timestamp in: query schema: type: integer format: int64 responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSRMLicenseUsageDTO' /cv/api/usage/SRM: get: tags: - Usage operationId: getSRMLicenseUsage parameters: - name: accountIdentifier in: query required: true schema: type: string - name: timestamp in: query schema: type: integer format: int64 responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/ResponseDTOSRMLicenseUsageDTO' /cv/api/usage/SRM/active-monitored-services: post: tags: - Usage summary: >- Returns a List of active monitored services along with identifier,Active Monitored Services Count and other details operationId: listSRMActiveMonitoredServices parameters: - name: accountIdentifier in: query description: Account Identifier for the Entity. schema: type: string - name: page in: query description: 'Page Index of the results to fetch.Default Value: 0' schema: type: integer format: int32 default: 0 - name: size in: query description: Results per page schema: maximum: 50 type: integer format: int32 default: 20 - name: sort in: query description: Sort criteria for the elements. schema: type: array items: type: string - name: timestamp in: query schema: type: integer format: int64 default: 0 requestBody: description: Details of the Active Services Monitored Filter content: '*/*': schema: $ref: '#/components/schemas/ActiveServiceMonitoredFilterParams' responses: default: description: Returns a list of active monitored services content: application/json: schema: $ref: '#/components/schemas/ResponseDTOPageActiveMonitoredService' /gitops/api/filters: get: summary: List filters description: List returns a list of filters. operationId: FilterService_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1FilterList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: searchTerm in: query required: false schema: type: string - name: filterType description: Filter type. One of {APPLICATION} in: query required: false schema: type: string enum: - FILTER_TYPE_UNSET - APPLICATION - AGENT - CLUSTER - REPO default: FILTER_TYPE_UNSET - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - Filters post: summary: Create a filter description: CreateFilter creates a filter operationId: FilterService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Filter' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/v1Filter' tags: - Filters put: summary: Update a filter description: Update updates a filter operationId: FilterService_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Filter' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/v1Filter' tags: - Filters /gitops/api/filters/{identifier}: get: summary: Get get filter details description: Get filter details. operationId: FilterService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Filter' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier description: Identifier for the filter. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: filterType description: Filter type. One of {APPLICATION} in: query required: false schema: type: string enum: - FILTER_TYPE_UNSET - APPLICATION - AGENT - CLUSTER - REPO default: FILTER_TYPE_UNSET tags: - Filters delete: summary: Delete deletes a filter description: Delete filter. operationId: FilterService_Delete responses: '200': description: A successful response. content: application/json: schema: type: boolean default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier description: Identifier for the filter. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: filterType description: Filter type. One of {APPLICATION} in: query required: false schema: type: string enum: - FILTER_TYPE_UNSET - APPLICATION - AGENT - CLUSTER - REPO default: FILTER_TYPE_UNSET tags: - Filters /gitops/api/v1/agents: get: description: List agents. operationId: AgentServiceForServer_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1AgentList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents post: description: Create agent. operationId: AgentServiceForServer_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Agent' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: $ref: '#/components/requestBodies/v1Agent' tags: - Agents /gitops/api/v1/agents/ns: get: description: Get agent namespaces. operationId: AgentServiceForServer_ListNamespaces responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/gitopsservicev1NamespaceList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents /gitops/api/v1/agents/search: post: description: Search agents. operationId: AgentServiceForServer_Search responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1AgentList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: content: application/json: schema: $ref: '#/components/schemas/v1AgentQuery' required: true tags: - Agents /gitops/api/v1/agents/tags: get: description: Get agent tags. operationId: AgentServiceForServer_ListTags responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1TagMap' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents /gitops/api/v1/agents/versions: get: description: Get agent versions. operationId: AgentServiceForServer_ListVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1VersionList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents /gitops/api/v1/agents/{agent.identifier}: put: summary: Update agents. description: >- This API can be used to update an agent's details in Harness. The following fields will be updated to the new values in the body - "tags", "metadata"(all nested fields in metadata will be replaced with new provided values including empty/nil values if they're sent), "description", "type". operationId: AgentServiceForServer_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Agent' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agent.identifier description: The gitops-server generated ID for this gitops-agent in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/v1Agent' tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/applications: get: summary: List applications for a specific agent description: List returns a list of applications for a specific agent. operationId: AgentApplicationService_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.name description: the application's name. in: query required: false schema: type: string - name: query.refresh description: >- set to "normal" OR "hard" if an application refresh is required before fetching. normal refresh only if source has changed(commit, helm chart version, etc.) hard refresh will invalidate all generated manifest caches and force regeneration. in: query required: false schema: type: string - name: query.project description: the project names to restrict returned list applications. in: query required: false explode: true schema: type: array items: type: string - name: query.resourceVersion description: >- when specified with a watch call, shows changes that occur after that particular version of a resource. in: query required: false schema: type: string - name: query.selector description: >- the selector to to restrict returned list to applications only with matched labels. in: query required: false schema: type: string - name: query.repo description: the repoURL to restrict returned list applications. in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: fetchFromHarness description: >- fetchFromHarness is used in Get Application API to fetch application directly from mongodb instead of from agent. Use in Get Application API to fetch application directly from harness. This is already the fallback if the task times out on Gitops Agent. Use with caution as this may not return the latest state of application. in: query required: false schema: type: boolean tags: - Applications post: summary: Create an application description: Create creates a new application in the specified project. operationId: AgentApplicationService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Application' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: clusterIdentifier in: query required: false schema: type: string - name: repoIdentifier in: query required: false schema: type: string - name: skipRepoValidation in: query required: false schema: type: boolean - name: repoIdentifiers in: query required: false explode: true schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationCreateRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/parent/{query.name}: get: summary: Get parent application description: >- Parent returns a parent application (app of apps or appset) by child name operationId: AgentApplicationService_Parent responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Application' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name description: the application's name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.refresh description: >- set to "normal" OR "hard" if an application refresh is required before fetching. normal refresh only if source has changed(commit, helm chart version, etc.) hard refresh will invalidate all generated manifest caches and force regeneration. in: query required: false schema: type: string - name: query.project description: the project names to restrict returned list applications. in: query required: false explode: true schema: type: array items: type: string - name: query.resourceVersion description: >- when specified with a watch call, shows changes that occur after that particular version of a resource. in: query required: false schema: type: string - name: query.selector description: >- the selector to to restrict returned list to applications only with matched labels. in: query required: false schema: type: string - name: query.repo description: the repoURL to restrict returned list applications. in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: fetchFromHarness description: >- fetchFromHarness is used in Get Application API to fetch application directly from mongodb instead of from agent. Use in Get Application API to fetch application directly from harness. This is already the fallback if the task times out on Gitops Agent. Use with caution as this may not return the latest state of application. in: query required: false schema: type: boolean tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.applicationName}/managed-resources: get: summary: Get ManagedResources description: ManagedResources returns list of managed resources. operationId: AgentApplicationService_ManagedResources responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsManagedResourcesResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.applicationName in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.namespace in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: query.version in: query required: false schema: type: string - name: query.group in: query required: false schema: type: string - name: query.kind in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.applicationName}/resource-tree: get: summary: Get resource tree description: ResourceTree returns resource tree. operationId: AgentApplicationService_ResourceTree responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationTree' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.applicationName in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.namespace in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: query.version in: query required: false schema: type: string - name: query.group in: query required: false schema: type: string - name: query.kind in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}: get: summary: Get application description: Get returns an application by name. operationId: AgentApplicationService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Application' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name description: the application's name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.refresh description: >- set to "normal" OR "hard" if an application refresh is required before fetching. normal refresh only if source has changed(commit, helm chart version, etc.) hard refresh will invalidate all generated manifest caches and force regeneration. in: query required: false schema: type: string - name: query.project description: the project names to restrict returned list applications. in: query required: false explode: true schema: type: array items: type: string - name: query.resourceVersion description: >- when specified with a watch call, shows changes that occur after that particular version of a resource. in: query required: false schema: type: string - name: query.selector description: >- the selector to to restrict returned list to applications only with matched labels. in: query required: false schema: type: string - name: query.repo description: the repoURL to restrict returned list applications. in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: fetchFromHarness description: >- fetchFromHarness is used in Get Application API to fetch application directly from mongodb instead of from agent. Use in Get Application API to fetch application directly from harness. This is already the fallback if the task times out on Gitops Agent. Use with caution as this may not return the latest state of application. in: query required: false schema: type: boolean tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/events: get: summary: List resource events description: ListResourceEvents returns a list of event resources. operationId: AgentApplicationService_ListResourceEvents responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsEventList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.resourceNamespace in: query required: false schema: type: string - name: query.resourceName in: query required: false schema: type: string - name: query.resourceUID in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/logs: get: summary: PodLogs returns stream of log entries for the specified pod(s). description: PodLogs returns stream of log entries for the specified pod(s). operationId: AgentApplicationStreamService_PodLogs2 responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/applicationsLogEntry' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of applicationsLogEntry default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.namespace in: query required: false schema: type: string - name: query.podName in: query required: false schema: type: string - name: query.container in: query required: false schema: type: string - name: query.sinceSeconds in: query required: false schema: type: string format: int64 - name: query.sinceTime.seconds description: |- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. in: query required: false schema: type: string format: int64 - name: query.sinceTime.nanos description: >- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context. in: query required: false schema: type: integer format: int32 - name: query.tailLines in: query required: false schema: type: string format: int64 - name: query.follow in: query required: false schema: type: boolean - name: query.untilTime in: query required: false schema: type: string - name: query.filter in: query required: false schema: type: string - name: query.kind in: query required: false schema: type: string - name: query.group in: query required: false schema: type: string - name: query.resourceName in: query required: false schema: type: string - name: query.previous in: query required: false schema: type: boolean - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/logs/batch: get: description: >- PodLogsBatch returns stream of log entry in batches of upto 1000 entries for the specified pod(s). operationId: AgentApplicationStreamService_PodLogsBatch2 responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/applicationsLogEntriesBatch' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of applicationsLogEntriesBatch default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.namespace in: query required: false schema: type: string - name: query.podName in: query required: false schema: type: string - name: query.container in: query required: false schema: type: string - name: query.sinceSeconds in: query required: false schema: type: string format: int64 - name: query.sinceTime.seconds description: |- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. in: query required: false schema: type: string format: int64 - name: query.sinceTime.nanos description: >- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context. in: query required: false schema: type: integer format: int32 - name: query.tailLines in: query required: false schema: type: string format: int64 - name: query.follow in: query required: false schema: type: boolean - name: query.untilTime in: query required: false schema: type: string - name: query.filter in: query required: false schema: type: string - name: query.kind in: query required: false schema: type: string - name: query.group in: query required: false schema: type: string - name: query.resourceName in: query required: false schema: type: string - name: query.previous in: query required: false schema: type: boolean - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/manifests: get: summary: Get application manifest description: GetManifests returns an application manifests. operationId: AgentApplicationService_GetManifests responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesManifestResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.revision in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string - name: query.sourcePositions in: query required: false explode: true schema: type: array items: type: string format: int64 - name: query.revisions in: query required: false explode: true schema: type: array items: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/pods/{query.podName}/logs: get: summary: PodLogs returns stream of log entries for the specified pod(s). description: PodLogs returns stream of log entries for the specified pod(s). operationId: AgentApplicationStreamService_PodLogs responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/applicationsLogEntry' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of applicationsLogEntry default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: query.podName in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.namespace in: query required: false schema: type: string - name: query.container in: query required: false schema: type: string - name: query.sinceSeconds in: query required: false schema: type: string format: int64 - name: query.sinceTime.seconds description: |- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. in: query required: false schema: type: string format: int64 - name: query.sinceTime.nanos description: >- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context. in: query required: false schema: type: integer format: int32 - name: query.tailLines in: query required: false schema: type: string format: int64 - name: query.follow in: query required: false schema: type: boolean - name: query.untilTime in: query required: false schema: type: string - name: query.filter in: query required: false schema: type: string - name: query.kind in: query required: false schema: type: string - name: query.group in: query required: false schema: type: string - name: query.resourceName in: query required: false schema: type: string - name: query.previous in: query required: false schema: type: boolean - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/pods/{query.podName}/logs/batch: get: description: >- PodLogsBatch returns stream of log entry in batches of upto 1000 entries for the specified pod(s). operationId: AgentApplicationStreamService_PodLogsBatch responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/applicationsLogEntriesBatch' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of applicationsLogEntriesBatch default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: query.podName in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.namespace in: query required: false schema: type: string - name: query.container in: query required: false schema: type: string - name: query.sinceSeconds in: query required: false schema: type: string format: int64 - name: query.sinceTime.seconds description: |- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. in: query required: false schema: type: string format: int64 - name: query.sinceTime.nanos description: >- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context. in: query required: false schema: type: integer format: int32 - name: query.tailLines in: query required: false schema: type: string format: int64 - name: query.follow in: query required: false schema: type: boolean - name: query.untilTime in: query required: false schema: type: string - name: query.filter in: query required: false schema: type: string - name: query.kind in: query required: false schema: type: string - name: query.group in: query required: false schema: type: string - name: query.resourceName in: query required: false schema: type: string - name: query.previous in: query required: false schema: type: boolean - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/revisions/{query.revision}/metadata: get: summary: Get revision metadata description: >- RevisionMetadata returns metadata for a specific revision of the application. operationId: AgentApplicationService_RevisionMetadata responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRevisionMetadata' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name description: the application's name in: path required: true schema: type: string - name: query.revision description: the revision of the app in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.appNamespace description: the application's namespace. in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string - name: query.sourceIndex description: source index (for multi source apps). in: query required: false schema: type: integer format: int32 - name: query.versionId description: versionId from historical data (for multi source apps). in: query required: false schema: type: integer format: int32 tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/syncwindows: get: summary: Get sync windows of the application description: GetApplicationSyncWindows returns sync windows of the application. operationId: AgentApplicationService_GetApplicationSyncWindows responses: '200': description: A successful response. content: application/json: schema: $ref: >- #/components/schemas/applicationsApplicationSyncWindowsResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.application.metadata.name}: put: summary: Update an application description: Update updates an application. operationId: AgentApplicationService_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Application' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.application.metadata.name description: >- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: clusterIdentifier in: query required: false schema: type: string - name: repoIdentifier in: query required: false schema: type: string - name: skipRepoValidation in: query required: false schema: type: boolean - name: repoIdentifiers in: query required: false explode: true schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationUpdateRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}: delete: summary: Delete an application description: Delete deletes an application. operationId: AgentApplicationService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: request.cascade in: query required: false schema: type: boolean - name: request.propagationPolicy in: query required: false schema: type: string - name: request.appNamespace in: query required: false schema: type: string - name: request.project in: query required: false schema: type: string - name: options.removeExistingFinalizers in: query required: false schema: type: boolean - name: options.forceDelete in: query required: false schema: type: boolean tags: - Applications patch: summary: Patch an application description: Patch applies a patch to an application. operationId: AgentApplicationService_Patch responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Application' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/servicev1ApplicationPatchRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/operation: delete: summary: Terminate operation description: TerminateOperation terminates the currently running operation. operationId: AgentApplicationService_TerminateOperation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsOperationTerminateResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: request.appNamespace in: query required: false schema: type: string - name: request.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource: get: summary: Get an application resource description: GetResource returns single application resource. operationId: AgentApplicationService_GetResource responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationResourceResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: request.namespace in: query required: false schema: type: string - name: request.resourceName in: query required: false schema: type: string - name: request.version in: query required: false schema: type: string - name: request.group in: query required: false schema: type: string - name: request.kind in: query required: false schema: type: string - name: request.appNamespace in: query required: false schema: type: string - name: request.project in: query required: false schema: type: string tags: - Applications delete: summary: Delete resource description: DeleteResource deletes a single application resource. operationId: AgentApplicationService_DeleteResource responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: request.namespace in: query required: false schema: type: string - name: request.resourceName in: query required: false schema: type: string - name: request.version in: query required: false schema: type: string - name: request.group in: query required: false schema: type: string - name: request.kind in: query required: false schema: type: string - name: request.force in: query required: false schema: type: boolean - name: request.orphan in: query required: false schema: type: boolean - name: request.appNamespace in: query required: false schema: type: string - name: request.project in: query required: false schema: type: string tags: - Applications post: summary: Patch an application resource description: PatchResource patch single application resource. operationId: AgentApplicationService_PatchResource responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationResourceResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationResourcePatchRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource/actions: get: summary: List resource actions description: ListResourceActions returns a list of resource actions. operationId: AgentApplicationService_ListResourceActions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsResourceActionsListResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: request.namespace in: query required: false schema: type: string - name: request.resourceName in: query required: false schema: type: string - name: request.version in: query required: false schema: type: string - name: request.group in: query required: false schema: type: string - name: request.kind in: query required: false schema: type: string - name: request.appNamespace in: query required: false schema: type: string - name: request.project in: query required: false schema: type: string tags: - Applications post: summary: Run resource action description: RunResourceAction runs a resource action. operationId: AgentApplicationService_RunResourceAction responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsResourceActionRunRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/rollback: post: summary: Rollback syncs an application to its target state description: >- Rollback syncs an application to its target state. Harness Event type (rollback). operationId: AgentApplicationService_Rollback responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Application' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationRollbackRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/rollouts/status: get: description: Get current status for the given Rollout resource operationId: RolloutsService_GetRolloutStatus responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1RolloutInfo' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: request.namespace in: query required: false schema: type: string - name: request.resourceName in: query required: false schema: type: string - name: request.version in: query required: false schema: type: string - name: request.group in: query required: false schema: type: string - name: request.kind in: query required: false schema: type: string - name: request.appNamespace in: query required: false schema: type: string - name: request.project in: query required: false schema: type: string tags: - Rollouts /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/spec: put: summary: Update application spec description: UpdateSpec updates an application spec. operationId: AgentApplicationService_UpdateSpec responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationSpec' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationUpdateSpecRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/sync: post: summary: Sync an application description: >- Sync syncs an application to its target state. Harness Event type (deploy) operationId: AgentApplicationService_Sync responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Application' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationSyncRequest' required: true tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping: get: summary: Get Harness-Argo project mapping by agent description: >- GetAppProjectMappingListByAgent retrieves Harness-Argo project mappings list by agent. operationId: AppProjectMappingService_GetAppProjectMappingListByAgent responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1AppProjectMapping' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - Project mappings post: summary: Create Harness-Argo project mapping description: Create creates Harness-Argo project mappings. operationId: AppProjectMappingService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Empty' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/servicev1AppProjectMapping' tags: - Project mappings put: summary: Update Harness-Argo project mapping description: Update updates Harness-Argo project mappings. operationId: AppProjectMappingService_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Empty' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/servicev1AppProjectMapping' tags: - Project mappings /gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping/{name}: delete: summary: Delete Harness-Arog project mapping description: Delete deletes Harness-Argo project mapping. operationId: AppProjectMappingService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Empty' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - Project mappings /gitops/api/v1/agents/{agentIdentifier}/autocreate-logs: get: summary: List auto-create logs description: >- Lists logs for auto-created resources (services, environments, cluster links). Supports filtering by import request ID, application set, or application name. operationId: ReconcilerService_ListAutoCreateLogs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ListAutoCreateLogsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier in: path required: true schema: type: string - name: accountIdentifier in: query required: false schema: type: string - name: orgIdentifier in: query required: false schema: type: string - name: projectIdentifier in: query required: false schema: type: string - name: importRequestId in: query required: false schema: type: string - name: appSetName in: query required: false schema: type: string - name: sinceTime in: query required: false schema: type: string format: int64 - name: limit in: query required: false schema: type: integer format: int32 - name: appName in: query required: false schema: type: string - name: skip in: query required: false schema: type: integer format: int32 tags: - Reconciler /gitops/api/v1/agents/{agentIdentifier}/certificates: get: summary: List all available repository certificates description: List repository certificates. operationId: AgentCertificateService_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/certificatesRepositoryCertificateList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier in: query required: false schema: type: string - name: query.hostNamePattern description: >- A file-glob pattern (not regular expression) the host name has to match. in: query required: false schema: type: string - name: query.certType description: The type of the certificate to match (ssh or https). in: query required: false schema: type: string - name: query.certSubType description: >- The sub type of the certificate to match (protocol dependent, usually only used for ssh certs). in: query required: false schema: type: string tags: - Repository Certificates delete: summary: Delete the certificates that match the RepositoryCertificateQuery description: Delete repository certificates. operationId: AgentCertificateService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/certificatesRepositoryCertificateList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier in: query required: false schema: type: string - name: query.hostNamePattern description: >- A file-glob pattern (not regular expression) the host name has to match. in: query required: false schema: type: string - name: query.certType description: The type of the certificate to match (ssh or https). in: query required: false schema: type: string - name: query.certSubType description: >- The sub type of the certificate to match (protocol dependent, usually only used for ssh certs). in: query required: false schema: type: string tags: - Repository Certificates post: summary: Creates repository certificates on the server description: Create repository certificates. operationId: AgentCertificateService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/certificatesRepositoryCertificateList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/certificatesRepositoryCertificateCreateRequest required: true tags: - Repository Certificates /gitops/api/v1/agents/{agentIdentifier}/cluster_byname: get: summary: Get a cluster managed by an agent by name description: Get a cluster managed by agent using name operationId: AgentClusterService_GetByName responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Cluster' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: fetchScopePrefixedIdentifier description: >- Indicates whether the identifier of cluster fetched must contain harness scope prefix (account./org.) in: query required: false schema: type: boolean tags: - Clusters /gitops/api/v1/agents/{agentIdentifier}/cluster_byurl: get: summary: Get a cluster managed by an agent by URL description: Get a cluster managed by agent using URL operationId: AgentClusterService_GetByUrl responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Cluster' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: server in: query required: false schema: type: string - name: fetchScopePrefixedIdentifier description: >- Indicates whether the identifier of cluster fetched must contain harness scope prefix (account./org.) in: query required: false schema: type: boolean tags: - Clusters /gitops/api/v1/agents/{agentIdentifier}/clusters: get: summary: List returns list of clusters description: List clusters. operationId: AgentClusterService_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/clustersClusterList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: query.server in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: query.id.type description: >- type is the type of the specified cluster identifier ( "server" - default, "name" ). in: query required: false schema: type: string - name: query.id.value description: value holds the cluster server URL or cluster name. in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Clusters post: summary: Create creates a cluster description: Create cluster. operationId: AgentClusterService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Cluster' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/clustersClusterCreateRequest' required: true tags: - Clusters /gitops/api/v1/agents/{agentIdentifier}/clusters/{identifier}: get: summary: Get returns a cluster by identifier description: Get cluster. operationId: AgentClusterService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Cluster' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.server in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: query.id.type description: >- type is the type of the specified cluster identifier ( "server" - default, "name" ). in: query required: false schema: type: string - name: query.id.value description: value holds the cluster server URL or cluster name. in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Clusters delete: summary: Delete deletes a cluster description: Delete cluster. operationId: AgentClusterService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/clustersClusterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.server in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: query.id.type description: >- type is the type of the specified cluster identifier ( "server" - default, "name" ). in: query required: false schema: type: string - name: query.id.value description: value holds the cluster server URL or cluster name. in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string - name: forceDelete in: query required: false schema: type: boolean tags: - Clusters put: summary: Update updates a cluster description: Update cluster. operationId: AgentClusterService_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Cluster' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: forceUpdate in: query required: false schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/clustersClusterUpdateRequest' required: true tags: - Clusters /gitops/api/v1/agents/{agentIdentifier}/deploy.yaml: get: description: GetDeployYaml returns deployment yamls for agents. operationId: AgentServiceForServer_GetDeployYaml responses: '200': description: A successful response. content: application/yaml: schema: type: string default: description: An unexpected error response. content: application/yaml: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: namespace in: query required: false schema: type: string - name: disasterRecoveryIdentifier description: Disaster Recovery Identifier for entity. in: query required: false schema: type: string - name: skipCrds in: query required: false schema: type: boolean - name: caData description: Certificate chain for the agent, must be base64 encoded. in: query required: false schema: type: string - name: proxy.http in: query required: false schema: type: string - name: proxy.https in: query required: false schema: type: string - name: proxy.username in: query required: false schema: type: string - name: proxy.password in: query required: false schema: type: string - name: proxy.skipSSLVerify in: query required: false schema: type: boolean - name: privateKey in: query required: false schema: type: string - name: argocdSettings.enableHelmPathTraversal description: >- Controls the Environment variable HELM_SECRETS_VALUES_ALLOW_PATH_TRAVERSAL to allow or deny dot-dot-slash values file paths. Disabled by default for security reasons. This config is pushed as an env variable to the repo-server. in: query required: false schema: type: boolean - name: argocdSettings.forceEnableInCluster description: >- For a Namespaced gitops agent, incluster is disabled by default. (controlled through variable `cluster.inclusterEnabled` in argocd-cm configmap. NOTE that you will have to manually restrict your namespaced agent's scope to its own cluster since this essentially makes the namespaced agent have access to incluster completely including creating clusterroles. in: query required: false schema: type: boolean - name: argocdSettings.enableArgocdHarnessPlugin in: query required: false schema: type: boolean - name: argocdSettings.applicationNamespaces description: >- Comma-separated list of namespaces (or "*" for all) where Application CRs are allowed to live. Maps to application.namespaces in argocd-cmd-params-cm. in: query required: false schema: type: string tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm: post: description: PostDeployHelmChart returns the Helm Chart for deploying the agents. operationId: AgentServiceForServer_PostDeployHelmChart responses: '200': description: A successful response.(streaming responses) content: application/octet-stream: schema: type: object properties: result: $ref: '#/components/schemas/v1DownloadResponse' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of v1DownloadResponse default: description: An unexpected error response. content: application/octet-stream: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/v1AgentYamlQuery' tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/deployment-spec/yaml: post: description: PostDeployYaml returns deployment yamls for agents. operationId: AgentServiceForServer_PostDeployYaml responses: '200': description: A successful response. content: application/yaml: schema: type: string default: description: An unexpected error response. content: application/yaml: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/v1AgentYamlQuery' tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/export: post: summary: Export GitOps setup description: Export GitOps entities applications, clusters, repositories. operationId: AgentServiceForServer_Export responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ExportResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1ExportRequest' required: true tags: - Export and backup /gitops/api/v1/agents/{agentIdentifier}/gpgkeys: get: summary: List all available repository certificates description: List all available repository certificates. operationId: AgentGPGKeyService_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/gpgkeysGnuPGPublicKeyList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.keyID description: The GPG key ID to query for. in: query required: false schema: type: string tags: - Clusters post: summary: Create one or more GPG public keys in the server's configuration description: Create one or more GPG public keys in the server's configuration. operationId: AgentGPGKeyService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/gpgkeysGnuPGPublicKeyCreateResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/gpgkeysGnuPGPublicKeyCreateRequest' required: true tags: - GnuPGP Keys /gitops/api/v1/agents/{agentIdentifier}/gpgkeys/{query.keyID}: get: summary: Get information about specified GPG public key from the server description: Get information about specified GPG public key from the server. operationId: AgentGPGKeyService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/gpgkeysGnuPGPublicKey' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.keyID description: The GPG key ID to query for in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - GnuPGP Keys delete: summary: Delete specified GPG public key from the server's configuration description: Delete specified GPG public key from the server's configuration. operationId: AgentGPGKeyService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/gpgkeysGnuPGPublicKeyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.keyID description: The GPG key ID to query for in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - GnuPGP Keys /gitops/api/v1/agents/{agentIdentifier}/helm-chart: get: description: GetDeployHelmChart returns the Helm Chart for deploying the agents. operationId: AgentServiceForServer_GetDeployHelmChart responses: '200': description: A successful response.(streaming responses) content: application/octet-stream: schema: type: object properties: result: $ref: '#/components/schemas/v1DownloadResponse' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of v1DownloadResponse default: description: An unexpected error response. content: application/octet-stream: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: namespace in: query required: false schema: type: string - name: disasterRecoveryIdentifier description: Disaster Recovery Identifier for entity. in: query required: false schema: type: string - name: skipCrds in: query required: false schema: type: boolean - name: caData description: Certificate chain for the agent, must be base64 encoded. in: query required: false schema: type: string - name: proxy.http in: query required: false schema: type: string - name: proxy.https in: query required: false schema: type: string - name: proxy.username in: query required: false schema: type: string - name: proxy.password in: query required: false schema: type: string - name: proxy.skipSSLVerify in: query required: false schema: type: boolean - name: privateKey in: query required: false schema: type: string - name: argocdSettings.enableHelmPathTraversal description: >- Controls the Environment variable HELM_SECRETS_VALUES_ALLOW_PATH_TRAVERSAL to allow or deny dot-dot-slash values file paths. Disabled by default for security reasons. This config is pushed as an env variable to the repo-server. in: query required: false schema: type: boolean - name: argocdSettings.forceEnableInCluster description: >- For a Namespaced gitops agent, incluster is disabled by default. (controlled through variable `cluster.inclusterEnabled` in argocd-cm configmap. NOTE that you will have to manually restrict your namespaced agent's scope to its own cluster since this essentially makes the namespaced agent have access to incluster completely including creating clusterroles. in: query required: false schema: type: boolean - name: argocdSettings.enableArgocdHarnessPlugin in: query required: false schema: type: boolean - name: argocdSettings.applicationNamespaces description: >- Comma-separated list of namespaces (or "*" for all) where Application CRs are allowed to live. Maps to application.namespaces in argocd-cmd-params-cm. in: query required: false schema: type: string tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/helm-overrides: get: description: GetDeployOverrides returns the Helm Chart overrides for the agents. operationId: AgentServiceForServer_GetDeployOverrides responses: '200': description: A successful response. content: application/yaml: schema: type: string default: description: An unexpected error response. content: application/yaml: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: namespace in: query required: false schema: type: string - name: disasterRecoveryIdentifier description: Disaster Recovery Identifier for entity. in: query required: false schema: type: string - name: skipCrds in: query required: false schema: type: boolean - name: caData description: Certificate chain for the agent, must be base64 encoded. in: query required: false schema: type: string - name: proxy.http in: query required: false schema: type: string - name: proxy.https in: query required: false schema: type: string - name: proxy.username in: query required: false schema: type: string - name: proxy.password in: query required: false schema: type: string - name: proxy.skipSSLVerify in: query required: false schema: type: boolean - name: privateKey in: query required: false schema: type: string - name: argocdSettings.enableHelmPathTraversal description: >- Controls the Environment variable HELM_SECRETS_VALUES_ALLOW_PATH_TRAVERSAL to allow or deny dot-dot-slash values file paths. Disabled by default for security reasons. This config is pushed as an env variable to the repo-server. in: query required: false schema: type: boolean - name: argocdSettings.forceEnableInCluster description: >- For a Namespaced gitops agent, incluster is disabled by default. (controlled through variable `cluster.inclusterEnabled` in argocd-cm configmap. NOTE that you will have to manually restrict your namespaced agent's scope to its own cluster since this essentially makes the namespaced agent have access to incluster completely including creating clusterroles. in: query required: false schema: type: boolean - name: argocdSettings.enableArgocdHarnessPlugin in: query required: false schema: type: boolean - name: argocdSettings.applicationNamespaces description: >- Comma-separated list of namespaces (or "*" for all) where Application CRs are allowed to live. Maps to application.namespaces in argocd-cmd-params-cm. in: query required: false schema: type: string tags: - Agents post: description: >- PostDeployOverrides returns the Helm Chart overrides for deploying the agents. operationId: AgentServiceForServer_PostDeployOverrides responses: '200': description: A successful response. content: application/yaml: schema: type: string default: description: An unexpected error response. content: application/yaml: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/v1AgentYamlQuery' tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/hosted/cluster: post: summary: CreateHosted creates a harness hosted cluster description: Creates Harness hosted cluster. operationId: AgentClusterService_CreateHosted responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Cluster' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string tags: - Clusters /gitops/api/v1/agents/{agentIdentifier}/operator/yaml: get: description: GetOperatorYaml returns operator yaml for deploying the agents. operationId: AgentServiceForServer_GetOperatorYaml responses: '200': description: A successful response. content: application/yaml: schema: type: string default: description: An unexpected error response. content: application/yaml: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: namespace in: query required: false schema: type: string - name: disasterRecoveryIdentifier description: Disaster Recovery Identifier for entity. in: query required: false schema: type: string - name: skipCrds in: query required: false schema: type: boolean - name: caData description: Certificate chain for the agent, must be base64 encoded. in: query required: false schema: type: string - name: proxy.http in: query required: false schema: type: string - name: proxy.https in: query required: false schema: type: string - name: proxy.username in: query required: false schema: type: string - name: proxy.password in: query required: false schema: type: string - name: proxy.skipSSLVerify in: query required: false schema: type: boolean - name: privateKey in: query required: false schema: type: string - name: argocdSettings.enableHelmPathTraversal description: >- Controls the Environment variable HELM_SECRETS_VALUES_ALLOW_PATH_TRAVERSAL to allow or deny dot-dot-slash values file paths. Disabled by default for security reasons. This config is pushed as an env variable to the repo-server. in: query required: false schema: type: boolean - name: argocdSettings.forceEnableInCluster description: >- For a Namespaced gitops agent, incluster is disabled by default. (controlled through variable `cluster.inclusterEnabled` in argocd-cm configmap. NOTE that you will have to manually restrict your namespaced agent's scope to its own cluster since this essentially makes the namespaced agent have access to incluster completely including creating clusterroles. in: query required: false schema: type: boolean - name: argocdSettings.enableArgocdHarnessPlugin in: query required: false schema: type: boolean - name: argocdSettings.applicationNamespaces description: >- Comma-separated list of namespaces (or "*" for all) where Application CRs are allowed to live. Maps to application.namespaces in argocd-cmd-params-cm. in: query required: false schema: type: string tags: - Agents post: description: PostOperatorYaml returns operator yaml for deploying the agents. operationId: AgentServiceForServer_PostOperatorYaml responses: '200': description: A successful response. content: application/yaml: schema: type: string default: description: An unexpected error response. content: application/yaml: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/v1AgentYamlQuery' tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/primaryNode: patch: description: Set primary disaster recovery node. operationId: AgentServiceForServer_SetPrimaryNode responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Agent' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1AgentSetPrimaryNodeRequest' required: true tags: - Agents /gitops/api/v1/agents/{agentIdentifier}/projects: get: summary: List returns list of Argo projects description: Lists lists Argo projects. operationId: AgentProjectService_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/appprojectsAppProjectList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string tags: - Projects post: summary: Create a new Argo project description: Create a new Argo project operationId: AgentProjectService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/appprojectsAppProject' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/projectsProjectCreateRequest' tags: - Projects /gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}: get: summary: Get returns an Argo project by name description: Get returns an Argo project by name. operationId: AgentProjectService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/appprojectsAppProject' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - Projects delete: summary: Delete deletes an Argo project description: Delete deletes an Argo project. operationId: AgentProjectService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/projectsEmptyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - Projects /gitops/api/v1/agents/{agentIdentifier}/projects/{request.project.metadata.name}: put: summary: Update updates an Argo project description: Update updates an Argo project. operationId: AgentProjectService_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/appprojectsAppProject' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.project.metadata.name description: >- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/projectsProjectUpdateRequest' tags: - Projects /gitops/api/v1/agents/{agentIdentifier}/reconcile/counts: post: summary: Collect entity counts on cluster via agent description: >- Returns number of entities that exist in the cluster on the agent. Filter can be used to count only global entities (with empty project) and those specified by the filter. operationId: ReconcilerService_CollectCounts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/reconcilerReconcileCountsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/servicev1ReconcilerFilter' tags: - Reconciler /gitops/api/v1/agents/{agentIdentifier}/reconcile/import: post: summary: Import data from cluster via agent description: >- Imports data from cluster via agent. There must be at least one project mapping in the database. Returns number of entities imported. operationId: ReconcilerService_ImportData responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/reconcilerReconcileCountsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/servicev1ReconcilerFilter' tags: - Reconciler /gitops/api/v1/agents/{agentIdentifier}/repocreds: post: summary: Create a new repository credential description: CreateRepositoryCredentials creates a new repository credential. operationId: AgentRepositoryCredentialsService_CreateRepositoryCredentials responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1RepositoryCredentials' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/hrepocredsRepoCredsCreateRequest' required: true tags: - Repository credentials /gitops/api/v1/agents/{agentIdentifier}/repocreds/get: post: summary: Get credentials for repository url description: >- GetCredentialsForRepositoryUrl returns a repository credential given its url. operationId: AgentRepositoryCredentialsService_GetCredentialsForRepositoryUrl responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1RepositoryCredentials' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/hrepocredsRepoCredsQuery' required: true tags: - Repository credentials /gitops/api/v1/agents/{agentIdentifier}/repocreds/{identifier}: get: summary: Get repository credential by identifier description: >- GetRepositoryCredentials retrieves a repository credential given its identifier. operationId: AgentRepositoryCredentialsService_GetRepositoryCredentials responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1RepositoryCredentials' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.url description: Repo URL for query. in: query required: false schema: type: string - name: query.repoCredsType description: RepoCreds type - git or helm. in: query required: false schema: type: string tags: - Repository credentials delete: summary: Delete a repository credential description: DeleteRepositoryCredentials deletes a specific repository credential. operationId: AgentRepositoryCredentialsService_DeleteRepositoryCredentials responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/hrepocredsRepoCredsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - Repository credentials put: summary: Update a repository credential description: UpdateRepositoryCredentials updates a specific repository credential. operationId: AgentRepositoryCredentialsService_UpdateRepositoryCredentials responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1RepositoryCredentials' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/hrepocredsRepoCredsUpdateRequest' required: true tags: - Repository credentials /gitops/api/v1/agents/{agentIdentifier}/repositories: get: summary: ListRepositories gets a list of all configured repositories description: ListRepositories gets a list of all configured repositories. operationId: AgentRepositoryService_ListRepositories responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRepositoryList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: query.repo description: Repo URL for query. in: query required: false schema: type: string - name: query.forceRefresh description: Whether to force a cache refresh on repo's connection state. in: query required: false schema: type: boolean - name: query.project description: The associated project project. in: query required: false schema: type: string tags: - Repositories post: summary: CreateRepository creates a new repository configuration description: CreateRepository creates a new repository configuration. operationId: AgentRepositoryService_CreateRepository responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Repository' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: repoCredsId in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoCreateRequest' required: true tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/eso/check: get: summary: Checks whether External Secrets Operator is installed description: >- CheckExternalSecretsOperator Checks whether External Secrets Operator is installed or not operationId: AgentRepositoryService_CheckExternalSecretsOperator responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesCheckESOResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/eso/generators: get: summary: Returns a list of ESO generators installed in agent namespace. description: Returns a list of ESO generators installed in agent namespace. operationId: AgentRepositoryService_ListESOGenerators responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesESOGeneratorResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - UNSET - AWS_ECR - GOOGLE_GCR default: UNSET - name: name in: query required: false schema: type: string - name: url in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/oci/type: post: summary: Returns the Repository type of OCI repo description: CheckOCIRepoType Returns the Repository type of OCI repo operationId: AgentRepositoryService_CheckOCIRepoType responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1OCIRepoTypeResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1OCIRepoType' required: true tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/validate: post: summary: ValidateAccess gets connection state for a repository description: ValidateAccess gets connection state for a repository. operationId: AgentRepositoryService_ValidateAccess responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/commonsConnectionState' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoAccessQuery' required: true tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}: get: summary: Get returns a repository or its credentials description: Get returns a repository or its credentials. operationId: AgentRepositoryService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Repository' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.repo description: Repo URL for query. in: query required: false schema: type: string - name: query.forceRefresh description: Whether to force a cache refresh on repo's connection state. in: query required: false schema: type: boolean - name: query.project description: The associated project project. in: query required: false schema: type: string tags: - Repositories delete: summary: DeleteRepository deletes a repository from the configuration description: DeleteRepository deletes a repository from the configuration. operationId: AgentRepositoryService_DeleteRepository responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.repo description: Repo URL for query. in: query required: false schema: type: string - name: query.forceRefresh description: Whether to force a cache refresh on repo's connection state. in: query required: false schema: type: boolean - name: query.project description: The associated project project. in: query required: false schema: type: string - name: forceDelete in: query required: false schema: type: boolean tags: - Repositories put: summary: UpdateRepository updates a repository configuration description: UpdateRepository updates a repository configuration. operationId: AgentRepositoryService_UpdateRepository responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Repository' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoUpdateRequest' required: true tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/appdetails: get: summary: GetAppDetails returns application details by given path description: GetAppDetails returns application details by given path. operationId: AgentRepositoryService_GetAppDetails responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoAppDetailsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.source.repoURL description: >- RepoURL is the URL to the repository (Git or Helm) that contains the application manifests. in: query required: false schema: type: string - name: query.source.path description: >- Path is a directory path within the Git repository, and is only valid for applications sourced from Git. in: query required: false schema: type: string - name: query.source.targetRevision description: >- TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version. in: query required: false schema: type: string - name: query.source.helm.valueFiles description: >- ValuesFiles is a list of Helm value files to use when generating a template. in: query required: false explode: true schema: type: array items: type: string - name: query.source.helm.releaseName description: >- ReleaseName is the Helm release name to use. If omitted it will use the application name. in: query required: false schema: type: string - name: query.source.helm.values description: >- Values specifies Helm values to be passed to helm template, typically defined as a block. in: query required: false schema: type: string - name: query.source.helm.version description: >- Version is the Helm version to use for templating (either "2" or "3"). in: query required: false schema: type: string - name: query.source.helm.passCredentials description: >- PassCredentials pass credentials to all domains (Helm's --pass-credentials). in: query required: false schema: type: boolean - name: query.source.helm.ignoreMissingValueFiles description: >- IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values. in: query required: false schema: type: boolean - name: query.source.helm.skipCrds description: >- SkipCrds skips custom resource definition installation step (Helm's --skip-crds). in: query required: false schema: type: boolean - name: query.source.helm.namespace description: >- Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace. in: query required: false schema: type: string - name: query.source.helm.kubeVersion description: >- KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster. in: query required: false schema: type: string - name: query.source.helm.apiVersions description: >- APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default, Argo CD uses the API versions of the target cluster. The format is [group/]version/kind. in: query required: false explode: true schema: type: array items: type: string - name: query.source.helm.skipTests description: >- SkipTests skips test manifest installation step (Helm's --skip-tests). in: query required: false schema: type: boolean - name: query.source.helm.skipSchemaValidation description: >- SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation). in: query required: false schema: type: boolean - name: query.source.kustomize.namePrefix description: >- NamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps. in: query required: false schema: type: string - name: query.source.kustomize.nameSuffix description: >- NameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps. in: query required: false schema: type: string - name: query.source.kustomize.images description: Images is a list of Kustomize image override specifications. in: query required: false explode: true schema: type: array items: type: string - name: query.source.kustomize.version description: >- Version controls which version of Kustomize to use for rendering manifests. in: query required: false schema: type: string - name: query.source.kustomize.forceCommonLabels description: >- ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps. in: query required: false schema: type: boolean - name: query.source.kustomize.forceCommonAnnotations description: >- ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps. in: query required: false schema: type: boolean - name: query.source.kustomize.namespace description: Namespace sets the namespace that Kustomize adds to all resources. in: query required: false schema: type: string - name: query.source.kustomize.commonAnnotationsEnvsubst description: >- CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values. in: query required: false schema: type: boolean - name: query.source.kustomize.components description: >- Components specifies a list of kustomize components to add to the kustomization before building. in: query required: false explode: true schema: type: array items: type: string - name: query.source.kustomize.labelWithoutSelector description: >- LabelWithoutSelector specifies whether to apply common labels to resource selectors or not. in: query required: false schema: type: boolean - name: query.source.kustomize.kubeVersion description: >- KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster. in: query required: false schema: type: string - name: query.source.kustomize.apiVersions description: >- APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default, Argo CD uses the API versions of the target cluster. The format is [group/]version/kind. in: query required: false explode: true schema: type: array items: type: string - name: query.source.kustomize.ignoreMissingComponents description: >- IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file. in: query required: false schema: type: boolean - name: query.source.kustomize.labelIncludeTemplates description: >- LabelIncludeTemplates specifies whether to apply common labels to resource templates or not. in: query required: false schema: type: boolean - name: query.source.ksonnet.environment description: Environment is a ksonnet application environment name. in: query required: false schema: type: string - name: query.source.directory.recurse description: >- Recurse specifies whether to scan a directory recursively for manifests. in: query required: false schema: type: boolean - name: query.source.directory.jsonnet.libs description: Additional library search dirs. in: query required: false explode: true schema: type: array items: type: string - name: query.source.directory.exclude description: >- Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation. in: query required: false schema: type: string - name: query.source.directory.include description: >- Include contains a glob pattern to match paths against that should be explicitly included during manifest generation. in: query required: false schema: type: string - name: query.source.plugin.name in: query required: false schema: type: string - name: query.source.chart description: >- Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo. in: query required: false schema: type: string - name: query.source.ref description: >- Ref is reference to another source within sources field. This field will not be used if used with a `source` tag. in: query required: false schema: type: string - name: query.source.name description: >- Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications. in: query required: false schema: type: string - name: query.appName in: query required: false schema: type: string - name: query.appProject in: query required: false schema: type: string - name: query.sourceIndex description: source index (for multi source apps). in: query required: false schema: type: integer format: int32 - name: query.versionId description: versionId from historical data (for multi source apps). in: query required: false schema: type: integer format: int32 tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/apps: get: summary: ListApps returns list of apps in the repo description: ListApps returns list of apps in the repo. operationId: AgentRepositoryService_ListApps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoAppsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.repo in: query required: false schema: type: string - name: query.revision in: query required: false schema: type: string - name: query.appName in: query required: false schema: type: string - name: query.appProject in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/helmcharts: get: summary: GetHelmCharts returns list of helm charts in the specified repository description: GetHelmCharts returns list of helm charts in the specified repository. operationId: AgentRepositoryService_GetHelmCharts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesHelmChartsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.repo description: Repo URL for query. in: query required: false schema: type: string - name: query.forceRefresh description: Whether to force a cache refresh on repo's connection state. in: query required: false schema: type: boolean - name: query.project description: The associated project project. in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/refs: get: summary: Returns a list of refs (e.g. branches and tags) in the repo description: Returns a list of refs (e.g. branches and tags) in the repo. operationId: AgentRepositoryService_ListRefs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRefs' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.repo description: Repo URL for query. in: query required: false schema: type: string - name: query.forceRefresh description: Whether to force a cache refresh on repo's connection state. in: query required: false schema: type: boolean - name: query.project description: The associated project project. in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/appdetails: get: summary: >- GetAppDetailsByUrl returns application details by given path for repositories by URL description: GetAppDetails returns application details by given path. operationId: AgentRepositoryService_GetAppDetailsByUrl responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoAppDetailsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: query.source.repoURL description: >- RepoURL is the URL to the repository (Git or Helm) that contains the application manifests. in: query required: false schema: type: string - name: query.source.path description: >- Path is a directory path within the Git repository, and is only valid for applications sourced from Git. in: query required: false schema: type: string - name: query.source.targetRevision description: >- TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version. in: query required: false schema: type: string - name: query.source.helm.valueFiles description: >- ValuesFiles is a list of Helm value files to use when generating a template. in: query required: false explode: true schema: type: array items: type: string - name: query.source.helm.releaseName description: >- ReleaseName is the Helm release name to use. If omitted it will use the application name. in: query required: false schema: type: string - name: query.source.helm.values description: >- Values specifies Helm values to be passed to helm template, typically defined as a block. in: query required: false schema: type: string - name: query.source.helm.version description: >- Version is the Helm version to use for templating (either "2" or "3"). in: query required: false schema: type: string - name: query.source.helm.passCredentials description: >- PassCredentials pass credentials to all domains (Helm's --pass-credentials). in: query required: false schema: type: boolean - name: query.source.helm.ignoreMissingValueFiles description: >- IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values. in: query required: false schema: type: boolean - name: query.source.helm.skipCrds description: >- SkipCrds skips custom resource definition installation step (Helm's --skip-crds). in: query required: false schema: type: boolean - name: query.source.helm.namespace description: >- Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace. in: query required: false schema: type: string - name: query.source.helm.kubeVersion description: >- KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster. in: query required: false schema: type: string - name: query.source.helm.apiVersions description: >- APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default, Argo CD uses the API versions of the target cluster. The format is [group/]version/kind. in: query required: false explode: true schema: type: array items: type: string - name: query.source.helm.skipTests description: >- SkipTests skips test manifest installation step (Helm's --skip-tests). in: query required: false schema: type: boolean - name: query.source.helm.skipSchemaValidation description: >- SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation). in: query required: false schema: type: boolean - name: query.source.kustomize.namePrefix description: >- NamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps. in: query required: false schema: type: string - name: query.source.kustomize.nameSuffix description: >- NameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps. in: query required: false schema: type: string - name: query.source.kustomize.images description: Images is a list of Kustomize image override specifications. in: query required: false explode: true schema: type: array items: type: string - name: query.source.kustomize.version description: >- Version controls which version of Kustomize to use for rendering manifests. in: query required: false schema: type: string - name: query.source.kustomize.forceCommonLabels description: >- ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps. in: query required: false schema: type: boolean - name: query.source.kustomize.forceCommonAnnotations description: >- ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps. in: query required: false schema: type: boolean - name: query.source.kustomize.namespace description: Namespace sets the namespace that Kustomize adds to all resources. in: query required: false schema: type: string - name: query.source.kustomize.commonAnnotationsEnvsubst description: >- CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values. in: query required: false schema: type: boolean - name: query.source.kustomize.components description: >- Components specifies a list of kustomize components to add to the kustomization before building. in: query required: false explode: true schema: type: array items: type: string - name: query.source.kustomize.labelWithoutSelector description: >- LabelWithoutSelector specifies whether to apply common labels to resource selectors or not. in: query required: false schema: type: boolean - name: query.source.kustomize.kubeVersion description: >- KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster. in: query required: false schema: type: string - name: query.source.kustomize.apiVersions description: >- APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default, Argo CD uses the API versions of the target cluster. The format is [group/]version/kind. in: query required: false explode: true schema: type: array items: type: string - name: query.source.kustomize.ignoreMissingComponents description: >- IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file. in: query required: false schema: type: boolean - name: query.source.kustomize.labelIncludeTemplates description: >- LabelIncludeTemplates specifies whether to apply common labels to resource templates or not. in: query required: false schema: type: boolean - name: query.source.ksonnet.environment description: Environment is a ksonnet application environment name. in: query required: false schema: type: string - name: query.source.directory.recurse description: >- Recurse specifies whether to scan a directory recursively for manifests. in: query required: false schema: type: boolean - name: query.source.directory.jsonnet.libs description: Additional library search dirs. in: query required: false explode: true schema: type: array items: type: string - name: query.source.directory.exclude description: >- Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation. in: query required: false schema: type: string - name: query.source.directory.include description: >- Include contains a glob pattern to match paths against that should be explicitly included during manifest generation. in: query required: false schema: type: string - name: query.source.plugin.name in: query required: false schema: type: string - name: query.source.chart description: >- Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo. in: query required: false schema: type: string - name: query.source.ref description: >- Ref is reference to another source within sources field. This field will not be used if used with a `source` tag. in: query required: false schema: type: string - name: query.source.name description: >- Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications. in: query required: false schema: type: string - name: query.appName in: query required: false schema: type: string - name: query.appProject in: query required: false schema: type: string - name: query.sourceIndex description: source index (for multi source apps). in: query required: false schema: type: integer format: int32 - name: query.versionId description: versionId from historical data (for multi source apps). in: query required: false schema: type: integer format: int32 tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/apps: get: summary: ListAppsByUrl returns list of apps in the repo description: ListApps returns list of apps in the repo. operationId: AgentRepositoryService_ListAppsByUrl responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRepoAppsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: query.repo in: query required: false schema: type: string - name: query.revision in: query required: false schema: type: string - name: query.appName in: query required: false schema: type: string - name: query.appProject in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/helmcharts: get: summary: GetHelmChartsByUrl returns list of helm charts in the repository by URL description: GetHelmCharts returns list of helm charts in the specified repository. operationId: AgentRepositoryService_GetHelmChartsByUrl responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesHelmChartsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: query.repo description: Repo URL for query. in: query required: false schema: type: string - name: query.forceRefresh description: Whether to force a cache refresh on repo's connection state. in: query required: false schema: type: boolean - name: query.project description: The associated project project. in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/refs: get: summary: Returns a list of refs (e.g. branches and tags) in the repo by URL description: Returns a list of refs (e.g. branches and tags) in the repo. operationId: AgentRepositoryService_ListRefsByUrl responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/repositoriesRefs' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: query.repo description: Repo URL for query. in: query required: false schema: type: string - name: query.forceRefresh description: Whether to force a cache refresh on repo's connection state. in: query required: false schema: type: boolean - name: query.project description: The associated project project. in: query required: false schema: type: string tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/repository_byurl: get: summary: Get a repository configured in gitops by URL from Harness description: 'Returns a repository by URL ' operationId: AgentRepositoryService_GetByUrl responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1RepoByUrlRespList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Agent. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Agent. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Agent. in: query required: false schema: type: string - name: url description: URL by which to find the repository entity managed by agent. in: query required: false explode: true schema: type: array items: type: string - name: fetchScopePrefixedIdentifier description: >- Indicates whether the identifier of repo fetched must contain the harness scope prefix such (account./org.) in: query required: false schema: type: boolean tags: - Repositories /gitops/api/v1/agents/{agentIdentifier}/stream/applications: get: summary: Watch returns stream of application change events description: Watch returns stream of application change events. operationId: AgentApplicationStreamService_Watch responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/applicationsApplicationWatchEvent' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of applicationsApplicationWatchEvent default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.name description: the application's name. in: query required: false schema: type: string - name: query.refresh description: >- set to "normal" OR "hard" if an application refresh is required before fetching. normal refresh only if source has changed(commit, helm chart version, etc.) hard refresh will invalidate all generated manifest caches and force regeneration. in: query required: false schema: type: string - name: query.project description: the project names to restrict returned list applications. in: query required: false explode: true schema: type: array items: type: string - name: query.resourceVersion description: >- when specified with a watch call, shows changes that occur after that particular version of a resource. in: query required: false schema: type: string - name: query.selector description: >- the selector to to restrict returned list to applications only with matched labels. in: query required: false schema: type: string - name: query.repo description: the repoURL to restrict returned list applications. in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: fetchFromHarness description: >- fetchFromHarness is used in Get Application API to fetch application directly from mongodb instead of from agent. Use in Get Application API to fetch application directly from harness. This is already the fallback if the task times out on Gitops Agent. Use with caution as this may not return the latest state of application. in: query required: false schema: type: boolean tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/stream/applications/{query.applicationName}/resource-tree: get: summary: WatchResourceTree returns stream of application resource tree description: WatchResourceTree returns stream of application resource tree. operationId: AgentApplicationStreamService_WatchResourceTree responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/applicationsApplicationTree' error: $ref: '#/components/schemas/runtimeStreamError' title: Stream result of applicationsApplicationTree default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.applicationName in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.namespace in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: query.version in: query required: false schema: type: string - name: query.group in: query required: false schema: type: string - name: query.kind in: query required: false schema: type: string - name: query.appNamespace in: query required: false schema: type: string - name: query.project in: query required: false schema: type: string tags: - Applications /gitops/api/v1/agents/{agentIdentifier}/sync-allowed: get: description: GetSyncStatus returns the sync status of the agent. operationId: AgentServiceForServer_GetSyncAllowed responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1SyncAllowedResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent Identifier for the Entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: disasterRecoveryIdentifier description: Disaster Recovery Identifier for entity. in: query required: false schema: type: string tags: - Agents put: description: >- UpdateSyncAllowed updates the sync status of the agent by creating deny sync windows for mapped app projects. operationId: AgentServiceForServer_UpdateSyncAllowed responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1SyncAllowedResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent Identifier for the Entity. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1AgentSyncAllowedUpdateRequest' required: true tags: - Agents /gitops/api/v1/agents/{identifier}: get: description: Get agents. operationId: AgentServiceForServer_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Agent' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents delete: description: Delete agents. operationId: AgentServiceForServer_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Agent' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents /gitops/api/v1/agents/{identifier}/credentials: post: description: Regenerate credentials for agents. operationId: AgentServiceForServer_RegenerateCredentials responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Agent' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier in: path required: true schema: type: string tags: - Agents /gitops/api/v1/agents/{identifier}/scale: post: description: Scale the Hosted agent. operationId: AgentServiceForServer_Scale responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Agent' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1AgentScaleRequest' required: true tags: - Agents /gitops/api/v1/agents/{identifier}/secret-resolution/enabled: get: summary: >- GetSecretResolutionEnabled reports whether Harness secret resolution is enabled for this account and agent version. description: Reports whether Harness secret resolution is enabled for the agent. operationId: AgentServiceForServer_GetSecretResolutionEnabled responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1SecretResolutionEnabledResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents /gitops/api/v1/agents/{identifier}/unique: get: description: Unique returns unique agents. operationId: AgentServiceForServer_Unique responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1UniqueMessage' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - AGENT_TYPE_UNSET - CONNECTED_ARGO_PROVIDER - MANAGED_ARGO_PROVIDER - HOSTED_ARGO_PROVIDER default: AGENT_TYPE_UNSET - name: tags in: query required: false explode: true schema: type: array items: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: scope in: query required: false schema: type: string enum: - AGENT_SCOPE_UNSET - ACCOUNT - ORG - PROJECT default: AGENT_SCOPE_UNSET - name: drIdentifier in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - SORT_BY_NOT_SET - NAME - HEALTH_STATUS - CONNECTIVITY_STATUS - NAMESPACE - VERSION default: SORT_BY_NOT_SET - name: sortOrder in: query required: false schema: type: string enum: - SORT_ORDER_NOT_SET - ASC - DESC default: SORT_ORDER_NOT_SET - name: metadataOnly in: query required: false schema: type: boolean - name: ignoreScope in: query required: false schema: type: boolean - name: connectedStatus in: query required: false schema: type: string enum: - CONNECTED_STATUS_UNSET - CONNECTED - DISCONNECTED default: CONNECTED_STATUS_UNSET - name: healthStatus in: query required: false schema: type: string enum: - HEALTH_STATUS_UNSET - HEALTHY - UNHEALTHY default: HEALTH_STATUS_UNSET - name: withCredentials description: >- Applicable when trying to retrieve an agent. Set to true to include the credentials for the agent in the response. (Private key may not be included in response if agent is already connected to harness). NOTE: Setting this to true requires the user to have edit permissions on Agent. in: query required: false schema: type: boolean - name: includeSecondary in: query required: false schema: type: boolean tags: - Agents /gitops/api/v1/applications: post: summary: List applications description: ListApps retrieves a list of applications. operationId: ApplicationService_ListApps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1Applicationlist' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: $ref: '#/components/requestBodies/servicev1ApplicationQuery' tags: - Application /gitops/api/v1/applications/attributes: get: summary: List attributes for applications description: ListAttributes returns a list of attributes for applications operationId: ApplicationService_ListAttributes responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ApplicationAttributesList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: applicationIdentifiers description: List of application identifiers in: query required: false explode: true schema: type: array items: type: string tags: - Applications /gitops/api/v1/applications/bulk/refresh: post: summary: Bulk refresh multiple applications description: >- BulkRefresh refreshes the status of multiple applications at once, optionally performing a hard refresh if refresh is set to hard. operationId: ApplicationService_BulkRefresh responses: '200': description: A successful response. content: application/json: schema: $ref: >- #/components/schemas/applicationsApplicationBulkRefreshResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationBulkRefreshRequest' required: true tags: - Applications /gitops/api/v1/applications/bulk/sync: post: summary: Bulk sync multiple applications description: >- BulkSync initiates sync for multiple applications to their target states. operationId: ApplicationService_BulkSync responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationBulkSyncResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationBulkSyncRequest' required: true tags: - Applications /gitops/api/v1/applications/ns: post: summary: List namespaces for a specific query description: ListNs retrieves a list of namespaces for a specific query. operationId: ApplicationService_ListNs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/gitopsservicev1NamespaceList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: $ref: '#/components/requestBodies/servicev1ApplicationQuery' tags: - Applications /gitops/api/v1/applications/sets: get: summary: List LegacyApplicationSets description: ListAppSets lists LegacyApplicationSets in the specified project operationId: ApplicationService_ListAppSets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1LegacyApplicationSetList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - Applications /gitops/api/v1/applications/sync: post: summary: List application sync status description: ListAppSync returns a list of application sync status operationId: ApplicationService_ListAppSync responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ApplicationSyncStatuslist' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: content: application/json: schema: $ref: '#/components/schemas/v1ApplicationSyncStatusQuery' required: true tags: - Applications /gitops/api/v1/applications/{name}/exists: get: summary: Check if an application exists description: >- Exists checks whether an application with the given name exists. When appNamespace is set, uniqueness is scoped to the Application CR namespace (apps in different namespaces may share the same Argo name). operationId: ApplicationService_Exists responses: '200': description: A successful response. content: application/json: schema: type: boolean default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: appNamespace in: query required: false schema: type: string tags: - Applications /gitops/api/v1/applicationset: post: summary: Update updates an applicationset description: Update applicationset. operationId: ApplicationSetService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1ApplicationSet' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/applicationsApplicationSetCreateRequest' tags: - ApplicationSet put: summary: Update updates an applicationset description: Update existing applicationset. operationId: ApplicationSetService_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1ApplicationSet' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/applicationsApplicationSetCreateRequest' tags: - ApplicationSet /gitops/api/v1/applicationset/generate: post: summary: Generate child applications from application set description: Generate child applications from application set. operationId: ApplicationSetService_Generate responses: '200': description: A successful response. content: application/json: schema: $ref: >- #/components/schemas/applicationsApplicationSetGenerateResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: createProject description: >- If project not specified and createProject is true, create project if it does not exist. in: query required: false schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationSetGenerateRequest' required: true tags: - ApplicationSet /gitops/api/v1/applicationset/generators: get: summary: List applicationset generators description: List applicationset generators operationId: ApplicationSetService_ListApplicationSetGenerators responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ApplicationSetGeneratorList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' tags: - ApplicationSet /gitops/api/v1/applicationset/generators/{type}: get: summary: Get applicationset generator description: Get applicationset generator operationId: ApplicationSetService_GetApplicationSetGenerator responses: '200': description: A successful response. content: application/json: schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: type in: path required: true schema: type: string enum: - GENERATOR_TYPE_NOT_SET - LIST - CLUSTERS - GIT - SCM_PROVIDER_GITHUB - SCM_PROVIDER_GITLAB - SCM_PROVIDER_GITEA - SCM_PROVIDER_BITBUCKET - SCM_PROVIDER_AZURE - SCM_PROVIDER_BITBUCKET_CLOUD - SCM_PROVIDER_AWS_CODE_COMMIT - DUCK_TYPE - PULL_REQUEST_GITHUB - PULL_REQUEST_GITLAB - PULL_REQUEST_GITEA - PULL_REQUEST_BITBUCKET - PULL_REQUEST_BITBUCKET_CLOUD - PULL_REQUEST_AZURE - MATRIX - MERGE - PLUGIN - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string tags: - ApplicationSet /gitops/api/v1/applicationset/templates/{type}: get: summary: Get applicationset template description: Get applicationset template operationId: ApplicationSetService_GetApplicationSetTemplate responses: '200': description: A successful response. content: application/json: schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: type in: path required: true schema: type: string enum: - GENERATOR_TYPE_NOT_SET - LIST - CLUSTERS - GIT - SCM_PROVIDER_GITHUB - SCM_PROVIDER_GITLAB - SCM_PROVIDER_GITEA - SCM_PROVIDER_BITBUCKET - SCM_PROVIDER_AZURE - SCM_PROVIDER_BITBUCKET_CLOUD - SCM_PROVIDER_AWS_CODE_COMMIT - DUCK_TYPE - PULL_REQUEST_GITHUB - PULL_REQUEST_GITLAB - PULL_REQUEST_GITEA - PULL_REQUEST_BITBUCKET - PULL_REQUEST_BITBUCKET_CLOUD - PULL_REQUEST_AZURE - MATRIX - MERGE - PLUGIN - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string tags: - ApplicationSet /gitops/api/v1/applicationset/{identifier}: get: summary: Get applicationset description: Returns an applicationset by identifier. operationId: ApplicationSetService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1ApplicationSet' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier description: UUID for the Application Set. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: fetchMode description: Fetch mode for the entity. in: query required: false schema: type: string enum: - NOT_SET - LIVE - CACHED default: NOT_SET tags: - ApplicationSet delete: summary: Delete applicationset by id description: Delete applicationset. operationId: ApplicationSetService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationSetResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier description: UUID for the Application Set. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string tags: - ApplicationSet /gitops/api/v1/applicationset/{identifier}/resource-tree: get: summary: ResourceTree returns resource tree description: ResourceTree returns resource tree operationId: ApplicationSetService_ResourceTree responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsApplicationSetTree' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: identifier description: UUID for the Application Set. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: query.appsetNamespace description: >- The application set namespace. Default empty is argocd control plane namespace. in: query required: false schema: type: string tags: - ApplicationSet /gitops/api/v1/applicationsets: post: summary: List applicationsets description: List applicationsets operationId: ApplicationSetService_List responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1ApplicationSetList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: content: application/json: schema: $ref: '#/components/schemas/v1ApplicationSetQuery' required: true tags: - ApplicationSet /gitops/api/v1/appprojectsmapping: get: summary: Get Harness-Argo project mappings description: GetAppProjectMappingList retrieves Harness-Argo project mappings list. operationId: AppProjectMappingService_GetAppProjectMappingList responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1AppProjectMapping' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string tags: - Project mappings /gitops/api/v1/certificates: get: summary: List certificates description: ListCerts retrieves a list of certificates operationId: CertificateService_ListCerts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Certificatelist' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: includeChildScopes in: query required: false schema: type: boolean tags: - Certificates /gitops/api/v1/clusters: post: summary: List clusters description: ListClusters returns a list of clusters. operationId: ClusterService_ListClusters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Clusterlist' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: content: application/json: schema: $ref: '#/components/schemas/servicev1ClusterQuery' required: true tags: - Clusters /gitops/api/v1/clusters/exists: get: summary: Check if a cluster exists description: Exists checks whether a cluster with the given identifier exists. operationId: ClusterService_Exists responses: '200': description: A successful response. content: application/json: schema: type: boolean default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: server in: query required: false schema: type: string tags: - Clusters /gitops/api/v1/dashboard/activity: post: summary: Get recent deployment statistics description: RecentDeployments returns aggregate statistics of recent deployments. operationId: DashboardService_RecentDeployments responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1RecentDeploymentsDetailsList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: content: application/json: schema: $ref: '#/components/schemas/v1RecentDeploymentQuery' required: true tags: - Dashboard Aggregates /gitops/api/v1/dashboard/counts: get: summary: Get recently created app, cluster, repo counts description: >- RecentlyCreatedCounts lists the count of clusters, repositories, and applications created within a specified time period. operationId: DashboardService_RecentlyCreatedCounts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1RecentlyCreatedOverview' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: endTime in: query required: false schema: type: integer format: int32 - name: startTime in: query required: false schema: type: integer format: int32 tags: - Dashboards /gitops/api/v1/dashboard/overview: get: summary: Get dashboard overview description: >- GetDashboardOverview provides an overview of the dashboard including key metrics. operationId: DashboardService_GetDashboardOverview responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1DashboardOverview' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: disasterRecoveryIdentifier in: query required: false schema: type: string tags: - Dashboards /gitops/api/v1/dashboard/topapps: get: summary: List top 5 most deployed apps description: >- TopApplicationPhaseStats lists phase status counts for the top 5 most deployed applications. operationId: DashboardService_TopApplicationPhaseStats responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1TopApplicationPhaseStatsList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: endTime in: query required: false schema: type: integer format: int32 - name: startTime in: query required: false schema: type: integer format: int32 - name: limit in: query required: false schema: type: integer format: int32 tags: - Dashboard Aggregates /gitops/api/v1/gpgkeys: get: summary: List all GPG keys description: ListGPGKeys retrieves all available GPG public keys. operationId: GnuPGKeyService_ListGPGKeys responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1GnuPGPublicKeyList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: gnuPG in: query required: false schema: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: includeChildScopes in: query required: false schema: type: boolean tags: - GPG Keys /gitops/api/v1/repocreds: post: summary: List repository credentials description: >- ListRepositoryCredentials retrieves a list of all repository credentials. operationId: AgentRepositoryCredentialsService_ListRepositoryCredentials responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/servicev1RepositoryCredentialsList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: content: application/json: schema: $ref: '#/components/schemas/v1RepositoryCredentialsQuery' required: true tags: - Repository credentials /gitops/api/v1/repositories: get: summary: List Repositories by repository credential template description: >- ListRepositoriesByRepositoryCredentialTemplate lists Repositories by repositories credential template operationId: RepositoryService_ListRepositoriesByRepositoryCredentialTemplate responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Repositorylist' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: repositoryCredentialURL in: query required: false schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - Repositories post: summary: List repositories description: ListRepositories retrieves a list of all configured repositories. operationId: RepositoryService_ListRepositories responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Repositorylist' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' requestBody: content: application/json: schema: $ref: '#/components/schemas/v1RepoListReq' required: true tags: - Repositories /gitops/api/v1/repositories/exists: get: summary: Check if a repository exists description: Exists checks whether a repository with the given URL exists. operationId: RepositoryService_Exists responses: '200': description: A successful response. content: application/json: schema: type: boolean default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: url in: query required: false schema: type: string tags: - Repositories /gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping: post: summary: Create Harness-Argo project mapping V2 description: CreateV2 creates Harness-Argo project mappings. operationId: AppProjectMappingService_CreateV2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1AppProjectMappingV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1AppProjectMappingCreateRequestV2' required: true tags: - Project mappings /gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}: get: summary: Get Harness-Argo project mapping V2 description: >- GetAppProjectMappingV2 retrieves Harness-Argo project mapping for the given identifier. operationId: AppProjectMappingService_GetAppProjectMappingV2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1AppProjectMappingV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier description: app project mapping identifier. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: argoProjectName in: query required: false schema: type: string - name: autoCreateServiceEnv description: >- Enable automated creation of service,environment and cluster-env link. Defaults to false. in: query required: false schema: type: boolean tags: - Project mappings delete: summary: Delete Harness-Argo project mapping description: DeleteV2 deletes Harness-Argo project mappings. operationId: AppProjectMappingService_DeleteV2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1Empty' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier description: app project mapping identifier. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: argoProjectName description: Argo Project name for the Entity. in: query required: false schema: type: string tags: - Project mappings put: summary: Update Harness-Argo project mappings V2 description: UpdateV2 updates Harness-Argo project mappings. operationId: AppProjectMappingService_UpdateV2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1AppProjectMappingV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier description: app project mapping identifier. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1AppProjectMappingQueryV2' required: true tags: - Project mappings /gitops/api/v2/agents/{agentIdentifier}/appprojectsmappings: get: summary: Get Harness-Argo project mapping list by agent V2 description: >- GetAppProjectMappingsListByAgentV2 retrieves Harness-Argo project mappings list by agent. operationId: AppProjectMappingService_GetAppProjectMappingsListByAgentV2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1AppProjectMappingV2List' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: identifier description: app project mapping identifier. in: query required: false schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: argoProjectName in: query required: false schema: type: string - name: autoCreateServiceEnv description: >- Enable automated creation of service,environment and cluster-env link. Defaults to false. in: query required: false schema: type: boolean tags: - Project mappings /gitops/api/v2/agents/{agentIdentifier}/argoprojects: get: description: ListForAgent lists all ArgoCD AppProjects mapped to this agent. operationId: AgentArgoProjectService_ListForAgent responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ArgoProjectList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: query.name in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - ArgoProjects post: description: >- Create creates an ArgoCD AppProject CRD in the cluster and auto-creates a Harness mapping if one does not exist. If a mapping already exists it is reused. operationId: AgentArgoProjectService_Create responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ArgoProject' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: mapToHarnessProject.projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: mapToHarnessProject.orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: mapToHarnessProject.autoCreateServiceEnv description: >- Enable automated creation of service,environment and cluster-env link. Defaults to false. in: query required: false schema: type: boolean requestBody: $ref: '#/components/requestBodies/projectsProjectCreateRequest' tags: - ArgoProjects /gitops/api/v2/agents/{agentIdentifier}/argoprojects/{query.name}: get: description: >- Get returns an ArgoCD AppProject by name. Must be mapped to a Harness project. operationId: AgentArgoProjectService_Get responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ArgoProject' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - ArgoProjects delete: description: >- Delete deletes an ArgoCD AppProject from the cluster. Must be mapped. Does not remove the Harness mapping. operationId: AgentArgoProjectService_Delete responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/projectsEmptyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - ArgoProjects /gitops/api/v2/agents/{agentIdentifier}/argoprojects/{query.name}/events: get: description: >- ListEvents returns Kubernetes events for a named ArgoCD AppProject. Must be mapped. operationId: AgentArgoProjectService_ListEvents responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/applicationsEventList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: query.name in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - ArgoProjects /gitops/api/v2/agents/{agentIdentifier}/argoprojects/{request.project.metadata.name}: put: description: >- Update updates an ArgoCD AppProject spec. Must be mapped to a Harness project. operationId: AgentArgoProjectService_Update responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ArgoProject' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: path required: true schema: type: string - name: request.project.metadata.name description: >- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional in: path required: true schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string requestBody: $ref: '#/components/requestBodies/projectsProjectUpdateRequest' tags: - ArgoProjects /gitops/api/v2/appprojectsmapping: get: summary: Get Harness-Argo project mappings with pagination and search description: >- ListAppProjectMappings retrieves Harness-Argo project mappings list with pagination and search. operationId: AppProjectMappingService_ListAppProjectMappings responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1AppProjectMappingList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: agentIdentifier description: Agent identifier for entity. in: query required: false schema: type: string - name: accountIdentifier description: Account Identifier for the Entity. in: query required: false schema: type: string - name: orgIdentifier description: Organization Identifier for the Entity. in: query required: false schema: type: string - name: projectIdentifier description: Project Identifier for the Entity. in: query required: false schema: type: string - name: searchTerm in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer format: int32 - name: pageIndex in: query required: false schema: type: integer format: int32 tags: - Project mappings /gitops/api/v2/versions/agents/upgrade-available: get: description: Check for version updates. operationId: VersionUpgradeService_UpgradeAvailableV2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1VersionUpgradeResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/gatewayruntimeError' parameters: - name: existingVersion description: Current Agent Version in: query required: false schema: type: string tags: - Agents /pm/api/v1/aida/accept: post: tags: - aida description: Record explicit AI acceptance from UI operationId: aida#accept parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Rerum tenetur. example: Blanditiis iusto. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AcceptRequestBody' example: output: |- package policy ... prompt: make a policy that... responses: '204': description: No Content response. '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] /pm/api/v1/aida/analyze: post: tags: - aida description: Describe Policy On Basis of rego operationId: aida#analyze parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Sed quae quia minima velit et vel. example: Blanditiis voluptatem non quis. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AnalyzeRequestBody' example: entityType: encryptedJsonData example rego: query example responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/AnalyzeResponse' example: desc: policy example status: SUCCESS '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] /pm/api/v1/aida/generate: post: tags: - aida description: Generate Policy On Basis of free Text operationId: aida#generate parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Sunt est soluta quaerat rerum id. example: Optio ipsam ratione fuga magni. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GenerateRequestBody' example: policyData: encryptedJsonData example query: query example responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/PolicySample' example: policy: policy example status: SUCCESS '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] /pm/api/v1/dashboard: get: tags: - dashboard description: Get metrics about policies, policy sets and evaluations operationId: dashboard#metrics parameters: - name: range in: query description: >- The time period over which to aggregate dashboard data. Can be: 24 hours, 7 days or 30 days allowEmptyValue: true schema: type: string description: >- The time period over which to aggregate dashboard data. Can be: 24 hours, 7 days or 30 days default: 30d example: 30d enum: - 24h - 7d - 30d example: 30d - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Suscipit quibusdam vero et et saepe mollitia. example: Dolor ad. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DashboardMetrics' example: aggregates: - error: 2668095310586059300 pass: 7917376174519928000 time: 877082768067338000 warning: 7963367341719450000 - error: 2668095310586059300 pass: 7917376174519928000 time: 877082768067338000 warning: 7963367341719450000 policy_health: total_evaluation_count: 6633902564523388000 total_evaluation_entity_count: error: 1424236024467160800 pass: 46865177373020330 warning: 1751867406371044400 total_policy_count: 3340742178032407600 total_policy_set_count: 7213994061844399000 total_policy_set_entity_count: Ad facere minima.: 1607291756625562600 Eum necessitatibus et fugit voluptatem ducimus quia.: 7181021126027306000 Quas cum est beatae eos voluptate.: 6670231524980875000 '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] /pm/api/v1/evaluate: post: tags: - evaluate description: Evaluate arbitrary rego operationId: evaluate#evaluate parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Rerum itaque earum consequatur odit et. example: Voluptatum sunt rerum quod quo velit. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EvaluateRequestBody' example: input: message: everyone rego: |- package test deny["should say hello world"] {input.message != "world"} responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/EvaluatedPolicy' example: deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 policy_severity: Warn & Continue status: error '400': description: 'LargePayload: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: [] - api_key_header_x-api-key: [] /pm/api/v1/evaluations: get: tags: - evaluations description: List evaluations operationId: evaluations#list parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: per_page in: query description: Number of results per page allowEmptyValue: true schema: type: integer description: Number of results per page default: 50 example: 20 format: int64 minimum: 1 maximum: 100 example: 20 - name: page in: query description: Page number (starting from 0) allowEmptyValue: true schema: type: integer description: Page number (starting from 0) default: 0 example: 4 format: int64 minimum: 0 example: 4 - name: entity in: query description: Filter by the entity associated with the evaluation allowEmptyValue: true schema: type: string description: Filter by the entity associated with the evaluation example: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e example: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e - name: type in: query description: Filter by the type associated with the evaluation allowEmptyValue: true schema: type: string description: Filter by the type associated with the evaluation example: pipeline example: pipeline - name: action in: query description: Filter by the action associated with the evaluation allowEmptyValue: true schema: type: string description: Filter by the action associated with the evaluation example: onrun example: onrun - name: last_seen in: query description: Retrieve results starting after this last-seen result allowEmptyValue: true schema: type: integer description: Retrieve results starting after this last-seen result example: 123 format: int64 example: 123 - name: created_date_from in: query description: Retrieve results created from this date allowEmptyValue: true schema: type: integer description: Retrieve results created from this date example: 123 format: int64 example: 123 - name: created_date_to in: query description: Retrieve results created up to this date allowEmptyValue: true schema: type: integer description: Retrieve results created up to this date example: 123 format: int64 example: 123 - name: status in: query description: Retrieve results with these statuses allowEmptyValue: true schema: type: string description: Retrieve results with these statuses example: pass,warning,error example: pass,warning,error - name: includeChildScopes in: query description: >- When true, evaluations from child scopes will be included in the results allowEmptyValue: true schema: type: boolean description: >- When true, evaluations from child scopes will be included in the results default: false example: true example: false - name: execution_id in: query description: Filter by the execution Id associated with the evaluation allowEmptyValue: true schema: type: string description: Filter by the execution Id associated with the evaluation example: ehsPKtczTRO5CUDAt-NR example: ehsPKtczTRO5CUDAt-NR - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Ipsa nihil tenetur et qui eum voluptatum. example: Tempora est facere. responses: '200': description: OK response. headers: Link: description: Link-based paging schema: type: string description: Link-based paging example: '' example: '' X-Page-Index: description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. example: 4 format: int64 example: 4 X-Page-Item-Count: description: Number of results in this page schema: type: integer description: Number of results in this page example: 20 format: int64 example: 20 X-Page-Number: description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. schema: type: integer description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. example: 4 format: int64 example: 4 X-Page-Size: description: >- Requested page size. Harness standard pagination header X-Page-Size. schema: type: integer description: >- Requested page size. Harness standard pagination header X-Page-Size. example: 20 format: int64 example: 20 X-Total-Elements: description: >- Total number of results available. Harness standard pagination header X-Total-Elements. schema: type: integer description: >- Total number of results available. Harness standard pagination header X-Total-Elements. example: 230 format: int64 example: 230 X-Total-Items: description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. example: 230 format: int64 example: 230 X-Total-Pages: description: Total pages available schema: type: integer description: Total pages available example: 12 format: int64 example: 12 content: application/json: schema: type: array items: $ref: '#/components/schemas/Evaluation' example: - account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service - account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service example: - account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service - account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_view - api_key_header_x-api-key: [] /pm/api/v1/evaluations/evaluation-input-signed-url/{evaluation_id}: get: tags: - evaluations summary: Get signed URL for evaluation input description: Get signed URL for evaluation input offloaded to bucket storage operationId: evaluations#evaluation-input-signed-url parameters: - name: evaluation_id in: path description: The evaluation ID to get the input signed URL for required: true schema: type: integer description: The evaluation ID to get the input signed URL for example: 1234 format: int64 example: 1234 - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Ut et ea dicta nisi eius dolor. example: Magni eligendi quod omnis sed. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/EvaluationInputSignedURLResponseBody' example: expires: 1704067200000 signed_url: Sit minus omnis rerum. '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_view - api_key_header_x-api-key: [] /pm/api/v1/evaluations/getYaml: get: tags: - evaluations description: Get entity yaml operationId: evaluations#getYaml parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: entityIdentifier in: query description: Entity identifier allowEmptyValue: true required: true schema: type: string description: Entity identifier example: testPipelineName example: testPipelineName - name: entityType in: query description: Entity type allowEmptyValue: true required: true schema: type: string description: Entity type example: pipeline enum: - pipeline example: pipeline - name: validateAsync in: query description: Validate Async allowEmptyValue: true schema: type: boolean description: Validate Async example: true example: true - name: parentEntityConnectorRef in: query description: Connector Reference allowEmptyValue: true schema: type: string description: Connector Reference example: github_connector example: github_connector - name: parentEntityRepoName in: query description: Repo Name allowEmptyValue: true schema: type: string description: Repo Name example: testrepo example: testrepo - name: loadFromFallbackBranch in: query description: Load from fall back branch allowEmptyValue: true schema: type: boolean description: Load from fall back branch example: true example: true - name: branch in: query description: Git Branch allowEmptyValue: true schema: type: string description: Git Branch example: main example: main - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Nemo aliquam aut. example: Fugit sit fugit. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/EntityYaml' example: yaml: 'x: asdf' '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: [] - api_key_header_x-api-key: [] /pm/api/v1/evaluations/{id}: get: tags: - evaluations description: Find an evaluation by ID operationId: evaluations#find parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: id in: path description: The ID of the evaluation to retrieve required: true schema: type: integer description: The ID of the evaluation to retrieve example: 123 format: int64 examples: default: summary: default value: 123 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Eos vero pariatur aperiam quasi earum. example: Fugiat sequi laudantium consequatur impedit dolorem. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/Evaluation' example: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 policy_severity: Warn & Continue status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 policy_severity: Warn & Continue status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_view - api_key_header_x-api-key: [] /pm/api/v1/examples: get: tags: - examples description: list examples operationId: examples#list parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Veniam accusantium dignissimos. example: Vitae ab sit et recusandae accusamus molestiae. responses: '200': description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyExample' example: - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval example: - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - desc: This is a pipeline example input: '{"message": "everyone"}' name: Pipeline example rego: |- package test deny["should say hello world"] {input.message != "world"} type: pipeline variables: - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval - default: - JiraUpdate - HarnessApproval desc: The required steps that the policy enforces id: requiredsteps name: Required Steps type: selectOne values: - JiraUpdate - HarnessApproval '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] /pm/api/v1/policies: get: tags: - policies description: List all policies operationId: policies#list parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: per_page in: query description: Number of results per page allowEmptyValue: true schema: type: integer description: Number of results per page default: 50 example: 20 format: int64 minimum: 1 maximum: 100 example: 20 - name: page in: query description: Page number (starting from 0) allowEmptyValue: true schema: type: integer description: Page number (starting from 0) default: 0 example: 4 format: int64 minimum: 0 example: 4 - name: identifierFilter in: query description: Comma separated List of Identifiers to filter on allowEmptyValue: true schema: type: string description: Comma separated List of Identifiers to filter on default: '' example: test-projectId1, test-projectId2 example: test-projectId1, test-projectId2 - name: searchTerm in: query description: Filter results by partial name match allowEmptyValue: true schema: type: string description: Filter results by partial name match default: '' example: poli example: poli - name: sort in: query description: Sort order for results allowEmptyValue: true schema: type: string description: Sort order for results default: name,ASC example: updated,ASC enum: - name,ASC - name,DESC - updated,ASC - updated,DESC example: name,DESC - name: excludeRegoFromResponse in: query description: Set to true to exclude Rego content from the response allowEmptyValue: true schema: type: boolean description: Set to true to exclude Rego content from the response default: false example: false example: false - name: includePolicySetCount in: query description: >- Set to true to include the count of policy sets associated with each policy in the response allowEmptyValue: true schema: type: boolean description: >- Set to true to include the count of policy sets associated with each policy in the response default: false example: true example: true - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Consequatur nam eveniet amet veritatis quia veritatis. example: Sit molestiae id quod quaerat consequatur. responses: '200': description: OK response. headers: Link: description: Link-based paging schema: type: string description: Link-based paging example: '' example: '' X-Page-Index: description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. example: 4 format: int64 example: 4 X-Page-Item-Count: description: Number of results in this page schema: type: integer description: Number of results in this page example: 20 format: int64 example: 20 X-Page-Number: description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. schema: type: integer description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. example: 4 format: int64 example: 4 X-Page-Size: description: >- Requested page size. Harness standard pagination header X-Page-Size. schema: type: integer description: >- Requested page size. Harness standard pagination header X-Page-Size. example: 20 format: int64 example: 20 X-Total-Elements: description: >- Total number of results available. Harness standard pagination header X-Total-Elements. schema: type: integer description: >- Total number of results available. Harness standard pagination header X-Total-Elements. example: 230 format: int64 example: 230 X-Total-Items: description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. example: 230 format: int64 example: 230 X-Total-Pages: description: Total pages available schema: type: integer description: Total pages available example: 12 format: int64 example: 12 content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyManagementPolicy' example: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 example: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 '400': description: 'GitError: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/PolicyManagementError' example: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '409': description: 'PolicyReferenced: Conflict response.' content: application/json: schema: $ref: '#/components/schemas/PolicyReferencedResult' example: message: Vel odit. referenced_by: - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] post: tags: - policies description: Create a policy operationId: policies#create parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: git_commit_msg in: query description: The commit message used in git when creating the policy allowEmptyValue: true schema: type: string description: The commit message used in git when creating the policy example: harness policy commit msg example: harness policy commit msg - name: git_import in: query description: >- A flag to determine if the api should try and import and existing policy from git allowEmptyValue: true schema: type: boolean description: >- A flag to determine if the api should try and import and existing policy from git example: true example: true - name: git_branch in: query description: The git branch the policy will be created in allowEmptyValue: true schema: type: string description: The git branch the policy will be created in example: main example: main - name: git_is_new_branch in: query description: A flag to determine if the api should try and commit to a new branch allowEmptyValue: true schema: type: boolean description: >- A flag to determine if the api should try and commit to a new branch example: true example: true - name: git_base_branch in: query description: >- If committing to a new branch, git_base_branch tells the api which branch to base the new branch from allowEmptyValue: true schema: type: string description: >- If committing to a new branch, git_base_branch tells the api which branch to base the new branch from example: main example: main - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Pariatur harum atque dolor rerum. example: Quas numquam aliquid suscipit. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRequestBody' example: git_connector_ref: . git_path: .harness/policy.rego git_repo: github.com/org/repo identifier: policy-1 name: Check that an approval step is present rego: |- package test deny["should say hello world"] {input.message != "world"} responses: '201': description: Created response. content: application/json: schema: $ref: '#/components/schemas/PolicyManagementPolicy' example: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Fugiat autem accusamus esse. polciy_size_in_bytes: 5151500800531891000 policy_package_name: Dolor laborum soluta exercitationem veritatis hic. policy_set_count: 3 project_id: test-project rego: '' unique_id: Voluptas non quam atque voluptates. updated: 1636669297674 '400': description: 'GitError: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/PolicyManagementError' example: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '409': description: 'PolicyReferenced: Conflict response.' content: application/json: schema: $ref: '#/components/schemas/PolicyReferencedResult' example: message: Ea adipisci quo sint consequatur. referenced_by: - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_create - api_key_header_x-api-key: [] /pm/api/v1/policies/move-policy/{identifier}: post: tags: - policies description: Move an inline policy's configuration to remote (Git) operationId: policies#move_policy parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: identifier in: path description: Identifier of the policy to move required: true schema: type: string description: Identifier of the policy to move example: policy-1 minLength: 1 example: policy-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Alias assumenda aut provident reiciendis. example: Et nihil. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MovePolicyRequestBody' example: git_base_branch: main git_branch: main git_commit_msg: Move policy to remote git_connector_ref: github_connector git_is_new_branch: false git_path: .harness/policy.rego git_repo: github.com/org/repo responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/PolicyManagementPolicy' example: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Et quis. polciy_size_in_bytes: 6239048642669652000 policy_package_name: Expedita optio ex qui perferendis at perferendis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Sit qui deserunt sed atque rerum. updated: 1636669297674 '400': description: 'GitError: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/PolicyManagementError' example: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '409': description: 'PolicyReferenced: Conflict response.' content: application/json: schema: $ref: '#/components/schemas/PolicyReferencedResult' example: message: Iusto ut exercitationem delectus perferendis aut atque. referenced_by: - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_edit - api_key_header_x-api-key: [] /pm/api/v1/policies/{identifier}: delete: tags: - policies description: >- Delete a policy by identifier. Returns 409 Conflict if the policy is referenced by policy sets (unless force=true). operationId: policies#delete parameters: - name: force in: query description: Force deletion even if the policy is referenced by policy sets allowEmptyValue: true schema: type: boolean description: Force deletion even if the policy is referenced by policy sets default: false example: false example: false - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: identifier in: path description: Identifier of the policy required: true schema: type: string description: Identifier of the policy example: policy-1 minLength: 1 examples: default: summary: default value: policy-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Iure consectetur odio. example: Saepe veniam vero aut distinctio omnis. responses: '204': description: No Content response. '400': description: 'GitError: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/PolicyManagementError' example: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '409': description: 'PolicyReferenced: Conflict response.' content: application/json: schema: $ref: '#/components/schemas/PolicyReferencedResult' example: message: Quod qui quod doloremque aspernatur. referenced_by: - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_delete - api_key_header_x-api-key: [] get: tags: - policies description: Find a policy by identifier operationId: policies#find parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: git_branch in: query description: The git branch the policy resides in allowEmptyValue: true schema: type: string description: The git branch the policy resides in example: main example: main - name: show_summary in: query description: "Setting to true returns the metadata about the\n\t\t\t requested policy including the information held about the status of this policy in the default branch.\n\t\t\t git_branch is ignored as no git operation takes place." allowEmptyValue: true schema: type: boolean description: "Setting to true returns the metadata about the\n\t\t\t requested policy including the information held about the status of this policy in the default branch.\n\t\t\t git_branch is ignored as no git operation takes place." example: true example: true - name: identifier in: path description: Identifier of the policy to retrieve required: true schema: type: string description: Identifier of the policy to retrieve example: policy-1 minLength: 1 examples: default: summary: default value: policy-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Quia amet sapiente. example: Explicabo illum sed. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/PolicyManagementPolicy' example: account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Autem inventore ut ea voluptates sunt. polciy_size_in_bytes: 3949905420204983300 policy_package_name: Aut ab vitae voluptate incidunt natus ullam. policy_set_count: 3 project_id: test-project rego: '' unique_id: Error et rerum nam. updated: 1636669297674 '400': description: 'GitError: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/PolicyManagementError' example: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '409': description: 'PolicyReferenced: Conflict response.' content: application/json: schema: $ref: '#/components/schemas/PolicyReferencedResult' example: message: Sed ut dolor ullam suscipit enim et. referenced_by: - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] patch: tags: - policies description: Update a policy by identifier operationId: policies#update parameters: - name: git_commit_msg in: query description: The commit message used in git when creating the policy allowEmptyValue: true schema: type: string description: The commit message used in git when creating the policy example: harness policy commit msg example: harness policy commit msg - name: git_is_new_branch in: query description: A flag to determine if the api should try and commit to a new branch allowEmptyValue: true schema: type: boolean description: >- A flag to determine if the api should try and commit to a new branch example: true example: true - name: git_base_branch in: query description: >- If committing to a new branch, git_base_branch tells the api which branch to base the new branch from allowEmptyValue: true schema: type: string description: >- If committing to a new branch, git_base_branch tells the api which branch to base the new branch from example: main example: main - name: git_branch in: query description: The git branch the policy resides in allowEmptyValue: true schema: type: string description: The git branch the policy resides in example: main example: main - name: git_commit_sha in: query description: The existing commit sha of the file being updated allowEmptyValue: true schema: type: string description: The existing commit sha of the file being updated example: 1369b45c20fc685113adcfd1a08a914180ff3c0d example: 1369b45c20fc685113adcfd1a08a914180ff3c0d - name: git_file_id in: query description: >- The existing file id of the file being updated, not required for bitbucket files allowEmptyValue: true schema: type: string description: >- The existing file id of the file being updated, not required for bitbucket files example: 1369b45c20fc685113adcfd1a08a914180ff3c0d example: 1369b45c20fc685113adcfd1a08a914180ff3c0d - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: identifier in: path description: Identifier of the policy required: true schema: type: string description: Identifier of the policy example: policy-1 example: policy-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Aut hic odio iste ea. example: Tempore sed saepe. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRequestBody' example: name: Check that an approval step is present rego: |- package test deny["should say hello world"] {input.message != "world"} responses: '204': description: No Content response. '400': description: 'GitError: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/PolicyManagementError' example: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '409': description: 'PolicyReferenced: Conflict response.' content: application/json: schema: $ref: '#/components/schemas/PolicyReferencedResult' example: message: Unde corrupti et consequatur laboriosam saepe officiis. referenced_by: - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_edit - api_key_header_x-api-key: [] /pm/api/v1/policies/{identifier}/policysets: get: tags: - policies description: List all policy sets that reference a specific policy operationId: policies#list_policy_sets parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: per_page in: query description: Number of results per page allowEmptyValue: true schema: type: integer description: Number of results per page default: 50 example: 20 format: int64 minimum: 1 maximum: 100 example: 20 - name: page in: query description: Page number (starting from 0) allowEmptyValue: true schema: type: integer description: Page number (starting from 0) default: 0 example: 4 format: int64 minimum: 0 example: 4 - name: searchTerm in: query description: Filter results by partial name match allowEmptyValue: true schema: type: string description: Filter results by partial name match default: '' example: poli example: poli - name: sort in: query description: Sort order for results allowEmptyValue: true schema: type: string description: Sort order for results default: name,ASC example: name,ASC enum: - name,ASC - name,DESC - updated,ASC - updated,DESC example: updated,ASC - name: identifier in: path description: Identifier for the policy required: true schema: type: string description: Identifier for the policy example: policy-1 example: policy-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Quis ut cum sunt. example: Accusantium fugiat sequi non blanditiis. responses: '200': description: OK response. headers: Link: description: Link-based paging schema: type: string description: Link-based paging example: '' example: '' X-Page-Index: description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. example: 4 format: int64 example: 4 X-Page-Item-Count: description: Number of results in this page schema: type: integer description: Number of results in this page example: 20 format: int64 example: 20 X-Page-Number: description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. schema: type: integer description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. example: 4 format: int64 example: 4 X-Page-Size: description: >- Requested page size. Harness standard pagination header X-Page-Size. schema: type: integer description: >- Requested page size. Harness standard pagination header X-Page-Size. example: 20 format: int64 example: 20 X-Total-Elements: description: >- Total number of results available. Harness standard pagination header X-Total-Elements. schema: type: integer description: >- Total number of results available. Harness standard pagination header X-Total-Elements. example: 230 format: int64 example: 230 X-Total-Items: description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. example: 230 format: int64 example: 230 X-Total-Pages: description: Total pages available schema: type: integer description: Total pages available example: 12 format: int64 example: 12 content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyToPolicySet' example: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 example: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project updated: 1636669297674 '400': description: 'GitError: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/PolicyManagementError' example: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '409': description: 'PolicyReferenced: Conflict response.' content: application/json: schema: $ref: '#/components/schemas/PolicyReferencedResult' example: message: Deserunt eius omnis voluptate debitis quo. referenced_by: - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. - account_id: Quis aliquam fugit facere. identifier: Non et vitae omnis id. name: Quod itaque. org_id: Laborum iure. project_id: Corporis sequi consequatur. '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicy_view - api_key_header_x-api-key: [] /pm/api/v1/policysets: get: tags: - policysets description: List all policy sets operationId: policysets#list parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: per_page in: query description: Number of results per page allowEmptyValue: true schema: type: integer description: Number of results per page default: 50 example: 20 format: int64 minimum: 1 maximum: 100 example: 20 - name: page in: query description: Page number (starting from 0) allowEmptyValue: true schema: type: integer description: Page number (starting from 0) default: 0 example: 4 format: int64 minimum: 0 example: 4 - name: identifierFilter in: query description: Comma separated List of Identifiers to filter on allowEmptyValue: true schema: type: string description: Comma separated List of Identifiers to filter on default: '' example: test-projectId1, test-projectId2 example: test-projectId1, test-projectId2 - name: searchTerm in: query description: Filter results by partial name match allowEmptyValue: true schema: type: string description: Filter results by partial name match default: '' example: poli example: poli - name: sort in: query description: Sort order for results allowEmptyValue: true schema: type: string description: Sort order for results default: name,ASC example: name,DESC enum: - name,ASC - name,DESC - updated,ASC - updated,DESC example: updated,DESC - name: type in: query description: Filter results by type allowEmptyValue: true schema: type: string description: Filter results by type example: pipeline minLength: 1 example: pipeline - name: types in: query description: >- Filter results by multiple types (comma-separated), e.g. pipeline,environment allowEmptyValue: true schema: type: string description: >- Filter results by multiple types (comma-separated), e.g. pipeline,environment example: pipeline,environment minLength: 1 example: pipeline,environment - name: action in: query description: Filter results by action allowEmptyValue: true schema: type: string description: Filter results by action example: onrun minLength: 1 example: onrun - name: yaml_version in: query description: Harness yaml version associated with this policySet allowEmptyValue: true schema: type: string description: Harness yaml version associated with this policySet default: '0' example: '0' enum: - '0' - '1' example: '0' - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Labore dolorum dolorum ut repudiandae ut nisi. example: Officia quasi ipsum consectetur facere quaerat illo. responses: '200': description: OK response. headers: Link: description: Link-based paging schema: type: string description: Link-based paging example: '' example: '' X-Page-Index: description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. example: 4 format: int64 example: 4 X-Page-Item-Count: description: Number of results in this page schema: type: integer description: Number of results in this page example: 20 format: int64 example: 20 X-Page-Number: description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. schema: type: integer description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. example: 4 format: int64 example: 4 X-Page-Size: description: >- Requested page size. Harness standard pagination header X-Page-Size. schema: type: integer description: >- Requested page size. Harness standard pagination header X-Page-Size. example: 20 format: int64 example: 20 X-Total-Elements: description: >- Total number of results available. Harness standard pagination header X-Total-Elements. schema: type: integer description: >- Total number of results available. Harness standard pagination header X-Total-Elements. example: 230 format: int64 example: 230 X-Total-Items: description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. example: 230 format: int64 example: 230 X-Total-Pages: description: Total pages available schema: type: integer description: Total pages available example: 12 format: int64 example: 12 content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyManagementPolicySet' example: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' example: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_view - api_key_header_x-api-key: [] post: tags: - policysets description: Create a policy set operationId: policysets#create parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Ea quibusdam eligendi. example: Ut repudiandae alias iusto. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRequestBody2' example: action: onrun description: Captures critical production policies enabled: true identifier: policyset-1 name: Production Policies type: pipeline yaml_version: '0' responses: '201': description: Created response. content: application/json: schema: $ref: '#/components/schemas/PolicyManagementPolicySet' example: account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Ea impedit magnam ut fuga cupiditate eos.: Est recusandae corrupti. Sit aut dolorum quidem consequatur quidem.: Fugit hic fugiat. Totam aliquid in doloremque.: Dolor praesentium aut rerum iste est. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Aut praesentium et itaque numquam ad.: Id suscipit. Deleniti delectus quae blanditiis.: Est vero eius nihil aut quisquam. Id sunt est.: Aut voluptas voluptate animi. namespace: default nodeSelector: Et sed assumenda.: Maiores cupiditate aut animi. Minus officia ullam est quia architecto facere.: Non sunt voluptatum vitae qui placeat. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: At voluptatem. polciy_size_in_bytes: 1150005784042707600 policy_package_name: Qui eum. project_id: test-project rego: '' severity: warning unique_id: Enim harum. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: At voluptatem. polciy_size_in_bytes: 1150005784042707600 policy_package_name: Qui eum. project_id: test-project rego: '' severity: warning unique_id: Enim harum. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: At voluptatem. polciy_size_in_bytes: 1150005784042707600 policy_package_name: Qui eum. project_id: test-project rego: '' severity: warning unique_id: Enim harum. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: At voluptatem. polciy_size_in_bytes: 1150005784042707600 policy_package_name: Qui eum. project_id: test-project rego: '' severity: warning unique_id: Enim harum. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Praesentium qui quia velit fugit accusamus. created: 3707126911972812300 identifier: Magni ullam quo. name: Illo officiis id quo qui eum. org_id: Excepturi provident illo similique autem. project_id: Consequatur deleniti deleniti molestias qui. - account_id: Praesentium qui quia velit fugit accusamus. created: 3707126911972812300 identifier: Magni ullam quo. name: Illo officiis id quo qui eum. org_id: Excepturi provident illo similique autem. project_id: Consequatur deleniti deleniti molestias qui. - account_id: Praesentium qui quia velit fugit accusamus. created: 3707126911972812300 identifier: Magni ullam quo. name: Illo officiis id quo qui eum. org_id: Excepturi provident illo similique autem. project_id: Consequatur deleniti deleniti molestias qui. - account_id: Praesentium qui quia velit fugit accusamus. created: 3707126911972812300 identifier: Magni ullam quo. name: Illo officiis id quo qui eum. org_id: Excepturi provident illo similique autem. project_id: Consequatur deleniti deleniti molestias qui. type: pipeline updated: 1636669297674 yaml_version: '0' '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_create - api_key_header_x-api-key: [] /pm/api/v1/policysets/all: get: tags: - policysets summary: List all policy sets hierarchically description: >- List all policy sets hierarchically (includes policy sets from account, org, and project levels) operationId: policysets#listall parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: per_page in: query description: Number of results per page allowEmptyValue: true schema: type: integer description: Number of results per page default: 50 example: 20 format: int64 minimum: 1 maximum: 100 example: 20 - name: page in: query description: Page number (starting from 0) allowEmptyValue: true schema: type: integer description: Page number (starting from 0) default: 0 example: 4 format: int64 minimum: 0 example: 4 - name: identifierFilter in: query description: Comma separated List of Identifiers to filter on allowEmptyValue: true schema: type: string description: Comma separated List of Identifiers to filter on default: '' example: test-projectId1, test-projectId2 example: test-projectId1, test-projectId2 - name: type in: query description: Filter results by type allowEmptyValue: true schema: type: string description: Filter results by type example: pipeline minLength: 1 example: pipeline - name: action in: query description: Filter results by action allowEmptyValue: true schema: type: string description: Filter results by action example: onrun minLength: 1 example: onrun - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Ex tempore magnam iusto. example: Et vero ullam dolor. responses: '200': description: OK response. headers: Link: description: Link-based paging schema: type: string description: Link-based paging example: '' example: '' X-Page-Index: description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use pageNumber / X-Page-Number instead. Same value as pageNumber; kept for legacy UI clients. example: 4 format: int64 example: 4 X-Page-Item-Count: description: Number of results in this page schema: type: integer description: Number of results in this page example: 20 format: int64 example: 20 X-Page-Number: description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. schema: type: integer description: >- Current page number (0-based). Harness standard pagination header X-Page-Number. example: 4 format: int64 example: 4 X-Page-Size: description: >- Requested page size. Harness standard pagination header X-Page-Size. schema: type: integer description: >- Requested page size. Harness standard pagination header X-Page-Size. example: 20 format: int64 example: 20 X-Total-Elements: description: >- Total number of results available. Harness standard pagination header X-Total-Elements. schema: type: integer description: >- Total number of results available. Harness standard pagination header X-Total-Elements. example: 230 format: int64 example: 230 X-Total-Items: description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. schema: type: integer description: >- Deprecated: Please use totalElements / X-Total-Elements instead. Same value as totalElements; kept for legacy UI clients. example: 230 format: int64 example: 230 X-Total-Pages: description: Total pages available schema: type: integer description: Total pages available example: 12 format: int64 example: 12 content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyManagementPolicySet' example: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' example: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Dolore odio expedita adipisci vel.: Molestiae consequuntur sint. Iusto earum enim ea incidunt.: Officiis quam voluptates dolor aut. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Modi quo dolorem sed facilis omnis.: Nihil voluptatem tempore nam qui accusamus. Perspiciatis dignissimos asperiores et quia facilis.: Aut vel eveniet. namespace: default nodeSelector: Consequatur dolorum minima molestiae aperiam repudiandae.: Pariatur ut architecto quisquam. Doloremque possimus corporis.: Nihil hic exercitationem. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Aliquam est. polciy_size_in_bytes: 4204212102816286000 policy_package_name: Aspernatur in molestias recusandae odit quia. policy_set_count: 3 project_id: test-project rego: '' unique_id: Ex consequuntur saepe. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: Ratione voluptas. polciy_size_in_bytes: 4684963588245291000 policy_package_name: Est cupiditate aliquam dolor rerum deserunt. project_id: test-project rego: '' severity: warning unique_id: Quam eos tempore. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. - account_id: Ipsa animi sed molestiae eveniet. created: 7309021134203126000 identifier: Reiciendis iure aut. name: Magnam et iusto accusamus. org_id: Minima voluptatem ut quam perferendis. project_id: Aut nemo omnis quam autem. type: pipeline updated: 1636669297674 yaml_version: '0' '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_view - api_key_header_x-api-key: [] /pm/api/v1/policysets/{identifier}: delete: tags: - policysets description: Delete a policy set by identifier operationId: policysets#delete parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: identifier in: path description: Identifier of the policy set required: true schema: type: string description: Identifier of the policy set example: policyset-1 minLength: 1 examples: default: summary: default value: policyset-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Et quae. example: Blanditiis labore illo sed ullam quisquam sapiente. responses: '204': description: No Content response. '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_delete - api_key_header_x-api-key: [] get: tags: - policysets description: Find a policy set by identifier operationId: policysets#find parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: identifier in: path description: Identifier of the policy set to retrieve required: true schema: type: string description: Identifier of the policy set to retrieve example: policyset-1 minLength: 1 examples: default: summary: default value: policyset-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Cupiditate cumque. example: Repudiandae aut assumenda. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/PolicyManagementPolicySet' example: account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies enabled: true entity_selector: all_entities_in_scope identifier: policyset-1 infra_params: annotations: Ea impedit magnam ut fuga cupiditate eos.: Est recusandae corrupti. Sit aut dolorum quidem consequatur quidem.: Fugit hic fugiat. Totam aliquid in doloremque.: Dolor praesentium aut rerum iste est. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Aut praesentium et itaque numquam ad.: Id suscipit. Deleniti delectus quae blanditiis.: Est vero eius nihil aut quisquam. Id sunt est.: Aut voluptas voluptate animi. namespace: default nodeSelector: Et sed assumenda.: Maiores cupiditate aut animi. Minus officia ullam est quia architecto facere.: Non sunt voluptatum vitae qui placeat. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies org_id: test-org policies: - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: At voluptatem. polciy_size_in_bytes: 1150005784042707600 policy_package_name: Qui eum. project_id: test-project rego: '' severity: warning unique_id: Enim harum. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: At voluptatem. polciy_size_in_bytes: 1150005784042707600 policy_package_name: Qui eum. project_id: test-project rego: '' severity: warning unique_id: Enim harum. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 imported_policies: - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC cache_response: cache_state: STALE_CACHE is_sync_enabled: true last_updated_at: 1773917288158 ttl_left: 258234442 created: 1636669297674 git_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_connector_ref: . git_default_branch: main git_default_branch_commit_sha: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_default_branch_file_url: '' git_default_branch_update_error: explanation: >- File with given filepath [file.rego] already exists in Github, thus couldn't create a new file hint: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. message: >- Please check if there's already a file [file.rego] in Github repository [rego-demo] for the given filepath and branch [main]. git_default_branch_updated: 1636669297674 git_file_id: 1369b45c20fc685113adcfd1a08a914180ff3c0d git_file_url: '' git_path: .harness/policy.rego git_repo: github.com/org/repo,omitempty identifier: policy-1 name: Pipeline Approval org_id: test-org parent_unique_id: Molestias iure iste. polciy_size_in_bytes: 4614805459106866000 policy_package_name: Et voluptate nobis ex quis distinctio quis. policy_set_count: 3 project_id: test-project rego: '' unique_id: Excepturi hic. updated: 1636669297674 name: Pipeline Approval org_id: test-org parent_unique_id: At voluptatem. polciy_size_in_bytes: 1150005784042707600 policy_package_name: Qui eum. project_id: test-project rego: '' severity: warning unique_id: Enim harum. updated: 1636669297674 project_id: test-project resource_groups: - account_id: Praesentium qui quia velit fugit accusamus. created: 3707126911972812300 identifier: Magni ullam quo. name: Illo officiis id quo qui eum. org_id: Excepturi provident illo similique autem. project_id: Consequatur deleniti deleniti molestias qui. - account_id: Praesentium qui quia velit fugit accusamus. created: 3707126911972812300 identifier: Magni ullam quo. name: Illo officiis id quo qui eum. org_id: Excepturi provident illo similique autem. project_id: Consequatur deleniti deleniti molestias qui. - account_id: Praesentium qui quia velit fugit accusamus. created: 3707126911972812300 identifier: Magni ullam quo. name: Illo officiis id quo qui eum. org_id: Excepturi provident illo similique autem. project_id: Consequatur deleniti deleniti molestias qui. type: pipeline updated: 1636669297674 yaml_version: '0' '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_view - api_key_header_x-api-key: [] patch: tags: - policysets description: Update a policy set by identifier operationId: policysets#update parameters: - name: accountIdentifier in: query description: Harness account ID allowEmptyValue: true schema: type: string description: Harness account ID default: '' example: eBqAoNchMLKigC_qZ5EdC example: eBqAoNchMLKigC_qZ5EdC - name: orgIdentifier in: query description: Harness organization ID allowEmptyValue: true schema: type: string description: Harness organization ID default: '' example: test-org example: test-org - name: projectIdentifier in: query description: Harness project ID allowEmptyValue: true schema: type: string description: Harness project ID default: '' example: test-project example: test-project - name: identifier in: path description: Identifier of the policy set required: true schema: type: string description: Identifier of the policy set example: policyset-1 example: policyset-1 - name: x-api-key in: header description: Harness PAT key used to perform authorization allowEmptyValue: true schema: type: string description: Harness PAT key used to perform authorization example: Non similique vitae et delectus. example: Eius nulla qui. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRequestBody2' example: action: onrun description: Captures critical production policies enabled: true entity_selector: all_entities_in_resource_groups infra_params: annotations: Alias quos.: Omnis cupiditate cum. Est omnis odio.: Rerum nesciunt saepe. Magni deserunt ab.: Veritatis quo non rerum neque sapiente rerum. connectorRef: account.k8s_connector harnessImageConnectorRef: account.docker_connector initTimeout: 10m labels: Excepturi quidem earum et cum eos.: Cum et est. Tempora quam consequatur.: Aperiam quaerat veritatis qui nihil culpa. Vel odio quo eius.: Nihil pariatur. namespace: default nodeSelector: Omnis deleniti iusto dolor.: Alias esse. Provident fugit molestiae harum.: Non eos. os: linux poolName: vm-pool-1 resources: limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi infra_type: KubernetesDirect name: Production Policies policies: - identifier: policy-1 severity: warning - identifier: policy-1 severity: warning - identifier: policy-1 severity: warning resource_groups: - account_id: Aperiam porro accusamus consequatur sapiente id sed. identifier: Quia beatae aspernatur doloremque aspernatur. org_id: Magnam non et. project_id: Autem pariatur qui modi est. - account_id: Aperiam porro accusamus consequatur sapiente id sed. identifier: Quia beatae aspernatur doloremque aspernatur. org_id: Magnam non et. project_id: Autem pariatur qui modi est. - account_id: Aperiam porro accusamus consequatur sapiente id sed. identifier: Quia beatae aspernatur doloremque aspernatur. org_id: Magnam non et. project_id: Autem pariatur qui modi est. type: pipeline responses: '204': description: No Content response. '400': description: 'BadRequest: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '401': description: 'Unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '403': description: 'Forbidden: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '404': description: 'NotFound: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '500': description: 'ScopeInfoError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' security: - jwt_header_Authorization: - core_governancePolicySets_edit - api_key_header_x-api-key: [] /pm/api/v1/system/health: get: tags: - system description: Check service health operationId: system#health responses: '204': description: No Content response. '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' /pm/api/v1/system/version: get: tags: - system description: Check service version operationId: system#version responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ServiceVersion' example: commit: 96381692bf3a2bd7904769c6886e832435768b57 version: v0.123.0 '500': description: 'InternalServer: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' '502': description: 'BadGateway: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyManagementError' /dashboard/api/dashboards/{dashboard_id}/download: get: tags: - dashboards description: Download the data of all tiles within a Dashboard. summary: Download data within a Dashboard operationId: get_dashboard_data parameters: - in: path name: dashboard_id schema: type: string required: true - in: query name: file_type schema: type: string enum: - csv required: true - in: query name: filters schema: type: string required: false responses: '200': description: >- Returns files of a specified type within a ZIP file for each tile within a Dashboard. content: application/json: schema: $ref: '#/components/schemas/DashboardDownloadResponse' '400': description: Please specify a valid File Type. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '404': description: Dashboard not found. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/dashboards/{dashboard_id}/elements: get: tags: - dashboards description: Get all elements within a dashboard by ID. operationId: get_dashboard_elements parameters: - in: path name: dashboard_id schema: type: string required: true - in: query name: accountId schema: type: string required: false responses: '200': description: Returns all of the elements within a dashboard. content: application/json: schema: $ref: '#/components/schemas/GetDashboardElementsResponse' '404': description: Dashboard or dashboard elements not found. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/dashboards/{dashboard_id}/filters: get: tags: - dashboards description: Get all filters within a dashboard by ID. operationId: get_dashboard_filters parameters: - in: path name: dashboard_id schema: type: string required: true - in: query name: accountId schema: type: string required: false responses: '200': description: Returns all of the filters within a dashboard. content: application/json: schema: $ref: '#/components/schemas/GetDashboardFiltersResponse' '404': description: Dashboard or dashboard filters not found. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/clone: post: tags: - dashboards description: Clone a dashboard. operationId: clone_dashboard parameters: - in: query name: accountId schema: type: string required: false requestBody: description: Clone a Dashboard required: true content: application/json: schema: $ref: '#/components/schemas/CloneDashboardRequestBody' responses: '200': description: Returns the newly created dashboard's details. content: application/json: schema: $ref: '#/components/schemas/ClonedDashboardResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/dashboards/{dashboard_id}: get: tags: - dashboards description: Get all details of a dashboard by ID. operationId: get_dashboard parameters: - in: path name: dashboard_id schema: type: string required: true - in: query name: accountId schema: type: string required: false responses: '200': description: Returns the details of a dashboard. content: application/json: schema: $ref: '#/components/schemas/GetDashboardResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/: patch: tags: - dashboards description: Update a dashboards name, tags or folder. operationId: update_dashboard parameters: - in: query name: accountId schema: type: string required: false requestBody: description: Update dashboard fields. required: true content: application/json: schema: $ref: '#/components/schemas/CreateDashboardRequest' responses: '200': description: Returns the updated fields of the dashboard. content: application/json: schema: $ref: '#/components/schemas/UpdateDashboardResponse' /dashboard/remove: delete: tags: - dashboards description: Delete a dashboard. operationId: delete_dashboard parameters: - in: query name: accountId schema: type: string required: false - in: query name: folderId schema: type: string required: true requestBody: description: Delete a Dashboard by ID. required: true content: application/json: schema: $ref: '#/components/schemas/DeleteDashboardRequest' responses: '200': description: Returns if Dashboard deletion was successful. content: application/json: schema: $ref: '#/components/schemas/DeleteDashboardResponse' /dashboard/folders: post: tags: - folders description: Create a new folder. operationId: create_folder parameters: - in: query name: accountId schema: type: string required: false requestBody: description: Create a new folder required: true content: application/json: schema: $ref: '#/components/schemas/CreateFolderRequestBody' responses: '200': description: Returns the newly created folder's details. content: application/json: schema: $ref: '#/components/schemas/GetFolderResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/folders/{folder_id}: get: tags: - folders description: Get a folder by ID. operationId: get_folder parameters: - in: path name: folder_id schema: type: string required: true - in: query name: accountId schema: type: string required: false responses: '200': description: Returns the folder details. content: application/json: schema: $ref: '#/components/schemas/GetFolderResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' patch: tags: - folders description: Update a folder's name. operationId: update_folder parameters: - in: path name: folder_id schema: type: string required: true - in: query name: accountId schema: type: string required: false requestBody: description: Change the name of a folder required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFolderRequestBody' responses: '200': description: Returns the updated folder. content: application/json: schema: $ref: '#/components/schemas/GetFolderResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' delete: tags: - folders description: Delete a folder along with any dashboards it contains. operationId: delete_folder parameters: - in: path name: folder_id schema: type: string required: true - in: query name: accountId schema: type: string required: false responses: '200': description: Returns the deleted folder. content: application/json: schema: $ref: '#/components/schemas/GetFolderResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/dashboards/{dashboard_id}/filters/{filter_id}: patch: tags: - dashboards description: Update a specific filter within a dashboard by ID. operationId: update_dashboard_filter parameters: - in: path name: dashboard_id schema: type: string required: true - in: path name: filter_id schema: type: string required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDashboardFilterRequest' responses: '200': description: Returns the updated dashboard filter. content: application/json: schema: $ref: '#/components/schemas/GetDashboardFilterResponse' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '403': description: User does not have permission to update this dashboard. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '404': description: Dashboard or dashboard filter not found. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/download/dashboards/{dashboard_id}/csv: get: tags: - dashboards description: Download a Dashboard in CSV format. summary: Download a Dashboard CSV operationId: get_dashboard_download_csv parameters: - in: path name: dashboard_id schema: type: string required: true - in: query name: accountId schema: type: string required: false - in: query name: filters schema: type: string required: false - in: query name: expanded_tables schema: type: boolean required: false - in: query name: apply_vis schema: type: boolean required: false responses: '200': description: >- Returns a zip of CSV files containing raw data of each tile within a Dashboard. content: application/json: schema: $ref: '#/components/schemas/DownloadCsvDashboardResponse' '400': description: Download Task has failed. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '404': description: Dashboard not found. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '504': description: Querying Dashboard to build CSV has timed out. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/download/dashboards/{dashboard_id}/pdf: get: tags: - dashboards description: Download a Dashboard in PDF format. summary: Download a Dashboard PDF operationId: get_dashboard_download_pdf parameters: - in: path name: dashboard_id schema: type: string required: true - in: query name: accountId schema: type: string required: false - in: query name: filters schema: type: string required: false - in: query name: expanded_tables schema: type: boolean required: false - in: query name: landscape schema: type: boolean required: false - in: query name: paper_size schema: type: string enum: - letter - legal - tabloid - a0 - a1 - a2 - a3 - a4 - a5 required: false - in: query name: style schema: type: string enum: - single_column - tiled required: false responses: '200': description: Returns a PDF file containing the visualization of a Dashboard. content: application/json: schema: $ref: '#/components/schemas/DownloadPdfDashboardResponse' '400': description: Render Task has failed. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '404': description: Dashboard not found. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '504': description: Render Task has timed out. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/schedules/run_once: post: tags: - dashboards description: Run a schedule delivery once summary: >- Runs a schedule delivery once that is then immediately sent via email to recipients operationId: schedules_run_once parameters: - in: query name: accountId schema: type: string required: false requestBody: description: Run a Dashboard Schedule Delivery once required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleReportRequestBody' responses: '200': description: >- A successful request does not necessarily mean successful delivery of emails content: application/json: schema: $ref: '#/components/schemas/ScheduleReportResponse' '400': description: Please specify a valid File Type. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '404': description: Dashboard not found. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/download/tasks/{task_id}: get: tags: - downloads description: Get the current status of a download task operationId: get_download_task_status parameters: - in: path name: task_id schema: type: string required: true description: ID of the download task to check responses: '200': description: Task status retrieved successfully content: application/json: schema: $ref: '#/components/schemas/DownloadQueryTaskResponse' '404': description: Task not found content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /dashboard/download/dashboards/{dashboard_id}/dashboard_elements/{dashboard_element_id}: post: tags: - downloads description: >- Creates an asynchronous download task for a specific element within a dashboard. operationId: create_dashboard_element_download_task parameters: - in: path name: dashboard_id schema: type: string required: true - in: path name: dashboard_element_id schema: type: string required: true - in: query name: accountId schema: type: string required: false - in: query name: expanded_tables schema: type: boolean required: false - in: query name: filters schema: type: string required: false - in: query name: apply_vis schema: type: boolean required: false responses: '200': description: Download task created successfully content: application/json: schema: $ref: '#/components/schemas/DownloadQueryTaskResponse' '400': description: Invalid request parameters content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' '404': description: Dashboard or Element not found content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' get: tags: - downloads description: >- Get the results of a download task for a specific element within a dashboard. operationId: get_dashboard_element_download_task_results parameters: - in: path name: dashboard_id schema: type: string required: true - in: path name: dashboard_element_id schema: type: string required: true - in: query name: accountId schema: type: string required: false - in: query name: task_id schema: type: string required: true - in: query name: compress schema: type: string default: zip enum: - zip - none required: false responses: '200': description: > Download task results retrieved successfully. When compress=zip (default) returns application/zip. When compress=none returns text/csv directly. content: application/zip: schema: type: string format: binary text/csv: schema: type: string format: binary '404': description: Dashboard, element, or task not found content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/DashboardsErrorResponse' /code/api/v1/checks/recent: get: operationId: listStatusCheckRecentSpace parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The substring which is used to filter the status checks by their UID. in: query name: query required: false schema: type: string - description: >- The timestamp (in Unix time millis) since the status checks have been run. in: query name: since required: false schema: type: integer - description: The result should include entities from child spaces. in: query name: recursive required: false schema: default: false type: boolean responses: '200': content: application/json: schema: items: type: string type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List recent status check for acc, org or proj tags: - status_checks /code/api/v1/labels: get: operationId: listSpaceLabels parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The result should inherit entities from parent spaces. in: query name: inherited required: false schema: default: false type: boolean - description: The substring which is used to filter the labels by their key. in: query name: query required: false schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesLabel' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List labels at account, org or project level tags: - labels post: operationId: defineSpaceLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' description: type: string key: type: string type: $ref: '#/components/schemas/EnumLabelType' type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesLabel' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create label at account, org or project level tags: - labels put: operationId: saveSpaceLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: properties: label: $ref: '#/components/schemas/TypesSaveLabelInput' values: items: $ref: '#/components/schemas/TypesSaveLabelValueInput' type: array type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesLabelWithValues' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Save label and values at account, org or project level tags: - labels /code/api/v1/labels/{key}: delete: operationId: deleteSpaceLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: key required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete label at account, org or project level tags: - labels patch: operationId: updateSpaceLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: key required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' description: type: string key: type: string type: $ref: '#/components/schemas/EnumLabelType' type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesLabel' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update label at account, org or project level tags: - labels /code/api/v1/labels/{key}/values: get: operationId: listSpaceLabelValues parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: key required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesLabelValue' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List label values at account, org or project level tags: - labels post: operationId: defineSpaceLabelValue parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: key required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' value: type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesLabelValue' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create label value at account, org or project level tags: - labels /code/api/v1/labels/{key}/values/{value}: delete: operationId: deleteSpaceLabelValue parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: key required: true schema: type: string - in: path name: value required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete label value at account, org or project level tags: - labels patch: operationId: updateSpaceLabelValue parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: key required: true schema: type: string - in: path name: value required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' value: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesLabelValue' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update label value at account, org or project level tags: - labels /code/api/v1/principals: get: operationId: listPrincipals parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The substring by which the principals are filtered. in: query name: query required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The types of principals to include. in: query name: type required: false schema: items: enum: - service - serviceaccount - user type: string type: array responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPrincipalInfo' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - principals /code/api/v1/principals/scoped: get: operationId: listPrincipalsScoped parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The substring by which the principals are filtered. in: query name: query required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The types of principals to include. in: query name: type required: false schema: items: enum: - service - serviceaccount - user type: string type: array - description: Identifier of the repo. in: query name: repoIdentifier required: false schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPrincipalInfo' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List principals scoped to an account, org, project or repo tags: - principals /code/api/v1/pullreq: get: operationId: listPullReqSpace parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The state of the pull requests to include in the result. explode: true in: query name: state required: false schema: items: default: open enum: - closed - merged - open type: string type: array style: form - description: Source repository ref of the pull requests. in: query name: source_repo_ref required: false schema: type: string - description: Source branch of the pull requests. in: query name: source_branch required: false schema: type: string - description: Target branch of the pull requests. in: query name: target_branch required: false schema: type: string - description: The substring by which the pull requests are filtered. in: query name: query required: false schema: type: string - description: List of principal IDs who created pull requests. explode: true in: query name: created_by required: false schema: items: type: integer type: array style: form - description: >- The result should contain only entries created before this timestamp (unix millis). in: query name: created_lt required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries created after this timestamp (unix millis). in: query name: created_gt required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries updated before this timestamp (unix millis). in: query name: updated_lt required: false schema: minimum: 0 type: integer - description: >- By providing this parameter the description would be excluded from the response. in: query name: exclude_description required: false schema: default: false type: boolean - description: >- The result should contain entries from the desired space and of its subspaces. in: query name: include_subspaces required: false schema: default: false type: boolean - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: List of label ids used to filter pull requests. explode: true in: query name: label_id required: false schema: items: type: integer type: array style: form - description: List of label value ids used to filter pull requests. explode: true in: query name: value_id required: false schema: items: type: integer type: array style: form - description: Return only pull requests where this user is the author. in: query name: author_id required: false schema: type: integer - description: >- Return only pull requests where this user has created at least one comment. in: query name: commenter_id required: false schema: type: integer - description: Return only pull requests where this user has been mentioned. in: query name: mentioned_id required: false schema: type: integer - description: >- Return only pull requests where this user has been added as a reviewer. in: query name: reviewer_id required: false schema: type: integer - description: >- Require only this review decision of the reviewer. Requires reviewer_id parameter. explode: true in: query name: review_decision required: false schema: items: enum: - approved - changereq - pending - reviewed type: string type: array style: form - description: If true, the git diff stats would be included in the response. in: query name: include_git_stats required: false schema: default: false type: boolean - description: >- If true, the summary of check for the branch commit SHA would be included in the response. in: query name: include_checks required: false schema: default: false type: boolean - description: >- If true, a list of rules that apply to this branch would be included in the response. in: query name: include_rules required: false schema: default: false type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPullReqRepo' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List pull requests in account/org/project tags: - pullreq /code/api/v1/pullreq/count: get: operationId: countPullReqSpace parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The state of the pull requests to include in the result. explode: true in: query name: state required: false schema: items: default: open enum: - closed - merged - open type: string type: array style: form - description: Source repository ref of the pull requests. in: query name: source_repo_ref required: false schema: type: string - description: Source branch of the pull requests. in: query name: source_branch required: false schema: type: string - description: Target branch of the pull requests. in: query name: target_branch required: false schema: type: string - description: The substring by which the pull requests are filtered. in: query name: query required: false schema: type: string - description: List of principal IDs who created pull requests. explode: true in: query name: created_by required: false schema: items: type: integer type: array style: form - description: >- The result should contain only entries created before this timestamp (unix millis). in: query name: created_lt required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries created after this timestamp (unix millis). in: query name: created_gt required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries updated before this timestamp (unix millis). in: query name: updated_lt required: false schema: minimum: 0 type: integer - description: >- The result should contain entries from the desired space and of its subspaces. in: query name: include_subspaces required: false schema: default: false type: boolean - description: List of label ids used to filter pull requests. explode: true in: query name: label_id required: false schema: items: type: integer type: array style: form - description: List of label value ids used to filter pull requests. explode: true in: query name: value_id required: false schema: items: type: integer type: array style: form - description: Return only pull requests where this user is the author. in: query name: author_id required: false schema: type: integer - description: >- Return only pull requests where this user has created at least one comment. in: query name: commenter_id required: false schema: type: integer - description: Return only pull requests where this user has been mentioned. in: query name: mentioned_id required: false schema: type: integer - description: >- Return only pull requests where this user has been added as a reviewer. in: query name: reviewer_id required: false schema: type: integer - description: >- Require only this review decision of the reviewer. Requires reviewer_id parameter. explode: true in: query name: review_decision required: false schema: items: enum: - approved - changereq - pending - reviewed type: string type: array style: form - description: >- If true, a list of rules that apply to this branch would be included in the response. in: query name: include_rules required: false schema: default: false type: boolean responses: '200': content: application/json: schema: type: integer description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Count pull requests in account/org/project tags: - pullreq /code/api/v1/repos: get: operationId: listRepos parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The substring which is used to filter the repositories by their path name. in: query name: query required: false schema: type: string - description: The data by which the repositories are sorted. in: query name: sort required: false schema: default: identifier enum: - identifier - created - updated type: string - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: >- The result should contain only the favorite entries for the logged in user. in: query name: only_favorites required: false schema: default: false type: boolean - description: The result should include entities from child spaces. in: query name: recursive required: false schema: default: false type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RepoRepositoryOutput' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List repositories tags: - repository post: operationId: createRepository parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCreateRepositoryRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create repository tags: - repository /code/api/v1/repos/{repo_identifier}: delete: operationId: deleteRepository parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoSoftDeleteResponse' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Soft delete repository tags: - repository get: operationId: getRepository parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get repository tags: - repository patch: operationId: updateRepository parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiUpdateRepoRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update repository tags: - repository /code/api/v1/repos/{repo_identifier}/activities: get: operationId: listRepoActivities parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The result should contain only entries created at and after this timestamp (unix millis). in: query name: after required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries created before this timestamp (unix millis). in: query name: before required: false schema: minimum: 0 type: integer - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesRepoActivity' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List repository activities tags: - repository /code/api/v1/repos/{repo_identifier}/archive/{git_ref}.{format}: get: operationId: archive parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- Without an optional path parameter, all files and subdirectories of the current working directory are included in the archive. If one or more paths are specified, only these are included. in: query name: path required: false schema: items: type: string type: array - description: Prepend / to paths in the archive. in: query name: prefix required: false schema: type: string - description: >- Look for attributes in .gitattributes files in the working tree as well in: query name: attributes required: false schema: type: string - description: >- Set modification time of archive entries. Without this option the committer time is used if is a commit or tag, and the current time if it is a tree. in: query name: time required: false schema: type: string - description: >- Specify compression level. Larger values allow the command to spend more time to compress to smaller size. in: query name: compression required: false schema: type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: git_ref required: true schema: type: string - in: path name: format required: true schema: type: string responses: '200': content: application/gzip: schema: type: string application/tar: schema: type: string application/zip: schema: type: string description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Download repo in archived format tags: - repository /code/api/v1/repos/{repo_identifier}/blame/{path}: get: operationId: getBlame parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used. in: query name: git_ref required: false schema: default: '{Repository Default Branch}' type: string - description: Line number from which the file data is considered in: query name: line_from required: false schema: default: 0 type: integer - description: Line number to which the file data is considered in: query name: line_to required: false schema: default: 0 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: path required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/GitBlamePart' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get git blame tags: - repository /code/api/v1/repos/{repo_identifier}/branches: get: operationId: listBranches parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- Indicates whether optional commit information should be included in the response. in: query name: include_commit required: false schema: default: false type: boolean - description: The substring by which the branches are filtered. in: query name: query required: false schema: type: string - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The data by which the branches are sorted. in: query name: sort required: false schema: default: name enum: - name - date type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: >- If true, the summary of check for the branch commit SHA would be included in the response. in: query name: include_checks required: false schema: default: false type: boolean - description: >- If true, a list of rules that apply to this branch would be included in the response. in: query name: include_rules required: false schema: default: false type: boolean - description: >- If true, a list of pull requests from the branch would be included in the response. in: query name: include_pullreqs required: false schema: default: false type: boolean - description: >- If greater than zero, branch divergence from the default branch will be included in the response. The divergence would be calculated up the this many commits. in: query name: max_divergence required: false schema: default: 0 type: integer - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesBranchExtended' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List branches tags: - repository post: operationId: createBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCreateBranchRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesCreateBranchOutput' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '422': content: application/json: schema: $ref: '#/components/schemas/TypesRulesViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create branch tags: - repository /code/api/v1/repos/{repo_identifier}/branches/{branch_name}: delete: operationId: deleteBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: Bypass rule violations if possible. in: query name: bypass_rules required: false schema: default: false type: boolean - description: Dry run rules for operations in: query name: dry_run_rules required: false schema: default: false type: boolean - in: path name: repo_identifier required: true schema: type: string - in: path name: branch_name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesDeleteBranchOutput' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/TypesRulesViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete branch tags: - repository get: operationId: getBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- If true, the summary of check for the branch commit SHA would be included in the response. in: query name: include_checks required: false schema: default: false type: boolean - description: >- If true, a list of rules that apply to this branch would be included in the response. in: query name: include_rules required: false schema: default: false type: boolean - description: >- If true, a list of pull requests from the branch would be included in the response. in: query name: include_pullreqs required: false schema: default: false type: boolean - description: >- If greater than zero, branch divergence from the default branch will be included in the response. The divergence would be calculated up the this many commits. in: query name: max_divergence required: false schema: default: 0 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: branch_name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesBranchExtended' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get branch tags: - repository /code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}: get: operationId: listStatusCheckResults parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: >- The substring which is used to filter the status checks by their UID. in: query name: query required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: commit_sha required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesCheck' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List status check results tags: - status_checks put: operationId: reportStatusCheckResults parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: commit_sha required: true schema: type: string requestBody: content: application/json: schema: properties: bypassed_by: nullable: true type: integer check_uid: deprecated: true type: string ended: type: integer identifier: type: string link: type: string payload: $ref: '#/components/schemas/TypesCheckPayload' started: type: integer status: $ref: '#/components/schemas/EnumCheckStatus' summary: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesCheck' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Report status check results tags: - status_checks /code/api/v1/repos/{repo_identifier}/checks/recent: get: operationId: listStatusCheckRecent parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The substring which is used to filter the status checks by their UID. in: query name: query required: false schema: type: string - description: >- The timestamp (in Unix time millis) since the status checks have been run. in: query name: since required: false schema: type: integer - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: type: string type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List recent status check tags: - status_checks /code/api/v1/repos/{repo_identifier}/codeowners/validate: get: operationId: codeOwnersValidate parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used. in: query name: git_ref required: false schema: default: '{Repository Default Branch}' type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Validate code owners file tags: - repository /code/api/v1/repos/{repo_identifier}/commits: get: operationId: listCommits parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used. in: query name: git_ref required: false schema: default: '{Repository Default Branch}' type: string - description: >- The result should only contain commits that occurred after the provided reference. in: query name: after required: false schema: type: string - description: Path for which commit information should be retrieved in: query name: path required: false schema: default: '' type: string - description: Epoch timestamp since when commit information should be retrieved. in: query name: since required: false schema: example: 1728348213 type: integer - description: Epoch timestamp until when commit information should be retrieved. in: query name: until required: false schema: example: 1746668446 type: integer - description: Committer pattern for which commit information should be retrieved. in: query name: committer required: false schema: type: string - description: >- Committer principal IDs list for which commit information should be retrieved. explode: true in: query name: committer_id required: false schema: items: type: integer type: array style: form - description: Author pattern for which commit information should be retrieved. in: query name: author required: false schema: type: string - description: >- Author principal IDs for which commit information should be retrieved. explode: true in: query name: author_id required: false schema: items: type: integer type: array style: form - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: Indicates whether optional stats should be included in the response. in: query name: include_stats required: false schema: default: false type: boolean - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesListCommitResponse' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List commits tags: - repository post: operationId: commitFiles parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCommitFilesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesCommitFilesResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/TypesRulesViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Commit files tags: - repository /code/api/v1/repos/{repo_identifier}/commits/{commit_sha}: get: operationId: getCommit parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: commit_sha required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesCommit' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get commit tags: - repository /code/api/v1/repos/{repo_identifier}/commits/{commit_sha}/diff: get: operationId: getCommitDiff parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: commit_sha required: true schema: type: string responses: '200': content: text/plain: schema: type: string description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get raw git diff of a commit tags: - repository /code/api/v1/repos/{repo_identifier}/commits/calculate-divergence: post: operationId: calculateCommitDivergence parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCalculateCommitDivergenceRequest' responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesCommitDivergence' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get commit divergence tags: - repository /code/api/v1/repos/{repo_identifier}/content/{path}: get: operationId: getContent parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used. in: query name: git_ref required: false schema: default: '{Repository Default Branch}' type: string - description: >- Indicates whether optional commit information should be included in the response. in: query name: include_commit required: false schema: default: false type: boolean - description: Flatten directories that contain just one subdirectory. in: query name: flatten_directories required: false schema: default: false type: boolean - in: path name: repo_identifier required: true schema: type: string - in: path name: path required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiGetContentOutput' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get content of a file tags: - repository /code/api/v1/repos/{repo_identifier}/default-branch: post: operationId: updateDefaultBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiUpdateDefaultBranchRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update default branch tags: - repository /code/api/v1/repos/{repo_identifier}/diff-stats/{range}: get: operationId: diffStats parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: provide path for diff operation in: query name: path schema: description: provide path for diff operation items: type: string type: array - in: path name: repo_identifier required: true schema: type: string - in: path name: range required: true schema: example: main..dev type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesDiffStats' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get diff stats tags: - repository /code/api/v1/repos/{repo_identifier}/diff/{range}: get: operationId: rawDiff parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: provide path for diff operation in: query name: path schema: description: provide path for diff operation items: type: string type: array - in: path name: repo_identifier required: true schema: type: string - in: path name: range required: true schema: example: main..dev type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/GitFileDiff' type: array text/plain: schema: type: string description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get raw diff tags: - repository post: operationId: rawDiffPost parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: range required: true schema: example: main..dev type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiPostRawDiffRequest' responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/GitFileDiff' type: array text/plain: schema: type: string description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get raw diff tags: - repository /code/api/v1/repos/{repo_identifier}/fork: post: operationId: forkCreate parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: fork_branch: type: string identifier: type: string parent_ref: type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - repository /code/api/v1/repos/{repo_identifier}/fork-sync: post: operationId: forkSyncBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: branch: type: string branch_commit_sha: $ref: '#/components/schemas/ShaSHA' branch_upstream: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesForkSyncOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/TypesForkSyncConflict' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - repository /code/api/v1/repos/{repo_identifier}/labels: get: operationId: listRepoLabels parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The result should inherit entities from parent spaces. in: query name: inherited required: false schema: default: false type: boolean - description: The substring which is used to filter the labels by their key. in: query name: query required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesLabel' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List labels at repo level tags: - labels post: operationId: defineRepoLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' description: type: string key: type: string type: $ref: '#/components/schemas/EnumLabelType' type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesLabel' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create label at repo level tags: - labels put: operationId: saveRepoLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: label: $ref: '#/components/schemas/TypesSaveLabelInput' values: items: $ref: '#/components/schemas/TypesSaveLabelValueInput' type: array type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesLabelWithValues' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Save label and values at repo level tags: - labels /code/api/v1/repos/{repo_identifier}/labels/{key}: delete: operationId: deleteRepoLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: key required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete label at repo level tags: - labels patch: operationId: updateRepoLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: key required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' description: type: string key: type: string type: $ref: '#/components/schemas/EnumLabelType' type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesLabel' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update label at repo level tags: - labels /code/api/v1/repos/{repo_identifier}/labels/{key}/values: get: operationId: listRepoLabelValues parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: key required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesLabelValue' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List label values at repo level tags: - labels post: operationId: defineRepoLabelValue parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: key required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' value: type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesLabelValue' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create label value at repo level tags: - labels /code/api/v1/repos/{repo_identifier}/labels/{key}/values/{value}: delete: operationId: deleteRepoLabelValue parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: key required: true schema: type: string - in: path name: value required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete label value at repo level tags: - labels patch: operationId: updateRepoLabelValue parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: key required: true schema: type: string - in: path name: value required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' value: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesLabelValue' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update label value at repo level tags: - labels /code/api/v1/repos/{repo_identifier}/languages: get: operationId: getRepoLanguages parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesRepoLangStat' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get repository language statistics tags: - repository /code/api/v1/repos/{repo_identifier}/linked/source: get: operationId: getLinkedSource parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoLinkedSourceOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - repository /code/api/v1/repos/{repo_identifier}/linked/sync: post: operationId: linkedSync parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: branches: items: type: string nullable: true type: array type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoLinkedSyncOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - repository /code/api/v1/repos/{repo_identifier}/merge-check/{range}: post: operationId: mergeCheck parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: provide path for diff operation in: query name: path schema: description: provide path for diff operation items: type: string type: array - in: path name: repo_identifier required: true schema: type: string - in: path name: range required: true schema: example: main..dev type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoMergeCheck' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Check mergeability tags: - repository /code/api/v1/repos/{repo_identifier}/merge-commit: post: operationId: mergeCommit parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: base_branch: type: string base_commit_sha: $ref: '#/components/schemas/ShaSHA' bypass_rules: type: boolean dry_run: type: boolean dry_run_rules: type: boolean head_branch: type: string head_commit_sha: $ref: '#/components/schemas/ShaSHA' message: type: string title: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesMergeCommitResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/TypesMergeViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Creates a merge commit on the head branch with changes from the base tags: - repository /code/api/v1/repos/{repo_identifier}/mergequeue/{branch_name}: delete: operationId: mergeQueueClear parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: branch_name required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - repository get: operationId: mergeQueueListEntries parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: branch_name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoMergeQueueFullInfo' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - repository /code/api/v1/repos/{repo_identifier}/path-details: post: operationId: pathDetails parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used. in: query name: git_ref required: false schema: default: '{Repository Default Branch}' type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiPathsDetailsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoPathsDetailsOutput' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get commit details tags: - repository /code/api/v1/repos/{repo_identifier}/paths: get: operationId: listPaths parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used. in: query name: git_ref required: false schema: default: '{Repository Default Branch}' type: string - description: Indicates whether directories should be included in the response. in: query name: include_directories required: false schema: default: false type: boolean - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoListPathsOutput' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List all paths tags: - repository /code/api/v1/repos/{repo_identifier}/pullreq: get: operationId: listPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The state of the pull requests to include in the result. explode: true in: query name: state required: false schema: items: default: open enum: - closed - merged - open type: string type: array style: form - description: Source repository ref of the pull requests. in: query name: source_repo_ref required: false schema: type: string - description: Source branch of the pull requests. in: query name: source_branch required: false schema: type: string - description: Target branch of the pull requests. in: query name: target_branch required: false schema: type: string - description: The substring by which the pull requests are filtered. in: query name: query required: false schema: type: string - description: List of principal IDs who created pull requests. explode: true in: query name: created_by required: false schema: items: type: integer type: array style: form - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The data by which the pull requests are sorted. in: query name: sort required: false schema: default: number enum: - created - edited - merged - number - updated type: string - description: >- The result should contain only entries created before this timestamp (unix millis). in: query name: created_lt required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries created after this timestamp (unix millis). in: query name: created_gt required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries updated before this timestamp (unix millis). in: query name: updated_lt required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries updated after this timestamp (unix millis). in: query name: updated_gt required: false schema: minimum: 0 type: integer - description: >- By providing this parameter the description would be excluded from the response. in: query name: exclude_description required: false schema: default: false type: boolean - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: List of label ids used to filter pull requests. explode: true in: query name: label_id required: false schema: items: type: integer type: array style: form - description: List of label value ids used to filter pull requests. explode: true in: query name: value_id required: false schema: items: type: integer type: array style: form - description: Return only pull requests where this user is the author. in: query name: author_id required: false schema: type: integer - description: >- Return only pull requests where this user has created at least one comment. in: query name: commenter_id required: false schema: type: integer - description: Return only pull requests where this user has been mentioned. in: query name: mentioned_id required: false schema: type: integer - description: >- Return only pull requests where this user has been added as a reviewer. in: query name: reviewer_id required: false schema: type: integer - description: >- Require only this review decision of the reviewer. Requires reviewer_id parameter. explode: true in: query name: review_decision required: false schema: items: enum: - approved - changereq - pending - reviewed type: string type: array style: form - description: If true, the git diff stats would be included in the response. in: query name: include_git_stats required: false schema: default: false type: boolean - description: >- If true, the summary of check for the branch commit SHA would be included in the response. in: query name: include_checks required: false schema: default: false type: boolean - description: >- If true, a list of rules that apply to this branch would be included in the response. in: query name: include_rules required: false schema: default: false type: boolean - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPullReq' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List pull requests tags: - pullreq post: operationId: createPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCreatePullReqRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesPullReq' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create pull request tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}: get: operationId: getPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReq' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get pull request tags: - pullreq patch: operationId: updatePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiUpdatePullReqRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReq' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update pull request tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/activities: get: operationId: listPullReqActivities parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The kind of the pull request activity to include in the result. in: query name: kind required: false schema: items: enum: - change-comment - comment - system type: string type: array - description: The type of the pull request activity to include in the result. in: query name: type required: false schema: items: enum: - auto-merge-unsupported-merge-method - branch-delete - branch-restore - branch-update - code-comment - comment - label-modify - merge - merge-queue-added - merge-queue-removed - non-unique-merge-base - review-submit - reviewer-add - reviewer-delete - state-change - target-branch-change - target-branch-deleted - title-change - user-group-reviewer-add - user-group-reviewer-delete type: string type: array - description: >- The result should contain only entries created at and after this timestamp (unix millis). in: query name: after required: false schema: minimum: 0 type: integer - description: >- The result should contain only entries created before this timestamp (unix millis). in: query name: before required: false schema: minimum: 0 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPullReqActivity' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List activities tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge: delete: operationId: prAutoMergeDisable parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Disable the auto-merge option for the pull request. tags: - pullreq get: operationId: prAutoMergeGet parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesAutoMergeResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get the auto-merge option for the pull request. tags: - pullreq put: operationId: prAutoMergeEnable parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: properties: delete_source_branch: type: boolean message: type: string method: $ref: '#/components/schemas/EnumMergeMethod' title: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesAutoMergeResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Enable the auto-merge option for the pull request. tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/branch: post: operationId: restorePullReqSourceBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: properties: bypass_rules: type: boolean dry_run_rules: type: boolean type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesCreateBranchOutput' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '409': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/TypesRulesViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Restore source branch tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/checks: get: operationId: checksPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqChecks' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get status checks tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/codeowners: get: operationId: codeownersPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesCodeOwnerEvaluation' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get code owners tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments: post: operationId: commentCreatePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCommentCreatePullReqRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqActivity' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create new pull request comment tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}: delete: operationId: commentDeletePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: pullreq_comment_id required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete pull request comment tags: - pullreq patch: operationId: commentUpdatePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: pullreq_comment_id required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCommentUpdatePullReqRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqActivity' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update pull request comment tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}/reactions/{pullreq_reaction_emoji}: delete: operationId: commentReactionDeletePullReq parameters: - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: pullreq_comment_id required: true schema: type: integer - in: path name: pullreq_reaction_emoji required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Remove emoji reaction from pull request comment tags: - pullreq post: operationId: commentReactionCreatePullReq parameters: - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: pullreq_comment_id required: true schema: type: integer - in: path name: pullreq_reaction_emoji required: true schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqCommentReaction' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Add emoji reaction to pull request comment tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}/status: put: operationId: commentStatusPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: pullreq_comment_id required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCommentStatusPullReqRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqActivity' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update status of pull request comment tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/apply-suggestions: post: operationId: commentApplySuggestions parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCommentApplySuggestionstRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PullreqCommentApplySuggestionsOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '422': content: application/json: schema: $ref: '#/components/schemas/TypesRulesViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Apply pull request code comment suggestions tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/commits: get: operationId: listPullReqCommits parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesCommit' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List commits tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/diff: get: operationId: diffPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: provide path for diff operation in: query name: path schema: description: provide path for diff operation items: type: string type: array - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/GitFileDiff' type: array text/plain: schema: type: string description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get file changes tags: - pullreq post: operationId: diffPullReqPost parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiPostRawPRDiffRequest' responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/GitFileDiff' type: array text/plain: schema: type: string description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get file changes tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views: get: operationId: fileViewListPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPullReqFileView' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List viewed files tags: - pullreq put: operationId: fileViewAddPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiFileViewAddPullReqRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqFileView' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Mark file as viewed tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views/{file_path}: delete: operationId: fileViewDeletePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: file_path required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Remove file view tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels: get: operationId: listPullReqLabels parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The result should contain all labels assignable to the pullreq. in: query name: assignable required: false schema: default: false type: boolean - description: The substring which is used to filter the labels by their key. in: query name: query required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesScopesLabels' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List labels assigned to pull request tags: - labels put: operationId: assignLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiPullReqAssignLabelInput' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqLabel' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Assign label to pull request tags: - labels /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels/{label_id}: delete: operationId: unassignLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: label_id required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Unassign label from pull request tags: - labels /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/merge: post: operationId: mergePullReqOp parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiMergePullReq' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesMergeResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/TypesMergeViolations' description: Unprocessable Entity summary: Merge tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue: delete: operationId: prMergeQueueRemove parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Remove the pull request from the merge queue. tags: - pullreq get: operationId: prMergeQueueGet parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesMergeQueueInfo' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get the pull request's merge-queue details. tags: - pullreq put: operationId: prMergeQueueEnable parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: properties: bypass_rules: type: boolean delete_source_branch: type: boolean message: type: string method: $ref: '#/components/schemas/EnumMergeMethod' title: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesMergeQueueInfo' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Place the pull request to the target branch's merge queue. tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue/prioritize: post: operationId: prMergeQueuePrioritize parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Reorder the merge queue so that this PR is at the head of the queue. tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/metadata: get: operationId: pullReqMetaData parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqStats' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get metadata tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/revert: post: operationId: revertPullReqOp parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: properties: message: type: string revert_branch: type: string title: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesRevertResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Method Not Allowed summary: Revert of a merged pull request tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers: get: operationId: reviewerListPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPullReqReviewer' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List reviewers tags: - pullreq put: operationId: reviewerAddPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiReviewerAddPullReqRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqReviewer' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Add reviewer tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/{pullreq_reviewer_id}: delete: operationId: reviewerDeletePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: pullreq_reviewer_id required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Remove reviewer tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/combined: get: operationId: reviewerCombinedListPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/PullreqCombinedListResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/usergroups: put: operationId: userGroupReviewerAddPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiUserGroupReviewerAddRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesUserGroupReviewer' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/usergroups/{user_group_id}: delete: operationId: userGroupReviewerDeletePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: user_group_id required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviews: post: operationId: reviewSubmitPullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiReviewSubmitPullReqRequest' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Submit review tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/state: post: operationId: statePullReq parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiStatePullReqRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReq' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update state of pull request tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels: get: operationId: listSuggestedLabels parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesPullReqLabelSuggestionResponse' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List suggested labels tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels/{label_id}: delete: operationId: removeSuggestedLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: label_id required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Remove suggested label tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels/{label_id}/apply: post: operationId: applySuggestedLabel parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: label_id required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqLabel' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Apply suggested label tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels/batch: post: operationId: suggestLabelsBatch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiPullReqSuggestLabelsBatchRequest' responses: '200': description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create label suggestions tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers: get: operationId: listSuggestedReviewers parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesListReviewerSuggestionsOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List suggested reviewers tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers/{principal_id}: delete: operationId: removeSuggestedReviewer parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: principal_id required: true schema: type: integer responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Remove suggested reviewer tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers/{principal_id}/apply: post: operationId: applySuggestedReviewer parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer - in: path name: principal_id required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesPullReqReviewer' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Apply suggested reviewer tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers/batch: post: operationId: suggestReviewersBatch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiPullReqSuggestReviewersBatchRequest' responses: '200': description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create reviewer suggestions tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/view: get: operationId: pullReqViewGet parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/PullreqPullReqViewResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get pull request view tags: - pullreq put: operationId: pullReqViewCreate parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: pullreq_number required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiPullReqViewCreateRequest' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create or update pull request view tags: - pullreq /code/api/v1/repos/{repo_identifier}/pullreq/candidates: get: operationId: prCandidates parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesBranchTable' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - pullreq /code/api/v1/repos/{repo_identifier}/purge: post: operationId: purgeRepository parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The exact time the resource was delete at in epoch format. in: query name: deleted_at required: true schema: type: integer - in: path name: repo_identifier required: true schema: type: string responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Purge repository tags: - repository /code/api/v1/repos/{repo_identifier}/raw/{path}: get: operationId: getRaw parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used. in: query name: git_ref required: false schema: default: '{Repository Default Branch}' type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: path required: true schema: type: string responses: '200': description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get raw file content tags: - repository /code/api/v1/repos/{repo_identifier}/rebase: post: operationId: rebaseBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: base_branch: type: string base_commit_sha: $ref: '#/components/schemas/ShaSHA' bypass_rules: type: boolean dry_run: type: boolean dry_run_rules: type: boolean head_branch: type: string head_commit_sha: $ref: '#/components/schemas/ShaSHA' type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesRebaseResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/TypesMergeViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Rebase a branch relative to another branch or a commit tags: - repository /code/api/v1/repos/{repo_identifier}/restore: post: operationId: restoreRepository parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The exact time the resource was delete at in epoch format. in: query name: deleted_at required: true schema: type: integer - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiRestoreRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Restore repository tags: - repository /code/api/v1/repos/{repo_identifier}/rules: get: operationId: repoRuleList parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The substring by which the repository protection rules are filtered. in: query name: query required: false schema: type: string - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The field by which the protection rules are sorted. in: query name: sort required: false schema: default: created_at enum: - created_at - identifier - uid - updated_at type: string - description: The types of rules to include. explode: true in: query name: type required: false schema: items: enum: - branch - tag - push type: string type: array style: form - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The result should inherit entities from parent spaces. in: query name: inherited required: false schema: default: false type: boolean - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/OpenapiRule' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List repo protection rules tags: - rules post: operationId: repoRuleAdd parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: definition: $ref: '#/components/schemas/OpenapiRuleDefinition' description: type: string identifier: type: string pattern: $ref: '#/components/schemas/ProtectionPattern' repo_target: $ref: '#/components/schemas/ProtectionRepoTarget' state: $ref: '#/components/schemas/EnumRuleState' type: $ref: '#/components/schemas/OpenapiRuleType' uid: deprecated: true type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenapiRule' description: Created '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Add repo protection rule tags: - rules /code/api/v1/repos/{repo_identifier}/rules/{rule_identifier}: delete: operationId: repoRuleDelete parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: rule_identifier required: true schema: type: string responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete repo protection rule tags: - rules get: operationId: repoRuleGet parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: rule_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiRule' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get repo protection rule tags: - rules patch: operationId: repoRuleUpdate parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: rule_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: definition: $ref: '#/components/schemas/OpenapiRuleDefinition' description: nullable: true type: string identifier: nullable: true type: string pattern: $ref: '#/components/schemas/ProtectionPattern' repo_target: $ref: '#/components/schemas/ProtectionRepoTarget' state: $ref: '#/components/schemas/EnumRuleState' type: $ref: '#/components/schemas/OpenapiRuleType' uid: deprecated: true nullable: true type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiRule' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update repo protection rule tags: - rules /code/api/v1/repos/{repo_identifier}/settings/general: get: operationId: findGeneralSettings parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingsGeneralSettings' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get general settings tags: - repository patch: operationId: updateGeneralSettings parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiGeneralSettingsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingsGeneralSettings' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update general settings tags: - repository /code/api/v1/repos/{repo_identifier}/settings/security: get: operationId: findSecuritySettings parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingsSecuritySettings' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get security settings tags: - repository patch: operationId: updateSecuritySettings parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiSecuritySettingsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingsSecuritySettings' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update security settings tags: - repository /code/api/v1/repos/{repo_identifier}/squash: post: operationId: squashBranch parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: base_branch: type: string base_commit_sha: $ref: '#/components/schemas/ShaSHA' bypass_rules: type: boolean dry_run: type: boolean dry_run_rules: type: boolean head_branch: type: string head_commit_sha: $ref: '#/components/schemas/ShaSHA' message: type: string title: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesSquashResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/TypesMergeViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Squashes commits in a branch relative to another branch or a commit tags: - repository /code/api/v1/repos/{repo_identifier}/summary: get: operationId: summary parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesRepositorySummary' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get repository summary tags: - repository /code/api/v1/repos/{repo_identifier}/tags: get: operationId: listTags parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- Indicates whether optional commit information should be included in the response. in: query name: include_commit required: false schema: default: false type: boolean - description: The substring by which the tags are filtered. in: query name: query required: false schema: type: string - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The data by which the tags are sorted. in: query name: sort required: false schema: default: name enum: - name - date type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesCommitTag' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List tags tags: - repository post: operationId: createTag parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCreateTagRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesCommitTag' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '409': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/TypesRulesViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create tag tags: - repository /code/api/v1/repos/{repo_identifier}/tags/{tag_name}: delete: operationId: deleteTag parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: Bypass rule violations if possible. in: query name: bypass_rules required: false schema: default: false type: boolean - description: Dry run rules for operations in: query name: dry_run_rules required: false schema: default: false type: boolean - in: path name: repo_identifier required: true schema: type: string - in: path name: tag_name required: true schema: type: string responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/TypesRulesViolations' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete tag tags: - repository /code/api/v1/repos/{repo_identifier}/uploads: post: operationId: repoArtifactUpload parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/octet-stream: schema: {} description: Binary file to upload required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/UploadResult' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Repo artifact upload tags: - upload /code/api/v1/repos/{repo_identifier}/uploads/{file_ref}: get: operationId: repoArtifactDownload parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: file_ref required: true schema: type: string responses: '200': description: OK '307': description: Temporary Redirect '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Repo artifact download tags: - upload /code/api/v1/repos/{repo_identifier}/webhooks: get: operationId: listRepoWebhooks parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The substring which is used to filter the webhooks by their identifier. in: query name: query required: false schema: type: string - description: The data by which the webhooks are sorted. in: query name: sort required: false schema: default: identifier enum: - id - uid - display_name - created - updated type: string - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/OpenapiWebhookType' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List repo webhooks tags: - webhook post: operationId: createRepoWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiCreateRepoWebhookRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenapiWebhookType' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create repo webhook tags: - webhook /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}: delete: operationId: deleteRepoWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: webhook_identifier required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete repo webhook tags: - webhook get: operationId: getRepoWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: webhook_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiWebhookType' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get repo webhook tags: - webhook patch: operationId: updateRepoWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: webhook_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiUpdateRepoWebhookRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiWebhookType' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update repo webhook tags: - webhook /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions: get: operationId: listRepoWebhookExecutions parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: webhook_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesWebhookExecution' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List repo webhook executions tags: - webhook /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}: get: operationId: getRepoWebhookExecution parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: repo_identifier required: true schema: type: string - in: path name: webhook_identifier required: true schema: type: string - in: path name: webhook_execution_id required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesWebhookExecution' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get repo webhook execution tags: - webhook /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger: post: operationId: retriggerRepoWebhookExecution parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: repo_identifier required: true schema: type: string - in: path name: webhook_identifier required: true schema: type: string - in: path name: webhook_execution_id required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesWebhookExecution' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Retrigger repo webhook execution tags: - webhook /code/api/v1/repos/import: post: operationId: importRepository parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: properties: description: type: string identifier: type: string parent_ref: type: string pipelines: $ref: '#/components/schemas/ImporterPipelineOption' provider: $ref: '#/components/schemas/ImporterProvider' provider_repo: type: string uid: deprecated: true type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Import repository tags: - repository /code/api/v1/repos/link: post: operationId: linkedCreate parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: properties: connector_ref: type: string description: type: string identifier: type: string is_public: type: boolean parent_ref: type: string repo_identifier: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/RepoRepositoryOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - repository /code/api/v1/resources/gitignore: get: operationId: listGitignore responses: '200': content: application/json: schema: items: type: string type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List available gitignore names tags: - resource /code/api/v1/resources/license: get: operationId: listLicenses responses: '200': content: application/json: schema: items: properties: label: type: string value: type: string type: object type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List available license names tags: - resource /code/api/v1/rules: get: operationId: spaceRuleList parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The substring by which the repository protection rules are filtered. in: query name: query required: false schema: type: string - description: The types of rules to include. explode: true in: query name: type required: false schema: items: enum: - branch - tag - push type: string type: array style: form - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The field by which the protection rules are sorted. in: query name: sort required: false schema: default: created_at enum: - created_at - identifier - uid - updated_at type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The result should inherit entities from parent spaces. in: query name: inherited required: false schema: default: false type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/OpenapiRule' type: array description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List acc/org/proj protection rules tags: - rules post: operationId: spaceRuleAdd parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: properties: definition: $ref: '#/components/schemas/OpenapiRuleDefinition' description: type: string identifier: type: string pattern: $ref: '#/components/schemas/ProtectionPattern' repo_target: $ref: '#/components/schemas/ProtectionRepoTarget' state: $ref: '#/components/schemas/EnumRuleState' type: $ref: '#/components/schemas/OpenapiRuleType' uid: deprecated: true type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenapiRule' description: Created '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Add acc/org/proj protection rule tags: - rules /code/api/v1/rules/{rule_identifier}: delete: operationId: spaceRuleDelete parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: rule_identifier required: true schema: type: string responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete acc/org/proj protection rule tags: - rules get: operationId: spaceRuleGet parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: rule_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiRule' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get acc/org/proj protection rule tags: - rules patch: operationId: spaceRuleUpdate parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: rule_identifier required: true schema: type: string requestBody: content: application/json: schema: properties: definition: $ref: '#/components/schemas/OpenapiRuleDefinition' description: nullable: true type: string identifier: nullable: true type: string pattern: $ref: '#/components/schemas/ProtectionPattern' repo_target: $ref: '#/components/schemas/ProtectionRepoTarget' state: $ref: '#/components/schemas/EnumRuleState' type: $ref: '#/components/schemas/OpenapiRuleType' uid: deprecated: true nullable: true type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiRule' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update acc/org/proj protection rule tags: - rules /code/api/v1/settings/general: get: operationId: findSpaceGeneralSettings parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The result should inherit entities from parent spaces. in: query name: inherited required: false schema: default: false type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingsGeneralSettingsSpace' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Find general settings of the account, organization, or project. tags: - settings patch: operationId: updateSpaceGeneralSettings parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SettingsGeneralSettingsSpace' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingsGeneralSettingsSpace' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update general settings of the account, organization, or project. tags: - settings /code/api/v1/user/favorite: post: operationId: createFavorite parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesFavoriteResource' responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesFavoriteResource' description: Created '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create favorite tags: - user /code/api/v1/user/favorite/{resource_id}: delete: operationId: deleteFavorite parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The type of the resource to be unfavorited. in: query name: resource_type required: false schema: enum: - CONNECTOR - GITSPACE - INFRAPROVIDER - INTEGRATION - PIPELINE - REGISTRY - REPOSITORY - SECRET - SERVICE - SERVICEACCOUNT - SPACE - TEMPLATE - USER type: string - in: path name: resource_id required: true schema: type: integer responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete favorite tags: - user /code/api/v1/usergroups: get: operationId: listUsergroups parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The substring which is used to filter usergroups by their identifier. in: query name: query required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesUserGroupInfo' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List usergroups at account, org or project level tags: - usergroups /code/api/v1/usergroups/scoped: get: operationId: listUsergroupsScoped parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The substring which is used to filter usergroups by their identifier. in: query name: query required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesUserGroupInfo' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List usergroups scoped to a space tags: - usergroups /code/api/v1/webhooks: get: operationId: listSpaceWebhooks parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: >- The substring which is used to filter the webhooks by their identifier. in: query name: query required: false schema: type: string - description: The data by which the webhooks are sorted. in: query name: sort required: false schema: default: identifier enum: - id - uid - display_name - created - updated type: string - description: The order of the output. in: query name: order required: false schema: default: asc enum: - asc - desc type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/OpenapiWebhookType' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List acc, org or proj webhooks tags: - webhook post: operationId: createSpaceWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesWebhookCreateInput' responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenapiWebhookType' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Create acc, org or proj webhook tags: - webhook /code/api/v1/webhooks/{webhook_identifier}: delete: operationId: deleteSpaceWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: webhook_identifier required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Delete acc, org or proj webhook tags: - webhook get: operationId: getSpaceWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: webhook_identifier required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiWebhookType' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get acc, org or proj webhook tags: - webhook patch: operationId: updateSpaceWebhook parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: webhook_identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenapiUpdateSpaceWebhookRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenapiWebhookType' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Update acc, org or proj webhook tags: - webhook /code/api/v1/webhooks/{webhook_identifier}/executions: get: operationId: listSpaceWebhookExecutions parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: webhook_identifier required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesWebhookExecution' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: List acc, org or proj webhook executions tags: - webhook /code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}: get: operationId: getSpaceWebhookExecution parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - description: The page to return. in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit required: false schema: default: 30 maximum: 100 minimum: 1 type: integer - in: path name: webhook_identifier required: true schema: type: string - in: path name: webhook_execution_id required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesWebhookExecution' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Get acc, org or proj webhook execution tags: - webhook /code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger: post: operationId: retriggerSpaceWebhookExecution parameters: - description: Account Identifier for the Entity. in: query name: accountIdentifier required: true schema: type: string - description: Organization Identifier for the Entity. in: query name: orgIdentifier required: false schema: type: string - description: Project Identifier for the Entity. in: query name: projectIdentifier required: false schema: type: string - in: path name: webhook_identifier required: true schema: type: string - in: path name: webhook_execution_id required: true schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesWebhookExecution' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error summary: Retrigger acc, org or proj webhook execution tags: - webhook /har/api/v1/registry: post: description: Create a Registry. operationId: CreateRegistry parameters: - $ref: '#/components/parameters/requiredSpaceRefQueryParam' requestBody: $ref: '#/components/requestBodies/RegistryRequest' responses: '201': $ref: '#/components/responses/RegistryResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Create Registry. tags: - Registries /har/api/v1/registry/{registry_identifier}/artifact/{artifact}/redirect: get: description: Redirect to Harness Artifact Page operationId: RedirectHarnessArtifact parameters: - $ref: '#/components/parameters/RegistryIdentifierPathParam' - $ref: '#/components/parameters/AccountIdentifierParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionParam' responses: '302': $ref: '#/components/responses/Redirect' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Redirect to Harness Artifact Page tags: - Artifacts /har/api/v1/registry/{registry_ref}: delete: description: Delete a Registry in the account for the given key operationId: DeleteRegistry parameters: - $ref: '#/components/parameters/registryRefPathParam' responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Delete a Registry tags: - Registries get: description: Returns Registry Details in the account for the given key operationId: GetRegistry parameters: - $ref: '#/components/parameters/registryRefPathParam' responses: '200': $ref: '#/components/responses/RegistryResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Returns Registry Details tags: - Registries put: description: Updates a Registry in the account for the given key operationId: ModifyRegistry parameters: - $ref: '#/components/parameters/registryRefPathParam' requestBody: $ref: '#/components/requestBodies/RegistryRequest' responses: '200': $ref: '#/components/responses/RegistryResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Updates a Registry tags: - Registries /har/api/v1/registry/{registry_ref}/artifact/{artifact}: delete: description: Delete Artifact. operationId: DeleteArtifact parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Delete Artifact tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/labels: put: description: Update Artifact Labels. operationId: UpdateArtifactLabels parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' requestBody: $ref: '#/components/requestBodies/ArtifactLabelRequest' responses: '200': $ref: '#/components/responses/ArtifactLabelResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Update Artifact Labels tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/stats: get: description: Get Artifact Stats. operationId: GetArtifactStats parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/fromDateParam' - $ref: '#/components/parameters/toDateParam' responses: '200': $ref: '#/components/responses/ArtifactStatsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Artifact Stats tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/summary: get: description: Get Artifact Summary. operationId: GetArtifactSummary parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' responses: '200': $ref: '#/components/responses/ArtifactSummaryResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Artifact Summary tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/tags: get: description: Lists OCI Artifact Tags. operationId: GetOciArtifactTags parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/searchTerm' responses: '200': $ref: '#/components/responses/ListOciArtifactTagsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List OCI Artifact tags tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}: delete: description: Delete Artifact Version. operationId: DeleteArtifactVersion parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/filtersParam' responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Delete an Artifact Version tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/bulk-download: get: description: Create a bulk download request operationId: CreateBulkDownloadRequestV1 parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' responses: '200': $ref: '#/components/responses/CreateBulkDownloadRequestResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Create a bulk download request tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/deploymentdetails: get: description: Get Artifact Deployments operationId: GetArtifactDeployments parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/envType' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/searchTerm' - $ref: '#/components/parameters/versionTypeParam' responses: '200': $ref: '#/components/responses/ArtifactDeploymentsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Artifact Deployments tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/details: get: description: Get Artifact Details operationId: GetArtifactDetails parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/childVersionParam' - $ref: '#/components/parameters/filtersParam' responses: '200': $ref: '#/components/responses/ArtifactDetailResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Artifact Details tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/details: get: description: Get Docker Artifact Details operationId: GetDockerArtifactDetails parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/digestParam' - $ref: '#/components/parameters/versionTypeParam' responses: '200': $ref: '#/components/responses/DockerArtifactDetailResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Docker Artifact Detail tags: - Docker Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/integrationdetails: get: description: Get Docker Artifact Integration Details operationId: GetDockerArtifactIntegrationDetails parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/digestParam' - $ref: '#/components/parameters/versionTypeParam' responses: '200': $ref: '#/components/responses/DockerArtifactDetailIntegrationResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Docker Artifact Integration Detail tags: - Docker Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/layers: get: description: Get Docker Artifact Layers operationId: GetDockerArtifactLayers parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/digestParam' responses: '200': $ref: '#/components/responses/DockerLayersResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Docker Artifact Layers tags: - Docker Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifest: get: description: Get Docker Artifact Manifest operationId: GetDockerArtifactManifest parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/digestParam' responses: '200': $ref: '#/components/responses/DockerArtifactManifestResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Docker Artifact Manifest tags: - Docker Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifests: get: description: Get Docker Artifact Manifests operationId: GetDockerArtifactManifests parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/versionTypeParam' responses: '200': $ref: '#/components/responses/DockerManifestsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Docker Artifact Manifests tags: - Docker Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/file/{file_name}: get: description: just validate existence of Artifact file operationId: GetArtifactFile parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/fileNamePathParam' - $ref: '#/components/parameters/filtersParam' responses: '200': $ref: '#/components/responses/ArtifactFileResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Artifact file tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/files: get: description: Get Artifact files operationId: GetArtifactFiles parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/searchTerm' - $ref: '#/components/parameters/filtersParam' responses: '200': $ref: '#/components/responses/FileDetailResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Artifact files tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/details: get: description: Get Helm Artifact Details operationId: GetHelmArtifactDetails parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/versionTypeParam' responses: '200': $ref: '#/components/responses/HelmArtifactDetailResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Helm Artifact Detail tags: - Helm Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/manifest: get: description: Get Helm Artifact Manifest operationId: GetHelmArtifactManifest parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/versionPathParam' responses: '200': $ref: '#/components/responses/HelmArtifactManifestResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Describe Helm Artifact Manifest tags: - Helm Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/summary: get: description: Get Artifact Version Summary. operationId: GetArtifactVersionSummary parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/versionPathParam' - $ref: '#/components/parameters/digestOptParam' - $ref: '#/components/parameters/filtersParam' responses: '200': $ref: '#/components/responses/ArtifactVersionSummaryResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Artifact Version Summary tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/{artifact}/versions: get: description: Lists all the Artifact Versions. operationId: GetAllArtifactVersions parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactPathParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/searchTerm' - $ref: '#/components/parameters/deleteFilterParam' responses: '200': $ref: '#/components/responses/ListArtifactVersionResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List Artifact Versions tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/labels: get: description: List Artifact Labels. operationId: ListArtifactLabels parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/searchTerm' responses: '200': $ref: '#/components/responses/ListArtifactLabelResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List Artifact Labels tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifact/stats: get: description: Get Artifact Stats. operationId: GetArtifactStatsForRegistry parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/fromDateParam' - $ref: '#/components/parameters/toDateParam' responses: '200': $ref: '#/components/responses/ArtifactStatsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Artifact Stats tags: - Artifacts /har/api/v1/registry/{registry_ref}/artifacts: get: description: Lists all the Artifacts for Registry operationId: GetAllArtifactsByRegistry parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/LabelsParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/searchTerm' - $ref: '#/components/parameters/artifactTypeParam' responses: '200': $ref: '#/components/responses/ListRegistryArtifactResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List Artifacts for Registry tags: - Registries /har/api/v1/registry/{registry_ref}/client-setup-details: get: description: Returns CLI Client Setup Details based on package type operationId: GetClientSetupDetails parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactParam' - $ref: '#/components/parameters/versionParam' - $ref: '#/components/parameters/artifactTypeParam' responses: '200': $ref: '#/components/responses/ClientSetupDetailsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Returns CLI Client Setup Details tags: - Registries /har/api/v1/registry/{registry_ref}/quarantine: delete: description: delete Quarantine file path operationId: deleteQuarantineFilePath parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/artifactParam' - $ref: '#/components/parameters/versionParam' - $ref: '#/components/parameters/filePathParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/filtersParam' responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: deleteQuarantineFilePath tags: - quarantine put: description: quarantine file path operationId: quarantineFilePath parameters: - $ref: '#/components/parameters/registryRefPathParam' requestBody: $ref: '#/components/requestBodies/quarantineRequest' responses: '200': $ref: '#/components/responses/quarantinePathResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: quarantineFilePath tags: - quarantine /har/api/v1/registry/{registry_ref}/webhooks: get: description: Returns List of Webhook Details operationId: ListWebhooks parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/searchTerm' responses: '200': $ref: '#/components/responses/ListWebhooksResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: ListWebhooks tags: - Webhooks post: description: Returns Webhook Details operationId: CreateWebhook parameters: - $ref: '#/components/parameters/registryRefPathParam' requestBody: $ref: '#/components/requestBodies/WebhookRequest' responses: '201': $ref: '#/components/responses/WebhookResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: CreateWebhook tags: - Webhooks /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}: delete: description: Delete a Webhook operationId: DeleteWebhook parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/webhookIdentifierPathParam' responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: DeleteWebhook tags: - Webhooks get: description: Returns Webhook Details operationId: GetWebhook parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/webhookIdentifierPathParam' responses: '200': $ref: '#/components/responses/WebhookResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: GetWebhook tags: - Webhooks put: description: Returns Webhook Details operationId: UpdateWebhook parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/webhookIdentifierPathParam' requestBody: $ref: '#/components/requestBodies/WebhookRequest' responses: '201': $ref: '#/components/responses/WebhookResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: UpdateWebhook tags: - Webhooks /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions: get: description: Returns Webhook Execution Details List operationId: ListWebhookExecutions parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/webhookIdentifierPathParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' responses: '200': $ref: '#/components/responses/ListWebhooksExecutionResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: ListWebhookExecutions tags: - Webhooks /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}: get: description: Returns Webhook Execution Details operationId: GetWebhookExecution parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/webhookIdentifierPathParam' - $ref: '#/components/parameters/webhookExecutionIdPathParam' responses: '200': $ref: '#/components/responses/WebhookExecutionResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: GetWebhookExecution tags: - Webhooks /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger: get: description: Retrigger Webhook Execution operationId: ReTriggerWebhookExecution parameters: - $ref: '#/components/parameters/registryRefPathParam' - $ref: '#/components/parameters/webhookIdentifierPathParam' - $ref: '#/components/parameters/webhookExecutionIdPathParam' responses: '200': $ref: '#/components/responses/WebhookExecutionResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: ReTriggerWebhookExecution tags: - Webhooks /har/api/v1/replication/rules: get: description: List all replication rules operationId: listReplicationRules parameters: - $ref: '#/components/parameters/spaceRefQueryParam' responses: '200': $ref: '#/components/responses/ListReplicationRuleResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List replication rules tags: - Replication post: description: Create a replication rule operationId: createReplicationRule parameters: - $ref: '#/components/parameters/spaceRefQueryParam' requestBody: $ref: '#/components/requestBodies/ReplicationRuleRequest' responses: '200': $ref: '#/components/responses/ReplicationRuleResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Create a replication rule tags: - Replication /har/api/v1/replication/rules/{id}: delete: description: Delete a replication rule operationId: deleteReplicationRule parameters: - in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Delete a replication rule tags: - Replication get: description: Get a replication rule operationId: getReplicationRule parameters: - in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/ReplicationRuleResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get a replication rule tags: - Replication put: description: Update a replication rule operationId: updateReplicationRule parameters: - in: path name: id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/ReplicationRuleRequest' responses: '200': $ref: '#/components/responses/ReplicationRuleResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Update a replication rule tags: - Replication /har/api/v1/replication/rules/{id}/migration/images: get: description: List migration images given an id operationId: listMigrationImages parameters: - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' responses: '200': $ref: '#/components/responses/ListMigrationImageResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List migration images tags: - Replication /har/api/v1/replication/rules/{id}/migration/images/{image_id}/logs: get: operationId: getMigrationLogsForImage parameters: - in: path name: id required: true schema: type: string - in: path name: image_id required: true schema: type: string responses: '200': $ref: '#/components/responses/PlainTextResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get migration logs for an image tags: - Replication /har/api/v1/replication/rules/{id}/migration/start: post: description: Start migration given an id operationId: startMigration parameters: - in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Start migration tags: - Replication /har/api/v1/replication/rules/{id}/migration/stop: post: description: Stop migration given an id operationId: stopMigration parameters: - in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Stop migration tags: - Replication /har/api/v1/spaces/{space_ref}/artifact/stats: get: description: Get artifact stats operationId: GetArtifactStatsForSpace parameters: - $ref: '#/components/parameters/spaceRefPathParam' - $ref: '#/components/parameters/fromDateParam' - $ref: '#/components/parameters/toDateParam' responses: '200': $ref: '#/components/responses/ArtifactStatsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get artifact stats tags: - Spaces /har/api/v1/spaces/{space_ref}/artifacts: get: description: Lists all the artifacts operationId: GetAllArtifacts parameters: - $ref: '#/components/parameters/spaceRefPathParam' - $ref: '#/components/parameters/RegistryIdentifierParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/searchTerm' - $ref: '#/components/parameters/latestVersion' - $ref: '#/components/parameters/deployedArtifact' - $ref: '#/components/parameters/packageTypeParam' responses: '200': $ref: '#/components/responses/ListArtifactResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List artifacts tags: - Spaces /har/api/v1/spaces/{space_ref}/details: get: description: Get storage details for given space operationId: GetStorageDetails parameters: - $ref: '#/components/parameters/spaceRefPathParam' responses: '200': $ref: '#/components/responses/StorageDetailsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get storage details for given space tags: - Spaces /har/api/v1/spaces/{space_ref}/labels: get: operationId: RegistrylistSpaceLabels parameters: - description: The page to return. in: query name: page schema: default: 1 minimum: 1 type: integer - description: The maximum number of results to return. in: query name: limit schema: default: 30 maximum: 100 minimum: 1 type: integer - description: The result should inherit entities from parent spaces. in: query name: inherited schema: default: false type: boolean - description: The substring which is used to filter the labels by their key. in: query name: query schema: type: string - in: path name: space_ref required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RegistryTypesLabel' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces post: operationId: RegistrydefineSpaceLabel parameters: - in: path name: space_ref required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' description: type: string key: type: string type: $ref: '#/components/schemas/EnumLabelType' type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/RegistryTypesLabel' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces put: operationId: RegistrysaveSpaceLabel parameters: - in: path name: space_ref required: true schema: type: string requestBody: content: application/json: schema: properties: label: $ref: '#/components/schemas/TypesSaveLabelInput' values: items: $ref: '#/components/schemas/TypesSaveLabelValueInput' type: array type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegistryTypesLabelWithValues' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces /har/api/v1/spaces/{space_ref}/labels/{key}: delete: operationId: RegistrydeleteSpaceLabel parameters: - in: path name: space_ref required: true schema: type: string - in: path name: key required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces get: operationId: findSpaceLabel parameters: - description: The result should include label values. in: query name: include_values schema: default: false type: boolean - in: path name: space_ref required: true schema: type: string - in: path name: key required: true schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/RegistryTypesLabelWithValues' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces patch: operationId: RegistryupdateSpaceLabel parameters: - in: path name: space_ref required: true schema: type: string - in: path name: key required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' description: type: string key: type: string type: $ref: '#/components/schemas/EnumLabelType' type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegistryTypesLabel' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces /har/api/v1/spaces/{space_ref}/labels/{key}/values: get: operationId: RegistrylistSpaceLabelValues parameters: - in: path name: space_ref required: true schema: type: string - in: path name: key required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TypesLabelValue' type: array description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces post: operationId: RegistrydefineSpaceLabelValue parameters: - in: path name: space_ref required: true schema: type: string - in: path name: key required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' value: type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/TypesLabelValue' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces /har/api/v1/spaces/{space_ref}/labels/{key}/values/{value}: delete: operationId: RegistrydeleteSpaceLabelValue parameters: - in: path name: space_ref required: true schema: type: string - in: path name: key required: true schema: type: string - in: path name: value required: true schema: type: string responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces patch: operationId: RegistryupdateSpaceLabelValue parameters: - in: path name: space_ref required: true schema: type: string - in: path name: key required: true schema: type: string - in: path name: value required: true schema: type: string requestBody: content: application/json: schema: properties: color: $ref: '#/components/schemas/EnumLabelColor' value: type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypesLabelValue' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/UsererrorError' description: Internal Server Error tags: - Spaces /har/api/v1/spaces/{space_ref}/registries: get: description: Lists all the registries. operationId: GetAllRegistries parameters: - $ref: '#/components/parameters/spaceRefPathParam' - $ref: '#/components/parameters/packageTypeParam' - $ref: '#/components/parameters/RegistryTypeParam' - $ref: '#/components/parameters/RegistrypageNumber' - $ref: '#/components/parameters/RegistrypageSize' - $ref: '#/components/parameters/RegistrysortOrder' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/searchTerm' - $ref: '#/components/parameters/recursiveParam' - $ref: '#/components/parameters/scopeParam' responses: '200': $ref: '#/components/responses/ListRegistryResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List registries tags: - Spaces /har/api/v2/artifacts: get: description: Lists all the Versions. operationId: ListVersions parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/OrgIdentifier' - $ref: '#/components/parameters/ProjectIdentifier' - $ref: '#/components/parameters/RegistryIdentifiersParam' - $ref: '#/components/parameters/PackageParam' - $ref: '#/components/parameters/MetadataFilter' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/SortOrder' - $ref: '#/components/parameters/SortField' - $ref: '#/components/parameters/RegistrySearchTerm' - $ref: '#/components/parameters/PackageTypeParam' - $ref: '#/components/parameters/DeleteFilterParam' responses: '200': $ref: '#/components/responses/ListVersionResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List Versions tags: - Registry V2 x-internal: true /har/api/v2/copy: post: description: Copy Artifact operationId: Copy parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/SrcOrgIdentifier' - $ref: '#/components/parameters/SrcProjectIdentifier' - $ref: '#/components/parameters/SrcRegistryIdentifierParam' - $ref: '#/components/parameters/SrcArtifact' - $ref: '#/components/parameters/SrcVersion' - $ref: '#/components/parameters/TargetOrgIdentifier' - $ref: '#/components/parameters/TargetProjectIdentifier' - $ref: '#/components/parameters/TargetRegistryIdentifierParam' - $ref: '#/components/parameters/artifactTypeParam' - $ref: '#/components/parameters/FiltersParam' responses: '200': $ref: '#/components/responses/CopyResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Copy Artifact tags: - Registry V2 x-internal: true /har/api/v2/files/{file_name}: get: description: Download file using file path operationId: GetFile parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/RegistryIdentifier' - $ref: '#/components/parameters/FilePath' - $ref: '#/components/parameters/FileName' responses: '200': $ref: '#/components/responses/DownloadFileResponse' '302': $ref: '#/components/responses/Redirect' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Download file using file path tags: - Registry V2 x-internal: true /har/api/v2/files/bulk-download: post: description: Create a bulk download request operationId: CreateBulkDownloadRequest parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' requestBody: $ref: '#/components/requestBodies/BulkDownloadFilesRequest' responses: '200': $ref: '#/components/responses/CreateBulkDownloadRequestResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Create a bulk download request tags: - Registry V2 x-internal: true /har/api/v2/files/bulk-download/{download_id}: get: description: Get bulk download request status operationId: GetBulkDownloadRequestStatus parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/DownloadId' responses: '200': $ref: '#/components/responses/GetBulkDownloadRequestStatusResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get bulk download request status tags: - Registry V2 x-internal: true /har/api/v2/files/search: get: description: Search all the files. operationId: SearchFiles parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/RegistryIdentifier' - $ref: '#/components/parameters/Query' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' responses: '200': $ref: '#/components/responses/ListFilesResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Search Files tags: - Registry V2 x-internal: true /har/api/v2/metadata: delete: description: > Delete metadata key-value pairs for a specific entity. This endpoint allows you to delete existing metadata for packages, versions, or registry-level entities. The operation supports deleting existing metadata in a single request. operationId: DeleteMetadata parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' requestBody: $ref: '#/components/requestBodies/MetadataRequest' responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Delete Metadata tags: - Registry V2 x-internal: true get: description: > Retrieves all metadata key-value pairs associated with a specific entity. This endpoint returns metadata for packages, versions, or registry-level entities based on the provided path. operationId: GetMetadata parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/RegistryIdentifier' - $ref: '#/components/parameters/PathParam' - $ref: '#/components/parameters/PackageParam' - $ref: '#/components/parameters/VersionParam' - $ref: '#/components/parameters/FiltersParam' responses: '200': $ref: '#/components/responses/MetadataResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Metadata tags: - Registry V2 x-internal: true post: description: > Creates new metadata or overwrites existing metadata key-value pairs for a specific entity. This endpoint allows you to add new metadata or overwrites existing metadata for packages, versions, or registry-level entities. The operation supports both creating new metadata entries and updating existing ones in a single request. operationId: UpdateMetadata parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' requestBody: $ref: '#/components/requestBodies/MetadataRequest' responses: '200': $ref: '#/components/responses/MetadataResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Update Metadata tags: - Registry V2 x-internal: true put: description: > Saves metadata key-value pairs for a specific entity. This endpoint allows you to save metadata for packages, versions, or registry-level entities. This operation will remove existing metadata and save the new metadata. It is an idempotent operation. operationId: SaveMetadata parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' requestBody: $ref: '#/components/requestBodies/MetadataRequest' responses: '200': $ref: '#/components/responses/MetadataResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Save Metadata tags: - Registry V2 x-internal: true /har/api/v2/metadata/keys: get: description: Retrieve a paginated list of all available metadata keys. operationId: GetMetadataKeys parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/OrgIdentifier' - $ref: '#/components/parameters/ProjectIdentifier' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/RegistrySearchTerm' responses: '200': $ref: '#/components/responses/MetadataKeysResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Metadata Keys tags: - Registry V2 x-internal: true /har/api/v2/metadata/values: get: description: Retrieve all possible values for a specific metadata key. operationId: GetMetadataValues parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/OrgIdentifier' - $ref: '#/components/parameters/ProjectIdentifier' - $ref: '#/components/parameters/KeyParam' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/RegistrySearchTerm' responses: '200': $ref: '#/components/responses/MetadataValuesResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Get Metadata Values tags: - Registry V2 x-internal: true /har/api/v2/oci/tags: post: description: Add OCI Artifact Tags. operationId: AddOciArtifactTags parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/OrgIdentifier' - $ref: '#/components/parameters/ProjectIdentifier' - $ref: '#/components/parameters/RegistryIdentifier' requestBody: $ref: '#/components/requestBodies/AddTagsRequest' responses: '200': $ref: '#/components/responses/AddTagsResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: Add tags to OCI artifact tags: - Registry V2 x-internal: true /har/api/v2/packages: get: description: Lists all the Image/Package operationId: ListPackages parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/OrgIdentifier' - $ref: '#/components/parameters/ProjectIdentifier' - $ref: '#/components/parameters/RegistryIdentifiersParam' - $ref: '#/components/parameters/MetadataFilter' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/SortOrder' - $ref: '#/components/parameters/SortField' - $ref: '#/components/parameters/RegistrySearchTerm' - $ref: '#/components/parameters/ArtifactTypeParam' - $ref: '#/components/parameters/PackageTypeParam' - $ref: '#/components/parameters/DeleteFilterParam' responses: '200': $ref: '#/components/responses/ListPackageResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List Image/Package tags: - Registry V2 x-internal: true /har/api/v2/registries: get: description: Lists all the registries. operationId: ListRegistries parameters: - $ref: '#/components/parameters/RegistryAccountIdentifier' - $ref: '#/components/parameters/OrgIdentifier' - $ref: '#/components/parameters/ProjectIdentifier' - $ref: '#/components/parameters/PackageTypeParam' - $ref: '#/components/parameters/RegistryTypeParam' - $ref: '#/components/parameters/MetadataFilter' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/SortOrder' - $ref: '#/components/parameters/SortField' - $ref: '#/components/parameters/RegistrySearchTerm' - $ref: '#/components/parameters/RegistryScope' - $ref: '#/components/parameters/DeleteFilterParam' responses: '200': $ref: '#/components/responses/ListRegistryResponse' '400': $ref: '#/components/responses/RegistryBadRequest' '401': $ref: '#/components/responses/RegistryUnauthenticated' '403': $ref: '#/components/responses/RegistryUnauthorized' '404': $ref: '#/components/responses/RegistryNotFound' '500': $ref: '#/components/responses/RegistryInternalServerError' summary: List registries tags: - Registry V2 x-internal: true /har/api/v3/build-info: post: description: Adds build info generated by CLI after package installation. operationId: AddBuildInfoV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' requestBody: $ref: '#/components/requestBodies/BuildInfoRequestV3' responses: '201': description: Build info added successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Add build info tags: - Registry V3 - Firewall x-internal: false /har/api/v3/build-info/pipeline/details: get: description: Returns all pipeline build info details. operationId: ListPipelineBuildInfoDetailsV3 parameters: - $ref: '#/components/parameters/PackageNameFilterParamV3' - $ref: '#/components/parameters/VersionFilterParamV3' - $ref: '#/components/parameters/RegistryIdFilterParamV3' - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PipelineIdFilterParamV3' - $ref: '#/components/parameters/ScanIDQueryParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/ProjectsOptionalListParamV3' - $ref: >- #/components/parameters/SecurityViolationCategoriesOptionalListParamV3 - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryScopeV3' responses: '200': $ref: '#/components/responses/ListPipelineBuildInfoDetailsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List pipeline build info details tags: - Registry V3 - Firewall x-internal: false /har/api/v3/bulk-download: post: description: Create a bulk download request operationId: CreateBulkDownloadRequestV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' requestBody: $ref: '#/components/requestBodies/BulkDownloadFilesRequestV3' responses: '202': $ref: '#/components/responses/CreateBulkDownloadRequestAcceptedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Create a bulk download request tags: - Registry V3 - Transfer x-internal: true /har/api/v3/bulk-download/{id}: get: description: Get bulk download request status operationId: GetBulkDownloadRequestStatusV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': $ref: '#/components/responses/GetBulkDownloadRequestStatusResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get bulk download request status tags: - Registry V3 - Transfer x-internal: true /har/api/v3/bulkdelete: post: description: Execute bulk delete operation operationId: BulkDeleteV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: $ref: '#/components/requestBodies/BulkDeleteRequestV3' responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkDeleteResponseV3' description: Bulk delete executed successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Execute bulk delete tags: - Registry V3 - Bulk Deletion x-internal: true /har/api/v3/copy: post: description: Copy resources operationId: CopyResourcesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' requestBody: $ref: '#/components/requestBodies/CopyResourcesRequestV3' responses: '200': description: Copied successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Copy resources tags: - Registry V3 - Transfer x-internal: false /har/api/v3/files: get: description: List files. operationId: ListFilesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/RegistryIdOptionalParamV3' - $ref: '#/components/parameters/PackageIdOptionalParamV3' - $ref: '#/components/parameters/VersionIdOptionalParamV3' - $ref: '#/components/parameters/ConanRecipeRevisionOptionalParamV3' - $ref: '#/components/parameters/ConanPackageRevisionOptionalParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/SearchTermV3' responses: '200': $ref: '#/components/responses/ListFilesResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Search Files tags: - Registry V3 - Files x-internal: false /har/api/v3/files/{id}/content: get: description: > Download a file using its id. When `preview=true` is supplied the response is a `302` redirect to an inline-preview URL for the file instead of the file bytes. operationId: GetFileV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/FilePreviewQueryParamV3' responses: '200': $ref: '#/components/responses/DownloadFileResponseV3' '302': $ref: '#/components/responses/RedirectV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Download file using file id tags: - Registry V3 - Files x-internal: false /har/api/v3/files/{id}/metadata: get: description: Retrieves all metadata for a file. operationId: GetFileMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get File Metadata tags: - Registry V3 - Files x-internal: false post: description: Creates or overwrites metadata for a file. operationId: UpsertFileMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Upsert File Metadata tags: - Registry V3 - Files x-internal: false put: description: Replaces all metadata for a file. operationId: SaveFileMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Replace File Metadata tags: - Registry V3 - Files x-internal: false /har/api/v3/files/{id}/preview: get: description: > Returns a URL for rendering a file inline in the browser. For cloud (S3/GCS) deployments the URL is a presigned URL with inline Content-Disposition and a forced Content-Type baked in, expiring after 20 minutes. For filesystem deployments the URL routes back through the protocol API with preview=true and relies on the caller's session. The endpoint enforces the preview allowlist and a configured maximum size before returning a URL. operationId: GetFilePreviewV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': $ref: '#/components/responses/FilePreviewResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get inline preview URL for a file tags: - Registry V3 - Files x-internal: true /har/api/v3/files/search: post: description: > Search files across a registry using a POSIX regular expression matched server-side against the full node path. Filter payload is sent in the request body so that regex characters such as `?`, `&`, `+`, `#` and `%` do not need URL-encoding and are not truncated by proxies. Backs the CLI bulk-download flow: the server performs regex filtering and the client parallelizes the individual file downloads. operationId: SearchRegistryFilesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' requestBody: $ref: '#/components/requestBodies/SearchRegistryFilesRequestV3' responses: '200': $ref: '#/components/responses/ListFilesResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Search Registry Files by path regex tags: - Registry V3 - Files x-internal: true /har/api/v3/filters: get: description: | List filter definitions available for the requested `resource_type` (REGISTRY, PACKAGE, or VERSION). Filters returned depend on the scope inferred from the supplied identifiers (ACCOUNT / ORG / PROJECT). For PACKAGE and VERSION resource types, if `package_type` is provided the response is augmented with type-specific filters (e.g. Docker, Maven, npm). `package_type` is ignored when `resource_type=REGISTRY`. operationId: ListFiltersV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/FilterResourceTypeParamV3' - $ref: '#/components/parameters/PackageTypeFilterParamV3' - $ref: '#/components/parameters/FilterIdOptionalParamV3' - $ref: '#/components/parameters/SearchTermV3' responses: '200': $ref: '#/components/responses/ListFiltersResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Filters tags: - Registry V3 - Filters x-internal: false /har/api/v3/filters/options: get: description: | List the selectable values for a single filter identified by `filter_id`. Same authorization and scoping semantics as `GET /filters`. `package_type` is only meaningful for filters on PACKAGE and VERSION resources and is ignored otherwise; `search_term` narrows the returned options in place of pagination. operationId: ListFilterOptionsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/FilterResourceTypeParamV3' - $ref: '#/components/parameters/FilterIdParamV3' - $ref: '#/components/parameters/PackageTypeFilterParamV3' - $ref: '#/components/parameters/OptionValuesParamV3' - $ref: '#/components/parameters/SearchTermV3' responses: '200': $ref: '#/components/responses/ListFilterOptionsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Filter Options tags: - Registry V3 - Filters x-internal: false /har/api/v3/internal/registries/{registry_name}/files: get: description: List files belonging to a registry. operationId: ListRegistryFilesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/RegistryNamePathParamV3' - $ref: '#/components/parameters/PackageNameFilterParamV3' - $ref: '#/components/parameters/VersionFilterParamV3' - $ref: '#/components/parameters/FilePathFilterParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/SearchTermV3' responses: '200': $ref: '#/components/responses/ListFilesResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Registry Files tags: - Registry V3 - Files x-internal: true /har/api/v3/internal/search/backfill: post: operationId: TriggerBackfillV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' requestBody: $ref: '#/components/requestBodies/BackfillTriggerRequestV3' responses: '202': content: application/json: schema: properties: data: $ref: '#/components/schemas/BackfillTriggerDataV3' required: - data type: object description: Accepted — backfill task created. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Conflict — backfill already running for this account. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Trigger ES search backfill for an account tags: - Registry V3 - Internal x-internal: true /har/api/v3/internal/search/backfill/state: get: operationId: GetBackfillStateV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/BackfillStateDataV3' required: - data type: object description: Backfill state per entity type. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get backfill state by account tags: - Registry V3 - Internal x-internal: true /har/api/v3/internal/search/backfill/status/{job_id}: get: operationId: GetBackfillTaskStatusV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - in: path name: job_id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/BackfillTaskStatusDataV3' required: - data type: object description: Job status. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Task not found. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get backfill task status tags: - Registry V3 - Internal x-internal: true /har/api/v3/lifecycle/executions: get: description: >- Lists lifecycle executions for the given scope, optionally filtered by policy. operationId: ListLifecycleExecutionsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/LifecycleScopeParamV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/LifecycleExecutionStatusParamV3' responses: '200': $ref: '#/components/responses/ListLifecycleExecutionsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List lifecycle executions tags: - Registry V3 - Lifecycle x-internal: false post: description: Triggers a dry-run execution for a lifecycle rule. operationId: CreateLifecycleExecutionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: content: application/json: schema: $ref: '#/components/schemas/LifecycleDryRunRequestBodyV3' required: true responses: '201': $ref: '#/components/responses/LifecycleExecutionCreatedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Trigger a dry-run lifecycle execution tags: - Registry V3 - Lifecycle x-internal: false /har/api/v3/lifecycle/executions/{executionId}: get: description: Returns a specific lifecycle execution by ID. operationId: GetLifecycleExecutionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - description: The execution ID. in: path name: executionId required: true schema: type: string responses: '200': $ref: '#/components/responses/LifecycleExecutionResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get a lifecycle execution tags: - Registry V3 - Lifecycle x-internal: false /har/api/v3/lifecycle/executions/{executionId}/items: get: description: Lists the artifact-level items evaluated during a lifecycle execution. operationId: ListLifecycleExecutionItemsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/LifecycleExecutionItemStatusParamV3' - $ref: '#/components/parameters/LifecycleScopeParamV3' - description: The execution ID. in: path name: executionId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListLifecycleExecutionItemsResponseV3' description: Execution items list. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List lifecycle execution items tags: - Registry V3 - Lifecycle x-internal: false /har/api/v3/lifecycle/rules: get: description: Lists lifecycle rules for the given scope. operationId: ListLifecycleRulesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/LifecycleScopeParamV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/LifecycleActionParamV3' responses: '200': $ref: '#/components/responses/ListLifecycleRulesResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List lifecycle rules tags: - Registry V3 - Lifecycle x-internal: false post: description: Creates a new lifecycle rule. operationId: CreateLifecycleRuleV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: content: application/json: schema: $ref: '#/components/schemas/LifecycleRuleRequestBodyV3' required: true responses: '201': $ref: '#/components/responses/LifecycleRuleCreatedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Create a lifecycle rule tags: - Registry V3 - Lifecycle x-internal: false /har/api/v3/lifecycle/rules/{id}: delete: description: Deletes a lifecycle rule. Only the owner scope may delete. operationId: DeleteLifecycleRuleV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '204': description: Lifecycle rule deleted successfully. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Delete a lifecycle rule tags: - Registry V3 - Lifecycle x-internal: false get: description: Returns a specific lifecycle rule by ID. operationId: GetLifecycleRuleV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': $ref: '#/components/responses/LifecycleRuleResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get a lifecycle rule tags: - Registry V3 - Lifecycle x-internal: false patch: description: Partially updates a lifecycle rule. Only provided fields are modified. operationId: PatchLifecycleRuleV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: content: application/json: schema: $ref: '#/components/schemas/LifecycleRulePatchBodyV3' required: true responses: '200': $ref: '#/components/responses/LifecycleRuleResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Partially update a lifecycle rule tags: - Registry V3 - Lifecycle x-internal: false put: description: Updates an existing lifecycle rule. operationId: UpdateLifecycleRuleV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: content: application/json: schema: $ref: '#/components/schemas/LifecycleRuleRequestBodyV3' required: true responses: '200': $ref: '#/components/responses/LifecycleRuleUpdatedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Update a lifecycle rule tags: - Registry V3 - Lifecycle x-internal: false /har/api/v3/lifecycle/stats: get: description: Returns aggregate lifecycle execution metrics for the given scope. operationId: GetLifecycleStatsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/LifecycleScopeParamV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/LifecycleActionParamV3' responses: '200': content: application/json: schema: $ref: '#/components/schemas/LifecycleStatsResponseV3' description: Lifecycle stats. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get lifecycle stats tags: - Registry V3 - Lifecycle x-internal: false /har/api/v3/metadata/{id}: delete: description: | Delete metadata key-value pairs by ID of metadata operationId: DeleteMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': description: Metadata deleted successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Delete Metadata tags: - Registry V3 - Metadata x-internal: false /har/api/v3/metadata/keys: get: description: Retrieve a paginated list of all available metadata keys. operationId: GetMetadataKeysV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SearchTermV3' responses: '200': $ref: '#/components/responses/MetadataKeysResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Metadata Keys tags: - Registry V3 - Metadata x-internal: false /har/api/v3/metadata/values: get: description: Retrieve all possible values for a specific metadata key. operationId: GetMetadataValuesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/KeyParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SearchTermV3' responses: '200': $ref: '#/components/responses/MetadataValuesResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Metadata Values tags: - Registry V3 - Metadata x-internal: false /har/api/v3/packages: get: description: Lists Packages operationId: ListPackagesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/MetadataFilterListParamV3' - $ref: '#/components/parameters/PackageKindQueryParamV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/DeleteFilterParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/IncludeMetaParamV3' responses: '200': $ref: '#/components/responses/ListPackageResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Packages tags: - Registry V3 - Packages x-internal: false /har/api/v3/packages/{id}: delete: description: Delete a package/image operationId: DeletePackageV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ForceParamV3' responses: '200': description: Deleted successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Delete a Package tags: - Registry V3 - Packages x-internal: true /har/api/v3/packages/{id}/metadata: get: description: Retrieves all metadata for a package. operationId: GetPackageMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Package Metadata tags: - Registry V3 - Packages x-internal: false post: description: Creates or overwrites metadata for a package. operationId: UpsertPackageMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Upsert Package Metadata tags: - Registry V3 - Packages x-internal: false put: description: Replaces all metadata for a package. operationId: SavePackageMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Replace Package Metadata tags: - Registry V3 - Packages x-internal: false /har/api/v3/packages/{id}/restore: post: description: Restore a previously soft-deleted package/image by ID operationId: RestorePackageV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': description: Restored successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Restore a Soft-Deleted Package tags: - Registry V3 - Packages x-internal: true /har/api/v3/packages/stats: post: description: >- Get statistics (artifactsCount, size, downloadCount) for a list of packages by their UUIDs. operationId: GetPackagesStatsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: $ref: '#/components/requestBodies/PackagesStatsRequestV3' responses: '200': $ref: '#/components/responses/PackagesStatsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get statistics for multiple packages tags: - Registry V3 - Packages x-internal: false /har/api/v3/principals: get: description: Lists Principals operationId: ListPrincipalsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/PrincipalTypeFilterParamV3' responses: '200': $ref: '#/components/responses/ListPrincipalsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Principals tags: - Registry V3 - Principals x-internal: false /har/api/v3/registries: get: description: Lists registries. operationId: ListRegistriesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryTypeParamV3' - $ref: '#/components/parameters/MetadataFilterListParamV3' - $ref: '#/components/parameters/RegistryScopeV3' - $ref: '#/components/parameters/DeleteFilterParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/IncludeMetaParamV3' responses: '200': $ref: '#/components/responses/ListRegistryResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List registries tags: - Registry V3 - Registries x-internal: false /har/api/v3/registries/{id}: delete: description: Delete a registry (soft or hard delete based on deleteType parameter) operationId: DeleteRegistryV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ForceParamV3' responses: '200': description: Deleted successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Delete a Registry tags: - Registry V3 - Registries x-internal: true /har/api/v3/registries/{id}/metadata: get: description: Retrieves all metadata for a registry. operationId: GetRegistryMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Registry Metadata tags: - Registry V3 - Registries x-internal: false post: description: Creates or overwrites metadata for a registry. operationId: UpsertRegistryMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Upsert Registry Metadata tags: - Registry V3 - Registries x-internal: false put: description: Replaces all metadata for a registry. operationId: SaveRegistryMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Replace Registry Metadata tags: - Registry V3 - Registries x-internal: false /har/api/v3/registries/{id}/migrate: post: description: >- Migrate a generic registry to raw registry type. This will change the registry type from GENERIC to RAW and delete all images associated with the registry. operationId: MigrateRegistryV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': description: Migrated successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Migrate Generic Registry to Raw Registry tags: - Registry V3 - Registries x-internal: true /har/api/v3/registries/{id}/rebuild-index: post: description: >- Trigger an asynchronous rebuild of the repository index for the given registry. The rebuild runs in the background; this endpoint returns immediately once the request is accepted. Index rebuild is package-type specific — it is currently supported only for HELM_HTTP registries. Registries whose package type does not maintain a rebuildable index return 405. operationId: RebuildRegistryIndexV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '202': $ref: '#/components/responses/RebuildRegistryIndexAcceptedV3' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Index rebuild is not supported for this registry's package type. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Rebuild the index for a registry tags: - Registry V3 - Registries x-internal: false /har/api/v3/registries/{id}/restore: post: description: Restore a previously soft-deleted registry by ID operationId: RestoreRegistryV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': description: Restored successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Restore a Soft-Deleted Registry tags: - Registry V3 - Registries x-internal: true /har/api/v3/registries/stats: post: description: >- Get statistics (packageCount, size, downloadCount, artifactsCount) for a list of registries by their UUIDs. operationId: GetRegistriesStatsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: $ref: '#/components/requestBodies/RegistriesStatsRequestV3' responses: '200': $ref: '#/components/responses/RegistriesStatsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get statistics for multiple registries tags: - Registry V3 - Registries x-internal: false /har/api/v3/scans: get: description: Get the list of artifact scan result for a particular scope operationId: GetArtifactScansV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/PolicySetRefParamV3' - $ref: >- #/components/parameters/SecurityViolationCategoriesOptionalListParamV3 - $ref: '#/components/parameters/ScanIDQueryParamV3' - $ref: '#/components/parameters/ScanStatusParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/RegistryScopeV3' responses: '200': $ref: '#/components/responses/ListArtifactScanResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get the list of artifact scan result for a particular scope tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/{id}/details: get: description: Get the details of a artifact scan operationId: GetArtifactScanDetailsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/PolicySetRefParamV3' responses: '200': $ref: '#/components/responses/ArtifactScanDetailsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get the details of a artifact scan tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/bulk-evaluate: post: description: Triggers firewall policy evaluation for multiple artifacts operationId: InitiateBulkScanEvaluationV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: $ref: '#/components/requestBodies/BulkScanEvaluationRequestV3' responses: '202': $ref: '#/components/responses/BulkScanEvaluationAcceptedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Initiate bulk scan evaluation tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/bulk-evaluate-sync: post: description: > Synchronously evaluates firewall policies for up to 50 artifacts and returns the scan result for each one. No data is written to the database. operationId: BulkEvaluateArtifactsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: $ref: '#/components/requestBodies/BulkScanEvaluateSyncRequestV3' responses: '200': $ref: '#/components/responses/BulkScanEvaluateSyncResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Synchronous bulk artifact scan evaluation (no DB write) tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/bulk-evaluate/{evaluation_id}: get: description: Returns the status of a bulk scan evaluation operationId: GetBulkScanEvaluationStatusV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/EvaluationIdParamV3' responses: '200': $ref: '#/components/responses/BulkScanEvaluationStatusResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get bulk scan evaluation status tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/evaluate: post: description: Re-evaluate artifact scan operationId: EvaluateArtifactScanV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' requestBody: $ref: '#/components/requestBodies/ArtifactScanEvaluateRequestV3' responses: '202': $ref: '#/components/responses/ArtifactScanEvaluateRequestAcceptedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Re-evaluate artifact scan tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/exceptions: get: description: List firewall exceptions with optional filters operationId: ListFirewallExceptionsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/FirewallExceptionStatusFilterParamV3' - $ref: '#/components/parameters/PackageNameFilterParamV3' - $ref: '#/components/parameters/VersionFilterParamV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/ExceptionIdFilterParamV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' responses: '200': $ref: '#/components/responses/ListFirewallExceptionResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List firewall exceptions tags: - Registry V3 - Firewall x-internal: false post: description: Create a firewall exception for an artifact operationId: CreateFirewallExceptionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' requestBody: $ref: '#/components/requestBodies/FirewallExceptionCreateRequestV3' responses: '201': $ref: '#/components/responses/FirewallExceptionCreatedV3' '409': content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Duplicate exception. default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Create a firewall exception tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/exceptions/{id}: delete: description: Delete a firewall exception by ID operationId: DeleteFirewallExceptionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '204': description: Firewall exception deleted successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Delete a firewall exception tags: - Registry V3 - Firewall x-internal: false put: description: Update a firewall exception. Only allowed when status is PENDING. operationId: UpdateFirewallExceptionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/FirewallExceptionUpdateRequestV3' responses: '200': $ref: '#/components/responses/FirewallExceptionUpdatedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Update a firewall exception tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/exceptions/{id}/status: put: description: Update the status of a firewall exception (approve or reject) operationId: UpdateStatusFirewallExceptionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/FirewallExceptionApprovalRequestV3' responses: '200': $ref: '#/components/responses/FirewallExceptionApprovedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Update status of a firewall exception tags: - Registry V3 - Firewall x-internal: false /har/api/v3/scans/versions: get: description: >- List versions for a specific package in a registry, for use when creating firewall exceptions operationId: ListFirewallExceptionVersionsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/RegistryIdFilterParamV3' - $ref: '#/components/parameters/PackageNameFilterParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' responses: '200': $ref: '#/components/responses/ListFirewallExceptionVersionsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List versions for firewall exceptions tags: - Registry V3 - Firewall x-internal: false /har/api/v3/system/info: get: description: | Returns system-level information for the Harness Artifact Registry, including the base registry URL for the account. Use this endpoint to discover the correct registry hostname for pulling and pushing artifacts. operationId: GetSystemInfoV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' responses: '200': $ref: '#/components/responses/SystemInfoResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get System Info tags: - Registry V3 - System x-internal: false /har/api/v3/versions: get: description: Lists versions of packages operationId: ListVersionsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' - $ref: '#/components/parameters/RegistryIdListOptionalParamV3' - $ref: '#/components/parameters/PackageIdListOptionalParamV3' - $ref: '#/components/parameters/PackageTypeListParamV3' - $ref: '#/components/parameters/DeleteFilterParamV3' - $ref: '#/components/parameters/MetadataFilterListParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/SearchTermV3' - $ref: '#/components/parameters/IncludeMetaParamV3' - $ref: '#/components/parameters/UploadedByParamV3' responses: '200': $ref: '#/components/responses/ListVersionResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List versions of packages tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}: delete: description: Delete a version (soft or hard delete based on deleteType parameter) operationId: DeleteVersionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ForceParamV3' responses: '200': description: Deleted successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Delete a Version tags: - Registry V3 - Versions x-internal: true /har/api/v3/versions/{id}/conan/recipe-revisions: get: description: List finalized Conan recipe revisions for a version. operationId: ListConanRecipeRevisionsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' responses: '200': $ref: '#/components/responses/ConanRecipeRevisionsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Conan Recipe Revisions tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/details: get: description: Get a Conan recipe revision (RREV) detail. operationId: GetConanRecipeRevisionDetailV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ConanRecipeRevisionPathParamV3' responses: '200': $ref: '#/components/responses/ConanRecipeRevisionDetailResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Conan Recipe Revision Detail tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages: get: description: List the packages (PKGIDs) under a Conan recipe revision. operationId: ListConanPackagesV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ConanRecipeRevisionPathParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' responses: '200': $ref: '#/components/responses/ConanPackagesResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Conan Packages of a Recipe Revision tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/details: get: description: Get a Conan package (PKGID) detail with its package revisions. operationId: GetConanPackageDetailV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ConanRecipeRevisionPathParamV3' - $ref: '#/components/parameters/ConanPackageIdPathParamV3' responses: '200': $ref: '#/components/responses/ConanPackageDetailResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Conan Package Detail tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/package-revisions: get: description: List the package revisions (PREVs) under a Conan package. operationId: ListConanPackageRevisionsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ConanRecipeRevisionPathParamV3' - $ref: '#/components/parameters/ConanPackageIdPathParamV3' - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' responses: '200': $ref: '#/components/responses/ConanPackageRevisionsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List Conan Package Revisions of a Package tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/package-revisions/{package_revision_id}/details: get: description: Get a Conan package revision (PREV) detail. operationId: GetConanPackageRevisionDetailV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - $ref: '#/components/parameters/ConanRecipeRevisionPathParamV3' - $ref: '#/components/parameters/ConanPackageIdPathParamV3' - $ref: '#/components/parameters/ConanPackageRevisionPathParamV3' responses: '200': $ref: '#/components/responses/ConanPackageRevisionDetailResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Conan Package Revision Detail tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/deployments: get: description: > List Harness CD deployments for a specific version. Returns the environments and services that are actively running this version, together with aggregate prod/non-prod counts in `meta`. For OCI-based package types (DOCKER, HELM) the artifact is identified by `image:tag` — supply `package_tag` or an empty response is returned. For all other package types the artifact is identified by `package_name/version_name`. operationId: ListVersionDeploymentsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' - description: > Filter by environment type. Allowed values: `PRODUCTION`, `PRE_PRODUCTION`. in: query name: env_type schema: enum: - PRODUCTION - PRE_PRODUCTION type: string - $ref: '#/components/parameters/PageNumberV3' - $ref: '#/components/parameters/PageSizeV3' - $ref: '#/components/parameters/SortV3' - $ref: '#/components/parameters/SearchTermV3' - description: > Tag to use when identifying the artifact in CD. Currently used for Docker images: provide the tag (e.g. `latest`) so the artifact is resolved as `image:tag`. For OCI-based package types (DOCKER, HELM), if this parameter is omitted no deployment data is returned. in: query name: package_tag schema: type: string responses: '200': $ref: '#/components/responses/ListVersionDeploymentsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: List deployments for a version tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/metadata: get: description: Retrieves all metadata for a version. operationId: GetVersionMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get Version Metadata tags: - Registry V3 - Versions x-internal: false post: description: Creates or overwrites metadata for a version. operationId: UpsertVersionMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Upsert Version Metadata tags: - Registry V3 - Versions x-internal: false put: description: Replaces all metadata for a version. operationId: SaveVersionMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/MetadataRequestV3' responses: '200': $ref: '#/components/responses/MetadataResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Replace Version Metadata tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/{id}/restore: post: description: Restore a previously soft-deleted version by ID operationId: RestoreVersionV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' responses: '200': description: Restored successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Restore a Soft-Deleted Version tags: - Registry V3 - Versions x-internal: true /har/api/v3/versions/{id}/tags: post: description: >- Add tags to version of package. Currently supported for only OCI package. operationId: AddVersionTagsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/IdPathParamV3' requestBody: $ref: '#/components/requestBodies/AddTagsRequestV3' responses: '204': description: Tags added successfully default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Add tags to version of package tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/rebuild-metadata: post: description: Trigger metadata rebuild for all versions in a registry operationId: RebuildVersionMetadataV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' requestBody: content: application/json: schema: $ref: '#/components/schemas/RebuildVersionMetadataRequestV3' description: Request body containing registry ID to rebuild metadata required: true responses: '202': $ref: '#/components/responses/RebuildVersionMetadataAcceptedV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Rebuild metadata for all versions in a registry tags: - Registry V3 - Versions x-internal: false /har/api/v3/versions/stats: post: description: >- Get statistics (deploymentMetadata, downloadCount, fileCount, scanStatus, scanID, size, artifactKey) for a list of versions by their UUIDs. operationId: GetVersionsStatsV3 parameters: - $ref: '#/components/parameters/AccountIdentifierV3' - $ref: '#/components/parameters/OrgIdentifierV3' - $ref: '#/components/parameters/ProjectIdentifierV3' requestBody: $ref: '#/components/requestBodies/VersionsStatsRequestV3' responses: '200': $ref: '#/components/responses/VersionsStatsResponseV3' default: content: application/json: schema: $ref: '#/components/schemas/ErrorV3' description: Error response. summary: Get statistics for multiple versions tags: - Registry V3 - Versions x-internal: false /iacm/api/enforcement/client/usage/{metric}: put: tags: - usage summary: Show usage description: Retrieve a single usage operationId: usage#getUsage parameters: - name: accountIdentifier in: query description: Account identifier allowEmptyValue: true required: true schema: type: string description: Account identifier example: Laborum dicta dolor voluptatem. example: Alias praesentium. - name: metric in: path description: Usage metric required: true schema: type: string description: Usage metric example: Qui occaecati explicabo quaerat. example: Cum accusamus ut. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowUsageResponse' example: data: ansible: uniqueHosts30d: 4993966439619897000 count: 7484279815988722000 status: Voluptatibus et explicabo voluptates nisi quasi. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/health: get: tags: - system summary: health system description: Check server health operationId: IaCMsystem#health responses: '200': description: OK response. /iacm/api/latest-plugin-version: post: tags: - system summary: latest-plugin-version system description: Get the latest plugin version operationId: system#latest-plugin-version requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginReportedVersion' example: commit: 96381692bf3a2bd7904769c6886e832435768b57 version: v0.123.0 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/HarnessIacmPluginversion' example: commit: 96381692bf3a2bd7904769c6886e832435768b57 version: 0.2.0 /iacm/api/migrate/template-connectors: post: tags: - migration summary: Trigger template connector migration description: >- Triggers an async one-off update that adds provider_connectors to template YAMLs for templates in use. operationId: migration#migrate-template-connectors requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MigrateTemplateConnectorsRequest' example: dry_run: false responses: '202': description: Accepted response. content: application/json: schema: $ref: '#/components/schemas/MigrateTemplateConnectorsResponse' example: message: Migration job started successfully '500': description: 'internal_error: Internal server error' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/migrate/workspace-connectors: post: tags: - migration summary: Trigger workspace connector migration description: >- Triggers an async one-off migration that moves connector data from workspaces into the provider_connectors table. operationId: migration#migrate-workspace-connectors requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MigrateWorkspaceConnectorsRequest' example: dry_run: false responses: '202': description: Accepted response. content: application/json: schema: $ref: '#/components/schemas/MigrateWorkspaceConnectorsResponse' example: message: Migration job started successfully '500': description: 'internal_error: Internal server error' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules: get: tags: - module-registry summary: List modules description: List all modules from the module registry operationId: module-registry#list_modules-by-account parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: searchTerm in: query description: Filter results by partial name or provider match allowEmptyValue: true schema: type: string description: Filter results by partial name or provider match default: '' example: mymod example: mymod - name: sort in: query description: Sort order for results allowEmptyValue: true schema: type: string description: Sort order for results default: name,ASC example: updated,DESC enum: - name,ASC - name,DESC - updated,ASC - updated,DESC example: name,DESC - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Et ipsa. example: Atque quaerat. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Et cum numquam expedita veritatis perspiciatis. example: Aspernatur sint atque. - name: provider in: query description: >- Filter modules to these providers (module_system values). Repeatable query param. allowEmptyValue: true schema: type: array items: type: string example: Natus sed quas doloremque. description: >- Filter modules to these providers (module_system values). Repeatable query param. example: - terraform - tofu example: - terraform - tofu - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Consequatur exercitationem. example: Minus ipsam quaerat eaque est. responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ModuleResourceCollection' example: - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - >- Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - >- Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - >- Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - >- Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - module-registry summary: Create module description: Create a new module in the module registry operationId: module-registry#create-module parameters: - name: scope_org in: query description: Organization identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 example: my_org - name: scope_project in: query description: Project identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 example: my_project - name: Harness-Account in: header description: Harness account ID that owns the module. allowEmptyValue: true required: true schema: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 example: abc123DEFghiJKL requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleRequest' example: description: Provisions a VPC with public and private subnets. git_tag_style: module-name-* name: my-vpc-module onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' storage_type: artifact system: aws tags: Officia officia velit voluptatem soluta quaerat. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ModuleRegistryCreateModuleResponseBody' example: account: abc123DEFghiJKL created: 5459285281721391000 description: Provisions a VPC with public and private subnets. id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff name: my-vpc-module org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' scope_org: my_org scope_project: my_project storage_type: git_reference system: aws tags: Eius sed assumenda illum sint beatae provident. updated: 5355892478085344000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}: delete: tags: - module-registry summary: Delete module description: Delete a module from the module registry operationId: module-registry#delete-module parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Vel quibusdam consequatur id sit alias. example: Magni nemo non incidunt quia omnis vitae. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Doloremque nostrum dolorum est ut in. example: Assumenda necessitatibus fugiat porro. - name: id in: path description: id required: true schema: type: string description: id example: Quae molestiae officiis officiis sunt. example: Reprehenderit praesentium. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Modi ut soluta. example: Laboriosam molestias neque. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - module-registry summary: List module by id description: List a module from the module registry by ID operationId: module-registry#list-modules-by-id parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Voluptates magnam dolorem delectus velit. example: Repellendus porro officia quia doloribus est. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Veritatis dolorem enim architecto iusto. example: Voluptatem quis molestiae voluptates rerum. - name: id in: path description: module id required: true schema: type: string description: module id example: Itaque atque ipsum. example: Dolores ratione distinctio. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Est eveniet doloremque consequatur sint placeat accusantium. example: Quia dolore. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListModuleByIDResponse' example: account: abc123DEFghiJKL created: 7074782854274014000 description: Provisions a VPC with public and private subnets. domain_prefix: Quia assumenda non quam. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Et inventore mollitia fugiat expedita tempore mollitia. name: my-vpc-module namespace: Alias ipsum sint consequuntur. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true onboarding_pipeline_wh: webhook_abc123 org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et veniam consequatur totam. scope_org: my_org scope_project: my_project storage_type: git_reference synced: 3892658297188124700 system: aws tags: Eligendi ut dicta voluptatem tempore. testing_enabled: false testing_metadata: account: r org: 'y' pipelines: - Eos ex voluptas consequatur asperiores fugit. - Molestiae dolorum rerum sed voluptatibus veniam fuga. - Assumenda magni qui vel eaque repellendus ducimus. project: h provider_connector: Quod est illo tempore dolores. provisioner_type: Pariatur velit quasi. provisioner_version: Dolorum non labore tenetur impedit doloribus. release_pipeline: Architecto odio iure eius. updated: 5254455737636099000 version_statuses: Aut quaerat asperiores.: Corrupti fuga explicabo. versions: - Voluptates aut sunt. - Quos voluptatem et doloribus minima laboriosam aperiam. - Quia et exercitationem alias sit velit mollitia. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - module-registry summary: Update module description: Update a module in the module registry operationId: module-registry#update-module parameters: - name: scope_org in: query description: Organization identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 example: my_org - name: scope_project in: query description: Project identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 example: my_project - name: id in: path description: module id required: true schema: type: string description: module id example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff - name: Harness-Account in: header description: Harness account ID that owns the module. allowEmptyValue: true required: true schema: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 example: abc123DEFghiJKL requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateModuleRequest' example: description: Provisions a VPC with public and private subnets. git_tag_style: module-name-* name: my-vpc-module onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' storage_type: git_reference system: aws tags: Vero quod natus hic nesciunt est facere. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/lifecycle: delete: tags: - module-registry summary: Delete module lifecycle rule description: >- Delete the lifecycle rule and all overrides for a module; all versions revert to supported operationId: module-registry#delete-module-lifecycle parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Voluptatem non laborum. example: Nulla quisquam eum labore. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Ut eveniet. example: Vel est ipsum perferendis natus quos. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Alias autem vitae porro quae. example: Rem quia pariatur id voluptate occaecati ipsam. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Vero eaque iure itaque qui magni. example: Porro inventore. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - module-registry summary: Get module lifecycle rule description: Get the lifecycle rule for a module operationId: module-registry#get-module-lifecycle parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Nostrum ut enim voluptate. example: Odio sint officia et. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Itaque velit quia. example: Repellendus magnam voluptatem aut voluptatibus. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Quidem maxime. example: Consequatur consequatur sit quo. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Aliquam incidunt at. example: Aut iusto et voluptatem. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetModuleLifecycleResponse' example: deprecated_action: no_action overrides: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 supported_action: warn supported_count: 3 warning_action: warn warning_count: 2 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - module-registry summary: Upsert module lifecycle rule description: >- Create or replace the lifecycle rule for a module, atomically replacing all overrides operationId: module-registry#put-module-lifecycle parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Illo ullam nemo ea. example: Sint voluptas. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Iure temporibus recusandae ea qui non. example: Vero autem est et eveniet ipsum quis. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Cupiditate rerum ut. example: A dicta quo sit accusantium omnis. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Omnis sunt adipisci omnis. example: Est quae alias est est est non. requestBody: description: Lifecycle rule with overrides required: true content: application/json: schema: $ref: '#/components/schemas/ModuleLifecycleRule' example: deprecated_action: warn overrides: - reason: 7hw tier: deprecated version: v2.1.0 - reason: 7hw tier: deprecated version: v2.1.0 - reason: 7hw tier: deprecated version: v2.1.0 supported_action: warn supported_count: 3 warning_action: no_action warning_count: 2 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/PutModuleLifecycleResponse' example: deprecated_action: fail overrides: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 supported_action: no_action supported_count: 3 warning_action: fail warning_count: 2 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/lifecycle/versions/{version}: get: tags: - module-registry summary: Get module version lifecycle status description: >- Compute the lifecycle tier and enforcement action for a specific module version operationId: module-registry#get-module-lifecycle-version-status parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Culpa debitis corporis tempore ducimus corporis. example: Doloremque delectus necessitatibus deleniti quasi. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Iste illum amet. example: Cupiditate iure maiores voluptatem saepe. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Sed labore tenetur non officiis dolor ut. example: Autem consequatur. - name: version in: path description: Version to look up required: true schema: type: string description: Version to look up example: Repudiandae est expedita. example: Quia facere nulla error quia dignissimos. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Inventore earum distinctio. example: Ut molestiae qui ipsam assumenda. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetModuleLifecycleVersionStatusResponse' example: action: no_action minimum_supported_version: Non error dolorem rerum. tier: warning '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/pipeline: post: tags: - module-registry summary: Create testing pipeline description: Create a new testing pipeline for a given module operationId: module-registry#create-testing-pipelines parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Expedita tempora. example: Veniam aperiam praesentium et delectus nihil. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Pariatur molestiae rerum. example: Qui quis voluptas aliquid aliquam aut ut. - name: id in: path description: module id required: true schema: type: string description: module id example: Error cum. example: Impedit aut porro. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Voluptas cum aut. example: Eum et id. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTestingPipelineRequest' example: pipeline_org: Voluptatem earum possimus enim repellat. pipeline_project: Saepe aspernatur alias temporibus. type: Sed sed neque. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/sync: post: tags: - module-registry summary: Sync module metadata description: Sync the module metadata from the module registry operationId: module-registry#sync-module-metadata parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Quibusdam ipsum deleniti dolorum vel quia. example: Optio quia. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Exercitationem velit dignissimos ullam. example: Voluptates quia. - name: id in: path description: id required: true schema: type: string description: id example: Ut voluptas id ipsum quia minima. example: Repellat aut aut et vitae minima. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Quisquam voluptas possimus molestiae molestiae. example: Nesciunt qui qui nobis vel molestias. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/tags: get: tags: - module-registry summary: List module tags description: List the module tags from the module registry operationId: module-registry#list-module-tags-by-id parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Sint ea praesentium. example: Necessitatibus illo. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Debitis eius consequatur eligendi. example: Quo labore esse deserunt ea eum assumenda. - name: id in: path description: module id required: true schema: type: string description: module id example: Amet quas. example: Possimus eaque sit ut et aspernatur non. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Rerum tempore eius ut. example: Qui voluptas nobis laboriosam fugit aspernatur qui. responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Quam rerum. example: - Nam fugit ut facere saepe pariatur eveniet. - Possimus mollitia pariatur est. - Atque molestiae. - Vero quo voluptatum. example: - Ut et vel consequatur et quae. - Accusantium rem recusandae quas et laudantium ab. - Ex nihil esse quos occaecati. - Atque vitae dolores et est dolor. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/testing: delete: tags: - module-registry summary: Disable testing description: Disable testing for a module operationId: module-registry#disable-testing parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Non consequatur nihil cumque reprehenderit optio amet. example: Nisi sit aut quod velit eum. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Praesentium tempore omnis ipsum iste. example: Qui voluptatem enim recusandae. - name: id in: path description: module id required: true schema: type: integer description: module id example: 4150810973825628000 format: int64 example: 4849135301420935000 - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Sed distinctio. example: Dolore cum aliquid minus fugiat inventore. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - module-registry summary: Enable testing description: Enable testing for a module operationId: module-registry#enable-testing parameters: - name: scope_org in: query description: module org allowEmptyValue: true schema: type: string description: module org example: Eveniet in totam. example: Consequatur qui nostrum aliquam ratione hic. - name: scope_project in: query description: module project allowEmptyValue: true schema: type: string description: module project example: Id exercitationem ab facilis. example: Odit qui provident similique. - name: id in: path description: module id required: true schema: type: string description: module id example: Quia ipsum in enim ipsam praesentium est. example: Error sed illum animi. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Libero pariatur dolorum. example: Dolorum recusandae. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableTestingRequest' example: pipeline_id: - Praesentium impedit. - Qui eligendi dolorem sunt. - Consequuntur ut. - Numquam in occaecati voluptatum numquam harum. pipeline_org: Iste sunt libero assumenda debitis eum debitis. pipeline_project: Aut sit. provider_connector: Quidem iure et inventore dolore aliquid nihil. provisioner_type: Ut quas. provisioner_version: Quasi eum quae. release_pipeline: Nostrum a ex enim. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - module-registry summary: Update module testing description: Update module testing metadata operationId: module-registry#update-module-testing parameters: - name: scope_org in: query description: module org allowEmptyValue: true schema: type: string description: module org example: Est autem laudantium vel alias ipsam vel. example: Quidem officiis voluptatem. - name: scope_project in: query description: module project allowEmptyValue: true schema: type: string description: module project example: Occaecati non. example: Praesentium quod ut neque ab quod esse. - name: id in: path description: module id required: true schema: type: string description: module id example: Sit enim quo impedit in totam. example: Quibusdam officiis soluta a deleniti ipsum. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Tempora quaerat quia dicta minima illo. example: Aut aspernatur omnis rerum. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTestingRequest' example: pipeline_id: - Dolor mollitia et. - Necessitatibus omnis qui. - Voluptas aut nihil magni optio enim modi. - Praesentium et consectetur velit omnis est ducimus. pipeline_org: Molestiae qui ea sit eaque. pipeline_project: Alias blanditiis. provider_connector: Qui ipsa ex voluptatem et vel soluta. provisioner_type: Rerum enim repellendus quaerat aliquid doloribus quidem. provisioner_version: Ut similique impedit sint est deleniti et. release_pipeline: Ducimus quibusdam ut. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/versions/{version}: delete: tags: - module-registry summary: Delete module version description: Delete a specific version from a module in the module registry operationId: module-registry#delete-module-versions parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Omnis voluptatibus et explicabo et totam aut. example: Ut ut ut libero. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Cupiditate culpa expedita quo iusto. example: Enim enim velit aspernatur id quibusdam quia. - name: id in: path description: module id required: true schema: type: string description: module id example: Et qui autem velit. example: Qui quo. - name: version in: path description: version to delete required: true schema: type: string description: version to delete example: Optio consequatur quo. example: Atque impedit. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Et nobis est ea illo eveniet eos. example: Atque autem minima quos ullam. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/examples/file: get: tags: - module-registry summary: Get module example file description: >- Download a single file from a module version's examples/ tree. The path must begin with "examples/" and identify a file (not a directory). operationId: module-registry#get-module-example-file parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Aut deleniti assumenda pariatur. example: Voluptatem tempora animi omnis magnam. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Id dicta et molestias tempora accusamus placeat. example: Ea et ut quidem consectetur magni qui. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Vitae laborum excepturi magnam ex. example: Voluptas cumque. - name: path in: query description: >- relative path under the module root; must begin with "examples/" and identify a file (e.g. "examples/iam-account/main.tf" or "examples/iam-account/modules/foo/main.tf") allowEmptyValue: true required: true schema: type: string description: >- relative path under the module root; must begin with "examples/" and identify a file (e.g. "examples/iam-account/main.tf" or "examples/iam-account/modules/foo/main.tf") example: z8 pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$ minLength: 1 maxLength: 1024 example: k65 - name: module_id in: path description: module id required: true schema: type: string description: module id example: Laboriosam adipisci aspernatur accusantium qui voluptatibus. example: Dolores reiciendis et iste numquam. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Qui quaerat pariatur numquam. example: Qui aut est eum totam. responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/examples/tree: get: tags: - module-registry summary: List module example tree description: >- List the immediate children (files and subdirectories) at the given path within a module version's examples/ tree. The path must be exactly "examples" (root listing) or begin with "examples/". Returns one level of entries, each tagged as a file or directory. operationId: module-registry#list-module-example-tree parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Veritatis aut adipisci vero. example: Iste exercitationem officiis. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Consequuntur soluta neque laboriosam corporis. example: Est vitae. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Beatae sequi deserunt ut tenetur minima. example: Sapiente veniam animi dolorem ab non. - name: path in: query description: >- relative path under the module root; must be "examples" or begin with "examples/" allowEmptyValue: true required: true schema: type: string description: >- relative path under the module root; must be "examples" or begin with "examples/" example: k05 pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$ minLength: 1 maxLength: 1024 example: dqh - name: module_id in: path description: module id required: true schema: type: string description: module id example: Sequi labore veritatis ad. example: Omnis assumenda. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Est odio error eos. example: Ab cumque quia. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListModuleExampleTreeResponse' example: items: - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/metadata: get: tags: - module-registry summary: List module metadata description: List the module metadata from the module registry operationId: module-registry#list-metadata-by-module parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Ab voluptas. example: Dolores quos. - name: submodule in: query description: submodule name allowEmptyValue: true schema: type: string description: submodule name example: Nemo suscipit. example: Sed excepturi maxime veniam. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Sed dolorem eos ut perferendis. example: Voluptatum optio. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Qui eum et aperiam eveniet. example: Voluptates repellat fugiat sed ut. - name: module_id in: path description: module id required: true schema: type: string description: module id example: Saepe libero. example: Sint maiores. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Et similique. example: Odit vitae dignissimos rem itaque nisi ut. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListModuleMetadataResponse' example: account: Voluptas voluptatum veritatis repellendus eligendi quo qui. dependencies: - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. examples_paths: - A consequatur voluptatem sequi repellat. - Soluta tempore non voluptatum. - Quia enim repellat. metadata_error: Repellendus aut nesciunt. module_version: Autem nam laborum facilis enim. name: Eaque vel ut recusandae nisi cupiditate. outputs: - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true providers: - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. resources: - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. scope_org: Est maiores beatae hic. scope_project: Corrupti ut voluptatem sit quod dolor. submodule: - Maiores at aliquid minus ut et sunt. - Reprehenderit sit. system: Atque et sequi et et explicabo. variables: - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/readme: get: tags: - module-registry summary: List module readme description: List the module readme from the module registry operationId: module-registry#list-readme-by-id parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Repudiandae laudantium odit officiis qui. example: Eum est enim facere qui aliquam. - name: submodule in: query description: submodule name allowEmptyValue: true schema: type: string description: submodule name example: Explicabo necessitatibus eos facere. example: Quod ad nihil consequatur iure. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Nisi consequatur omnis. example: Vitae error. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Vitae corrupti. example: Repellat illum reiciendis eos. - name: module_id in: path description: module id required: true schema: type: string description: module id example: Et sit possimus. example: Ipsam minima illo eveniet. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Veritatis sequi illum cumque. example: Omnis voluptate consectetur eligendi et voluptas. responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{moduleId}/events: post: tags: - module-registry summary: Send an event related with a module execution description: Send an event related with a module execution operationId: module-registry#send-module-event parameters: - name: moduleId in: path description: module id associated with this event required: true schema: type: string description: module id associated with this event example: v minLength: 1 maxLength: 1024 example: cr7 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendModuleEventRequest' example: account: Porro numquam animi molestias vero praesentium sed. eventType: Odit hic porro enim nostrum nostrum molestiae. metadata: pipeline: Est porro ullam omnis sit. pipeline_execution_id: Nisi eveniet. pipeline_execution_number: Deserunt exercitationem sit consequatur. pipeline_name: Dolores et magni. pipeline_stage_id: Reiciendis unde in temporibus sit laborum. trigger: Nam ex maxime consequatur dolor facere.: Ut quod qui iure rerum. Sed voluptatem non.: Inventore eos officiis. org: Id rem illum accusantium ut voluptate nisi. project: Placeat quidem velit explicabo. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{moduleId}/executions: get: tags: - module-registry summary: List executions for a specific module description: List all module executions for a module. operationId: module-registry#list-module-executions-id parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: pipeline_execution_id in: query description: Pipeline identifier allowEmptyValue: true schema: type: string description: Pipeline identifier example: Voluptatem iusto aut occaecati fuga error. example: Ipsa quo voluptatum aut. - name: status in: query description: Status of the execution allowEmptyValue: true schema: type: array items: type: string example: Earum voluptas est provident maiores autem. description: Status of the execution example: - Sunt mollitia aut quas mollitia sint. - Blanditiis corporis non. - Expedita placeat esse excepturi quia et quae. - Deserunt a suscipit ut. example: - Sed ullam distinctio eos. - Laboriosam esse. - Nisi et non consequatur aut facere. - name: start_time in: query description: Specify the start time for the query allowEmptyValue: true schema: type: integer description: Specify the start time for the query example: 1691150743950 format: int64 example: 1691150743950 - name: end_time in: query description: Specify the end time limit for the query allowEmptyValue: true schema: type: integer description: Specify the end time limit for the query example: 1691150743950 format: int64 example: 1691150743950 - name: module_onboarding in: query description: Is module onboarding execution allowEmptyValue: true schema: type: boolean description: Is module onboarding execution default: false example: false example: false - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Aspernatur est porro. example: Dolorem dolore provident autem amet ut. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Et corporis rerum iste autem officia. example: Laudantium dolor et. - name: moduleId in: path description: Module identifier required: true schema: type: string description: Module identifier example: Saepe eligendi distinctio. example: Optio sit voluptates delectus quia et. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: y0p minLength: 1 maxLength: 128 example: z95 responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ModuleExecutionResourceCollection' example: - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - module-registry summary: Create a new module execution description: Create a new module execution. operationId: module-registry#create-module-execution parameters: - name: moduleId in: path description: The unique identifier for the associated module required: true schema: type: string description: The unique identifier for the associated module example: Accusamus culpa ut. example: Amet qui numquam necessitatibus et. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleExecutionRequest' example: account: Eos maxime ad et delectus ut soluta. module_onboarding: true pipeline: Esse molestiae enim nihil quod deleniti. pipeline_org: Sit non dicta. pipeline_project: Autem cupiditate sit quo et fugit. pipelineExecutionId: Cupiditate itaque corrupti eaque laudantium velit. pipelineStageId: Ut ullam quos sit voluptatum iste. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateModuleExecutionResponse' example: account: Est facere cum cupiditate cumque neque. created: 4061667798647593000 metadata: pipeline: Molestias nihil nam reprehenderit. pipeline_execution_id: Ea qui quo magnam cupiditate laudantium nostrum. pipeline_execution_number: Est quo voluptas est. pipeline_name: Quasi rerum aperiam. pipeline_stage_id: Corrupti ducimus sed minus qui illo ut. trigger: Aut voluptatem.: Consequatur est non magni eum est. Cumque quis enim odio quia ut molestiae.: Nihil quisquam rerum est iste et alias. Nam in.: Doloremque sint omnis quis maxime et molestiae. module_onboarding: false moduleId: Sunt molestiae ipsa culpa aspernatur vero. org: Quasi enim. project: Nihil numquam natus delectus ab nam. status: Molestiae a quia. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/examples: post: tags: - module-registry summary: Create module example description: >- Endpoint to upload README and Terraform source files for a single example directory of a module version operationId: module-registry#post-module-example parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Laborum rerum voluptatem consequatur. example: Officiis tempora quis possimus deleniti odit expedita. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Sit iure a et eum nihil sunt. example: Sit nesciunt id cum nam ipsa est. - name: path in: query description: >- relative path under the module root; must be "examples" or begin with "examples/" (e.g. "examples/eks-auto-mode") allowEmptyValue: true required: true schema: type: string description: >- relative path under the module root; must be "examples" or begin with "examples/" (e.g. "examples/eks-auto-mode") example: hx pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$ minLength: 1 maxLength: 1024 example: x - name: name in: path description: module name required: true schema: type: string description: module name example: Iure aut minus quam. example: Eaque molestias. - name: system in: path description: system name required: true schema: type: string description: system name example: Cumque nesciunt quaerat officiis deserunt dolor. example: Asperiores totam omnis laudantium distinctio. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Rerum delectus fugit laudantium perferendis. example: Ut dolores debitis amet omnis voluptates dolore. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Optio ut harum placeat architecto omnis. example: Dolores id. - name: Content-Type in: header description: Content-Type header (multipart/form-data with boundary) allowEmptyValue: true required: true schema: type: string description: Content-Type header (multipart/form-data with boundary) example: Qui dolorum velit. example: Facilis itaque dolor aspernatur aut vel perferendis. - name: Content-Length in: header description: Size in bytes of the multipart body allowEmptyValue: true schema: type: integer description: Size in bytes of the multipart body example: 4870268399397385000 format: int64 example: 1655906209272749600 responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/metadata: post: tags: - module-registry summary: Create module data description: Create a new module in the module registry operationId: module-registry#module-parsed-data parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Officia sint iure aspernatur eveniet reiciendis rerum. example: Debitis corporis perspiciatis ut nemo. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Sequi non. example: Unde et. - name: name in: path description: module name required: true schema: type: string description: module name example: Et quaerat. example: Exercitationem consequatur consectetur. - name: system in: path description: system name required: true schema: type: string description: system name example: Quia eligendi. example: Commodi vel vero. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Enim qui velit. example: Magnam quisquam aut error et tenetur. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Doloribus nostrum. example: Nisi omnis consequatur. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleDataRequest' example: download_url: Et perferendis ut temporibus sed commodi animi. error: Veritatis ut.: Quia omnis. examples_paths: - Porro assumenda similique voluptas. - Nihil esse consequuntur cupiditate sit ut voluptate. - Voluptatum placeat eligendi. git_tag: At qui. metadata: Ducimus sit. repo_url: Vitae in eius. submodule_name: Aut porro mollitia quia in quo. submodule_paths: - Possimus vitae qui commodi qui explicabo. - Rerum ducimus officia at dolorum sed tempore. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/readme: post: tags: - module-registry summary: Create module readme description: Endpoint to push the Readme for a given module operationId: module-registry#post-module-readme parameters: - name: submoduleName in: query description: submodule name allowEmptyValue: true schema: type: string description: submodule name example: Sunt incidunt. example: Quod expedita non tempore et provident. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Aut occaecati fuga voluptatem est. example: Rerum voluptatibus harum. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Consequatur ipsa. example: Qui iste. - name: name in: path description: module name required: true schema: type: string description: module name example: Ea harum repellat. example: Voluptatem qui deserunt est quia magnam dignissimos. - name: system in: path description: system name required: true schema: type: string description: system name example: Dicta vitae. example: Ipsum enim enim voluptates et. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Voluptatem at esse fugit nesciunt aut. example: Tempora at et. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Eaque aliquam est exercitationem praesentium qui molestiae. example: Quia omnis aut et quibusdam tempore ut. - name: Content-Length in: header description: Size in bytes of the readme allowEmptyValue: true schema: type: integer description: Size in bytes of the readme example: 2374365714865187000 format: int64 example: 7192753419360744000 responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/upload: post: tags: - module-registry summary: Upload module artifact files description: Upload module artifact to the module registry operationId: module-registry#post-module-artifact parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Magnam quo eius non. example: Dolore tenetur blanditiis sed. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Quia error est consequuntur aspernatur voluptas labore. example: Ipsam eos est quis. - name: name in: path description: Module artifact name required: true schema: type: string description: Module artifact name example: Ab nulla ad atque rem provident qui. example: Eos et quos illum vel itaque. - name: system in: path description: Module artifact system required: true schema: type: string description: Module artifact system example: Quam iure ut enim nihil. example: Aliquam facere cumque. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Omnis accusamus odit. example: Debitis minima ut harum asperiores voluptatibus est. - name: Harness-Account in: header description: Account ID allowEmptyValue: true required: true schema: type: string description: Account ID example: harness example: harness - name: Content-Disposition in: header description: Content-Disposition header allowEmptyValue: true required: true schema: type: string description: Content-Disposition header example: Enim possimus labore sit. example: Consequatur illum doloremque in perspiciatis. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/tags: post: tags: - module-registry summary: Create module tags description: List all tags for a given module operationId: module-registry#post-module-tags parameters: - name: scope_org in: query description: Organization identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 example: my_org - name: scope_project in: query description: Project identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 example: my_project - name: name in: path description: >- Human-readable name of the module. Must be unique within the same scope and system. required: true schema: type: string description: >- Human-readable name of the module. Must be unique within the same scope and system. example: my-vpc-module minLength: 1 maxLength: 128 example: my-vpc-module - name: system in: path description: >- Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). required: true schema: type: string description: >- Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). example: aws pattern: ^[a-z]+$ minLength: 1 maxLength: 128 example: aws - name: Harness-Account in: header description: Harness account ID that owns the module. allowEmptyValue: true required: true schema: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 example: abc123DEFghiJKL requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleTagsRequest' example: error: Nesciunt pariatur et quo possimus nostrum.: Facilis id velit dignissimos dolor exercitationem et. tags: - Nihil voluptatem optio distinctio repudiandae rerum dolorem. - Nihil voluptatibus eum dolore quae. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/connectors: get: tags: - module-registry summary: List connectors description: List all connectors from the module registry for a specific account operationId: module-registry#list-connectors parameters: - name: org in: query description: organization name allowEmptyValue: true schema: type: string description: organization name example: Labore qui sapiente autem quisquam et ducimus. example: Rerum asperiores consequatur occaecati repellat dolorem. - name: project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Quae hic eaque sunt facilis. example: Et aut id mollitia ipsam. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Rerum optio est ut. example: Et nobis sint molestias aut voluptatem. responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Assumenda nemo qui autem libero. example: - Quia consequuntur et sapiente. - At consequatur eum. - Molestiae quasi. example: - Et corrupti sapiente. - Nam voluptas voluptas quae eum hic. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/lifecycle/batch-check: post: tags: - module-registry summary: Batch check module lifecycle status description: >- Batch-check lifecycle status for a list of modules resolved during terraform init; only violations are returned operationId: module-registry#batch-check-module-lifecycle parameters: - name: Harness-Account in: header description: Harness account ID allowEmptyValue: true required: true schema: type: string description: Harness account ID example: Tempore tempora voluptatem. example: Voluptas aspernatur est. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchCheckModuleLifecycleRequest' example: items: - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/BatchCheckModuleLifecycleResponse' example: results: - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/pipeline/onboarding: post: tags: - module-registry summary: Create onboarding pipeline description: Create a new onboarding pipeline for module registry operationId: module-registry#create-onboarding-pipeline parameters: - name: scope_org in: query description: module org name allowEmptyValue: true schema: type: string description: module org name example: Autem quo culpa. example: Et in. - name: scope_project in: query description: module project name allowEmptyValue: true schema: type: string description: module project name example: Quaerat modi in excepturi at. example: Est fuga unde dolorem sit et tempore. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: g minLength: 1 maxLength: 128 example: 'y' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOnboardingPipelineRequest' example: org: b project: xj responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/providers: get: tags: - module-registry summary: List module providers description: >- List the distinct providers (module_system values) in the module registry for a scope operationId: module-registry#list-module-providers parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Et qui maiores. example: Rem ratione odio fuga nam. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Dignissimos esse ipsum qui voluptates laborum odit. example: Rerum porro quis dolores ut aut. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Assumenda qui temporibus sapiente. example: Aut sunt non rerum et id. responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Dolor est hic ullam error amet. example: - Sint minus quia aperiam quibusdam debitis et. - Cum ea sunt cumque eos. - Reprehenderit voluptatem culpa eaque. - Sit facilis in cum in eos sint. example: - Sed sint asperiores repellat beatae expedita. - Commodi eos est error molestiae. - Qui sit quas. - Eum rem odio quia. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/activities: get: tags: - activities summary: List activities description: List all activities operationId: activities#list-activities parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: workspace in: query description: Workspace identifier allowEmptyValue: true schema: type: string description: Workspace identifier example: Non magnam quis deleniti voluptas. example: Culpa minima atque omnis. - name: pipeline in: query description: Pipeline filter allowEmptyValue: true schema: type: string description: Pipeline filter example: Nihil tenetur ut. example: Tempore voluptates. - name: pipeline_execution_id in: query description: Pipeline execution filter allowEmptyValue: true schema: type: string description: Pipeline execution filter example: Est et libero recusandae voluptas debitis. example: Quia molestiae repellat et. - name: pipeline_stage_id in: query description: Pipeline stage filter allowEmptyValue: true schema: type: string description: Pipeline stage filter example: Laborum suscipit ad molestiae deserunt quos. example: Voluptates qui nesciunt cupiditate ipsum provident quae. - name: activity_type in: query description: Activity type filter allowEmptyValue: true schema: type: string description: Activity type filter example: Eaque atque aperiam voluptatum quidem. example: Autem cumque mollitia nihil. - name: activity_status in: query description: Activity status filter allowEmptyValue: true schema: type: string description: Activity status filter example: Consequatur maiores in necessitatibus et et pariatur. example: Corporis nisi nihil id expedita molestiae eligendi. - name: start_time in: query description: Start time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: Start time filter (Unix timestamp) example: 317303704311037200 format: int64 example: 4523578234231308000 - name: end_time in: query description: End time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: End time filter (Unix timestamp) example: 2918553615035180500 format: int64 example: 128157541012208500 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: s minLength: 1 maxLength: 128 example: y6f - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: er minLength: 1 maxLength: 128 example: x - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: bv minLength: 1 maxLength: 128 example: bm responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ActivityResourceCollection' example: - account: 7ax created: 1443014888504235500 id: Aliquam eveniet ipsa consequatur et veritatis aspernatur. metadata: PlannedChangesCount: 8068703872190990000 activity_status: failure activity_type: synth cost_breakdown_uuid: Qui ratione. cost_currency: Numquam quis maxime. cost_diff_total_monthly: Possimus voluptatem quidem dolorem ullam. cost_diff_uuid: Quis reprehenderit expedita atque aut. cost_past_total_monthly: Distinctio suscipit et et aut saepe. cost_total_monthly: Harum tenetur voluptas eum. cost_total_monthly_percentage_change: Autem ipsum tempora sed et. data_length: 716540082371348100 drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 enable_solutions_factory: false git_branch: Amet voluptatibus est veniam molestias. git_commit_message: Sed molestiae minus omnis consequatur et ad. git_commit_sha: Et tenetur voluptas velit ratione iste sequi. git_repo: Aperiam labore exercitationem ab. modules_uuid: >- Nihil debitis molestiae consequatur nihil quibusdam commodi. output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 pipeline: Laboriosam minus assumenda. pipeline_execution_id: Adipisci est eum est ipsa dolor laborum. pipeline_execution_number: Iusto enim. pipeline_name: Quod molestiae. pipeline_stage_id: Omnis possimus unde dolores vitae. plan_uuid: Consequuntur tempora magnam eligendi. providers_uuid: Itaque et dolorem perferendis et dolore. provisioner: Ut inventore. provisioner_version: Et asperiores. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 rollback_reason: Totam deleniti. rollback_source_id: Deleniti neque ut quam optio dolorum. stacks: - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. state_checksum: Et quibusdam rerum et. state_uuid: Odio qui quis. terragrunt_details: - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. trigger: Impedit culpa.: Voluptatem tenetur. org: w0 project: g workspace: Eligendi delectus voluptas. - account: 7ax created: 1443014888504235500 id: Aliquam eveniet ipsa consequatur et veritatis aspernatur. metadata: PlannedChangesCount: 8068703872190990000 activity_status: failure activity_type: synth cost_breakdown_uuid: Qui ratione. cost_currency: Numquam quis maxime. cost_diff_total_monthly: Possimus voluptatem quidem dolorem ullam. cost_diff_uuid: Quis reprehenderit expedita atque aut. cost_past_total_monthly: Distinctio suscipit et et aut saepe. cost_total_monthly: Harum tenetur voluptas eum. cost_total_monthly_percentage_change: Autem ipsum tempora sed et. data_length: 716540082371348100 drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 enable_solutions_factory: false git_branch: Amet voluptatibus est veniam molestias. git_commit_message: Sed molestiae minus omnis consequatur et ad. git_commit_sha: Et tenetur voluptas velit ratione iste sequi. git_repo: Aperiam labore exercitationem ab. modules_uuid: >- Nihil debitis molestiae consequatur nihil quibusdam commodi. output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 pipeline: Laboriosam minus assumenda. pipeline_execution_id: Adipisci est eum est ipsa dolor laborum. pipeline_execution_number: Iusto enim. pipeline_name: Quod molestiae. pipeline_stage_id: Omnis possimus unde dolores vitae. plan_uuid: Consequuntur tempora magnam eligendi. providers_uuid: Itaque et dolorem perferendis et dolore. provisioner: Ut inventore. provisioner_version: Et asperiores. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 rollback_reason: Totam deleniti. rollback_source_id: Deleniti neque ut quam optio dolorum. stacks: - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. state_checksum: Et quibusdam rerum et. state_uuid: Odio qui quis. terragrunt_details: - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. trigger: Impedit culpa.: Voluptatem tenetur. org: w0 project: g workspace: Eligendi delectus voluptas. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/activities/{id}/resource-changes: get: tags: - activities summary: List resource changes description: List resource changes associated with this activity operationId: activities#list-activity-resource-changes parameters: - name: workspace in: query description: The unique identifier for the associated workspace allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated workspace example: Culpa eveniet illo earum aperiam error. example: Quia assumenda voluptas error. - name: path_id in: query description: Terragrunt path identifier allowEmptyValue: true schema: type: string description: Terragrunt path identifier example: Quis aut quia. example: Mollitia modi recusandae dolores. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: r09 minLength: 1 maxLength: 128 example: k - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: g minLength: 1 maxLength: 128 example: a - name: id in: path description: The unique identifier for this activity required: true schema: type: string description: The unique identifier for this activity example: Qui modi inventore qui delectus ut. example: Odio tempora quis assumenda praesentium iusto. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: q minLength: 1 maxLength: 128 example: dz responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListActivityResourceChangesResponse' example: data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket drift_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket has_dependency_graph: false outputs: - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 pipeline_execution: Sed qui necessitatibus mollitia incidunt et. pipeline_stage: Omnis at excepturi id sint quod. planned_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket risk_assessment: overall_risk_summary: overall_level: HIGH overall_score: 7 reason: >- Driven by highest-risk resource: aws_s3_bucket_public_access_block.secure (score: 8) resource_risks: Dolores temporibus velit qui asperiores nostrum est.: risk_factors: - Cum mollitia aut ipsum consequuntur. - Et aut odit cumque. - Odit doloribus porro voluptas dolores maiores. risk_level: HIGH risk_mitigation: - Quis nihil voluptates ipsa. - Earum in beatae corrupti laudantium optio. - Quasi officiis nisi ratione quibusdam. - Facilis harum sit est unde nihil. risk_score: 2 stage_id: Est sit id quas sit sit. workspace_id: Enim illo. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/approvals: get: tags: - approvals summary: List approvals description: List all the approvals operationId: approvals#list-approvals parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: workspace in: query description: Workspace identifier allowEmptyValue: true schema: type: string description: Workspace identifier example: Ipsa ratione. example: Eaque voluptas natus modi omnis. - name: pipeline_execution_id in: query description: Pipeline identifier allowEmptyValue: true schema: type: string description: Pipeline identifier example: Amet et sit qui. example: Omnis consequatur rerum amet deleniti ex. - name: pipeline_stage_id in: query description: Pipeline stage identifier allowEmptyValue: true schema: type: string description: Pipeline stage identifier example: Voluptas earum. example: Est a hic beatae non. - name: status_type in: query description: Status of the approval step allowEmptyValue: true schema: type: string description: Status of the approval step example: rejected enum: - approved - rejected - pending example: rejected - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: q0 minLength: 1 maxLength: 128 example: 2g - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '0' minLength: 1 maxLength: 128 example: u9 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: j minLength: 1 maxLength: 128 example: hw responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ApprovalResourceCollection' example: - account: kn8 actioned_by: John Doe actioned_by_email: john.doe@example.com created: 8923043851235030000 id: Aliquid quia dignissimos aut accusamus voluptates rerum. org: '1' pipeline_execution_id: A tempora asperiores consectetur. pipeline_stage_id: Id consequatur atque. project: bcz status: Quam saepe sit magnam tenetur. updated: 4501857522395362000 workspace_id: Itaque sed eum. - account: kn8 actioned_by: John Doe actioned_by_email: john.doe@example.com created: 8923043851235030000 id: Aliquid quia dignissimos aut accusamus voluptates rerum. org: '1' pipeline_execution_id: A tempora asperiores consectetur. pipeline_stage_id: Id consequatur atque. project: bcz status: Quam saepe sit magnam tenetur. updated: 4501857522395362000 workspace_id: Itaque sed eum. - account: kn8 actioned_by: John Doe actioned_by_email: john.doe@example.com created: 8923043851235030000 id: Aliquid quia dignissimos aut accusamus voluptates rerum. org: '1' pipeline_execution_id: A tempora asperiores consectetur. pipeline_stage_id: Id consequatur atque. project: bcz status: Quam saepe sit magnam tenetur. updated: 4501857522395362000 workspace_id: Itaque sed eum. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - approvals summary: Create approval description: Create an approval resource operationId: approvals#create-approval parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: p6w minLength: 1 maxLength: 128 example: 9f - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: qy minLength: 1 maxLength: 128 example: u - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: urv minLength: 1 maxLength: 128 example: 9d requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApprovalRequest' example: pipeline_execution_id: Voluptas incidunt aut in et nostrum corrupti. pipeline_stage_id: Fugit perspiciatis nostrum. status: rejected workspace_id: Consectetur perferendis ipsa fugiat distinctio. responses: '200': description: OK response. content: application/json: schema: $ref: >- #/components/schemas/ApprovalsCreateApprovalResponseBodyCreation example: id: Molestiae laborum molestiae vero temporibus in accusantium. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/approvals/{id}: get: tags: - approvals summary: Show approval description: Retrieve a single approval operationId: approvals#show-approval parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: c minLength: 1 maxLength: 128 example: '0x3' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 6i2 minLength: 1 maxLength: 128 example: oau - name: id in: path required: true schema: type: string example: 0908a582-8625-4512-bf0d-45bdf2e112d0 format: uuid example: 98fcd82e-9918-45be-b790-17eb77a06c16 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: s minLength: 1 maxLength: 128 example: ao responses: '200': description: OK response. content: application/json: schema: $ref: >- #/components/schemas/ApprovalsShowApprovalResponseBodyStatusInfo example: actioned_by: John Doe actioned_by_email: john.doe@example.com created: 5637120847478505000 status: Omnis vitae voluptas necessitatibus cum aliquam. updated: 301395675069357600 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - approvals summary: Update approval description: Update a single approval operationId: approvals#update-approval parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: amc minLength: 1 maxLength: 128 example: n1z - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: vm1 minLength: 1 maxLength: 128 example: '85' - name: id in: path required: true schema: type: string example: d58acd58-54f0-4e21-ba42-d8cace73ae8e format: uuid example: 9695d48e-df8e-4230-aad5-eb17f3a053c3 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: epo minLength: 1 maxLength: 128 example: 6is requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateApprovalRequest' example: actioned_by: John Doe actioned_by_email: john.doe@example.com status: approved responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/costs: get: tags: - costs summary: List costs description: List the monthly cost per each workspace operationId: costs#list-costs parameters: - name: start_time in: query description: Specify the start time for the query allowEmptyValue: true schema: type: integer description: Specify the start time for the query example: 1691150743950 format: int64 example: 1691150743950 - name: end_time in: query description: Specify the end time limit for the query allowEmptyValue: true schema: type: integer description: Specify the end time limit for the query example: 1691150743950 format: int64 example: 1691150743950 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: workspaces in: query description: Filter the workspaces to retrieve the cost allowEmptyValue: true schema: type: array items: type: string example: Eos corporis rerum. description: Filter the workspaces to retrieve the cost example: - Quia ut dolor qui. - Consequatur hic ad distinctio quia consequatur voluptatem. - Eveniet ducimus repellendus similique nesciunt facilis. example: - Quas magni aut aut ad occaecati. - Sunt dolorum neque. - Autem illo. - Minus in nihil reprehenderit consectetur corrupti consequatur. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 6y minLength: 1 maxLength: 128 example: t - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: z4 minLength: 1 maxLength: 128 example: ob - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: kwy minLength: 1 maxLength: 128 example: 8f responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListCostsResponse' example: pageSize: 50 totalItems: 1800 totalPages: 36 workspaces: - cost: '12.13' created: 1672531200 currency: USD workspace_id: Unde qui ab rerum. workspace_name: Aperiam sapiente hic. - cost: '12.13' created: 1672531200 currency: USD workspace_id: Unde qui ab rerum. workspace_name: Aperiam sapiente hic. - cost: '12.13' created: 1672531200 currency: USD workspace_id: Unde qui ab rerum. workspace_name: Aperiam sapiente hic. - cost: '12.13' created: 1672531200 currency: USD workspace_id: Unde qui ab rerum. workspace_name: Aperiam sapiente hic. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/costs/{workspace}: get: tags: - costs summary: List costs per workspace description: List the cost of the workspace and correlate it with the executions operationId: costs#list-costs-per-workspace parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: start_time in: query description: Specify the start time for the query allowEmptyValue: true schema: type: integer description: Specify the start time for the query example: 1691150743950 format: int64 example: 1691150743950 - name: end_time in: query description: Specify the end time limit for the query allowEmptyValue: true schema: type: integer description: Specify the end time limit for the query example: 1691150743950 format: int64 example: 1691150743950 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: gi minLength: 1 maxLength: 128 example: ix - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: u minLength: 1 maxLength: 128 example: f7b - name: workspace in: path description: >- Workspace id to retrieve the cost and the metadata associated with it required: true schema: type: string description: >- Workspace id to retrieve the cost and the metadata associated with it example: Et et et. example: Totam dolor sit. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: c minLength: 1 maxLength: 128 example: '201' responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/CostResourceCollection' example: - account: dl activity_type: apply cost: '12.13' created: 1672531200 currency: USD org: id5 pipeline: Similique consequatur veritatis id nam. pipeline_execution_id: Debitis eos dolorem voluptatibus. pipeline_stage_id: Omnis nesciunt fuga dolores est. project: 1c workspace: Asperiores dolorem qui laborum est. - account: dl activity_type: apply cost: '12.13' created: 1672531200 currency: USD org: id5 pipeline: Similique consequatur veritatis id nam. pipeline_execution_id: Debitis eos dolorem voluptatibus. pipeline_stage_id: Omnis nesciunt fuga dolores est. project: 1c workspace: Asperiores dolorem qui laborum est. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions: get: tags: - executions summary: List executions description: List all executions. operationId: executions#list-executions parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: workspace in: query description: Workspace identifier allowEmptyValue: true schema: type: string description: Workspace identifier example: Accusamus maiores impedit repellat blanditiis cupiditate. example: Pariatur deleniti quisquam vero quis laborum. - name: pipeline_execution_id in: query description: Pipeline identifier allowEmptyValue: true schema: type: string description: Pipeline identifier example: Qui iste ut sint. example: Dolores corporis qui eos ex unde sit. - name: status in: query description: Status of the execution allowEmptyValue: true schema: type: array items: type: string example: Est animi. description: Status of the execution example: - Quis placeat enim corporis. - Repellat ut. - Officiis accusamus voluptas praesentium nihil. - Ut eaque molestias consequatur unde. example: - Id ipsam facilis a quis. - Molestias sit sint. - Commodi nostrum quo. - Laudantium sit assumenda sed nulla. - name: pipeline_name in: query description: Pipeline name allowEmptyValue: true schema: type: string description: Pipeline name example: Aliquid omnis enim voluptatem est. example: Quo magni dignissimos accusantium quidem voluptatem. - name: start_time in: query description: Specify the start time for the query allowEmptyValue: true schema: type: integer description: Specify the start time for the query example: 1691150743950 format: int64 example: 1691150743950 - name: end_time in: query description: Specify the end time limit for the query allowEmptyValue: true schema: type: integer description: Specify the end time limit for the query example: 1691150743950 format: int64 example: 1691150743950 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 5m3 minLength: 1 maxLength: 128 example: g - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: jzr minLength: 1 maxLength: 128 example: wsr - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 54f minLength: 1 maxLength: 128 example: snr responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ExecutionResourceCollection' example: - account: '0' created: 7825736693665040000 org: ij pipeline: Ut necessitatibus placeat. pipeline_execution_id: Est nam occaecati distinctio eligendi. pipeline_stage_id: Qui quis dolor magnam. project: fmt status: failure workspace: Rerum culpa voluptates voluptatem. - account: '0' created: 7825736693665040000 org: ij pipeline: Ut necessitatibus placeat. pipeline_execution_id: Est nam occaecati distinctio eligendi. pipeline_stage_id: Qui quis dolor magnam. project: fmt status: failure workspace: Rerum culpa voluptates voluptatem. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - executions summary: Create execution description: Create a new execution. operationId: executions#create-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: b minLength: 1 maxLength: 128 example: 9sx - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 7u4 minLength: 1 maxLength: 128 example: d - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 4fo minLength: 1 maxLength: 128 example: f requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateExecutionRequest' example: pipeline: Sequi illum. pipeline_execution_id: Blanditiis quo qui. pipeline_stage_id: Eum et debitis sint ducimus. workspace: Expedita eum. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateExecutionResponse' example: account: w2 created: 481289297168361660 org: b pipeline: Ea voluptas minima pariatur laudantium. pipeline_execution_id: Ducimus ipsum dignissimos corporis ut delectus aut. pipeline_stage_id: Maiores excepturi facilis reprehenderit cupiditate dicta. project: 5n status: none workspace: Architecto quis enim numquam pariatur. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}: get: tags: - executions summary: Show execution description: Show an individual execution. operationId: executions#show-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: rv0 minLength: 1 maxLength: 128 example: dgo - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: zl2 minLength: 1 maxLength: 128 example: q - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: oda minLength: 1 maxLength: 128 example: e4 - name: pipeline_stage_id in: path description: Pipeline execution stage ID required: true schema: type: string description: Pipeline execution stage ID example: u minLength: 1 maxLength: 128 example: 9u - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: i responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowExecutionResponse' example: account: '3' created: 1676536529633814000 org: v pipeline: Placeat provident. pipeline_execution_id: Et magni architecto quia ut ratione earum. pipeline_stage_id: Sed quam quisquam enim. project: 4r status: success workspace: Similique non eos dolorem sit. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}/audit-event: post: tags: - executions summary: Update execution description: Modify an individual execution by adding audit data. operationId: executions#modify-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: c minLength: 1 maxLength: 128 example: iq - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: e4 minLength: 1 maxLength: 128 example: cw - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: u8 minLength: 1 maxLength: 128 example: d - name: pipeline_stage_id in: path description: Pipeline execution stage ID required: true schema: type: string description: Pipeline execution stage ID example: giq minLength: 1 maxLength: 128 example: cfx - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: uxp minLength: 1 maxLength: 128 example: g requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateExecutionRequest' example: audit: git_audit_data: hash: 90k name: Adipisci temporibus consequuntur magnam rerum. repo_url: b type: branch, tag responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes: get: tags: - executions summary: List cost changes description: >- List cost changes from the latest plan and last applied state for the current execution. operationId: executions#list-cost-changes parameters: - name: pipeline_stage_id in: query allowEmptyValue: true schema: type: string default: '' example: Vitae officiis. example: Molestiae recusandae dolores architecto. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: za minLength: 1 maxLength: 128 example: e - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: z minLength: 1 maxLength: 128 example: tsm - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: jfy minLength: 1 maxLength: 128 example: t2a - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: b minLength: 1 maxLength: 128 example: re2 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListCostChangesResponse' example: currency: Tenetur expedita sed eos voluptatibus doloremque perferendis. diff: Laborum voluptas architecto eum voluptatum.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Quia repudiandae modi rerum aspernatur.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. diff_total_monthly_cost: Repellat quia numquam nihil dolor sequi praesentium. past_total_monthly_cost: Ea deserunt adipisci et quod officiis. percentage_change_total_monthly_cost: 7075636458171253000 stage_execution_id: In ut nulla aut et vero. stage_id: Pariatur maxime omnis qui. total_monthly_cost: Sit et eligendi et. workspace_id: Facilis amet sint natus sint. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages: get: tags: - executions summary: List cost changes for all stages description: >- List cost changes for all stages from the latest plan and last applied state for the current execution. operationId: executions#list-cost-changes-all-stages parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: j2 minLength: 1 maxLength: 128 example: b - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 13j minLength: 1 maxLength: 128 example: ar - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: 0vp minLength: 1 maxLength: 128 example: wg - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ekh minLength: 1 maxLength: 128 example: 9o responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ChangedCostsCollection' example: - currency: Odio ea dolores perferendis eos esse ut. diff: Blanditiis et cum enim.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Nihil non autem quia aut fugit eos.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Vel nam et.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. diff_total_monthly_cost: Aut autem. past_total_monthly_cost: Excepturi maiores temporibus id vel consequatur aut. percentage_change_total_monthly_cost: 4877408993750340000 stage_execution_id: Accusantium et iste. stage_id: Corrupti reiciendis. total_monthly_cost: Qui est quas aut quibusdam sapiente sapiente. workspace_id: Culpa dolorum aut iusto alias id. - currency: Odio ea dolores perferendis eos esse ut. diff: Blanditiis et cum enim.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Nihil non autem quia aut fugit eos.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Vel nam et.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. diff_total_monthly_cost: Aut autem. past_total_monthly_cost: Excepturi maiores temporibus id vel consequatur aut. percentage_change_total_monthly_cost: 4877408993750340000 stage_execution_id: Accusantium et iste. stage_id: Corrupti reiciendis. total_monthly_cost: Qui est quas aut quibusdam sapiente sapiente. workspace_id: Culpa dolorum aut iusto alias id. - currency: Odio ea dolores perferendis eos esse ut. diff: Blanditiis et cum enim.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Nihil non autem quia aut fugit eos.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Vel nam et.: current_monthly_cost: Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. diff_total_monthly_cost: Aut autem. past_total_monthly_cost: Excepturi maiores temporibus id vel consequatur aut. percentage_change_total_monthly_cost: 4877408993750340000 stage_execution_id: Accusantium et iste. stage_id: Corrupti reiciendis. total_monthly_cost: Qui est quas aut quibusdam sapiente sapiente. workspace_id: Culpa dolorum aut iusto alias id. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages-by-modules: get: tags: - executions summary: List cost changes for all stages by modules description: >- List cost changes per module (stack path) for all stages for the current execution. operationId: executions#list-cost-changes-all-stages-by-modules parameters: - name: stack_path in: query description: Optional module stack path filter allowEmptyValue: true schema: type: string description: Optional module stack path filter default: '' example: Dolor quis. example: Velit iste molestias aut eveniet. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: wfa minLength: 1 maxLength: 128 example: jg - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 3f minLength: 1 maxLength: 128 example: t - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: k minLength: 1 maxLength: 128 example: o - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: b minLength: 1 maxLength: 128 example: gy responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ChangedCostsByModuleResourceCollection' example: - modules: Qui odit perspiciatis et sunt et.: currency: Odio ea dolores perferendis eos esse ut. diff: Blanditiis et cum enim.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Nihil non autem quia aut fugit eos.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Vel nam et.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. diff_total_monthly_cost: Aut autem. past_total_monthly_cost: Excepturi maiores temporibus id vel consequatur aut. percentage_change_total_monthly_cost: 4877408993750340000 stage_execution_id: Accusantium et iste. stage_id: Corrupti reiciendis. total_monthly_cost: Qui est quas aut quibusdam sapiente sapiente. workspace_id: Culpa dolorum aut iusto alias id. stage_execution_id: Quae non facere fuga. stage_id: Sunt ut eveniet dolor voluptas. workspace_id: Quibusdam soluta voluptatem earum quia libero. - modules: Qui odit perspiciatis et sunt et.: currency: Odio ea dolores perferendis eos esse ut. diff: Blanditiis et cum enim.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Nihil non autem quia aut fugit eos.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Vel nam et.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. diff_total_monthly_cost: Aut autem. past_total_monthly_cost: Excepturi maiores temporibus id vel consequatur aut. percentage_change_total_monthly_cost: 4877408993750340000 stage_execution_id: Accusantium et iste. stage_id: Corrupti reiciendis. total_monthly_cost: Qui est quas aut quibusdam sapiente sapiente. workspace_id: Culpa dolorum aut iusto alias id. stage_execution_id: Quae non facere fuga. stage_id: Sunt ut eveniet dolor voluptas. workspace_id: Quibusdam soluta voluptatem earum quia libero. - modules: Qui odit perspiciatis et sunt et.: currency: Odio ea dolores perferendis eos esse ut. diff: Blanditiis et cum enim.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Nihil non autem quia aut fugit eos.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. Vel nam et.: current_monthly_cost: >- Officiis praesentium et distinctio magni voluptas magni. diff: - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. - current_monthly_cost: >- Debitis reiciendis et consectetur distinctio sequi. diff_monthly_cost: >- Doloremque dolores ullam dolores corporis quia non. name: Atque omnis ut voluptatem qui commodi eos. percentage_change_monthly_cost: 7757122607419809000 previous_monthly_cost: Dignissimos perspiciatis et asperiores et eos. subresources: Dignissimos et facere.: current_monthly_cost: >- Ipsum ipsum harum occaecati laborum vel placeat. diff_monthly_cost: Vero qui id ut iure. percentage_change_monthly_cost: 6337052443379880000 previous_monthly_cost: Ipsum earum corrupti. diff_monthly_cost: Qui repudiandae maiores. percentage_change_monthly_cost: 1842691425972299300 previous_monthly_cost: Nihil at vitae reprehenderit dolorem. diff_total_monthly_cost: Aut autem. past_total_monthly_cost: Excepturi maiores temporibus id vel consequatur aut. percentage_change_total_monthly_cost: 4877408993750340000 stage_execution_id: Accusantium et iste. stage_id: Corrupti reiciendis. total_monthly_cost: Qui est quas aut quibusdam sapiente sapiente. workspace_id: Culpa dolorum aut iusto alias id. stage_execution_id: Quae non facere fuga. stage_id: Sunt ut eveniet dolor voluptas. workspace_id: Quibusdam soluta voluptatem earum quia libero. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/dependency-graph: get: tags: - executions summary: Get dependency graph description: Get dependency graph for an execution operationId: executions#get-dependency-graph parameters: - name: pipeline_stage_id in: query allowEmptyValue: true schema: type: string default: '' example: Ut quia non incidunt quia maiores voluptatum. example: Voluptas laborum itaque sed minus quod magnam. - name: path_id in: query description: Terragrunt path identifier for filtering module-specific graph allowEmptyValue: true schema: type: string description: Terragrunt path identifier for filtering module-specific graph example: dev example: dev - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 47j minLength: 1 maxLength: 128 example: ar - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: u minLength: 1 maxLength: 128 example: d - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: p minLength: 1 maxLength: 128 example: c - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: pnq minLength: 1 maxLength: 128 example: t1 responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes: get: tags: - executions summary: List resource changes description: List resource changes from the latest plan and state for this execution. operationId: executions#list-resource-changes parameters: - name: exclude_state in: query description: When true, exclude values from the state in the response allowEmptyValue: true schema: type: boolean description: When true, exclude values from the state in the response default: false example: true example: true - name: pipeline_stage_id in: query allowEmptyValue: true schema: type: string default: '' example: Ad sed soluta libero repudiandae. example: Ducimus tenetur ipsa. - name: path_id in: query description: Terragrunt path identifier for filtering module-specific resources allowEmptyValue: true schema: type: string description: Terragrunt path identifier for filtering module-specific resources example: dev example: dev - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: de minLength: 1 maxLength: 128 example: hg - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ug minLength: 1 maxLength: 128 example: t1 - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: qp8 minLength: 1 maxLength: 128 example: ya - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 7e minLength: 1 maxLength: 128 example: xyo responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListResourceChangesResponse' example: data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket drift_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket has_dependency_graph: false outputs: - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 pipeline_execution: Natus eligendi sint minima ratione quisquam non. pipeline_stage: Ut velit voluptatem quos enim ut quo. planned_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket risk_assessment: overall_risk_summary: overall_level: HIGH overall_score: 7 reason: >- Driven by highest-risk resource: aws_s3_bucket_public_access_block.secure (score: 8) resource_risks: Dolores temporibus velit qui asperiores nostrum est.: risk_factors: - Cum mollitia aut ipsum consequuntur. - Et aut odit cumque. - Odit doloribus porro voluptas dolores maiores. risk_level: HIGH risk_mitigation: - Quis nihil voluptates ipsa. - Earum in beatae corrupti laudantium optio. - Quasi officiis nisi ratione quibusdam. - Facilis harum sit est unde nihil. risk_score: 2 stage_id: Quisquam animi non reiciendis sit deserunt. workspace_id: Rerum iste qui qui commodi. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes-all-stages: get: tags: - executions summary: List resource changes for all stages description: >- List resource changes for all stages from the latest plan and state for this execution. operationId: executions#list-resource-changes-all-stages parameters: - name: exclude_state in: query description: When true, exclude values from the state in the response allowEmptyValue: true schema: type: boolean description: When true, exclude values from the state in the response default: false example: true example: false - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: h minLength: 1 maxLength: 128 example: k - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 4p minLength: 1 maxLength: 128 example: m - name: pipeline_execution_id in: path description: Pipeline execution ID required: true schema: type: string description: Pipeline execution ID example: u2 minLength: 1 maxLength: 128 example: v1 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ps minLength: 1 maxLength: 128 example: oan responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ChangedResourcesCollection' example: - data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket drift_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket has_dependency_graph: true outputs: - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 pipeline_execution: Repellat sunt soluta. pipeline_stage: Ab suscipit fugit numquam asperiores itaque. planned_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket risk_assessment: overall_risk_summary: overall_level: HIGH overall_score: 7 reason: >- Driven by highest-risk resource: aws_s3_bucket_public_access_block.secure (score: 8) resource_risks: Natus labore accusantium repudiandae sint ut voluptas.: risk_factors: - Nostrum cupiditate vel adipisci cum omnis. - Fugit qui. - >- Sapiente aperiam aut inventore nesciunt non repudiandae. risk_level: MEDIUM risk_mitigation: - Repellat eum suscipit cupiditate ea. - Est explicabo voluptate recusandae. risk_score: 3 stage_id: Magni labore eum reiciendis et esse debitis. workspace_id: Assumenda nihil quos. - data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket drift_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket has_dependency_graph: true outputs: - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 pipeline_execution: Repellat sunt soluta. pipeline_stage: Ab suscipit fugit numquam asperiores itaque. planned_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket risk_assessment: overall_risk_summary: overall_level: HIGH overall_score: 7 reason: >- Driven by highest-risk resource: aws_s3_bucket_public_access_block.secure (score: 8) resource_risks: Natus labore accusantium repudiandae sint ut voluptas.: risk_factors: - Nostrum cupiditate vel adipisci cum omnis. - Fugit qui. - >- Sapiente aperiam aut inventore nesciunt non repudiandae. risk_level: MEDIUM risk_mitigation: - Repellat eum suscipit cupiditate ea. - Est explicabo voluptate recusandae. risk_score: 3 stage_id: Magni labore eum reiciendis et esse debitis. workspace_id: Assumenda nihil quos. - data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket drift_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket has_dependency_graph: true outputs: - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 pipeline_execution: Repellat sunt soluta. pipeline_stage: Ab suscipit fugit numquam asperiores itaque. planned_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket risk_assessment: overall_risk_summary: overall_level: HIGH overall_score: 7 reason: >- Driven by highest-risk resource: aws_s3_bucket_public_access_block.secure (score: 8) resource_risks: Natus labore accusantium repudiandae sint ut voluptas.: risk_factors: - Nostrum cupiditate vel adipisci cum omnis. - Fugit qui. - >- Sapiente aperiam aut inventore nesciunt non repudiandae. risk_level: MEDIUM risk_mitigation: - Repellat eum suscipit cupiditate ea. - Est explicabo voluptate recusandae. risk_score: 3 stage_id: Magni labore eum reiciendis et esse debitis. workspace_id: Assumenda nihil quos. - data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket drift_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket has_dependency_graph: true outputs: - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 - change: added expression: <+outputs.instance_id> name: instance_public_ip new: new value old: old value sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 pipeline_execution: Repellat sunt soluta. pipeline_stage: Ab suscipit fugit numquam asperiores itaque. planned_changes: - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket - change: added change_count: 10 changes: Molestias qui odio qui placeat.: change: added drift: false new: new value old: old value sensitive: true drift: false module: full_stack name: app_server provider: AWS type: S3 Bucket resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket risk_assessment: overall_risk_summary: overall_level: HIGH overall_score: 7 reason: >- Driven by highest-risk resource: aws_s3_bucket_public_access_block.secure (score: 8) resource_risks: Natus labore accusantium repudiandae sint ut voluptas.: risk_factors: - Nostrum cupiditate vel adipisci cum omnis. - Fugit qui. - >- Sapiente aperiam aut inventore nesciunt non repudiandae. risk_level: MEDIUM risk_mitigation: - Repellat eum suscipit cupiditate ea. - Est explicabo voluptate recusandae. risk_score: 3 stage_id: Magni labore eum reiciendis et esse debitis. workspace_id: Assumenda nihil quos. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/remediation/config: delete: tags: - remediation-agent summary: Disable project remediation description: Disable project-level AI remediation operationId: remediation-agent#disable-project-remediation parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: v minLength: 1 maxLength: 128 example: p - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: d2z minLength: 1 maxLength: 128 example: 6ai - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: hte minLength: 1 maxLength: 128 example: sx responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - remediation-agent summary: Get project remediation config description: Check whether project-level AI remediation is enabled operationId: remediation-agent#get-project-remediation-config parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: s minLength: 1 maxLength: 128 example: hn - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ld minLength: 1 maxLength: 128 example: a43 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: o minLength: 1 maxLength: 128 example: oxj responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetProjectRemediationConfigResponse' example: enabled: true pipeline_id: At tempore. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - remediation-agent summary: Enable project remediation description: >- Enable AI remediation for all workspaces in the project, optionally attaching or replacing a remediation pipeline operationId: remediation-agent#enable-project-remediation parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 4ip minLength: 1 maxLength: 128 example: lf - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: lbq minLength: 1 maxLength: 128 example: 2h - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '5' minLength: 1 maxLength: 128 example: gc requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableProjectRemediationRequest' example: pipeline_id: Vel est commodi ut qui inventore. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/settings/default-pipelines: delete: tags: - settings summary: Delete default pipeline description: >- Delete the association between a default pipeline and a provisioner operation operationId: settings#delete-default-pipeline parameters: - name: org in: path required: true schema: type: string example: Eius nesciunt. example: Ut rerum aut aut eveniet occaecati nostrum. - name: project in: path required: true schema: type: string example: Voluptatem qui itaque quia. example: Magnam autem sit culpa fugiat. - name: Harness-Account in: header allowEmptyValue: true required: true schema: type: string example: Aut quia vitae est quo temporibus. example: At sit facilis qui ut ipsa. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteDefaultPipelineRequest' example: operation: plan provisioner: opentofu workspace: plan responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - settings summary: List default pipelines description: >- List all associations between provisioner operations and default pipelines operationId: settings#list-default-pipelines parameters: - name: workspace in: query description: Workspace identifier allowEmptyValue: true schema: type: string description: Workspace identifier default: '' example: workspace123 example: workspace123 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: vy minLength: 1 maxLength: 128 example: 4p2 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: t7 minLength: 1 maxLength: 128 example: t - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 89e minLength: 1 maxLength: 128 example: zz5 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DefaultPipelineCollection' example: - account: Sint vitae molestiae voluptatem ad. operation: plan org: Ducimus et quam. pipeline: testpipeline project: Maiores fugit. provisioner: opentofu updated: 1636669297674 workspace: plan - account: Sint vitae molestiae voluptatem ad. operation: plan org: Ducimus et quam. pipeline: testpipeline project: Maiores fugit. provisioner: opentofu updated: 1636669297674 workspace: plan - account: Sint vitae molestiae voluptatem ad. operation: plan org: Ducimus et quam. pipeline: testpipeline project: Maiores fugit. provisioner: opentofu updated: 1636669297674 workspace: plan '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - settings summary: Upsert default pipeline description: Associate a default pipeline with a provisioner operation operationId: settings#upsert-default-pipeline parameters: - name: org in: path required: true schema: type: string example: Aliquam blanditiis ut. example: Fugit deleniti consequatur facere non. - name: project in: path required: true schema: type: string example: Laborum exercitationem aut atque dolores in ut. example: Quidem asperiores veniam. - name: Harness-Account in: header allowEmptyValue: true required: true schema: type: string example: Voluptatibus voluptatem ipsa laboriosam. example: Ut optio corrupti quae. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertDefaultPipelineRequest' example: operation: plan pipeline: testpipeline provisioner: opentofu updated: 1636669297674 workspace: plan responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/settings/disabled: get: tags: - settings summary: Check push data description: Check if the plan/state should be sent to the server operationId: settings#check-push-data parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: k minLength: 1 maxLength: 128 example: les - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 13h minLength: 1 maxLength: 128 example: '8' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v7 minLength: 1 maxLength: 128 example: e responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CheckPushDataResponse' example: disabled: false '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/settings/drift-config: delete: tags: - settings summary: Disable drift automation for all workspaces in a project description: >- Enqueues a background job that removes drift triggers for every workspace in the project. operationId: settings#disable-project-drift parameters: - name: provisioner in: query description: Provisioner type to disable drift for allowEmptyValue: true required: true schema: type: string description: Provisioner type to disable drift for example: terragrunt enum: - terraform - opentofu - terragrunt - awscdk example: terraform - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 8qf minLength: 1 maxLength: 128 example: r - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: r0s minLength: 1 maxLength: 128 example: '9' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: sz responses: '202': description: Accepted response. content: application/json: schema: $ref: '#/components/schemas/DisableProjectDriftResponse' example: job_id: 1784745457245046800 status: Sed ut quis accusantium aspernatur rerum dicta. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - settings summary: Get project-level drift automation status for a provisioner description: >- Returns whether drift automation is currently enabled at the project level for the given provisioner, along with its pipeline_id and schedule. operationId: settings#get-project-drift parameters: - name: provisioner in: query description: Provisioner type to query drift status for allowEmptyValue: true required: true schema: type: string description: Provisioner type to query drift status for example: opentofu enum: - terraform - opentofu - terragrunt - awscdk example: terraform - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: g minLength: 1 maxLength: 128 example: w6 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 6h minLength: 1 maxLength: 128 example: 3w - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: rva minLength: 1 maxLength: 128 example: s responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetProjectDriftResponse' example: enabled: false pipeline_id: Nulla dolore corporis. provisioner: Iste sit quibusdam doloremque ipsa qui. run_every: 119490300577806300 run_every_unit: hours '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - settings summary: Enable drift automation for all workspaces in a project description: >- Enqueues a background job that creates drift triggers for every workspace in the project. operationId: settings#enable-project-drift parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: qn minLength: 1 maxLength: 128 example: bq - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: op minLength: 1 maxLength: 128 example: 6y - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: a minLength: 1 maxLength: 128 example: wmi requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableProjectDriftRequest' example: pipeline_id: Esse corrupti beatae exercitationem recusandae aspernatur. provisioner: terragrunt run_every: 390544456384722700 run_every_unit: minutes responses: '202': description: Accepted response. content: application/json: schema: $ref: '#/components/schemas/EnableProjectDriftResponse' example: job_id: 3619947106265864000 status: Molestias modi nobis. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/settings/ephemeral-config: delete: tags: - settings summary: Disable ephemeral TTL for all workspaces in a project description: >- Enqueues a background job that removes ephemeral schedules for every workspace in the project. operationId: settings#disable-ephemeral-workspaces-in-project parameters: - name: provisioner in: query description: Provisioner type to disable ephemeral for allowEmptyValue: true required: true schema: type: string description: Provisioner type to disable ephemeral for example: awscdk enum: - terraform - opentofu - terragrunt - awscdk example: opentofu - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: wrf minLength: 1 maxLength: 128 example: aj - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: i minLength: 1 maxLength: 128 example: a3l - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: wt minLength: 1 maxLength: 128 example: x6s responses: '202': description: Accepted response. content: application/json: schema: $ref: >- #/components/schemas/DisableEphemeralWorkspacesInProjectResponse example: job_id: 7889353967923743000 status: Ipsa nesciunt dolor quod. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - settings summary: Get project-level ephemeral configuration for a provisioner description: >- Returns whether ephemeral automation is currently enabled at the project level for the given provisioner, along with its raw schedule fields (ttl, destroy_on_date, delete_*) so the UI can re-render previously saved values. operationId: settings#get-ephemeral-workspaces-in-project parameters: - name: provisioner in: query description: Provisioner type to query ephemeral status for allowEmptyValue: true required: true schema: type: string description: Provisioner type to query ephemeral status for example: terragrunt enum: - terraform - opentofu - terragrunt - awscdk example: opentofu - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: y6y minLength: 1 maxLength: 128 example: r - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ay minLength: 1 maxLength: 128 example: '1' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: mxw minLength: 1 maxLength: 128 example: 56y responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetEphemeralWorkspacesInProjectResponse' example: delete_delay_unit: minutes delete_delay_value: 4788931909215015000 delete_on_date: Qui et quia. delete_workspace: false destroy_on_date: Labore reiciendis harum minima laboriosam velit. enabled: true pipeline_id: Harum consequuntur. provisioner: Natus ut cupiditate aut quia facere voluptas. ttl_unit: seconds ttl_value: 1163343200896130600 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - settings summary: Enable ephemeral TTL for all workspaces in a project description: >- Enqueues a background job that configures ephemeral destroy/delete schedules for every workspace in the project. operationId: settings#enable-ephemeral-workspaces-in-project parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: h minLength: 1 maxLength: 128 example: nwe - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '7' minLength: 1 maxLength: 128 example: seh - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 14y minLength: 1 maxLength: 128 example: s requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableEphemeralWorkspacesInProjectRequest' example: delete_delay_unit: hours delete_delay_value: 2666456894812327400 delete_on_date: Iste dolor sint modi. delete_workspace: false destroy_delay_unit: days destroy_delay_value: 8247386288086625000 destroy_on_date: Quia voluptas maxime aut nesciunt ea aliquam. pipeline_id: Labore atque necessitatibus. provisioner: awscdk responses: '202': description: Accepted response. content: application/json: schema: $ref: >- #/components/schemas/EnableEphemeralWorkspacesInProjectResponse example: job_id: 505502153795094100 status: Aliquam quia rerum enim voluptatum ea. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/tags: get: tags: - workspaces summary: List all workspace tags description: List all tags operationId: workspaces#list-all-workspace-tags parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '1' minLength: 1 maxLength: 128 example: '83' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: lc minLength: 1 maxLength: 128 example: gt - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '1' minLength: 1 maxLength: 128 example: lf6 responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Sint et voluptatibus voluptatem magnam. example: - Quo placeat vero vel. - Adipisci harum. - Fuga corrupti omnis. example: - Aperiam hic sit et culpa in. - Debitis et. - Aut quas rem nihil qui labore molestiae. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/unified-executions: post: tags: - unified-executions summary: Create unified execution description: Create a new unified execution. operationId: unified-executions#create-unified-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: wke minLength: 1 maxLength: 128 example: 8y - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '5' minLength: 1 maxLength: 128 example: 'y' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 'y' minLength: 1 maxLength: 128 example: 4v requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnifiedExecutionRequest2' example: inventories: - Sed corrupti nam expedita praesentium. - Alias quas. - Natus ut minus voluptates dolores rerum iure. - Aliquam exercitationem soluta deleniti asperiores. module_test: Cumque tempora. pipeline_execution_id: Quasi recusandae quaerat aut amet. pipeline_id: Sit atque amet ut sit. pipeline_stage_id: Sint asperiores qui id. playbooks: - Sit et possimus. - Quas commodi odio possimus iusto est. - Ut rerum provident ipsum consequatur recusandae. - Explicabo in est distinctio quis dignissimos. remote_execution_id: Est quod facere. skip_adding_to_db: true webhook: connector: Est laboriosam beatae. link: Sunt commodi placeat veritatis est. repo: Officia adipisci consequuntur et. type: merged workspace: Est eum aliquid ratione. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UnifiedExecutionResponse' example: env_variables: Dolor nesciunt consequatur dolorum.: Odio ut accusamus accusamus eveniet. Fuga et voluptatem sunt et.: Vel voluptates qui. Non dolorum officia ad.: Et et ut laboriosam omnis sunt aut. outputs: Harum harum sequi ut.: Eaque dolor nesciunt optio saepe sapiente porro. Qui quia laudantium non accusamus repellendus distinctio.: Et illum asperiores accusantium dolor. steps: - dynamic_fields: In laudantium.: Non quidem in itaque. id: Aut sit et aspernatur delectus ducimus alias. name: Doloribus iste esse qui dolores quibusdam. yaml: Sed et distinctio sapiente occaecati est. - dynamic_fields: In laudantium.: Non quidem in itaque. id: Aut sit et aspernatur delectus ducimus alias. name: Doloribus iste esse qui dolores quibusdam. yaml: Sed et distinctio sapiente occaecati est. - dynamic_fields: In laudantium.: Non quidem in itaque. id: Aut sit et aspernatur delectus ducimus alias. name: Doloribus iste esse qui dolores quibusdam. yaml: Sed et distinctio sapiente occaecati est. - dynamic_fields: In laudantium.: Non quidem in itaque. id: Aut sit et aspernatur delectus ducimus alias. name: Doloribus iste esse qui dolores quibusdam. yaml: Sed et distinctio sapiente occaecati est. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/variable-set: delete: tags: - variable_sets summary: Delete Variable Set by query identifier on project level description: >- Delete Variable Set on project level using identifier as a query parameter. Required when the identifier contains characters that are unsafe in URL paths (e.g. '/'). operationId: variable_sets#delete-variable-set-by-query-proj-level parameters: - name: identifier in: query description: Identifier is the VariableSet identifier. allowEmptyValue: true required: true schema: type: string description: Identifier is the VariableSet identifier. example: s0x minLength: 1 maxLength: 128 example: vb - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: e0 minLength: 1 maxLength: 128 example: mm - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: hc minLength: 1 maxLength: 128 example: 3y - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: b minLength: 1 maxLength: 128 example: 2b responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - variable_sets summary: Create a new Variable Set on project level description: Create a new Variable Set on project level. operationId: variable_sets#create-variable-set-proj-level parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '8' minLength: 1 maxLength: 128 example: wl - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: r minLength: 1 maxLength: 128 example: ndd - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: bce minLength: 1 maxLength: 128 example: q requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateVariableSetRequestProjScope' example: connectors: - connector_ref: bdw created: 1627590400 id: 8790588802215279000 type: gcp updated: 1627686800 - connector_ref: bdw created: 1627590400 id: 8790588802215279000 type: gcp updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. environment_variables: Sit at molestiae quod ut consequatur.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string Voluptatibus magni eos ut enim.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string id: 3350247895561842700 identifier: pq name: resource name terraform_variable_files: - created: 1627590400 id: 6849075209830916000 repository: Est nobis. repository_branch: main repository_commit: abc10ed repository_connector: Nam cupiditate. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 6849075209830916000 repository: Est nobis. repository_branch: main repository_commit: abc10ed repository_connector: Nam cupiditate. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 6849075209830916000 repository: Est nobis. repository_branch: main repository_commit: abc10ed repository_connector: Nam cupiditate. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 6849075209830916000 repository: Est nobis. repository_branch: main repository_commit: abc10ed repository_connector: Nam cupiditate. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Molestiae nesciunt vitae doloremque voluptas.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string Provident ab laudantium.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string updated: 1627686800 responses: '201': description: Created response. content: application/json: schema: $ref: >- #/components/schemas/VariableSetsCreateVariableSetAccountLevelResponseBody example: account: 8mb connectors: - connector_ref: g created: 1627590400 id: 3570993256144174600 type: azure updated: 1627686800 - connector_ref: g created: 1627590400 id: 3570993256144174600 type: azure updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. environment_variables: A id voluptas.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string identifier: o6 name: resource name org: '6' project: '76' terraform_variable_files: - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Id dolor aut aut labore doloribus sit.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string Tempora ut sint hic dolore.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string updated: 1627686800 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}: delete: tags: - variable_sets summary: Delete Variable Set by identifier on project level description: Delete Variable Set by identifier on project level. operationId: variable_sets#delete-variable-set-proj-level parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: od minLength: 1 maxLength: 128 example: pcw - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '9' minLength: 1 maxLength: 128 example: t - name: identifier in: path description: Identifier is the VariableSet identifier. required: true schema: type: string description: Identifier is the VariableSet identifier. example: r minLength: 1 maxLength: 128 example: jt - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: xbf minLength: 1 maxLength: 128 example: q responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - variable_sets summary: Get Variable Set by identifier on project level description: Get Variable Set by identifier on project level. operationId: variable_sets#get-variable-set-proj-level parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: xof minLength: 1 maxLength: 128 example: 1v - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: q minLength: 1 maxLength: 128 example: '1' - name: identifier in: path description: Identifier is the VariableSet identifier. required: true schema: type: string description: Identifier is the VariableSet identifier. example: '2e0' minLength: 1 maxLength: 128 example: q - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ek minLength: 1 maxLength: 128 example: v responses: '200': description: OK response. content: application/json: schema: $ref: >- #/components/schemas/VariableSetsGetVariableSetAccountLevelResponseBody example: account: u connectors: - connector_ref: g created: 1627590400 id: 3570993256144174600 type: azure updated: 1627686800 - connector_ref: g created: 1627590400 id: 3570993256144174600 type: azure updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. environment_variables: Aliquid iure ut alias maiores tempora est.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string identifier: 2mw name: resource name org: 3t project: t terraform_variable_files: - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Molestiae aut maxime ducimus quis.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string Qui sit libero et.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string updated: 1627686800 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - variable_sets summary: Update a Variable Set on project level description: Update a Variable Set on project level. operationId: variable_sets#update-variable-set-proj-level parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '2' minLength: 1 maxLength: 128 example: fur - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: zl0 minLength: 1 maxLength: 128 example: 5kh - name: identifier in: path description: Identifier is the VariableSet identifier. required: true schema: type: string description: Identifier is the VariableSet identifier. example: whm pattern: ^[^/?#\s]+$ minLength: 1 maxLength: 128 example: x - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 5z minLength: 1 maxLength: 128 example: km7 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateVariableSetRequestProjScope' example: connectors: - connector_ref: bdw created: 1627590400 id: 8790588802215279000 type: gcp updated: 1627686800 - connector_ref: bdw created: 1627590400 id: 8790588802215279000 type: gcp updated: 1627686800 - connector_ref: bdw created: 1627590400 id: 8790588802215279000 type: gcp updated: 1627686800 - connector_ref: bdw created: 1627590400 id: 8790588802215279000 type: gcp updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. environment_variables: Non sunt totam quos.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string Voluptate fugit quia repudiandae eius aut.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string id: 6600854647460047000 name: resource name terraform_variable_files: - created: 1627590400 id: 6849075209830916000 repository: Est nobis. repository_branch: main repository_commit: abc10ed repository_connector: Nam cupiditate. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 6849075209830916000 repository: Est nobis. repository_branch: main repository_commit: abc10ed repository_connector: Nam cupiditate. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Qui eaque dicta voluptatem.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string Sit doloremque non.: created: 1627590400 id: 5497824769661668000 key: d updated: 1627686800 value: In omnis asperiores assumenda et nulla. value_type: string updated: 1627686800 responses: '200': description: OK response. content: application/json: schema: $ref: >- #/components/schemas/VariableSetsCreateVariableSetAccountLevelResponseBody example: account: 8mb connectors: - connector_ref: g created: 1627590400 id: 3570993256144174600 type: azure updated: 1627686800 - connector_ref: g created: 1627590400 id: 3570993256144174600 type: azure updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. environment_variables: A id voluptas.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string identifier: o6 name: resource name org: '6' project: '76' terraform_variable_files: - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 2095405973143976000 repository: Eos voluptate non dolores expedita. repository_branch: main repository_commit: abc10ed repository_connector: Est et qui et aut quidem. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Id dolor aut aut labore doloribus sit.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string Tempora ut sint hic dolore.: created: 1627590400 id: 3052340623608331000 key: '0' updated: 1627686800 value: Saepe ad autem modi quasi libero harum. value_type: string updated: 1627686800 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}/references: get: tags: - variable_sets summary: Get Variable Set References list on project level description: Get Variable Set References list on project level. operationId: variable_sets#list-variable-set-references-proj-level parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: r1 minLength: 1 maxLength: 128 example: b - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 4q0 minLength: 1 maxLength: 128 example: r5 - name: identifier in: path description: Identifier is the VariableSet identifier. required: true schema: type: string description: Identifier is the VariableSet identifier. example: f minLength: 1 maxLength: 128 example: 0mu - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: r0j minLength: 1 maxLength: 128 example: h3i responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/HarnessIacmWorkspaceList' example: items: - account: u associated_template: template_id: un version: '4' backend_locked: true budget: 0.13164885 ccm_cost_enabled: true cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true created: 8462172761815003000 default_pipelines: Repellendus repudiandae distinctio sed saepe aliquid.: project_pipeline: >- Voluptatem explicabo quam consequatur consequatur repudiandae. workspace_pipeline: Ut porro quos. description: this is a more detailed explanation of the resource. environment_variables: A aut dolorum ipsum reprehenderit a iste.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string id: 1247872255421117700 identifier: nc lock: created_at: 1666185428605123300 id: Incidunt velit sed. locked_by_display_name: Tempore dolorem molestiae sapiente magnam. locked_by_principal_id: Ab corporis in molestiae quam. locked_by_principal_type: Aliquam quis. manual: true reason: Doloremque qui. modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name org: '3' project: f provider_connector: Voluptas quod nesciunt corporis ullam maxime. provider_connectors: - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Quibusdam qui perferendis qui. provisioner_configuration: Voluptas qui itaque est qui quibusdam ut. provisioner_data: Vel laborum voluptatum voluptas. provisioner_version: Quia voluptas quo asperiores. prune_sensitive_data: true repository: Distinctio pariatur. repository_branch: main repository_commit: abc10ed repository_connector: Qui magnam nemo voluptatum id ipsum est. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: true sparse_checkout: Et odit. state_checksum: >- d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f status: unknown tags: cost-center: engineering environment: production team: platform terraform_plan_json: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: - repository: Sit perferendis. repository_branch: main repository_commit: abc10ed repository_connector: Commodi quae quam voluptate ex eum. repository_path: '' repository_sha: abc10ed - repository: Sit perferendis. repository_branch: main repository_commit: abc10ed repository_connector: Commodi quae quam voluptate ex eum. repository_path: '' repository_sha: abc10ed - repository: Sit perferendis. repository_branch: main repository_commit: abc10ed repository_connector: Commodi quae quam voluptate ex eum. repository_path: '' repository_sha: abc10ed terraform_variables: Et sed dolor non.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string Necessitatibus numquam natus.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string Veritatis velit maiores explicabo quisquam fugit qui.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string terragrunt_provider: true terragrunt_version: Fugit voluptas molestiae. updated: 7587986511157125000 variable_sets: - A eveniet amet qui dolores dolorem. - Fuga nobis. - Vero omnis sunt dolore. - Ad eaque. - account: u associated_template: template_id: un version: '4' backend_locked: true budget: 0.13164885 ccm_cost_enabled: true cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true created: 8462172761815003000 default_pipelines: Repellendus repudiandae distinctio sed saepe aliquid.: project_pipeline: >- Voluptatem explicabo quam consequatur consequatur repudiandae. workspace_pipeline: Ut porro quos. description: this is a more detailed explanation of the resource. environment_variables: A aut dolorum ipsum reprehenderit a iste.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string id: 1247872255421117700 identifier: nc lock: created_at: 1666185428605123300 id: Incidunt velit sed. locked_by_display_name: Tempore dolorem molestiae sapiente magnam. locked_by_principal_id: Ab corporis in molestiae quam. locked_by_principal_type: Aliquam quis. manual: true reason: Doloremque qui. modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name org: '3' project: f provider_connector: Voluptas quod nesciunt corporis ullam maxime. provider_connectors: - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 - connector_ref: a created: 1627590400 id: 5534848325807077000 terragrunt_provider: false type: aws updated: 1627686800 workspace_id: 1785679687111850800 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Quibusdam qui perferendis qui. provisioner_configuration: Voluptas qui itaque est qui quibusdam ut. provisioner_data: Vel laborum voluptatum voluptas. provisioner_version: Quia voluptas quo asperiores. prune_sensitive_data: true repository: Distinctio pariatur. repository_branch: main repository_commit: abc10ed repository_connector: Qui magnam nemo voluptatum id ipsum est. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: true sparse_checkout: Et odit. state_checksum: >- d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f status: unknown tags: cost-center: engineering environment: production team: platform terraform_plan_json: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: - repository: Sit perferendis. repository_branch: main repository_commit: abc10ed repository_connector: Commodi quae quam voluptate ex eum. repository_path: '' repository_sha: abc10ed - repository: Sit perferendis. repository_branch: main repository_commit: abc10ed repository_connector: Commodi quae quam voluptate ex eum. repository_path: '' repository_sha: abc10ed - repository: Sit perferendis. repository_branch: main repository_commit: abc10ed repository_connector: Commodi quae quam voluptate ex eum. repository_path: '' repository_sha: abc10ed terraform_variables: Et sed dolor non.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string Necessitatibus numquam natus.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string Veritatis velit maiores explicabo quisquam fugit qui.: created: 3351986607864910300 key: '30' updated: 6738835912814902000 value: Omnis et velit voluptas. value_type: string terragrunt_provider: true terragrunt_version: Fugit voluptas molestiae. updated: 7587986511157125000 variable_sets: - A eveniet amet qui dolores dolorem. - Fuga nobis. - Vero omnis sunt dolore. - Ad eaque. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/variable-sets: get: tags: - variable_sets summary: Get Variable Set list on project level description: Get Variable Set list on project level. operationId: variable_sets#list-variable-sets-proj-level parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: c3h minLength: 1 maxLength: 128 example: 'y' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 3h minLength: 1 maxLength: 128 example: r - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '9' minLength: 1 maxLength: 128 example: 6bm responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/HarnessIacmVariableSetList' example: items: - account: ip connectors: - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. env_vars_count: 2528447298707913700 environment_variables: Autem optio rerum autem.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Et maiores consequatur cupiditate quia quas sint.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret In sint.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret id: 3202918072030779000 identifier: r name: resource name org: 7a project: g terraform_variable_files: - created: 1627590400 id: 1395276265876081000 repository: Beatae cum. repository_branch: main repository_commit: abc10ed repository_connector: Inventore ut totam autem eveniet et. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 1395276265876081000 repository: Beatae cum. repository_branch: main repository_commit: abc10ed repository_connector: Inventore ut totam autem eveniet et. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Qui molestiae quia expedita.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Qui occaecati incidunt est autem.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Quidem labore recusandae est.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret tf_vars_count: 1452611948348895500 updated: 1627686800 var_files_count: 575631548047009100 - account: ip connectors: - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. env_vars_count: 2528447298707913700 environment_variables: Autem optio rerum autem.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Et maiores consequatur cupiditate quia quas sint.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret In sint.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret id: 3202918072030779000 identifier: r name: resource name org: 7a project: g terraform_variable_files: - created: 1627590400 id: 1395276265876081000 repository: Beatae cum. repository_branch: main repository_commit: abc10ed repository_connector: Inventore ut totam autem eveniet et. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 1395276265876081000 repository: Beatae cum. repository_branch: main repository_commit: abc10ed repository_connector: Inventore ut totam autem eveniet et. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Qui molestiae quia expedita.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Qui occaecati incidunt est autem.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Quidem labore recusandae est.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret tf_vars_count: 1452611948348895500 updated: 1627686800 var_files_count: 575631548047009100 - account: ip connectors: - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 - connector_ref: 3q created: 1627590400 id: 6948993381784559000 type: azure updated: 1627686800 created: 1627590400 description: this is a more detailed explanation of the resource. env_vars_count: 2528447298707913700 environment_variables: Autem optio rerum autem.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Et maiores consequatur cupiditate quia quas sint.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret In sint.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret id: 3202918072030779000 identifier: r name: resource name org: 7a project: g terraform_variable_files: - created: 1627590400 id: 1395276265876081000 repository: Beatae cum. repository_branch: main repository_commit: abc10ed repository_connector: Inventore ut totam autem eveniet et. repository_path: '' repository_sha: abc10ed updated: 1627686800 - created: 1627590400 id: 1395276265876081000 repository: Beatae cum. repository_branch: main repository_commit: abc10ed repository_connector: Inventore ut totam autem eveniet et. repository_path: '' repository_sha: abc10ed updated: 1627686800 terraform_variables: Qui molestiae quia expedita.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Qui occaecati incidunt est autem.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret Quidem labore recusandae est.: created: 1627590400 id: 7472896661941035000 key: '36' updated: 1627686800 value: Ut magnam quis ducimus officiis possimus mollitia. value_type: secret tf_vars_count: 1452611948348895500 updated: 1627686800 var_files_count: 575631548047009100 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspace-metrics: get: tags: - workspaces summary: Show workspace metrics description: Show metrics for workspaces operationId: workspaces#show-workspace-metrics parameters: - name: start_time in: query description: Start time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: Start time filter (Unix timestamp) example: 3702652903170433000 format: int64 example: 2312895160738468400 - name: end_time in: query description: End time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: End time filter (Unix timestamp) example: 1175252005813441000 format: int64 example: 1453570943024446700 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: f89 minLength: 1 maxLength: 128 example: x - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '3' minLength: 1 maxLength: 128 example: s - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: kh minLength: 1 maxLength: 128 example: b responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowWorkspaceMetricsRequest' example: status_counts: Necessitatibus ut minima et aut.: 2399362582700301000 Perspiciatis unde ut consequatur.: 6747443222738879000 Sunt ut maxime rerum qui.: 7043253897266228000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspace/template/{workspace_id}/yaml-diff: get: tags: - workspace_templates summary: Retrieve workspace-template reconciliation diff description: >- Get the differences between the current workspace YAML and what it will look like when reconciled with the template operationId: workspace_templates#get-workspace-template-reconciliation-diff parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: f minLength: 1 maxLength: 128 example: c - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: d minLength: 1 maxLength: 128 example: m - name: workspace_id in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: e minLength: 1 maxLength: 128 example: 0fh - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 9t minLength: 1 maxLength: 128 example: 29s responses: '200': description: OK response. content: application/json: schema: $ref: >- #/components/schemas/GetWorkspaceTemplateReconciliationDiffResponse example: currentWorkspaceYaml: Id quibusdam mollitia qui. reconcilableWorkspaceYaml: Id ipsam delectus sit. requiresReconciliation: true '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspace/templates: post: tags: - workspace_templates summary: Create workspace template description: Add a workspace-template combination to the table. operationId: workspace_templates#add-workspace-template parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 7fl minLength: 1 maxLength: 128 example: tp - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: g2 minLength: 1 maxLength: 128 example: g - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: dv minLength: 1 maxLength: 128 example: qs requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceTemplateRequest' example: template_id: ah version: '64' workspace_id: l2u responses: '201': description: Created response. content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceTemplateResponse' example: account: kp4 created_at: 1627590400 org: nfz project: rt template_id: gk updated_at: 1627686800 version: l workspace_id: z '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}: get: tags: - workspace_templates summary: List workspaces by template id description: >- Get all workspaces associated with a specific template ID for a given scope. operationId: workspace_templates#get-workspaces-by-template-id parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: w5a minLength: 1 maxLength: 128 example: z - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: a minLength: 1 maxLength: 128 example: '7' - name: template_id in: path description: Template identifier to filter workspaces required: true schema: type: string description: Template identifier to filter workspaces example: kzp minLength: 1 maxLength: 128 example: x6u - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: un minLength: 1 maxLength: 128 example: f responses: '200': description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/HarnessIacmWorkspaceTemplate' description: List of workspaces associated with the template ID example: - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx example: - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}/{workspace_id}: delete: tags: - workspace_templates summary: Delete workspace template description: Remove the association between a template and a workspace. operationId: workspace_templates#remove-workspace-template parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 3w minLength: 1 maxLength: 128 example: w5 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: sf4 minLength: 1 maxLength: 128 example: ovs - name: template_id in: path description: Template identifier required: true schema: type: string description: Template identifier example: ik minLength: 1 maxLength: 128 example: ze - name: workspace_id in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: vh minLength: 1 maxLength: 128 example: klh - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: dfh minLength: 1 maxLength: 128 example: 5h responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - workspace_templates summary: Update workspace template description: Update a workspace template combo to change its version. operationId: workspace_templates#update-workspace-template parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: q minLength: 1 maxLength: 128 example: 'y' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: vtk minLength: 1 maxLength: 128 example: l0 - name: template_id in: path description: Template identifier required: true schema: type: string description: Template identifier example: jo minLength: 1 maxLength: 128 example: 3pd - name: workspace_id in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: 84d minLength: 1 maxLength: 128 example: '1' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: x minLength: 1 maxLength: 128 example: l requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceTemplateRequest' example: version: he responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceTemplateResponse' example: account: 14y created_at: 1627590400 org: 0l project: h5a template_id: 'n' updated_at: 1627686800 version: fx workspace_id: '8' '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces: get: tags: - workspaces summary: List workspaces description: List all workspaces. operationId: workspaces#list-workspaces parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: searchTerm in: query description: Filter results by partial name match allowEmptyValue: true schema: type: string description: Filter results by partial name match default: '' example: mysta example: mysta - name: sort in: query description: Sort order for results allowEmptyValue: true schema: type: string description: Sort order for results default: name,ASC example: name,DESC enum: - name,ASC - name,DESC - updated,ASC - updated,DESC example: name,DESC - name: status in: query description: Status of the execution allowEmptyValue: true schema: type: array items: type: string example: Qui perferendis facilis rem ipsam et. description: Status of the execution example: - Quaerat nam quia. - Nesciunt delectus quasi. example: - Nostrum voluptatibus id libero numquam totam. - Ex iure qui voluptatem. - Enim laudantium est quis id aperiam fuga. - Est a laborum reiciendis reprehenderit aliquid impedit. - name: tags in: query description: Comma separated list of tags to filter by allowEmptyValue: true schema: type: array items: type: string example: Temporibus sed autem tempora asperiores repellendus. description: Comma separated list of tags to filter by example: - Nostrum qui magnam asperiores in. - Praesentium vel ipsum dolorum. example: - Pariatur asperiores aut tempore. - Magnam odit quis nihil quae delectus amet. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '1' minLength: 1 maxLength: 128 example: w - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '5' minLength: 1 maxLength: 128 example: yyj - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: sd minLength: 1 maxLength: 128 example: k0r responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/WorkspaceResourceSummaryCollection' example: - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - workspaces summary: Create workspace description: Create a new workspace. operationId: workspaces#create-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: vkb minLength: 1 maxLength: 128 example: ye - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: v8 minLength: 1 maxLength: 128 example: '3' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 81l minLength: 1 maxLength: 128 example: b requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceRequest' example: associated_template: template_id: b version: '4' budget: 0.039115082 ccm_cost_enabled: false cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true default_pipelines: Est in.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. description: this is a more detailed explanation of the resource. environment_variables: Et voluptas reprehenderit commodi quo.: key: nd value: Aut excepturi soluta. value_type: secret Magni itaque labore non.: key: nd value: Aut excepturi soluta. value_type: secret Natus natus et.: key: nd value: Aut excepturi soluta. value_type: secret id: 639289500094086800 identifier: cp modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name provider_connector: Nulla harum. provider_connectors: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Illo mollitia pariatur molestiae. provisioner_configuration: Assumenda quibusdam ut libero rerum ratione maxime. provisioner_version: In minima adipisci alias fugiat eaque. prune_sensitive_data: true repository: Hic sequi et reiciendis. repository_branch: main repository_commit: abc10ed repository_connector: Corrupti doloribus consequatur tempore asperiores et. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: false sparse_checkout: Necessitatibus omnis. state_checksum: d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f tags: cost-center: engineering environment: production team: platform terraform_plan_json: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: Deleniti veritatis.: key: nd value: Aut excepturi soluta. value_type: secret Nobis laudantium non incidunt iure voluptatem aut.: key: nd value: Aut excepturi soluta. value_type: secret Non voluptatem fugiat et quis.: key: nd value: Aut excepturi soluta. value_type: secret terragrunt_provider: true terragrunt_version: Et voluptate eum natus autem ratione. variable_sets: - Esse non. - Et et officia. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspacesCreateWorkspaceResponseBody' example: policy_evaluation: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}: delete: tags: - workspaces summary: Destroy workspace description: Deletes the given workspace. operationId: workspaces#destroy-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: nlc minLength: 1 maxLength: 128 example: j - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: qn minLength: 1 maxLength: 128 example: '3' - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: p minLength: 1 maxLength: 128 example: 9oo - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: t responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - workspaces summary: Show workspace description: Show an individual workspace. operationId: workspaces#show-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: x7 minLength: 1 maxLength: 128 example: '3' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '51' minLength: 1 maxLength: 128 example: wf - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: a minLength: 1 maxLength: 128 example: m8c - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: g5g minLength: 1 maxLength: 128 example: 1a responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspacesShowWorkspaceResponseBody' example: account: l associated_template: template_id: u version: jkj backend_locked: true budget: 0.91501755 ccm_cost_enabled: false cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true created: 9142952793299314000 default_pipelines: Doloremque exercitationem inventore est reiciendis.: project_pipeline: Quam vitae nulla. workspace_pipeline: Dolor velit quo eaque saepe. Rerum quo dolor et asperiores.: project_pipeline: Quam vitae nulla. workspace_pipeline: Dolor velit quo eaque saepe. description: this is a more detailed explanation of the resource. environment_variables: Dolores eum suscipit impedit fuga optio ut.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Unde dolorum aut autem mollitia nemo ipsam.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string identifier: '0' lock: created_at: 5023311621798248000 id: Atque fuga. locked_by_display_name: Minima id rerum illo. locked_by_principal_id: Temporibus omnis culpa omnis debitis et et. locked_by_principal_type: Dolor quibusdam qui eos praesentium ea. manual: false reason: Doloribus laudantium nisi. modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name org: t project: 1w provider_connector: Enim voluptatibus totam iusto. provider_connectors: - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Ea dicta veniam soluta. provisioner_configuration: Nulla deleniti. provisioner_data: Est est iusto. provisioner_version: Porro amet blanditiis libero eos alias. prune_sensitive_data: true repository: Ab consectetur beatae mollitia accusamus placeat molestiae. repository_branch: main repository_commit: abc10ed repository_connector: Nesciunt voluptatibus voluptatem. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: true sparse_checkout: Ex libero ipsum. state_checksum: >- d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f status: provisioning tags: cost-center: engineering environment: production team: platform terraform_plan_json: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed terraform_variables: Id velit porro voluptatem.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Ratione dolorum qui culpa officia soluta.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Unde rerum neque dicta eius perferendis est.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string terragrunt_provider: true terragrunt_version: Itaque iste est tempore nulla minima. updated: 8860729591363064000 variable_sets: - Nemo laudantium. - Similique repellat ratione beatae et ut. - Unde quia modi. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - workspaces summary: Update workspace description: Updates the given workspace with new info. operationId: workspaces#update-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: gf minLength: 1 maxLength: 128 example: 7b9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: r minLength: 1 maxLength: 128 example: eo3 - name: identifier in: path description: Workspace identifier. required: true schema: type: string description: Workspace identifier. example: yl minLength: 1 maxLength: 128 example: g - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: f minLength: 1 maxLength: 128 example: gsc requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceRequest' example: budget: 0.27108407 ccm_cost_enabled: false cost_estimation_enabled: true default_pipelines: Omnis deserunt quo.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Quam eos deserunt a aut.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Velit officiis molestias minima.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. description: this is a more detailed explanation of the resource. environment_variables: Aut commodi velit.: key: nd value: Aut excepturi soluta. value_type: secret Id hic quia.: key: nd value: Aut excepturi soluta. value_type: secret Id laboriosam enim inventore corporis excepturi.: key: nd value: Aut excepturi soluta. value_type: secret name: resource name provider_connector: Consequatur harum aut dolores dicta voluptates. provider_connectors: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 provisioner: Enim numquam eum. provisioner_configuration: Atque debitis odit. provisioner_version: Id nostrum rerum tenetur soluta. prune_sensitive_data: true repository: Ipsa itaque fuga. repository_branch: main repository_commit: abc10ed repository_connector: Consequuntur iusto exercitationem itaque repellendus. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: true sparse_checkout: Reiciendis et ut ex aliquam pariatur. tags: cost-center: engineering environment: production team: platform terraform_variable_files: - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: Distinctio minus id.: key: nd value: Aut excepturi soluta. value_type: secret Eos voluptatem aut veniam autem et.: key: nd value: Aut excepturi soluta. value_type: secret Praesentium aut velit blanditiis.: key: nd value: Aut excepturi soluta. value_type: secret terragrunt_provider: false terragrunt_version: Sunt et minus voluptas recusandae sed qui. variable_sets: - Veniam sed aspernatur ut necessitatibus quae consectetur. - Voluptatem odit. - Rerum omnis vero rem rerum deleniti amet. - Consectetur iure architecto et. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceResponse' example: policy_evaluation: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/force-unlock: post: tags: - workspaces summary: Unlock workspace description: >- Unlock a workspace, removing the lock regardless of its origin (manual or automatic). Idempotent. operationId: workspaces#force-unlock-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: zir minLength: 1 maxLength: 128 example: '80' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 8m minLength: 1 maxLength: 128 example: shz - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: jb minLength: 1 maxLength: 128 example: cu - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: ki7 responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/lock: post: tags: - workspaces summary: Lock workspace description: Create a manual lock on a workspace. operationId: workspaces#lock-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 5b minLength: 1 maxLength: 128 example: v - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 0ij minLength: 1 maxLength: 128 example: pr - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: mj minLength: 1 maxLength: 128 example: s6 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 1gk minLength: 1 maxLength: 128 example: v requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LockWorkspacePayload2' example: reason: Q2 freeze responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/LockWorkspaceResponse' example: id: a5ff0ef5-e8e9-4a64-a8bc-f1aa7c13b53e locked_by_display_name: Sapiente assumenda illo accusantium. locked_by_principal_id: Doloremque dolor similique. locked_by_principal_type: Quam necessitatibus veniam. manual: true reason: Suscipit aut. workspace: Tempore iure id. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/modules: get: tags: - workspaces summary: List modules description: List modules associated with this workspace. operationId: workspaces#list-workspace-modules parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: h4z minLength: 1 maxLength: 128 example: ank - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 16x minLength: 1 maxLength: 128 example: 2h - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: x2 minLength: 1 maxLength: 128 example: utl - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: vl minLength: 1 maxLength: 128 example: dnn responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspaceModuleCollection' example: - invocations: 3 key: ec2-instance_test source: >- registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete stack_path: environments/prod/ec2 version: 5.0.0 - invocations: 3 key: ec2-instance_test source: >- registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete stack_path: environments/prod/ec2 version: 5.0.0 - invocations: 3 key: ec2-instance_test source: >- registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete stack_path: environments/prod/ec2 version: 5.0.0 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources: get: tags: - workspaces summary: List resources description: List resources associated with this workspace. operationId: workspaces#list-resources parameters: - name: limit in: query description: >- Limit is the number of records to return for a page. When omitted, all records are returned. allowEmptyValue: true schema: type: integer description: >- Limit is the number of records to return for a page. When omitted, all records are returned. example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: >- Page is the page number to return relative to the page 'limit'. When omitted, all records are returned. allowEmptyValue: true schema: type: integer description: >- Page is the page number to return relative to the page 'limit'. When omitted, all records are returned. example: 1 format: int64 minimum: 1 example: 1 - name: resource_types in: query description: Resource types to filter by. allowEmptyValue: true schema: type: array items: type: string example: Necessitatibus ut. description: Resource types to filter by. example: - aws_instance - google_compute_instance example: - aws_instance - google_compute_instance - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 'n' minLength: 1 maxLength: 128 example: fbm - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: u9 minLength: 1 maxLength: 128 example: tu - name: identifier in: path description: Workspace identifier. required: true schema: type: string description: Workspace identifier. example: mt minLength: 1 maxLength: 128 example: ix8 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: b minLength: 1 maxLength: 128 example: zgy responses: '200': description: OK response. headers: x-page-size: description: Current page size (only populated for paginated list operations) schema: type: integer description: >- Current page size (only populated for paginated list operations) example: 50 format: int64 example: 50 x-total-items: description: >- Total items available (only populated for paginated list operations) schema: type: integer description: >- Total items available (only populated for paginated list operations) example: 1800 format: int64 example: 1800 x-total-pages: description: >- Total pages available (only populated for paginated list operations) schema: type: integer description: >- Total pages available (only populated for paginated list operations) example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ListResourcesResponse' example: data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket outputs: - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket stack_outputs: IaCM/TGOverride/environments/dev/ec2: - name: instance_id sensitive: false stack_path: IaCM/TGOverride/environments/dev/ec2 value: i-1234567890abcdef0 total_resources: 42 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources/search: post: tags: - workspaces summary: List resources using selectors description: >- List resources for a workspace using selectors. Pagination is optional: when limit and page are omitted (or zero), all matching resources are returned for backward compatibility. operationId: workspaces#search-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: lw minLength: 1 maxLength: 128 example: e - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '1' minLength: 1 maxLength: 128 example: d - name: identifier in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Voluptatem voluptatibus a quod. example: Laboriosam libero quo neque nesciunt quo alias. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: dx minLength: 1 maxLength: 128 example: '0' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchResourcesRequest' example: limit: 30 page: 1 selectors: - include_conditions: - attribute: tag.environment operator: equals value: prod path_id: qa provider: aws resource_type: aws_instance search_text: some text - include_conditions: - attribute: tag.environment operator: equals value: prod path_id: qa provider: aws resource_type: aws_instance search_text: some text responses: '200': description: OK response. headers: x-page-size: description: Current page size (only populated for paginated list operations) schema: type: integer description: >- Current page size (only populated for paginated list operations) example: 50 format: int64 example: 50 x-total-items: description: >- Total items available (only populated for paginated list operations) schema: type: integer description: >- Total items available (only populated for paginated list operations) example: 1800 format: int64 example: 1800 x-total-pages: description: >- Total pages available (only populated for paginated list operations) schema: type: integer description: >- Total pages available (only populated for paginated list operations) example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/SearchResourcesResponse' example: data_sources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket outputs: - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. resources: - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket - attributes: ami: ami-830c94ec instance_type: t2.micro createdAt: 1627590400 drift_attributes: instance_type: t2.nano drift_status: changed lastSyncedAt: 1627686800 mode: resource module: full_stack monthly_cost: 0.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket stack_outputs: IaCM/TGOverride/environments/dev/ec2: - name: instance_id sensitive: false stack_path: IaCM/TGOverride/environments/dev/ec2 value: i-1234567890abcdef0 total_resources: 42 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/SearchResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ccm-costs: get: tags: - ccm_costs summary: Show CCM cost summary for a workspace description: >- Returns aggregated CCM cost data computed from per-resource cost records. operationId: ccm_costs#show parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: iq minLength: 1 maxLength: 128 example: g - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: cd2 minLength: 1 maxLength: 128 example: o - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: 1or minLength: 1 maxLength: 128 example: '8' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 7lr minLength: 1 maxLength: 128 example: sd responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowCcmCostsResponse' example: last_synced_at: 5537103169826113000 monthly_cost: 0.5564286730732355 monthly_saving: 0.9623706834593319 previous_monthly_cost: 0.10739846109282496 recommendation_count: 709505329237186300 resource_count: 7887751721790108000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/clone: post: tags: - workspaces summary: Clone workspace description: Clone the given workspace with new name. operationId: workspaces#clone-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: w8z minLength: 1 maxLength: 128 example: '1' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: b6 minLength: 1 maxLength: 128 example: b - name: workspace in: path required: true schema: type: string example: Aliquam sit harum iste. example: Recusandae enim molestiae quaerat magni sed necessitatibus. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: c minLength: 1 maxLength: 128 example: fkq requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CloneWorkspaceRequest' example: identifier: '3' name: resource name responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspacesCreateWorkspaceResponseBody' example: policy_evaluation: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data: get: tags: - workspaces summary: List data description: List all stored data for a workspace. operationId: workspaces#list-data parameters: - name: pipeline_execution_id in: query description: Filter by pipeline execution ID allowEmptyValue: true schema: type: string description: Filter by pipeline execution ID example: Sunt velit aut et explicabo. example: Dolores autem aut quos voluptas nisi voluptatem. - name: pipeline_stage_id in: query description: Filter by pipeline execution stage ID allowEmptyValue: true schema: type: string description: Filter by pipeline execution stage ID example: In pariatur consequatur ut at. example: Deleniti facilis facere. - name: provisioner_type in: query description: Filter by provisioner type allowEmptyValue: true schema: type: string description: Filter by provisioner type example: Omnis enim quos sint earum. example: Autem est necessitatibus quis omnis eos non. - name: data_type in: query description: Filter by data type allowEmptyValue: true schema: type: string description: Filter by data type example: Esse quia quos. example: Est sint quasi natus et. - name: stack_path in: query description: Filter by stack path allowEmptyValue: true schema: type: string description: Filter by stack path example: Rerum et enim eum et illo. example: Assumenda similique numquam magnam vel quasi nisi. - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 7c minLength: 1 maxLength: 128 example: 2y - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: h5 minLength: 1 maxLength: 128 example: l2j - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Error rerum nisi qui quis esse sapiente. example: Atque omnis aperiam vitae dignissimos quo. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: b minLength: 1 maxLength: 128 example: wz4 responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/WorkspaceDataResourceCollection' example: - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - workspaces summary: Create data description: >- Store binary data generated by the provisioner, such as plans and state files. operationId: workspaces#create-data parameters: - name: pipeline_id in: query description: The unique identifier for the associated pipeline allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline example: Deserunt similique id omnis doloribus. example: Sequi et sapiente perferendis non ea. - name: stage_id in: query description: The unique identifier for a stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for a stage example: Quae blanditiis eveniet voluptates ducimus. example: Perferendis eos deserunt quaerat qui. - name: pipeline_execution_id in: query description: The unique identifier for the associated pipeline execution allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution example: Cupiditate inventore totam numquam. example: Voluptatum dolorem velit cupiditate magni dolor ea. - name: pipeline_stage_id in: query description: The unique identifier for the associated pipeline execution stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution stage example: Nulla quaerat. example: Nihil nihil veniam ut porro rerum mollitia. - name: provisioner_type in: query description: Type of provisioner that created the data allowEmptyValue: true required: true schema: type: string description: Type of provisioner that created the data example: tf enum: - tf - awscdk example: tf - name: data_type in: query description: Type of data stored allowEmptyValue: true required: true schema: type: string description: Type of data stored example: cost_breakdown enum: - plan_human - state_raw - state_human - cost_breakdown - cost_diff - modules - providers - cdk_template - cdk_manifest - cdk_tree - cdk_assets - cdk_diff - cdk_drift example: cdk_diff - name: policy_action in: query description: Policy action used during OPA evaluation allowEmptyValue: true schema: type: string description: Policy action used during OPA evaluation example: afterTerraformApply example: afterTerraformApply - name: opa_sdk_supported in: query description: Indicates the plugin supports OPA SDK-based evaluation allowEmptyValue: true schema: type: boolean description: Indicates the plugin supports OPA SDK-based evaluation example: true example: true - name: stack_path in: query description: Optional path to the stack module allowEmptyValue: true schema: type: string description: Optional path to the stack module example: Voluptates sunt. example: Labore occaecati at omnis placeat molestias. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: b3 minLength: 1 maxLength: 128 example: ol - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: e minLength: 1 maxLength: 128 example: hu - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: pa minLength: 1 maxLength: 128 example: ptb - name: Content-Length in: header description: Size in bytes of the data. allowEmptyValue: true schema: type: integer description: Size in bytes of the data. example: 3498299841947132000 format: int64 example: 7539159219830345000 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateDataResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}: get: tags: - workspaces summary: Show data description: >- Get binary data generated by the provisioner, such as plans and state files. operationId: workspaces#show-data parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: pso minLength: 1 maxLength: 128 example: 1u - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: msy minLength: 1 maxLength: 128 example: k6v - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Libero sit. example: Vitae voluptatem quo perferendis. - name: id in: path description: The unique identifier for the data required: true schema: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa example: dc538c61-de48-4220-958c-5f3c4f983daa - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 8q minLength: 1 maxLength: 128 example: hql responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}/evaluate-policy: get: tags: - workspaces summary: Evaluate data description: >- Evaluate policy against previously stored data, such as plans and state files. operationId: workspaces#evaluate-data parameters: - name: pipeline_execution_id in: query description: Pipeline execution associated with this evaluation allowEmptyValue: true schema: type: string description: Pipeline execution associated with this evaluation example: Quo doloribus facere et fugiat exercitationem. example: Consequatur enim iure animi adipisci. - name: policy_action in: query description: Policy action used during OPA evaluation allowEmptyValue: true required: true schema: type: string description: Policy action used during OPA evaluation example: afterTerraformApply example: afterTerraformApply - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: v5 minLength: 1 maxLength: 128 example: 1n9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ocl minLength: 1 maxLength: 128 example: blk - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Est illum voluptas. example: Sint natus repellendus vel laboriosam at ipsa. - name: id in: path description: The unique identifier for the data required: true schema: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa example: dc538c61-de48-4220-958c-5f3c4f983daa - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: zcx minLength: 1 maxLength: 128 example: 5m responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/EvaluateDataResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/dependency-graph: post: tags: - workspaces summary: Upload dependency graph data description: Upload dependency graph for an existing plan file. operationId: workspaces#upload-dependency-graph parameters: - name: pipeline_id in: query description: The unique identifier for the associated pipeline allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline example: Atque autem recusandae non voluptas rerum amet. example: Rerum magni. - name: stage_id in: query description: The unique identifier for a stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for a stage example: Perspiciatis dolores vel aut veritatis sed. example: Amet exercitationem ullam praesentium veniam. - name: pipeline_execution_id in: query description: The unique identifier for the associated pipeline execution allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution example: Perspiciatis nemo enim nam. example: Tenetur voluptatum et. - name: pipeline_stage_id in: query description: The unique identifier for the associated pipeline execution stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution stage example: Nobis quia ipsum autem. example: Aut consequatur unde ad iste. - name: provisioner_type in: query description: Type of provisioner that created the data allowEmptyValue: true required: true schema: type: string description: Type of provisioner that created the data example: awscdk enum: - tf - awscdk example: tf - name: data_type in: query description: Type of data stored allowEmptyValue: true required: true schema: type: string description: Type of data stored example: cost_diff enum: - plan_human - state_raw - state_human - cost_breakdown - cost_diff - modules - providers - cdk_template - cdk_manifest - cdk_tree - cdk_assets - cdk_diff - cdk_drift example: modules - name: stack_path in: query description: Optional path to the stack module allowEmptyValue: true schema: type: string description: Optional path to the stack module example: Odit molestias atque quia nemo nihil accusantium. example: Consequatur autem eveniet corrupti ab. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: nk minLength: 1 maxLength: 128 example: e - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: v minLength: 1 maxLength: 128 example: 3e - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: z minLength: 1 maxLength: 128 example: kx6 - name: Content-Length in: header description: Size in bytes of the graph data. allowEmptyValue: true schema: type: integer description: Size in bytes of the graph data. example: 8692366172134112000 format: int64 example: 8773926597975846000 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UploadDependencyGraphResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config: delete: tags: - workspaces summary: Disable drift automation for a workspace description: Removes drift scheduling and related configuration for the workspace. operationId: workspaces#delete-drift-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Enim nesciunt dolor aliquam ea voluptates deleniti. example: >- Consequuntur dolorem consectetur doloremque inventore omnis perspiciatis. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: d minLength: 1 maxLength: 128 example: d - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: m minLength: 1 maxLength: 128 example: kx - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Est nemo minima omnis sed eos et. example: Et voluptatum doloribus officiis. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: h5n minLength: 1 maxLength: 128 example: '2' responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteDriftConfigResponse' example: status: Harum cum molestiae repellat quo quisquam. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - workspaces summary: Get drift automation status for a workspace description: Returns whether drift automation is enabled and related metadata. operationId: workspaces#get-drift-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Illum et facilis. example: Et qui modi. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: zf9 minLength: 1 maxLength: 128 example: z - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '7' minLength: 1 maxLength: 128 example: z - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Id perspiciatis consequuntur soluta. example: Labore eos velit doloribus eum nulla laudantium. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ou minLength: 1 maxLength: 128 example: mr responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetDriftConfigResponse' example: enabled: false pipeline_id: Inventore ad quo occaecati ratione aliquam. run_every: 8633270092580654000 run_every_unit: minutes trigger_id: Quidem est quia facilis maxime odit. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - workspaces summary: Enable drift automation for a workspace description: Configures drift detection pipeline and schedule for the workspace. operationId: workspaces#update-drift-config parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: q minLength: 1 maxLength: 128 example: f - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: v7i minLength: 1 maxLength: 128 example: ec - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Debitis iure architecto. example: Ipsum sed vel. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: hs4 minLength: 1 maxLength: 128 example: 1g1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDriftConfigRequest' example: pipeline_id: Reiciendis est dignissimos in magnam cum. provisioner: Numquam deleniti magni fugiat magni. run_every: 7662644581670084000 run_every_unit: minutes responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateDriftConfigResponse' example: status: Reprehenderit libero in. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config: delete: tags: - workspaces summary: Disable ephemeral TTL for a workspace description: >- Removes ephemeral scheduling and related configuration for the workspace. operationId: workspaces#delete-ephemeral-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Voluptas ipsam. example: Adipisci sequi et debitis. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: zch minLength: 1 maxLength: 128 example: 1m - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: e2z minLength: 1 maxLength: 128 example: w15 - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Excepturi dolorem ipsa. example: Optio explicabo eum eos asperiores ex. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: h minLength: 1 maxLength: 128 example: jlo responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteEphemeralConfigResponse' example: status: Ipsam suscipit impedit aliquam voluptate pariatur fugit. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - workspaces summary: Get ephemeral TTL status for a workspace description: Returns whether ephemeral TTL is enabled and related metadata. operationId: workspaces#get-ephemeral-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Eligendi minus omnis. example: Nulla est sint impedit qui eos aut. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: bsz minLength: 1 maxLength: 128 example: ok - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: r minLength: 1 maxLength: 128 example: mx3 - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Odit autem odit ducimus voluptatem inventore. example: Dignissimos inventore reiciendis qui eaque. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '38' minLength: 1 maxLength: 128 example: '12' responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetEphemeralConfigResponse' example: delete_at: Non magni impedit. delete_delay_unit: minutes delete_delay_value: 8909089752851921000 delete_on_date: Voluptate voluptas voluptas amet ut. delete_workspace: false destroy_at: Quae quis eum. destroy_on_date: Architecto atque cumque. enabled: true pipeline_id: Laborum provident consequuntur eum voluptas dolorem nisi. provisioner: Alias quidem quis nihil qui. source: disabled trigger_id: Sequi ut adipisci voluptatem. ttl_unit: seconds ttl_value: 7913793007029722000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - workspaces summary: Enable ephemeral TTL for a workspace description: >- Configures time-to-live settings to automatically destroy infrastructure and optionally delete the workspace. operationId: workspaces#update-ephemeral-config parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '2' minLength: 1 maxLength: 128 example: h - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: a minLength: 1 maxLength: 128 example: 5t - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Soluta cumque et dolores est repudiandae. example: Non ipsa praesentium voluptatem maiores. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: a minLength: 1 maxLength: 128 example: g requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEphemeralConfigRequest' example: delete_delay_unit: hours delete_delay_value: 957687761797899600 delete_on_date: Natus et voluptas corporis dolor. delete_workspace: true destroy_delay_unit: days destroy_delay_value: 5926462219303765000 destroy_on_date: Dolore soluta maiores in necessitatibus vel. pipeline_id: Sit aspernatur eligendi repudiandae. provisioner: Id repellat dolorem. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateEphemeralConfigResponse' example: delete_at: Error aut. destroy_at: Officia natus mollitia. status: Dolorem deleniti quos doloremque. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/events: post: tags: - workspaces summary: Send event description: >- Store binary data generated by the provisioner, such as plans and state files. operationId: workspaces#send-event parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '7' minLength: 1 maxLength: 128 example: 7x - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: b77 minLength: 1 maxLength: 128 example: ttq - name: workspace in: path description: Workspace associated with this event required: true schema: type: string description: Workspace associated with this event example: l minLength: 1 maxLength: 1024 example: k - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ur minLength: 1 maxLength: 128 example: j5 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendEventRequest' example: data: Aperiam dignissimos fuga qui.: Iusto odio exercitationem ipsa et dolorem. Maiores velit omnis dicta.: Corporis sit. Temporibus expedita vel iusto provident ducimus occaecati.: Est cupiditate quasi quia magnam facere tempore. event_type: plan metadata: PlannedChangesCount: 7183568001417402000 activity_status: incomplete activity_type: rollback cost_breakdown_uuid: Autem quia consequatur libero voluptas ipsa. cost_currency: Sapiente incidunt animi fuga. cost_diff_total_monthly: Doloremque accusantium officiis qui. cost_diff_uuid: Quod qui soluta tenetur odio quia cupiditate. cost_past_total_monthly: Ad placeat. cost_total_monthly: Earum culpa. cost_total_monthly_percentage_change: Modi corrupti expedita vel. data_length: 4979827047011853000 drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 enable_solutions_factory: true git_branch: Maiores ut et vel nihil. git_commit_message: Veritatis et aspernatur iste autem optio. git_commit_sha: Quaerat sint et est consequuntur veritatis. git_repo: Et iste assumenda. modules_uuid: Dolorem eius magni id sint quidem. output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 pipeline: Est et aut quaerat commodi dolore numquam. pipeline_execution_id: Eos numquam est quia voluptate. pipeline_execution_number: Optio doloribus ut totam. pipeline_name: Ut nemo corrupti et. pipeline_stage_id: Expedita sit. plan_uuid: Soluta eos dolor qui. providers_uuid: >- Ad facilis reprehenderit cumque consequuntur voluptatem voluptatem. provisioner: Et quam commodi tenetur. provisioner_version: Quo aut voluptatem beatae nisi sapiente. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 rollback_reason: Et odit blanditiis dignissimos qui. rollback_source_id: Doloremque consequatur et. stacks: - assets_uuid: Cumque et nesciunt. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Maxime mollitia suscipit ea pariatur. error_message: Necessitatibus dolore. manifest_uuid: Saepe qui sit harum. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: A saepe molestiae eveniet sequi sed. stack_outputs: Alias cum magni sit eligendi.: Laboriosam cupiditate blanditiis ratione eos veritatis. Harum earum at.: Aut amet assumenda sint rem neque. Illo nesciunt dicta saepe iste omnis.: Qui eos facere iusto sed eos velit. stack_path: Exercitationem est consequuntur. status: success template_uuid: Quis quis. tree_uuid: Enim assumenda. - assets_uuid: Cumque et nesciunt. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Maxime mollitia suscipit ea pariatur. error_message: Necessitatibus dolore. manifest_uuid: Saepe qui sit harum. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: A saepe molestiae eveniet sequi sed. stack_outputs: Alias cum magni sit eligendi.: Laboriosam cupiditate blanditiis ratione eos veritatis. Harum earum at.: Aut amet assumenda sint rem neque. Illo nesciunt dicta saepe iste omnis.: Qui eos facere iusto sed eos velit. stack_path: Exercitationem est consequuntur. status: success template_uuid: Quis quis. tree_uuid: Enim assumenda. state_checksum: Sit tenetur non quod iusto et dolorem. state_uuid: Accusantium possimus animi quis dolor et quia. terragrunt_details: - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. trigger: Non cum iure.: A cum impedit et. Qui aut eaque.: Tempore mollitia et non. pipeline_execution_id: Quasi doloribus itaque est explicabo. pipeline_stage_id: Tempora sit. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/insights: get: tags: - insights summary: List insights for a workspace description: >- Returns a paginated list of insights for a workspace. v1 returns only cost-optimization insights. operationId: insights#list-insights parameters: - name: limit in: query description: >- Limit is the number of records to return for a page. When omitted, all records are returned. allowEmptyValue: true schema: type: integer description: >- Limit is the number of records to return for a page. When omitted, all records are returned. example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: >- Page is the page number to return relative to the page 'limit'. When omitted, all records are returned. allowEmptyValue: true schema: type: integer description: >- Page is the page number to return relative to the page 'limit'. When omitted, all records are returned. example: 1 format: int64 minimum: 1 example: 1 - name: type in: query description: Filter by insight type. When omitted, all types are returned. allowEmptyValue: true schema: type: string description: Filter by insight type. When omitted, all types are returned. example: cost enum: - cost example: cost - name: state in: query description: Filter by insight state. When omitted, all states are returned. allowEmptyValue: true schema: type: string description: Filter by insight state. When omitted, all states are returned. example: APPLIED enum: - OPEN - APPLIED example: OPEN - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 6y minLength: 1 maxLength: 128 example: om - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: dtr minLength: 1 maxLength: 128 example: 8v - name: workspace in: path description: Workspace identifier. required: true schema: type: string description: Workspace identifier. example: 2ll minLength: 1 maxLength: 128 example: yl7 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: i minLength: 1 maxLength: 128 example: suc responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/InsightCollection' example: - action: MigrateToGraviton details_link: Quo ut. id: Sed et voluptatum dolore consequuntur est. monthly_saving: 0.827122981880376 monthly_spend: 0.3175470411269389 resource: account_id: '000000000000' instance_id: i-0123456789abcdef0 instance_type: c4.4xlarge resource_type: EC2_INSTANCE state: OPEN type: cost - action: MigrateToGraviton details_link: Quo ut. id: Sed et voluptatum dolore consequuntur est. monthly_saving: 0.827122981880376 monthly_spend: 0.3175470411269389 resource: account_id: '000000000000' instance_id: i-0123456789abcdef0 instance_type: c4.4xlarge resource_type: EC2_INSTANCE state: OPEN type: cost - action: MigrateToGraviton details_link: Quo ut. id: Sed et voluptatum dolore consequuntur est. monthly_saving: 0.827122981880376 monthly_spend: 0.3175470411269389 resource: account_id: '000000000000' instance_id: i-0123456789abcdef0 instance_type: c4.4xlarge resource_type: EC2_INSTANCE state: OPEN type: cost '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/pipelines: get: tags: - workspaces summary: List pipelines description: List the pipelines where the workspace is been used operationId: workspaces#list-pipelines parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '0' minLength: 1 maxLength: 128 example: vot - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: j7 minLength: 1 maxLength: 128 example: x - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Et numquam vero impedit tenetur placeat sapiente. example: Quidem voluptatem architecto. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: q minLength: 1 maxLength: 128 example: '1' responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ListPipelinesResponse' example: account: 2n org: '0' pipelines: - Est nemo necessitatibus mollitia eos dolorum ratione. - Non fuga maiores rem. project: yw0 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/{activity_id}/complete: post: tags: - provisioner_activities summary: Complete activity description: Complete a provisioner activity with results or error. operationId: provisioner_activities#complete-activity parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 3z minLength: 1 maxLength: 128 example: '5' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: i63 minLength: 1 maxLength: 128 example: o8 - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: 'n' minLength: 1 maxLength: 128 example: y8i - name: activity_id in: path description: The activity identifier from start-activity required: true schema: type: string description: The activity identifier from start-activity example: 4a5949c4-77db-40da-93c7-dea3dbc47d83 format: uuid example: 8b0a8891-26b4-4f96-888f-83b9b8a03221 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: qcw minLength: 1 maxLength: 128 example: s4 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CompleteActivityRequest' example: cdk_result: stacks: - assets_uuid: Voluptatem quia et provident. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Officiis nisi. error_message: A molestiae sint iure voluptas. manifest_uuid: Omnis aut. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: NetworkingStack stack_outputs: Aspernatur sit molestias alias nihil.: Sunt ea. Cumque aliquam placeat ut saepe.: Et distinctio iure animi facilis. Qui accusamus.: Ea et aliquid. stack_path: stacks/networking status: drifted template_uuid: Provident atque aut eum. tree_uuid: Aspernatur fugiat vel molestiae eveniet iusto. - assets_uuid: Voluptatem quia et provident. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Officiis nisi. error_message: A molestiae sint iure voluptas. manifest_uuid: Omnis aut. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: NetworkingStack stack_outputs: Aspernatur sit molestias alias nihil.: Sunt ea. Cumque aliquam placeat ut saepe.: Et distinctio iure animi facilis. Qui accusamus.: Ea et aliquid. stack_path: stacks/networking status: drifted template_uuid: Provident atque aut eum. tree_uuid: Aspernatur fugiat vel molestiae eveniet iusto. error_message: Sit rerum sit sunt molestiae. status: failed responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CompleteActivityResponse' example: activity_id: Inventore eos ea natus. completed_at: 1233633808770389000 status: completed workspace_status: destroying '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/start: post: tags: - provisioner_activities summary: Start activity description: >- Start a new provisioner activity. The activity_id is client-generated for idempotency. operationId: provisioner_activities#start-activity parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: e4h minLength: 1 maxLength: 128 example: t - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ji minLength: 1 maxLength: 128 example: foj - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: 8q minLength: 1 maxLength: 128 example: xyk - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: kf minLength: 1 maxLength: 128 example: hcg requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartActivityRequest' example: activity_id: 550e8400-e29b-41d4-a716-446655440000 activity_type: diff git_info: branch: main commit_message: Add new stack commit_sha: abc123def456 repo: https://github.com/org/repo pipeline_execution_id: Et et placeat rerum adipisci maxime. pipeline_id: Omnis et. pipeline_stage_id: Ducimus debitis. provisioner_type: awscdk provisioner_version: 2.100.0 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/StartActivityResponse' example: activity_id: Laboriosam neque veniam. started_at: 2643463819664643000 status: failed '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/config: delete: tags: - remediation summary: Disable remediation description: Disable AI remediation for a workspace operationId: remediation#disable-remediation parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: b0 minLength: 1 maxLength: 128 example: iyh - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 1qs minLength: 1 maxLength: 128 example: d5q - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: '2' minLength: 1 maxLength: 128 example: 6i - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: zan minLength: 1 maxLength: 128 example: il9 responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - remediation summary: Get remediation config description: Check whether AI remediation is enabled for a workspace operationId: remediation#get-remediation-config parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 1jf minLength: 1 maxLength: 128 example: u - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 8mt minLength: 1 maxLength: 128 example: mrj - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: qt minLength: 1 maxLength: 128 example: ib1 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: w7 minLength: 1 maxLength: 128 example: mr responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetRemediationConfigResponse' example: enabled: false source: none '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - remediation summary: Enable remediation description: Enable AI remediation for a workspace operationId: remediation#enable-remediation parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: uiw minLength: 1 maxLength: 128 example: zs - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: vz0 minLength: 1 maxLength: 128 example: '4' - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: seg minLength: 1 maxLength: 128 example: zp2 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: tk minLength: 1 maxLength: 128 example: c responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/drift-plan: get: tags: - remediation summary: Get drift plan description: >- Download the plan file associated with the workspace's current drift state. Validates the workspace is drifted and returns the plan binary from the drift-detection activity. operationId: remediation#get-drift-plan parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 2l minLength: 1 maxLength: 128 example: '5' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 5ck minLength: 1 maxLength: 128 example: l9 - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: i minLength: 1 maxLength: 128 example: er - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: kyv minLength: 1 maxLength: 128 example: nr responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs: get: tags: - remediation summary: List remediation runs description: List remediation runs for a workspace operationId: remediation#list-remediation-runs parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: t69 minLength: 1 maxLength: 128 example: 22h - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '58' minLength: 1 maxLength: 128 example: mrb - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: q minLength: 1 maxLength: 128 example: u6 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: z minLength: 1 maxLength: 128 example: h88 responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/RemediationRunResourceCollection' example: - account: Consequatur provident nostrum soluta deserunt qui magnam. created: 7118235779928889000 id: Aut eaque. input_payload: Eveniet est aliquam alias sint. org: Dolorum quia dolor dolor assumenda aut delectus. pipeline_execution_id: Sed vel adipisci ut explicabo explicabo quaerat. project: Voluptatem vel doloremque aut. remediation_type: drift result_payload: Et aut. result_type: explanation status: pending triggered_by: Provident et error molestiae. updated: 5959870848525148000 workspace: Provident dolor cum. - account: Consequatur provident nostrum soluta deserunt qui magnam. created: 7118235779928889000 id: Aut eaque. input_payload: Eveniet est aliquam alias sint. org: Dolorum quia dolor dolor assumenda aut delectus. pipeline_execution_id: Sed vel adipisci ut explicabo explicabo quaerat. project: Voluptatem vel doloremque aut. remediation_type: drift result_payload: Et aut. result_type: explanation status: pending triggered_by: Provident et error molestiae. updated: 5959870848525148000 workspace: Provident dolor cum. - account: Consequatur provident nostrum soluta deserunt qui magnam. created: 7118235779928889000 id: Aut eaque. input_payload: Eveniet est aliquam alias sint. org: Dolorum quia dolor dolor assumenda aut delectus. pipeline_execution_id: Sed vel adipisci ut explicabo explicabo quaerat. project: Voluptatem vel doloremque aut. remediation_type: drift result_payload: Et aut. result_type: explanation status: pending triggered_by: Provident et error molestiae. updated: 5959870848525148000 workspace: Provident dolor cum. - account: Consequatur provident nostrum soluta deserunt qui magnam. created: 7118235779928889000 id: Aut eaque. input_payload: Eveniet est aliquam alias sint. org: Dolorum quia dolor dolor assumenda aut delectus. pipeline_execution_id: Sed vel adipisci ut explicabo explicabo quaerat. project: Voluptatem vel doloremque aut. remediation_type: drift result_payload: Et aut. result_type: explanation status: pending triggered_by: Provident et error molestiae. updated: 5959870848525148000 workspace: Provident dolor cum. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - remediation summary: Create remediation run description: Create a new remediation run (called by the remediation pipeline plugin) operationId: remediation#create-remediation-run parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 5g5 minLength: 1 maxLength: 128 example: '9' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: zay minLength: 1 maxLength: 128 example: vb4 - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: '9' minLength: 1 maxLength: 128 example: pk - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: d minLength: 1 maxLength: 128 example: '71' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRemediationRunRequest' example: input_payload: Et qui. pipeline_execution_id: Tempora rem eius atque. remediation_type: ccm triggered_by: Debitis doloribus sint. responses: '201': description: Created response. content: application/json: schema: $ref: '#/components/schemas/CreateRemediationRunResponse' example: account: Numquam vitae mollitia consequuntur. created: 6538557817762261000 id: Eaque qui vel labore aperiam. input_payload: Ad aut praesentium maiores. org: Facilis dolor quia sed a accusantium. pipeline_execution_id: Fugiat omnis consectetur delectus delectus veritatis. project: Consequuntur veritatis nihil odit sequi. remediation_type: custom result_payload: Aut blanditiis. result_type: explanation status: succeeded triggered_by: Ipsum optio totam facilis autem. updated: 46980289191021060 workspace: Vitae aliquam. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs/{id}: get: tags: - remediation summary: Get remediation run description: Get a single remediation run by ID operationId: remediation#get-remediation-run parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: p minLength: 1 maxLength: 128 example: l0 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: pf minLength: 1 maxLength: 128 example: gk - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: f minLength: 1 maxLength: 128 example: sx - name: id in: path description: Remediation run identifier required: true schema: type: string description: Remediation run identifier example: Sed ut. example: Accusamus ea error cumque. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: zv minLength: 1 maxLength: 128 example: d responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetRemediationRunResponse' example: account: Ipsam qui. created: 2482497770401281000 id: Voluptatem saepe. input_payload: Totam explicabo nihil rerum. org: Sunt repudiandae totam. pipeline_execution_id: Molestiae voluptates tenetur dolorum. project: Consectetur nostrum at pariatur ut. remediation_type: custom result_payload: Rem aut eos. result_type: explanation status: running triggered_by: Qui fugit laborum aliquid vel. updated: 7674634737545412000 workspace: Veniam et quia praesentium. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - remediation summary: Update remediation run description: >- Update a remediation run status and results (called by the remediation pipeline plugin) operationId: remediation#update-remediation-run parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '5' minLength: 1 maxLength: 128 example: '1' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: n2n minLength: 1 maxLength: 128 example: l - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: 5kz minLength: 1 maxLength: 128 example: x1 - name: id in: path description: Remediation run identifier required: true schema: type: string description: Remediation run identifier example: Quis sint dignissimos. example: Consequuntur est autem temporibus placeat. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v8 minLength: 1 maxLength: 128 example: t requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRemediationRunRequest' example: pipeline_execution_id: Beatae assumenda et beatae sit. result_payload: Est aperiam dolorum. result_type: pr_created status: failed responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateRemediationRunResponse' example: account: Atque iusto quis. created: 8236265038666426000 id: Ex asperiores. input_payload: Tenetur quis libero. org: Earum eum et sapiente et quod. pipeline_execution_id: Quia suscipit nostrum ea et at. project: Repudiandae amet mollitia. remediation_type: custom result_payload: Tempore dolorem velit vel occaecati. result_type: explanation status: failed triggered_by: Quas facere ipsa consequuntur. updated: 5279675343789473000 workspace: Voluptate omnis minima laboriosam qui eos. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions: post: tags: - workspaces summary: Create remote execution description: Create a remote execution for a workspace. operationId: workspaces#create-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: sxt minLength: 1 maxLength: 128 example: du - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ce1 minLength: 1 maxLength: 128 example: gy - name: workspace in: path description: The workspace associated with the remote execution. required: true schema: type: string description: The workspace associated with the remote execution. example: Libero eum ad ut. example: Voluptatem ea provident neque consectetur. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: cmj minLength: 1 maxLength: 128 example: t requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRemoteExecutionRequest' example: custom_arguments: Aut nostrum aut modi est qui.: - Voluptas quia animi corporis corrupti laboriosam. - Facere commodi numquam itaque veritatis saepe magni. Sunt et rerum aut aut aliquam nobis.: - Voluptatum necessitatibus blanditiis. - Illum consequatur neque repellat quidem quia. - Omnis asperiores odit vero soluta labore. responses: '201': description: Created response. content: application/json: schema: $ref: '#/components/schemas/CreateRemoteExecutionResponse' example: account: rp created: 8925472830282933000 custom_arguments: Quaerat aliquam quo quia.: - Voluptatem aut. - Ullam sit reprehenderit enim minus commodi. - Qui vel iste assumenda porro. - Debitis deserunt atque. Saepe placeat minus.: - Modi dolorem fugiat animi maxime neque sint. - Sapiente illum. - Quo voluptatem quo voluptatibus maiores. executed: false id: a3859a1e-194d-4b56-8460-e2dab9442133 org: l pipeline_execution_id: Perspiciatis quis aperiam temporibus ut ipsum necessitatibus. pipeline_execution_url: Fugiat iste. project: egp sha256_checksum: Et porro blanditiis molestiae. updated: 8364298947036632000 workspace: Sit omnis distinctio ipsa assumenda voluptatum. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}: get: tags: - workspaces summary: Show remote execution description: Find remote execution operationId: workspaces#find-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: eds minLength: 1 maxLength: 128 example: a3 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ne1 minLength: 1 maxLength: 128 example: d - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Nulla aut est qui. example: Et nihil. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: 8cc47f61-b611-4d55-83ba-c7417ff96b2e format: uuid example: 3292f390-e81f-457b-87e6-bf2107ef5e55 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 'n' minLength: 1 maxLength: 128 example: vc4 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowRemoteExecutionResponse' example: account: h39 created: 3967728839398149000 custom_arguments: Eos consectetur qui.: - Et voluptatem autem quaerat illo. - Quidem eos sapiente. - Et voluptate nam nihil sequi quam. - Dolores sunt. executed: false id: 0ddabf08-5b35-478b-bc51-795d0881fe0a org: r pipeline_execution_id: Et dicta consequatur nisi enim numquam. pipeline_execution_url: Autem natus dolores assumenda qui. project: jd sha256_checksum: Fugiat quibusdam soluta sint eius. updated: 3954206623322953700 workspace: Ex fuga minima provident. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/download: get: tags: - workspaces summary: Download remote execution description: Download the source code for the remote plan. operationId: workspaces#download-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 3j1 minLength: 1 maxLength: 128 example: 8s - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: a minLength: 1 maxLength: 128 example: bh0 - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Ipsa porro temporibus earum. example: Et velit harum ullam illum. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: 2e7ed6be-cbf9-4ade-9d83-9af252f5b65a format: uuid example: 8ccb8b67-8897-42d1-8b83-5f5712d91da4 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '75' minLength: 1 maxLength: 128 example: gt responses: '200': description: OK response. headers: Content-Digest: description: >- Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. schema: type: string description: >- Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. example: Eius et qui reprehenderit. example: Animi exercitationem est inventore veritatis nisi architecto. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/execute: post: tags: - workspaces summary: execute-remote-execution workspaces description: Execute the remote execution operationId: workspaces#execute-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: x3 minLength: 1 maxLength: 128 example: g5 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: k minLength: 1 maxLength: 128 example: ryq - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Iure ratione commodi non eligendi rerum voluptas. example: Iusto quia quis veritatis itaque laborum. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: 98d9df20-a1a3-4cf5-8c9a-e4e1690aa258 format: uuid example: 32f4343b-ca19-4651-a4a1-08c476b221e2 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: p minLength: 1 maxLength: 128 example: h responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/RemoteExecution' example: account: i created: 4451650124350750700 custom_arguments: Esse consequuntur.: - Earum ipsam. - Quo consequatur et quos aliquam. Molestiae aspernatur commodi occaecati veniam.: - Et est quia tempore temporibus. - Aliquam voluptatem quos est nostrum ut. - Sit exercitationem. - Qui enim. Voluptatem deserunt minima iusto molestias nemo.: - Dolor porro animi culpa sint. - Ab doloremque veniam omnis sit. - Dolores odio consequuntur incidunt. - Maiores eligendi qui. executed: true id: b30ef95d-f331-4550-b000-5560a0f9714e org: '3' pipeline_execution_id: Dicta error iure amet assumenda voluptas repudiandae. pipeline_execution_url: Temporibus facere doloribus sint non dolorem excepturi. project: og8 sha256_checksum: Mollitia non omnis vel accusantium voluptatem quisquam. updated: 6713465418713585000 workspace: Repellat rerum qui pariatur. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/upload: post: tags: - workspaces summary: Upload remote execution source description: Upload the source code for the remote execution. operationId: workspaces#upload-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: o4 minLength: 1 maxLength: 128 example: gm - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: klq minLength: 1 maxLength: 128 example: '2' - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Nam est et architecto optio exercitationem. example: Et ut molestiae. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: d5c94778-9703-4d55-bbd9-9abc084a5653 format: uuid example: 0f6a8d51-5420-4ebc-9648-c2f9dcfcb0dd - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 2z minLength: 1 maxLength: 128 example: '1' - name: Content-Length in: header description: Size in bytes of the source code. allowEmptyValue: true schema: type: integer description: Size in bytes of the source code. example: 7915008551940518000 format: int64 example: 8403877257311434000 - name: Content-Digest in: header description: >- Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. allowEmptyValue: true required: true schema: type: string description: >- Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. example: Sed doloribus aut quidem. example: Aut labore. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UploadRemoteExecutionResponse' example: account: n4 created: 6317977531171780000 custom_arguments: A quis.: - Soluta voluptatem distinctio voluptatem. - Dolorem voluptatibus veniam nihil. - Incidunt itaque aperiam deleniti. - Et impedit tempora consequatur quia necessitatibus nulla. Ratione magni doloremque et dignissimos dolore et.: - Ea et tempora quam sed veritatis. - Omnis voluptas voluptate sapiente culpa. Totam consequatur voluptas.: - Magni ipsum deserunt in. - >- Recusandae aspernatur eligendi odio soluta corporis adipisci. - Dolore voluptatem. - Velit laboriosam. executed: true id: 83d20295-ed6e-44ea-8c9b-a24a55798cdf org: axy pipeline_execution_id: Natus libero tempore dolorum natus. pipeline_execution_url: Corporis deleniti. project: xhv sha256_checksum: Rerum id et quas. updated: 5100012433285201000 workspace: Impedit excepturi eum. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types: get: tags: - workspaces summary: List workspace resource types description: Retrieves the resource types used by workspaces operationId: workspaces#list-workspace-resource-types parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 9dy minLength: 1 maxLength: 128 example: cxy - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '2' minLength: 1 maxLength: 128 example: qs - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Aspernatur et. example: Ipsa et ut odit doloremque sapiente et. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: w6 minLength: 1 maxLength: 128 example: l9 responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Officia sit sint quia sit iusto perferendis. description: List of resource types example: - Quas blanditiis quo at. - Quo libero occaecati doloribus cumque. - Beatae cum ut velit voluptas error et. example: - Vitae consequatur. - Id aperiam. - Officiis molestias omnis laboriosam. - Similique quibusdam ipsum iusto explicabo. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types-and-attributes: get: tags: - workspaces summary: Map of resource types and their attributes description: Retrieves the resource type attributes used by workspaces and attributes operationId: workspaces#list-workspace-resource-types-and-attributes parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: j8 minLength: 1 maxLength: 128 example: 1ly - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: o06 minLength: 1 maxLength: 128 example: d - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Tenetur quam est ut. example: Ut adipisci veniam repellat quos. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: qx minLength: 1 maxLength: 128 example: al responses: '200': description: OK response. content: application/json: schema: type: object description: Map of resource types and their attributes example: Eum odit dolorem possimus.: - >- Laboriosam quod aut distinctio voluptatem adipisci tempora. - Autem molestias provident nesciunt sunt aut. - Quis deserunt et eaque tempore. Eum sint ipsa.: - Illum sequi. - Quis officiis nam reiciendis quasi vel. - Qui quibusdam omnis ut ab vel. - Doloremque nulla qui. Incidunt eos nemo laudantium.: - Sit inventore. - Dicta culpa rerum repellat quae placeat. additionalProperties: type: array items: type: string example: Quibusdam praesentium dolores velit. example: - Aut non aliquam vel saepe. - Enim sit distinctio perspiciatis laborum. - Dolore sed maxime. example: Non eligendi.: - Vero quis delectus ut libero. - Quia unde est at. - Aut sit exercitationem dolorem itaque quo. - Unde fugiat quam. Quo sed voluptas voluptatem.: - Officia in. - Sequi aut quasi commodi. Veniam repudiandae architecto consequatur sed facilis nisi.: - Sit magnam voluptas in blanditiis. - Velit sit. - Et dolor. - Eos qui expedita. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types/{resource_type}/attributes: get: tags: - workspaces summary: List workspace resource type attributes description: Retrieves the resource type attributes used by workspaces operationId: workspaces#list-workspace-resource-type-attributes parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '00' minLength: 1 maxLength: 128 example: c9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: de minLength: 1 maxLength: 128 example: p - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Ipsa earum quae sed quia ab architecto. example: Rerum provident harum. - name: resource_type in: path description: Resource type required: true schema: type: string description: Resource type example: Unde laudantium voluptatem ea exercitationem qui ut. example: Fugiat eaque sapiente iste et. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: k minLength: 1 maxLength: 128 example: 5k responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Officiis nam quam voluptatibus aut. description: List of resource type attributes example: - Assumenda est dolorem. - Est ut voluptatem est eius. example: - Ullam voluptatum commodi voluptas officiis hic. - Quis aliquid reiciendis autem est excepturi adipisci. - Dolor voluptatem odit in nostrum repellendus. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources: delete: tags: - workspaces summary: Delete resources description: Deletes destroyed resources for a workspace. operationId: workspaces#delete-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '79' minLength: 1 maxLength: 128 example: 2d5 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: zd minLength: 1 maxLength: 128 example: apg - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Porro quo ut est. example: Architecto eveniet quia molestias voluptatem doloribus. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: lvu requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteResourcesRequest' example: resources: - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteResourcesResponse' example: results: - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. summary: deleted: 3056372905831230500 failed: 1058023892543537200 skipped: 2913497782223108000 total: 8126230770775416000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/DeleteResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' patch: tags: - workspaces summary: Update resources description: Updates resources for a workspace. operationId: workspaces#update-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: k9r minLength: 1 maxLength: 128 example: m - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: d9s minLength: 1 maxLength: 128 example: fj - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Rerum est consequuntur quia sit. example: Et minima dolores enim. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: hxi minLength: 1 maxLength: 128 example: i requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateResourcesRequest' example: resources: - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. session_id: 4e93df4a-1aee-4cf9-a83e-aa74e4d807e2 update_mode: drift responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateResourcesResponse' example: results: - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. summary: failed: 3209551945199997400 skipped: 5371041077206878000 total: 2670516380320101000 updated: 8521338423719211000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/UpdateResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources/stale: delete: tags: - workspaces summary: Delete stale resources description: >- Deletes stale resources for a workspace that don't belong to the current session. operationId: workspaces#delete-stale-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: x minLength: 1 maxLength: 128 example: r - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '7' minLength: 1 maxLength: 128 example: hex - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Maiores deleniti perferendis. example: Sunt cum explicabo eos qui quam consequatur. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: h minLength: 1 maxLength: 128 example: 6wy requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteStaleResourcesRequest' example: session_id: 9671ad1f-f89d-4b6e-acf3-135ade5cae22 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteStaleResourcesResponse' example: deleted_count: 7006854695359918000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/DeleteStaleResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/risk-assessment: post: tags: - workspaces summary: Upload risk assessment data description: >- Upload per-resource risk data and overall risk summary for an existing plan file. operationId: workspaces#upload-risk-assessment parameters: - name: pipeline_id in: query description: The unique identifier for the associated pipeline allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline example: Eum nihil sit sit. example: Delectus aut et corrupti vero tempora. - name: stage_id in: query description: The unique identifier for a stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for a stage example: Eum et. example: Id praesentium adipisci ad. - name: pipeline_execution_id in: query description: The unique identifier for the associated pipeline execution allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution example: Est enim. example: Facere et ut ratione illum autem. - name: pipeline_stage_id in: query description: The unique identifier for the associated pipeline execution stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution stage example: Libero consequatur laborum sapiente et laboriosam. example: Adipisci dicta sit omnis nostrum quo quod. - name: provisioner_type in: query description: Type of provisioner that created the data allowEmptyValue: true required: true schema: type: string description: Type of provisioner that created the data example: awscdk enum: - tf - awscdk example: awscdk - name: data_type in: query description: Type of data stored allowEmptyValue: true required: true schema: type: string description: Type of data stored example: modules enum: - plan_human - state_raw - state_human - cost_breakdown - cost_diff - modules - providers - cdk_template - cdk_manifest - cdk_tree - cdk_assets - cdk_diff - cdk_drift example: state_human - name: stack_path in: query description: Optional path to the stack module allowEmptyValue: true schema: type: string description: Optional path to the stack module example: >- Voluptatem voluptas exercitationem adipisci quas rerum praesentium. example: Quia distinctio nobis. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: u minLength: 1 maxLength: 128 example: '80' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: esw minLength: 1 maxLength: 128 example: l - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '4' minLength: 1 maxLength: 128 example: ll - name: Content-Length in: header description: Size in bytes of the risk data. allowEmptyValue: true schema: type: integer description: Size in bytes of the risk data. example: 2259026685347259000 format: int64 example: 3371394724881327600 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UploadRiskAssessmentResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/state-versions/{data_id}/rollback: post: tags: - workspaces summary: Roll back workspace state to a previous version description: >- Copies a historical state file to a new version and sets the workspace state pointer to it. Blocked when a pipeline execution is in flight. operationId: workspaces#rollback-state parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: s minLength: 1 maxLength: 128 example: '91' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: kp minLength: 1 maxLength: 128 example: 'n' - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Enim eaque sint voluptate quo. example: In iste enim. - name: data_id in: path description: The unique identifier of the state version to roll back to required: true schema: type: string description: The unique identifier of the state version to roll back to example: 73dfd8ae-c6d1-4e5c-bf16-f773716260a5 format: uuid example: e926c50e-3e06-4d87-adc8-e67a095b91cf - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: a minLength: 1 maxLength: 128 example: c requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RollbackStateRequest' example: rollback_reason: Facere rerum laboriosam qui et. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/RollbackStateResponse' example: activity_id: a434b34c-44ff-4719-ab16-32b0e90b8d15 new_data_id: 43f63ea0-a3ae-4025-a59d-b17baf4cf3a4 new_file_version: 3017602585939659000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend: get: tags: - tf-standard-backend summary: Show terraform state operationId: tf-standard-backend#pull-terraform-state parameters: - name: accountIdentifier in: query description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: vhe minLength: 1 maxLength: 128 example: vtv - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: sf minLength: 1 maxLength: 128 example: eh2 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: p minLength: 1 maxLength: 128 example: a - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - tf-standard-backend summary: Create terraform state operationId: tf-standard-backend#push-terraform-state parameters: - name: accountIdentifier in: query description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: f minLength: 1 maxLength: 128 example: '53' - name: ID in: query description: >- If the backend is locked, this value must match the persisted terraform lock id. allowEmptyValue: true schema: type: string description: >- If the backend is locked, this value must match the persisted terraform lock id. example: 1ac4b858-bf0b-8539-9d80-8c521f6423cf example: 1ac4b858-bf0b-8539-9d80-8c521f6423cf - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: hl3 minLength: 1 maxLength: 128 example: tk - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: v minLength: 1 maxLength: 128 example: lao - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 - name: Content-Length in: header description: Size in bytes of the state. allowEmptyValue: true schema: type: integer description: Size in bytes of the state. example: 501043638353866 format: int64 example: 5414030745992186000 responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock: delete: tags: - tf-standard-backend summary: Unlock workspace operationId: tf-standard-backend#unlock-workspace parameters: - name: accountIdentifier in: query description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '4' minLength: 1 maxLength: 128 example: c - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: w minLength: 1 maxLength: 128 example: xut - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: esk minLength: 1 maxLength: 128 example: f - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnlockWorkspaceRequest' example: created: Quam quasi est a. id: 1ac4b858-bf0b-8539-9d80-8c521f6423cf info: production workspace lock operation: OperationTypePlan path: >- /api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c version: 1.0.0 who: user1 responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - tf-standard-backend summary: Lock workspace operationId: tf-standard-backend#lock-workspace parameters: - name: accountIdentifier in: query description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: abs minLength: 1 maxLength: 128 example: 5y - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '3' minLength: 1 maxLength: 128 example: al - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 6zo minLength: 1 maxLength: 128 example: nr - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LockWorkspaceRequest' example: created: Quae sit voluptas. id: 1ac4b858-bf0b-8539-9d80-8c521f6423cf info: production workspace lock operation: OperationTypePlan path: >- /api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c version: 1.0.0 who: user1 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/HarnessIacmLockinfo' example: account: l created: 8165251417377498000 id: 1ac4b858-bf0b-8539-9d80-8c521f6423cf info: production workspace lock locked_by_display_name: Ullam aut est qui. locked_by_principal_id: >- Explicabo facilis praesentium accusantium exercitationem aut necessitatibus. locked_by_principal_type: Temporibus sed aut sit. manual: true operation: OperationTypePlan org: 2ax path: >- /api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c project: a1 reason: Magnam quod cupiditate qui quo sint quisquam. version: 1.0.0 who: user1 workspace: workspace123 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables: get: tags: - variables summary: List workspace variables description: List all workspace variables. operationId: variables#list-variables parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: ndr minLength: 1 maxLength: 128 example: 'y' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '4' minLength: 1 maxLength: 128 example: '16' - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Necessitatibus incidunt ipsa. example: Laborum atque rem est quos illum deserunt. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: z9 minLength: 1 maxLength: 128 example: '3' responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspaceVariableResourceCollection' example: - account: sf created: 4979480583815519000 key: '7' kind: env org: h project: 0k updated: 6781776914154938000 value: Corrupti et nihil voluptates cupiditate. value_type: string workspace: Sunt accusamus aut inventore. - account: sf created: 4979480583815519000 key: '7' kind: env org: h project: 0k updated: 6781776914154938000 value: Corrupti et nihil voluptates cupiditate. value_type: string workspace: Sunt accusamus aut inventore. - account: sf created: 4979480583815519000 key: '7' kind: env org: h project: 0k updated: 6781776914154938000 value: Corrupti et nihil voluptates cupiditate. value_type: string workspace: Sunt accusamus aut inventore. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - variables summary: Create workspace variable description: Creates a new workspace variable operationId: variables#create-variable parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: d5 minLength: 1 maxLength: 128 example: 5i5 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: d minLength: 1 maxLength: 128 example: wj - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Id earum accusantium. example: Quia aut quibusdam voluptates. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: wv5 minLength: 1 maxLength: 128 example: 'y' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceVariableRequest' example: key: qb kind: tf value: At corporis excepturi. value_type: secret responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceVariableResponse' example: account: ix0 created: 752541232262179600 key: ske kind: tf org: xz6 policy_evaluation: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service project: qk4 updated: 2377730649865544000 value: Doloremque suscipit. value_type: string workspace: Non debitis autem laborum dolorem sit. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}: delete: tags: - variables summary: Destroy workspace variable description: Deletes the given workspace variable. operationId: variables#destroy-variable parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: zgr minLength: 1 maxLength: 128 example: '9' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 6ns minLength: 1 maxLength: 128 example: vwb - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Quo provident in necessitatibus. example: Aut velit eligendi. - name: kind in: path description: Kind is the classfcation of the variable. required: true schema: type: string description: Kind is the classfcation of the variable. example: tf enum: - env - tf example: env - name: key in: path description: Key is the identifier for the secret. required: true schema: type: string description: Key is the identifier for the secret. example: '6' pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 example: q - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: t0 minLength: 1 maxLength: 128 example: k responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DestroyWorkspaceVariableResponse' example: policy_evaluation: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - variables summary: Show workspace variable description: Show an individual workspace variable. operationId: variables#show-variable parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: bxa minLength: 1 maxLength: 128 example: px1 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: sf minLength: 1 maxLength: 128 example: v4d - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Itaque mollitia quae quisquam omnis voluptate. example: Corporis porro molestias facilis dolores saepe id. - name: kind in: path description: Kind is the classfcation of the variable. required: true schema: type: string description: Kind is the classfcation of the variable. example: env enum: - env - tf example: tf - name: key in: path description: Key is the identifier for the secret. required: true schema: type: string description: Key is the identifier for the secret. example: t pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 example: 9p1 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: jun minLength: 1 maxLength: 128 example: c responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowWorkspaceVariableResponse' example: account: 1z8 created: 738147406052097400 key: 2f2 kind: tf org: vrn project: rql updated: 8458323186870372000 value: Amet est ad eveniet doloremque. value_type: secret workspace: Ut modi dolore aliquam. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - variables summary: Update workspace variable description: Updates the given workspace variable with new info. operationId: variables#update-variable parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: w minLength: 1 maxLength: 128 example: 5t - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: s12 minLength: 1 maxLength: 128 example: 46c - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Non ipsa odio maxime ut eos reiciendis. example: Est pariatur non animi. - name: kind in: path description: Kind is the classfcation of the variable. required: true schema: type: string description: Kind is the classfcation of the variable. example: tf enum: - env - tf example: env - name: key in: path description: Key is the identifier for the secret. required: true schema: type: string description: Key is the identifier for the secret. example: j pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 example: u - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 'y' minLength: 1 maxLength: 128 example: f1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceVariableRequest' example: value: Autem sint impedit. value_type: string responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceVariableResponse' example: policy_evaluation: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error - deny_messages: - >- deployment stage 'example-stage' does not have a HarnessApproval step - >- deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: |- { "deny": [ "deployment stage 'deploy' does not have a HarnessApproval step" ], "stages_with_approval": [] } policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: >- policy.rego:25: rego_parse_error: non-terminated string m == "test status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/merged: get: tags: - variables summary: Get variables, provider connectors, and variable files description: >- Returns all terraform/environment variables, provider connectors, and variable files for a workspace operationId: variables#get-variables-and-providers parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 2m minLength: 1 maxLength: 128 example: ie - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '7' minLength: 1 maxLength: 128 example: c2 - name: workspace in: path description: >- Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: >- Workspace is the resource workspace this variable is associated with. example: Nemo magnam laborum quasi expedita modi voluptatem. example: Blanditiis ea reiciendis facilis saepe culpa sit. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: yg minLength: 1 maxLength: 128 example: q3a responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetVariablesAndProvidersResponse' example: environment_variables: - associatedTemplate: Autem natus. associatedVariableSet: Fuga exercitationem inventore maxime enim. created: 1470876583238414800 inUse: false includeInWorkspace: true isLocked: true key: Molestiae aperiam officia. kind: Minus voluptatem eveniet quis ut aut quia. permissions: canDelete: true canEditKey: true canEditValue: true canEditValueType: true source: template updated: 1875648784449092600 uuid: Autem odio ipsum. value: Quos recusandae ducimus est amet dignissimos quam. value_type: Magni voluptas odit. - associatedTemplate: Autem natus. associatedVariableSet: Fuga exercitationem inventore maxime enim. created: 1470876583238414800 inUse: false includeInWorkspace: true isLocked: true key: Molestiae aperiam officia. kind: Minus voluptatem eveniet quis ut aut quia. permissions: canDelete: true canEditKey: true canEditValue: true canEditValueType: true source: template updated: 1875648784449092600 uuid: Autem odio ipsum. value: Quos recusandae ducimus est amet dignissimos quam. value_type: Magni voluptas odit. - associatedTemplate: Autem natus. associatedVariableSet: Fuga exercitationem inventore maxime enim. created: 1470876583238414800 inUse: false includeInWorkspace: true isLocked: true key: Molestiae aperiam officia. kind: Minus voluptatem eveniet quis ut aut quia. permissions: canDelete: true canEditKey: true canEditValue: true canEditValueType: true source: template updated: 1875648784449092600 uuid: Autem odio ipsum. value: Quos recusandae ducimus est amet dignissimos quam. value_type: Magni voluptas odit. - associatedTemplate: Autem natus. associatedVariableSet: Fuga exercitationem inventore maxime enim. created: 1470876583238414800 inUse: false includeInWorkspace: true isLocked: true key: Molestiae aperiam officia. kind: Minus voluptatem eveniet quis ut aut quia. permissions: canDelete: true canEditKey: true canEditValue: true canEditValueType: true source: template updated: 1875648784449092600 uuid: Autem odio ipsum. value: Quos recusandae ducimus est amet dignissimos quam. value_type: Magni voluptas odit. provider_connectors: - associatedTemplate: Aut sint et ratione. associatedVariableSet: Tempora veniam. connector_ref: Enim corporis omnis unde sit. created: 7776016631375350000 inUse: false isInWorkspace: false isLocked: true permissions: canDelete: true source: template type: vault updated: 3151823349144997000 uuid: Quo ut nobis ea. - associatedTemplate: Aut sint et ratione. associatedVariableSet: Tempora veniam. connector_ref: Enim corporis omnis unde sit. created: 7776016631375350000 inUse: false isInWorkspace: false isLocked: true permissions: canDelete: true source: template type: vault updated: 3151823349144997000 uuid: Quo ut nobis ea. terraform_variables: - associatedTemplate: Autem natus. associatedVariableSet: Fuga exercitationem inventore maxime enim. created: 1470876583238414800 inUse: false includeInWorkspace: true isLocked: true key: Molestiae aperiam officia. kind: Minus voluptatem eveniet quis ut aut quia. permissions: canDelete: true canEditKey: true canEditValue: true canEditValueType: true source: template updated: 1875648784449092600 uuid: Autem odio ipsum. value: Quos recusandae ducimus est amet dignissimos quam. value_type: Magni voluptas odit. - associatedTemplate: Autem natus. associatedVariableSet: Fuga exercitationem inventore maxime enim. created: 1470876583238414800 inUse: false includeInWorkspace: true isLocked: true key: Molestiae aperiam officia. kind: Minus voluptatem eveniet quis ut aut quia. permissions: canDelete: true canEditKey: true canEditValue: true canEditValueType: true source: template updated: 1875648784449092600 uuid: Autem odio ipsum. value: Quos recusandae ducimus est amet dignissimos quam. value_type: Magni voluptas odit. variable_files: - associatedTemplate: Non sequi nihil impedit nisi cumque. associatedVariableSet: Voluptatem tempore porro harum. inUse: true isInWorkspace: true isLocked: false permissions: canDelete: true canEdit: true repository: Illo non alias reiciendis dolore maxime ab. repository_branch: Sed qui est aspernatur ipsa. repository_commit: Sed dolores excepturi. repository_connector: Commodi pariatur aliquam. repository_path: Rerum cupiditate quo in hic. repository_sha: Architecto aut accusamus quia ducimus. source: workspace uuid: Deserunt eum aspernatur corrupti cum aut ex. - associatedTemplate: Non sequi nihil impedit nisi cumque. associatedVariableSet: Voluptatem tempore porro harum. inUse: true isInWorkspace: true isLocked: false permissions: canDelete: true canEdit: true repository: Illo non alias reiciendis dolore maxime ab. repository_branch: Sed qui est aspernatur ipsa. repository_commit: Sed dolores excepturi. repository_connector: Commodi pariatur aliquam. repository_path: Rerum cupiditate quo in hic. repository_sha: Architecto aut accusamus quia ducimus. source: workspace uuid: Deserunt eum aspernatur corrupti cum aut ex. - associatedTemplate: Non sequi nihil impedit nisi cumque. associatedVariableSet: Voluptatem tempore porro harum. inUse: true isInWorkspace: true isLocked: false permissions: canDelete: true canEdit: true repository: Illo non alias reiciendis dolore maxime ab. repository_branch: Sed qui est aspernatur ipsa. repository_commit: Sed dolores excepturi. repository_connector: Commodi pariatur aliquam. repository_path: Rerum cupiditate quo in hic. repository_sha: Architecto aut accusamus quia ducimus. source: workspace uuid: Deserunt eum aspernatur corrupti cum aut ex. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/provisioners-ratio: get: tags: - workspaces summary: List provisioners ratio description: Retrieves the ratio of provisioners used by workspaces operationId: workspaces#list-provisioners-ratio parameters: - name: start_time in: query description: Start time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: Start time filter (Unix timestamp) example: 8013563813358098000 format: int64 example: 6705635906295202000 - name: end_time in: query description: End time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: End time filter (Unix timestamp) example: 5154886367248177000 format: int64 example: 8031480671987521000 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: h minLength: 1 maxLength: 128 example: d9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: a minLength: 1 maxLength: 128 example: 'n' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ac minLength: 1 maxLength: 128 example: 1h responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListProvisionersRatioResponse' example: provisioner: Dolor eos harum.: 0.07974645644321349 Iusto architecto quibusdam consequatur id sint.: 0.8459975667540844 total: 0.22165657980145306 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: