Skip to content

Latest commit

 

History

History
1494 lines (1480 loc) · 130 KB

README.md

File metadata and controls

1494 lines (1480 loc) · 130 KB
Raw

Go API client for swagger

This is the Open Api Spec 3 for the NextGen Manager. This is under active development. Beware of the breaking change with respect to the generated code stub # Authentication

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 3.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://app.harness.io/gateway

Class Method HTTP request Description
APIKeysApi AddAPIKey Post /cf/admin/apikey Creates an API key for the given Environment
APIKeysApi DeleteAPIKey Delete /cf/admin/apikey/{identifier} Deletes an API Key
APIKeysApi GetAPIKey Get /cf/admin/apikey/{identifier} Returns API keys
APIKeysApi GetAllAPIKeys Get /cf/admin/apikey Returns API Keys for an Environment
APIKeysApi UpdateAPIKey Put /cf/admin/apikey/{identifier} Updates an API Key
AccessControlListApi GetAccessControlList Post /authz/api/acl Check for permission on resource(s) for a principal
AccountSettingApi Get Get /ng/api/account-setting
AccountSettingApi List Get /ng/api/account-setting/list
AccountSettingApi UpdateAccountSetting Put /ng/api/account-setting Updates account settings
AccountsApi GetAccountNG Get /ng/api/accounts/{accountIdentifier} Gets an account
AccountsApi UpdateAccountDefaultExperienceNG Put /ng/api/accounts/{accountIdentifier}/default-experience Update Default Experience
AccountsApi UpdateAccountNameNG Put /ng/api/accounts/{accountIdentifier}/name Update Account Name
ApiKeyApi CreateApiKey Post /ng/api/apikey Creates an API key
ApiKeyApi DeleteApiKey Delete /ng/api/apikey/{identifier} Deletes the API Key corresponding to the provided ID.
ApiKeyApi GetAggregatedApiKey Get /ng/api/apikey/aggregate/{identifier} Fetches the API Keys details corresponding to the provided ID and Scope.
ApiKeyApi ListApiKeys Get /ng/api/apikey Fetches the list of API Keys corresponding to the request's filter criteria.
ApiKeyApi ListApiKeys1 Get /ng/api/apikey/aggregate Fetches the list of Aggregated API Keys corresponding to the request's filter criteria.
ApiKeyApi UpdateApiKey Put /ng/api/apikey/{identifier} Updates API Key for the provided ID
AuditApi GetAuditEventList Post /audit/api/audits/list List Audit Events
AuditFiltersApi DeleteAuditFilter Delete /audit/api/auditFilters/{identifier} Delete a Filter of type Audit by identifier
AuditFiltersApi GetAuditFilter Get /audit/api/auditFilters/{identifier} Gets a Filter of type Audit by identifier
AuditFiltersApi GetAuditFilterList Get /audit/api/auditFilters Get the list of Filters of type Audit satisfying the criteria (if any) in the request
AuditFiltersApi PostAuditFilter Post /audit/api/auditFilters Creates a Filter
AuditFiltersApi UpdateAuditFilter Put /audit/api/auditFilters Updates the Filter of type Audit
AuthenticationSettingsApi DeleteSamlMetaData Delete /ng/api/authentication-settings/delete-saml-metadata Deletes SAML meta data by accountIdentifier
AuthenticationSettingsApi GetAuthenticationSettings Get /ng/api/authentication-settings Get the authentication settings by accountIdentifier
AuthenticationSettingsApi GetPasswordStrengthSettings Get /ng/api/authentication-settings/login-settings/password-strength Get the password strength settings by accountIdentifier
AuthenticationSettingsApi GetSamlLoginTest Get /ng/api/authentication-settings/saml-login-test Get the SAML login test by accountId
AuthenticationSettingsApi RemoveOauthMechanism Delete /ng/api/authentication-settings/oauth/remove-mechanism Deletes OAuth mechanism by accountIdentifier
AuthenticationSettingsApi SetTwoFactorAuthAtAccountLevel Put /ng/api/authentication-settings/two-factor-admin-override-settings Set two factor auth at account lever by accountIdentifier
AuthenticationSettingsApi UpdateAuthMechanism Put /ng/api/authentication-settings/update-auth-mechanism Updates the Auth mechanism by accountIdentifier
AuthenticationSettingsApi UpdateOauthProviders Put /ng/api/authentication-settings/oauth/update-providers Updates the Oauth providers by accountIdentifier
AuthenticationSettingsApi UpdateSamlMetaData Put /ng/api/authentication-settings/saml-metadata-upload Updates the SAML metadata by accountId
AuthenticationSettingsApi UpdateWhitelistedDomains Put /ng/api/authentication-settings/whitelisted-domains Updates the Whitelisted domains by accountIdentifier
AuthenticationSettingsApi UploadSamlMetaData Post /ng/api/authentication-settings/saml-metadata-upload Uploads the SAML metadata by accountId
CloudCostAnomaliesApi GetAnomaliesSummary Post /ccm/api/anomaly/summary List Anomalies
CloudCostAnomaliesApi ListAnomalies Post /ccm/api/anomaly List Anomalies
CloudCostAnomaliesApi ListPerspectiveAnomalies Post /ccm/api/anomaly/perspective/{perspectiveId} List Anomalies for Perspective
CloudCostAnomaliesApi ReportAnomalyFeedback Put /ccm/api/anomaly/feedback Report Anomaly feedback
CloudCostAutoStoppingFixedSchedulesApi CreateAutoStoppingSchedules Post /lw/api/accounts/{account_id}/schedules Create a fixed schedule for an AutoStopping Rule
CloudCostAutoStoppingFixedSchedulesApi DeleteAutoStoppingSchedule Delete /lw/api/accounts/{account_id}/schedules/{schedule_id} Delete a fixed schedule for AutoStopping Rule.
CloudCostAutoStoppingFixedSchedulesApi ListAutoStoppingSchedules Get /lw/api/accounts/{account_id}/schedules Return all the AutoStopping Rule fixed schedules
CloudCostAutoStoppingLoadBalancersApi AccessPointRules Get /lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}/rules Return all the AutoStopping Rules in a load balancer
CloudCostAutoStoppingLoadBalancersApi CreateLoadBalancer Post /lw/api/accounts/{account_id}/autostopping/loadbalancers Create a load balancer
CloudCostAutoStoppingLoadBalancersApi DeleteLoadBalancer Delete /lw/api/accounts/{account_id}/autostopping/loadbalancers Delete load balancers and the associated resources
CloudCostAutoStoppingLoadBalancersApi DescribeLoadBalancer Get /lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id} Return details of a load balancer
CloudCostAutoStoppingLoadBalancersApi EditLoadBalancer Put /lw/api/accounts/{account_id}/autostopping/loadbalancers Update a load balancer
CloudCostAutoStoppingLoadBalancersApi ListLoadBalancers Get /lw/api/accounts/{account_id}/autostopping/loadbalancers Return all the load balancers
CloudCostAutoStoppingLoadBalancersApi LoadBalancerActivity Get /lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}/last_active_at Return last activity details of a load balancer
CloudCostAutoStoppingRulesApi AllAutoStoppingResources Get /lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/resources List all the resources for an AutoStopping Rule
CloudCostAutoStoppingRulesApi AutoStoppingRuleDetails Get /lw/api/accounts/{account_id}/autostopping/rules/{rule_id} Return AutoStopping Rule details
CloudCostAutoStoppingRulesApi CumulativeAutoStoppingSavings Get /lw/api/accounts/{account_id}/autostopping/rules/savings/cumulative Return cumulative savings for all the AutoStopping Rules
CloudCostAutoStoppingRulesApi DeleteAutoStoppingRule Delete /lw/api/accounts/{account_id}/autostopping/rules/{rule_id} Delete an AutoStopping Rule
CloudCostAutoStoppingRulesApi GetAutoStoppingDiagnostics Get /lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/diagnostics Return diagnostics result of an AutoStopping Rule
CloudCostAutoStoppingRulesApi HealthOfAutoStoppingRule Get /lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/health Return health status of an AutoStopping Rule
CloudCostAutoStoppingRulesApi ListAutoStoppingRules Get /lw/api/accounts/{account_id}/autostopping/rules List AutoStopping Rules
CloudCostAutoStoppingRulesApi SavingsFromAutoStoppingRule Get /lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/savings Return savings details for an AutoStopping Rule
CloudCostAutoStoppingRulesApi ToggleAutostoppingRule Put /lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/toggle_state Disable/Enable an Autostopping Rule
CloudCostAutoStoppingRulesApi UpdateAutoStoppingRule Post /lw/api/accounts/{account_id}/autostopping/rules Create an AutoStopping Rule
CloudCostBudgetsApi CloneBudget Post /ccm/api/budgets/{id} Clone a budget
CloudCostBudgetsApi CreateBudget Post /ccm/api/budgets Create a Budget
CloudCostBudgetsApi DeleteBudget Delete /ccm/api/budgets/{id} Delete a budget
CloudCostBudgetsApi GetBudget Get /ccm/api/budgets/{id} Fetch Budget details
CloudCostBudgetsApi GetCostDetails Get /ccm/api/budgets/{id}/costDetails Fetch the cost details of a Budget
CloudCostBudgetsApi ListBudgets Get /ccm/api/budgets List all the Budgets
CloudCostBudgetsApi ListBudgetsForPerspective Get /ccm/api/budgets/perspectiveBudgets List all the Budgets associated with a Perspective
CloudCostBudgetsApi UpdateBudget Put /ccm/api/budgets/{id} Update an existing budget
CloudCostDetailsApi Costdetailoverview Post /ccm/api/costdetails/overview Returns an overview of the cost
CloudCostDetailsApi Costdetailtabular Post /ccm/api/costdetails/tabularformat Returns cost details in a tabular format
CloudCostDetailsApi Costdetailttimeseries Post /ccm/api/costdetails/timeseriesformat Returns cost details in a time series format
CloudCostPerspectiveReportsApi CreateReportSetting Post /ccm/api/perspectiveReport/{accountIdentifier} Create a schedule for a Report
CloudCostPerspectiveReportsApi DeleteReportSetting Delete /ccm/api/perspectiveReport/{accountIdentifier} Delete cost Perspective report
CloudCostPerspectiveReportsApi GetReportSetting Get /ccm/api/perspectiveReport/{accountIdentifier} Fetch details of a cost Report
CloudCostPerspectiveReportsApi UpdateReportSetting Put /ccm/api/perspectiveReport/{accountIdentifier} Update a cost Perspective Report
CloudCostPerspectivesApi CreatePerspective Post /ccm/api/perspective Create a Perspective
CloudCostPerspectivesApi DeletePerspective Delete /ccm/api/perspective Delete a Perspective
CloudCostPerspectivesApi GetAllPerspectives Get /ccm/api/perspective/getAllPerspectives Return details of all the Perspectives
CloudCostPerspectivesApi GetLastPeriodCost Get /ccm/api/perspective/lastPeriodCost Get the last period cost for a Perspective
CloudCostPerspectivesApi GetPerspective Get /ccm/api/perspective Fetch details of a Perspective
CloudCostPerspectivesApi UpdatePerspective Put /ccm/api/perspective Update a Perspective
CloudCostRecommendationsApi ListRecommendations Post /ccm/api/recommendation/overview/list Return the list of Recommendations
CloudCostRecommendationsApi RecommendationFilterValues Post /ccm/api/recommendation/overview/filter-values Return the list of filter values for the Recommendations
CloudCostRecommendationsApi RecommendationStats Post /ccm/api/recommendation/overview/stats Return Recommendations statistics
CloudCostRecommendationsApi RecommendationsCount Post /ccm/api/recommendation/overview/count Return the number of Recommendations
CloudCostRecommendationsDetailsApi EcsRecommendationDetail Get /ccm/api/recommendation/details/ecs-service Return ECS Recommendation
CloudCostRecommendationsDetailsApi NodeRecommendationDetail Get /ccm/api/recommendation/details/node-pool Return node pool Recommendation
CloudCostRecommendationsDetailsApi WorkloadRecommendationDetail Get /ccm/api/recommendation/details/workload Return workload Recommendation
ConnectorsApi CreateConnector Post /ng/api/connectors Creates a Connector
ConnectorsApi DeleteConnector Delete /ng/api/connectors/{identifier} Deletes Connector by ID
ConnectorsApi GetAllAllowedFieldValues Get /ng/api/connectors/fieldValues Get the allowed field values by Connector Type
ConnectorsApi GetCEAwsTemplate Post /ng/api/connectors/getceawstemplateurl Get the Template URL of connector
ConnectorsApi GetConnector Get /ng/api/connectors/{identifier} Get the Connector by accountIdentifier and connectorIdentifier
ConnectorsApi GetConnectorCatalogue Get /ng/api/connectors/catalogue Gets the Connector catalogue by Account Identifier
ConnectorsApi GetConnectorList Get /ng/api/connectors Fetches the list of Connectors corresponding to the request's filter criteria.
ConnectorsApi GetConnectorListV2 Post /ng/api/connectors/listV2 Fetches the list of Connectors corresponding to the request's filter criteria.
ConnectorsApi GetConnectorStatistics Get /ng/api/connectors/stats Gets the connector's statistics by Account Identifier, Project Identifier and Organization Identifier
ConnectorsApi GetTestConnectionResult Post /ng/api/connectors/testConnection/{identifier} Tests the connection of the Connector by ID
ConnectorsApi GetTestGitRepoConnectionResult Post /ng/api/connectors/testGitRepoConnection/{identifier} Tests the Git Repo connection
ConnectorsApi ListConnectorByFQN Post /ng/api/connectors/listbyfqn Get the list of connectors by FQN satisfying the criteria (if any) in the request
ConnectorsApi UpdateConnector Put /ng/api/connectors Updates the Connector
ConnectorsApi ValidateTheIdentifierIsUnique Get /ng/api/connectors/validateUniqueIdentifier Validate the Connector by Account Identifier and Connector Identifier
DelegateGroupTagsResourceApi AddTagsToDelegateGroup Post /ng/api/delegate-group-tags/{groupIdentifier} Add given list of tags to the Delegate group
DelegateGroupTagsResourceApi DeleteTagsFromDelegateGroup Delete /ng/api/delegate-group-tags/{groupIdentifier} Deletes all tags from the Delegate group
DelegateGroupTagsResourceApi ListTagsForDelegateGroup Get /ng/api/delegate-group-tags/{groupIdentifier} Retrieves list of tags attached with Delegate group
DelegateGroupTagsResourceApi UpdateTagsOfDelegateGroup Put /ng/api/delegate-group-tags/{groupIdentifier} Clears all existing tags with delegate group and attach given set of tags to delegate group.
DelegateTokenResourceApi CreateDelegateToken Post /ng/api/delegate-token-ng Creates Delegate Token.
DelegateTokenResourceApi GetDelegateGroupsUsingToken Get /ng/api/delegate-token-ng/delegate-groups Lists delegate groups that are using the specified delegate token.
DelegateTokenResourceApi GetDelegateTokens Get /ng/api/delegate-token-ng Retrieves Delegate Tokens by Account, Organization, Project and status.
DelegateTokenResourceApi RevokeDelegateToken Put /ng/api/delegate-token-ng Revokes Delegate Token.
EnvironmentsApi CreateEnvironmentV2 Post /ng/api/environmentsV2 Create an Environment
EnvironmentsApi DeleteEnvironmentV2 Delete /ng/api/environmentsV2/{environmentIdentifier} Delete an Environment by identifier
EnvironmentsApi GetEnvironmentAccessList Get /ng/api/environmentsV2/list/access Gets Environment Access list
EnvironmentsApi GetEnvironmentList Get /ng/api/environmentsV2 Gets Environment list for a project
EnvironmentsApi GetEnvironmentV2 Get /ng/api/environmentsV2/{environmentIdentifier} Gets an Environment by identifier
EnvironmentsApi UpdateEnvironmentV2 Put /ng/api/environmentsV2 Update an Environment by identifier
EnvironmentsApi UpsertEnvironmentV2 Put /ng/api/environmentsV2/upsert Upsert an Environment by identifier
EnvironmentsApi ImportEnvironment Post /ng/api/environmentsV2/import Get Environment YAML from Git Repository
ExecuteApi GetPreFlightCheckResponse Get /pipeline/api/pipeline/execute/getPreflightCheckResponse Get Preflight Checks Response for a Preflight Id
ExecuteApi GetRetryStages Get /pipeline/api/pipeline/execute/{planExecutionId}/retryStages Get retry stages for failed pipeline
ExecuteApi GetStagesExecutionList Get /pipeline/api/pipeline/execute/stagesExecutionList Get list of Stages to select for Stage executions
ExecuteApi HandleManualInterventionInterrupt Put /pipeline/api/pipeline/execute/manualIntervention/interrupt/{planExecutionId}/{nodeExecutionId} Handles Ignore,Abort,MarkAsSuccess,Retry on post manual intervention for a given execution with the given planExecutionId
ExecuteApi HandleStageInterrupt Put /pipeline/api/pipeline/execute/interrupt/{planExecutionId}/{nodeExecutionId} Handles the interrupt for a given stage in a pipeline
ExecuteApi LatestExecutionId Get /pipeline/api/pipeline/execute/latestExecutionId/{planExecutionId} Latest ExecutionId from Retry Executions
ExecuteApi PostExecuteStages Post /pipeline/api/pipeline/execute/{identifier}/stages Execute given Stages of a Pipeline
ExecuteApi PostPipelineExecuteWithInputSetList Post /pipeline/api/pipeline/execute/{identifier}/inputSetList Execute a pipeline with input set references list
ExecuteApi PostPipelineExecuteWithInputSetYaml Post /pipeline/api/pipeline/execute/{identifier} Execute a pipeline with inputSet pipeline yaml
ExecuteApi PostReExecuteStages Post /pipeline/api/pipeline/execute/rerun/{originalExecutionId}/{identifier}/stages Re-run given Stages of a Pipeline
ExecuteApi PutHandleInterrupt Put /pipeline/api/pipeline/execute/interrupt/{planExecutionId} Execute an Interrupt on an execution
ExecuteApi RePostPipelineExecuteWithInputSetYaml Post /pipeline/api/pipeline/execute/rerun/{originalExecutionId}/{identifier} Re Execute a pipeline with inputSet pipeline yaml
ExecuteApi RerunPipelineWithInputSetIdentifierList Post /pipeline/api/pipeline/execute/rerun/{originalExecutionId}/{identifier}/inputSetList Rerun a pipeline with given inputSet identifiers
ExecuteApi RetryHistory Get /pipeline/api/pipeline/execute/retryHistory/{planExecutionId} Retry History for a given execution
ExecuteApi RetryPipeline Post /pipeline/api/pipeline/execute/retry/{identifier} Retry a executed pipeline with inputSet pipeline yaml
ExecuteApi StartPreFlightCheck Post /pipeline/api/pipeline/execute/preflightCheck Start Preflight Checks for a Pipeline
ExecutionDetailsApi GetExecutionDetail Get /pipeline/api/pipelines/execution/{planExecutionId} Get the Pipeline Execution details for given PlanExecution Id
ExecutionDetailsApi GetExecutionDetailV2 Get /pipeline/api/pipelines/execution/v2/{planExecutionId} Get the Pipeline Execution details for given PlanExecution Id without full graph unless specified explicitly
ExecutionDetailsApi GetInputsetYaml Get /pipeline/api/pipelines/execution/{planExecutionId}/inputset Get the Input Set YAML used for given Plan Execution
ExecutionDetailsApi GetInputsetYamlV2 Get /pipeline/api/pipelines/execution/{planExecutionId}/inputsetV2 Get the Input Set YAML used for given Plan Execution
ExecutionDetailsApi GetListOfExecutions Post /pipeline/api/pipelines/execution/summary Gets list of Executions of Pipelines for specific filters.
FeatureFlagsApi CreateFeatureFlag Post /cf/admin/features Creates a Feature Flag
FeatureFlagsApi DeleteFeatureFlag Delete /cf/admin/features/{identifier} Delete a Feature Flag
FeatureFlagsApi GetAllFeatures Get /cf/admin/features Returns all Feature Flags for the project
FeatureFlagsApi GetFeatureFlag Get /cf/admin/features/{identifier} Returns a Feature Flag
FeatureFlagsApi PatchFeature Patch /cf/admin/features/{identifier} Updates a Feature Flag
FileStoreApi Create Post /ng/api/file-store Creates file or folder
FileStoreApi DeleteFile Delete /ng/api/file-store/{identifier} Delete file or folder by identifier
FileStoreApi DownloadFile Get /ng/api/file-store/file/{fileIdentifier}/download Download File
FileStoreApi GetFolderNodes Post /ng/api/file-store/folder Get Folder nodes.
FileStoreApi Update Put /ng/api/file-store/{identifier} Updates file or folder
FilterApi DeleteFilter Delete /ng/api/filters/{identifier} Delete a Filter by identifier
FilterApi GetConnectorListV21 Get /ng/api/filters Get the list of Filters satisfying the criteria (if any) in the request
FilterApi GetFilter Get /ng/api/filters/{identifier} Gets a Filter by identifier
FilterApi PipelinedeleteFilter Delete /pipeline/api/filters/{identifier} Delete a Filter by identifier
FilterApi PipelinegetConnectorListV2 Get /pipeline/api/filters Get the list of Filters satisfying the criteria (if any) in the request
FilterApi PipelinegetFilter Get /pipeline/api/filters/{identifier} Gets a Filter by identifier
FilterApi PipelinepostFilter Post /pipeline/api/filters Creates a Filter
FilterApi PipelineupdateFilter Put /pipeline/api/filters Updates the Filter
FilterApi PostFilter Post /ng/api/filters Creates a Filter
FilterApi UpdateFilter Put /ng/api/filters Updates the Filter
GitBranchesApi GetListOfBranchesWithStatus Get /ng/api/git-sync-branch/listBranchesWithStatus Lists branches with their status(Synced, Unsynced) by Git Sync Config Id for the given scope
GitBranchesApi SyncGitBranch Post /ng/api/git-sync-branch/sync Sync the content of new Git Branch into harness with Git Sync Config Id
GitFullSyncApi CreateGitFullSyncConfig Post /ng/api/git-full-sync/config Create Configuration for Git Full Sync for the provided scope
GitFullSyncApi GetGitFullSyncConfig Get /ng/api/git-full-sync/config Fetch Configuration for Git Full Sync for the provided scope
GitFullSyncApi ListFullSyncFiles Post /ng/api/git-full-sync/files List files in full sync along with their status
GitFullSyncApi TriggerFullSync Post /ng/api/git-full-sync Trigger Full Sync
GitFullSyncApi UpdateGitFullSyncConfig Put /ng/api/git-full-sync/config Update Configuration for Git Full Sync for the provided scope
GitSyncApi CreateGitSyncConfig Post /ng/api/git-sync Creates Git Sync Config in given scope
GitSyncApi GetGitSyncConfigList Get /ng/api/git-sync Lists Git Sync Config for the given scope
GitSyncApi IsGitSyncEnabled Get /ng/api/git-sync/git-sync-enabled Check whether Git Sync is enabled for given scope or not
GitSyncApi UpdateDefaultFolder Put /ng/api/git-sync/{identifier}/folder/{folderIdentifier}/default Update existing Git Sync Config default root folder by Identifier
GitSyncApi UpdateGitSyncConfig Put /ng/api/git-sync Update existing Git Sync Config by Identifier
GitSyncErrorsApi GetGitSyncErrorsCount Get /ng/api/git-sync-errors/count Get Errors Count for the given scope, Repo and Branch
GitSyncErrorsApi ListGitSyncErrors Get /ng/api/git-sync-errors Lists Git to Harness Errors by file or connectivity errors for the given scope, Repo and Branch
GitSyncErrorsApi ListGitToHarnessErrorForCommit Get /ng/api/git-sync-errors/commits/{commitId} Lists Git to Harness Errors for the given Commit Id
GitSyncErrorsApi ListGitToHarnessErrorsGroupedByCommits Get /ng/api/git-sync-errors/aggregate Lists Git to Harness Errors grouped by Commits for the given scope, Repo and Branch
GitSyncSettingsApi CreateGitSyncSetting Post /ng/api/git-sync-settings Creates Git Sync Setting in a scope
GitSyncSettingsApi GetGitSyncSettings Get /ng/api/git-sync-settings Get Git Sync Setting for the given scope
GitSyncSettingsApi UpdateGitSyncSetting Put /ng/api/git-sync-settings This updates the existing Git Sync settings within the scope. Only changing Connectivity Mode is allowed
HarnessResourceGroupApi CreateResourceGroup Post /resourcegroup/api/resourcegroup Create a resource group
HarnessResourceGroupApi CreateResourceGroupV2 Post /resourcegroup/api/v2/resourcegroup Create a resource group
HarnessResourceGroupApi DeleteResourceGroup Delete /resourcegroup/api/resourcegroup/{identifier} Delete a resource group
HarnessResourceGroupApi DeleteResourceGroupV2 Delete /resourcegroup/api/v2/resourcegroup/{identifier} Delete a resource group
HarnessResourceGroupApi GetFilterResourceGroupList Post /resourcegroup/api/resourcegroup/filter This fetches a filtered list of Resource Groups
HarnessResourceGroupApi GetFilterResourceGroupListV2 Post /resourcegroup/api/v2/resourcegroup/filter This fetches a filtered list of Resource Groups
HarnessResourceGroupApi GetResourceGroup Get /resourcegroup/api/resourcegroup/{identifier} Get a resource group by identifier
HarnessResourceGroupApi GetResourceGroupList Get /resourcegroup/api/resourcegroup Get list of resource groups
HarnessResourceGroupApi GetResourceGroupListV2 Get /resourcegroup/api/v2/resourcegroup Get list of resource groups
HarnessResourceGroupApi GetResourceGroupV2 Get /resourcegroup/api/v2/resourcegroup/{identifier} Get a resource group by identifier
HarnessResourceGroupApi UpdateResourceGroup Put /resourcegroup/api/resourcegroup/{identifier} Update a resource group
HarnessResourceGroupApi UpdateResourceGroup1 Put /resourcegroup/api/v2/resourcegroup/{identifier} Update a resource group
HarnessResourceTypeApi GetResourceTypes Get /resourcegroup/api/resourcetype Gets all resource types available at this scope
HostsApi FilterHostsByConnector Post /ng/api/hosts/filter Gets the list of hosts filtered by accountIdentifier and connectorIdentifier
InputSetsApi DeleteInputSet Delete /pipeline/api/inputSets/{inputSetIdentifier} Delete the Input Set by Identifier
InputSetsApi GetInputSet Get /pipeline/api/inputSets/{inputSetIdentifier} Gets Input Set for a given identifier. Throws error if no Input Set exists for the given identifier.
InputSetsApi GetOverlayInputSet Get /pipeline/api/inputSets/overlay/{inputSetIdentifier} Gets an Overlay Input Set by identifier
InputSetsApi ListInputSet Get /pipeline/api/inputSets List all Input Sets for a pipeline
InputSetsApi MergeInputSets Post /pipeline/api/inputSets/merge Merge given Input Sets into a single Runtime Input YAML
InputSetsApi MergeRuntimeInputIntoPipeline Post /pipeline/api/inputSets/mergeWithTemplateYaml Merge given Runtime Input YAML into the Pipeline
InputSetsApi PostInputSet Post /pipeline/api/inputSets Create an Input Set for a Pipeline
InputSetsApi PostOverlayInputSet Post /pipeline/api/inputSets/overlay Create an Overlay Input Set for a pipeline
InputSetsApi PutInputSet Put /pipeline/api/inputSets/{inputSetIdentifier} Update Input Set for Pipeline
InputSetsApi PutOverlayInputSet Put /pipeline/api/inputSets/overlay/{inputSetIdentifier} Update an Overlay Input Set for a pipeline
InputSetsApi RuntimeInputTemplate Post /pipeline/api/inputSets/template Fetch Runtime Input Template for a Pipeline
InviteApi DeleteInvite Delete /ng/api/invites/{inviteId} Delete an Invite by Identifier
InviteApi GetInvite Get /ng/api/invites/invite Gets an Invite by either Invite Id or JwtToken
InviteApi GetInvites Get /ng/api/invites List all the Invites for a Project or Organization
InviteApi GetPendingUsersAggregated Post /ng/api/invites/aggregate List of all the Invites pending users
InviteApi SendInvite Post /ng/api/invites Send a user Invite to either Project or Organization (Deprecated). Please use the /user/users API to invite users
InviteApi UpdateInvite Put /ng/api/invites/{inviteId} Resend the Invite email
LicensesApi ExtendTrialLicense Post /ng/api/licenses/extend-trial Extends Trial License For A Module
LicensesApi GetAccountLicenses Get /ng/api/licenses/account Gets All Module License Information in Account
LicensesApi GetEditionActions Get /ng/api/licenses/actions Get Allowed Actions Under Each Edition
LicensesApi GetLastModifiedTimeForAllModuleTypes Post /ng/api/licenses/versions Get Last Modified Time Under Each ModuleType
LicensesApi GetLicensesAndSummary Get /ng/api/licenses/{accountIdentifier}/summary Gets Module Licenses With Summary By Account And ModuleType
LicensesApi GetModuleLicenseById Get /ng/api/licenses/{identifier} Gets Module License
LicensesApi GetModuleLicensesByAccountAndModuleType Get /ng/api/licenses/modules/{accountIdentifier} Gets Module Licenses By Account And ModuleType
LicensesApi StartFreeLicense Post /ng/api/licenses/free Starts Free License For A Module
LicensesApi StartTrialLicense Post /ng/api/licenses/trial Starts Trial License For A Module
MonitoredServiceApi DeleteMonitoredService Delete /monitored-service/{identifier} delete monitored service data
MonitoredServiceApi GetMonitoredService Get /monitored-service/{identifier} get monitored service data
MonitoredServiceApi SaveMonitoredService Post /monitored-service saves monitored service data
MonitoredServiceApi UpdateMonitoredService Put /monitored-service/{identifier} updates monitored service data
OrganizationApi DeleteOrganization Delete /ng/api/organizations/{identifier} Deletes the Organization corresponding to the specified Organization ID.
OrganizationApi GetOrganization Get /ng/api/organizations/{identifier} Get the Organization by accountIdentifier and orgIdentifier
OrganizationApi GetOrganizationList Get /ng/api/organizations Get the list of Organizations satisfying the criteria (if any) in the request
OrganizationApi PostOrganization Post /ng/api/organizations Creates an Organization
OrganizationApi PutOrganization Put /ng/api/organizations/{identifier} Updates the Organization
PermissionsApi GetPermissionList Get /authz/api/permissions Get all permissions in a scope or all permissions in the system.
PermissionsApi GetPermissionResourceTypesList Get /authz/api/permissions/resourcetypes Get all resource types for permissions in a scope or in the system.
PipelinesApi DeletePipeline Delete /pipeline/api/pipelines/{pipelineIdentifier} Deletes a Pipeline
PipelinesApi GetExecutionNode Get /pipeline/api/pipelines/getExecutionNode Get the Execution Node by Execution Id
PipelinesApi GetExpandedPipelineJSON Get /pipeline/api/pipelines/expandedJSON/{pipelineIdentifier} Gets Pipeline JSON with extra info for some fields
PipelinesApi GetPipeline Get /pipeline/api/pipelines/{pipelineIdentifier} Gets a Pipeline by identifier
PipelinesApi GetPipelineList Post /pipeline/api/pipelines/list List of pipelines
PipelinesApi GetPipelineSummary Get /pipeline/api/pipelines/summary/{pipelineIdentifier} Gets pipeline summary by pipeline identifier
PipelinesApi GetStepsV2 Post /pipeline/api/pipelines/v2/steps Gets all the Steps for given Category (V2 Version)
PipelinesApi PostPipeline Post /pipeline/api/pipelines Create a Pipeline
PipelinesApi PostPipeline1 Post /pipeline/api/pipelines/validate-yaml-with-schema Validate a Pipeline YAML with Schema
PipelinesApi PostPipeline2 Post /pipeline/api/pipelines/validate-pipeline-with-schema Validate a Pipeline with Schema
PipelinesApi PostPipelineV2 Post /pipeline/api/pipelines/v2 Create a Pipeline API With Governance Checks
PipelinesApi UpdatePipeline Put /pipeline/api/pipelines/{pipelineIdentifier} Update a Pipeline by identifier
PipelinesApi UpdatePipelineV2 Put /pipeline/api/pipelines/v2/{pipelineIdentifier} Updates a Pipeline by identifier with Governance checks
PipelinesDashboardApi GetPipelineDashboardExecution Get /pipeline/api/dashboard/pipelineExecution Fetches Pipeline Executions details for a given Interval and will be presented in day wise format
PipelinesDashboardApi GetPipelineExecution Get /pipeline/api/pipelines/pipelineExecution Fetches Pipeline Executions details for a given Interval and will be presented in day wise format
PipelinesDashboardApi GetPipelinedHealth Get /pipeline/api/pipelines/pipelineHealth Fetches Pipeline Health data for a given Interval and will be presented in day wise format
PipelinesDashboardApi GetPipelinedHealth1 Get /pipeline/api/dashboard/pipelineHealth Fetches Pipeline Health data for a given Interval and will be presented in day wise format
ProjectApi DeleteProject Delete /ng/api/projects/{identifier} Deletes the Project corresponding to the specified Project ID.
ProjectApi GetProject Get /ng/api/projects/{identifier} Gets a Project by ID
ProjectApi GetProjectList Get /ng/api/projects List user's project
ProjectApi GetProjectListWithMultiOrgFilter Get /ng/api/projects/list List user's project with support to filter by multiple organizations
ProjectApi PostProject Post /ng/api/projects Creates a Project
ProjectApi PutProject Put /ng/api/projects/{identifier} Update Project by ID
RoleAssignmentsApi DeleteRoleAssignment Delete /authz/api/roleassignments/{identifier} Delete an existing role assignment by identifier
RoleAssignmentsApi GetFilteredRoleAssignmentList Post /authz/api/roleassignments/filter List role assignments in the scope according to the given filter
RoleAssignmentsApi GetRoleAssignmentAggregateList Post /authz/api/roleassignments/aggregate List role assignments in the scope according to the given filter with added metadata
RoleAssignmentsApi GetRoleAssignmentList Get /authz/api/roleassignments List role assignments in the given scope
RoleAssignmentsApi PostRoleAssignment Post /authz/api/roleassignments Creates role assignment within the specified scope.
RoleAssignmentsApi PostRoleAssignments Post /authz/api/roleassignments/multi Create multiple role assignments in a scope. Returns all successfully created role assignments. Ignores failures and duplicates.
RoleAssignmentsApi PutRoleAssignment Put /authz/api/roleassignments/{identifier} Update existing role assignment by identifier and scope. Only changing the disabled/enabled state is allowed.
RoleAssignmentsApi ValidateRoleAssignment Post /authz/api/roleassignments/validate Check whether a proposed role assignment is valid.
RolesApi DeleteRole Delete /authz/api/roles/{identifier} Delete a Custom Role in a scope
RolesApi GetRole Get /authz/api/roles/{identifier} Get a Role by identifier
RolesApi GetRoleList Get /authz/api/roles List roles in the given scope
RolesApi PostRole Post /authz/api/roles Create a Custom Role in a scope
RolesApi PutRole Put /authz/api/roles/{identifier} Update a Custom Role by identifier
SCIMApi CreateUser Post /ng/api/scim/account/{accountIdentifier}/Users
SCIMApi DeleteUser Delete /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
SCIMApi GetUser Get /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
SCIMApi SearchUser Get /ng/api/scim/account/{accountIdentifier}/Users
SCIMApi UpdateUser Patch /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
SCIMApi UpdateUser1 Put /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
SCMApi CreatePR Post /ng/api/scm/createPR creates a Pull Request
SCMApi GetFileContent Get /ng/api/scm/fileContent Gets Git File Content
SCMApi GetListOfBranchesByConnector Get /ng/api/scm/listRepoBranches Lists Branches of given Repo by referenced Connector Identifier
SCMApi GetListOfBranchesByGitConfig Get /ng/api/scm/listBranchesByGitConfig Lists Branches by given Git Sync Config Id
SMTPApi CreateSmtpConfig Post /ng/api/smtpConfig Creates SMTP config
SMTPApi DeleteSmtpConfig Delete /ng/api/smtpConfig/{identifier} Delete Smtp Config by identifier
SMTPApi GetSmtpConfig Get /ng/api/smtpConfig Gets Smtp config by accountId
SMTPApi UpdateSmtp Put /ng/api/smtpConfig Updates the Smtp Config
SMTPApi ValidateConnectivity Post /ng/api/smtpConfig/validate-connectivity Tests the config's connectivity by sending a test email
SMTPApi ValidateName Post /ng/api/smtpConfig/validateName Checks whether other connectors exist with the same name
SecretManagersApi GetMetadata Post /ng/api/secret-managers/meta-data Gets the metadata of Secret Manager
SecretsApi DeleteSecretV2 Delete /ng/api/v2/secrets/{identifier} Deletes Secret by ID and Scope
SecretsApi GetSecretV2 Get /ng/api/v2/secrets/{identifier} Get the Secret by ID and Scope
SecretsApi ListSecretsV2 Get /ng/api/v2/secrets Fetches the list of Secrets corresponding to the request's filter criteria.
SecretsApi ListSecretsV3 Post /ng/api/v2/secrets/list Fetches the list of Secrets corresponding to the request's filter criteria.
SecretsApi PostSecret Post /ng/api/v2/secrets Creates a Secret at given Scope
SecretsApi PostSecretFileV2 Post /ng/api/v2/secrets/files Creates a Secret File
SecretsApi PostSecretViaYaml Post /ng/api/v2/secrets/yaml Creates a secret via YAML
SecretsApi PutSecret Put /ng/api/v2/secrets/{identifier} Updates the Secret by ID and Scope
SecretsApi PutSecretFileV2 Put /ng/api/v2/secrets/files/{identifier} Updates the Secret file by ID and Scope
SecretsApi PutSecretViaYaml Put /ng/api/v2/secrets/{identifier}/yaml Updates the Secret by ID and Scope via YAML
SecretsApi ValidateSecret Post /ng/api/v2/secrets/validate Validates Secret with the provided ID and Scope
SecretsApi ValidateSecretIdentifierIsUnique Get /ng/api/v2/secrets/validateUniqueIdentifier/{identifier} Checks whether the identifier is unique or not
ServiceAccountApi CreateServiceAccount Post /ng/api/serviceaccount Creates a Service Account
ServiceAccountApi DeleteServiceAccount Delete /ng/api/serviceaccount/{identifier} Deletes Service Account by ID
ServiceAccountApi GetAggregatedServiceAccount Get /ng/api/serviceaccount/aggregate/{identifier} Get the Service Account by accountIdentifier and Service Account ID and Scope.
ServiceAccountApi ListAggregatedServiceAccounts Get /ng/api/serviceaccount/aggregate Fetches the list of Aggregated Service Accounts corresponding to the request's filter criteria.
ServiceAccountApi ListServiceAccount Get /ng/api/serviceaccount Fetches the list of Service Accounts corresponding to the request's filter criteria.
ServiceAccountApi UpdateServiceAccount Put /ng/api/serviceaccount/{identifier} Updates the Service Account.
ServicesApi CreateServiceV2 Post /ng/api/servicesV2 Create a Service
ServicesApi CreateServicesV2 Post /ng/api/servicesV2/batch Create Services
ServicesApi DeleteServiceV2 Delete /ng/api/servicesV2/{serviceIdentifier} Delete a Service by identifier
ServicesApi GetServiceAccessList Get /ng/api/servicesV2/list/access Gets Service Access list
ServicesApi GetServiceList Get /ng/api/servicesV2 Gets Service list
ServicesApi GetServiceV2 Get /ng/api/servicesV2/{serviceIdentifier} Gets a Service by identifier
ServicesApi UpdateServiceV2 Put /ng/api/servicesV2 Update a Service by identifier
ServicesApi UpsertServiceV2 Put /ng/api/servicesV2/upsert Upsert a Service by identifier
ServicesApi ImportService Post /ng/api/servicesV2/import Get Service YAML from Git Repository
ServiceOverridesApi CreateServiceOverrideV2 Post /serviceOverrides Create an ServiceOverride Entity
ServiceOverridesApi DeleteServiceOverrideV2 Delete /serviceOverrides/{identifier} Delete a Service Override entity
ServiceOverridesApi GetServiceOverridesV2 Get /serviceOverrides/get-with-yaml/{identifier} Gets Service Overrides by Identifier
ServiceOverridesApi UpdateServiceOverrideV2 Put /serviceOverrides Update an ServiceOverride Entity
ServiceOverridesApi ImportServiceOverrides Post /serviceOverrides/import import Service Overrides from remote
SloApi DeleteSLODataNg Delete /account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier} delete slo data
SloApi GetServiceLevelObjectiveNg Get /account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier} get service level objective data
SloApi SaveSLODataNg Post /account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2 saves slo data
SloApi UpdateSLODataNg Put /account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier} update slo data
SourceCodeManagerApi CreateSourceCodeManager Post /ng/api/source-code-manager Creates Source Code Manager
SourceCodeManagerApi DeleteSourceCodeManager Delete /ng/api/source-code-manager/{identifier} Deletes the Source Code Manager corresponding to the specified Source Code Manager Id
SourceCodeManagerApi GetSourceCodeManagers Get /ng/api/source-code-manager Lists Source Code Managers for the given account
SourceCodeManagerApi UpdateSourceCodeManager Put /ng/api/source-code-manager/{identifier} Updates Source Code Manager Details with the given Source Code Manager Id
TargetGroupsApi CreateSegment Post /cf/admin/segments Creates a Target Group
TargetGroupsApi DeleteSegment Delete /cf/admin/segments/{identifier} Deletes a Target Group
TargetGroupsApi GetAllSegments Get /cf/admin/segments Returns all Target Groups
TargetGroupsApi GetAvailableFlagsForSegment Get /cf/admin/segments/{identifier}/available_flags Returns Feature Flags that are available to be added to the given Target Group
TargetGroupsApi GetSegment Get /cf/admin/segments/{identifier} Returns Target Group details for the given identifier
TargetGroupsApi GetSegmentFlags Get /cf/admin/segments/{identifier}/flags Returns Feature Flags in a Target Group
TargetGroupsApi PatchSegment Patch /cf/admin/segments/{identifier} Updates a Target Group
TargetsApi CreateTarget Post /cf/admin/targets Creates a Target
TargetsApi DeleteTarget Delete /cf/admin/targets/{identifier} Deletes a Target
TargetsApi GetAllTargets Get /cf/admin/targets Returns all Targets
TargetsApi GetTarget Get /cf/admin/targets/{identifier} Returns details of a Target
TargetsApi GetTargetSegments Get /cf/admin/targets/{identifier}/segments Returns Target Groups for the given Target
TargetsApi ModifyTarget Put /cf/admin/targets/{identifier} Modifies a Target
TargetsApi PatchTarget Patch /cf/admin/targets/{identifier} Updates a Target
TargetsApi UploadTargets Post /cf/admin/targets/upload Add Target details
TokenApi CreateToken Post /ng/api/token Creates a Token
TokenApi DeleteToken Delete /ng/api/token/{identifier} Deletes a Token by ID
TokenApi ListAggregatedTokens Get /ng/api/token/aggregate Fetches the list of Aggregated Tokens corresponding to the request's filter criteria.
TokenApi RotateToken Post /ng/api/token/rotate/{identifier} Rotates a Token by ID
TokenApi UpdateToken Put /ng/api/token/{identifier} Updates a Token by ID
TriggersApi CreateTrigger Post /pipeline/api/triggers Creates Trigger for triggering target pipeline identifier.
TriggersApi DeleteTrigger Delete /pipeline/api/triggers/{triggerIdentifier} Deletes Trigger by identifier.
TriggersApi GetListForTarget Get /pipeline/api/triggers Gets the paginated list of triggers for accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier.
TriggersApi GetTrigger Get /pipeline/api/triggers/{triggerIdentifier} Gets the trigger by accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier and triggerIdentifier.
TriggersApi GetTriggerDetails Get /pipeline/api/triggers/{triggerIdentifier}/details Fetches Trigger details for a specific accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier, triggerIdentifier.
TriggersApi UpdateTrigger Put /pipeline/api/triggers/{triggerIdentifier} Updates trigger for pipeline with target pipeline identifier.
TriggersApi UpdateTriggerStatus Put /pipeline/api/triggers/{triggerIdentifier}/status Activates or deactivate trigger for pipeline with target pipeline identifier.
UsageApi CcmgetCDLicenseUsageForServiceInstances Get /ccm/api/usage/CD/serviceInstancesLicense Gets License Usage By Module, Timestamp, and Account Identifier
UsageApi CcmgetCDLicenseUsageForServices Get /ccm/api/usage/CD/servicesLicense Gets License Usage By Module, Timestamp, and Account Identifier
UsageApi CcmgetLicenseUsage Get /ccm/api/usage/{module} Gets License Usage By Module, Timestamp, and Account Identifier
UsageApi GetCDLicenseUsageForServiceInstances Get /ng/api/usage/CD/serviceInstancesLicense Gets License Usage By Module, Timestamp, and Account Identifier
UsageApi GetCDLicenseUsageForServices Get /ng/api/usage/CD/servicesLicense Gets License Usage By Module, Timestamp, and Account Identifier
UsageApi GetLicenseUsage Get /ng/api/usage/{module} Gets License Usage By Module, Timestamp, and Account Identifier
UserApi AddUsers Post /ng/api/user/users Add user(s) to given scope
UserApi ChangeUserPassword Put /ng/api/user/password Updates the User password
UserApi CheckIfLastAdmin Get /ng/api/user/last-admin Boolean status whether the user is last admin at scope or not
UserApi DisableTTwoFactorAuth Put /ng/api/user/disable-two-factor-auth Disables two-factor-auth for an user in an account
UserApi EnableTwoFactorAuth Put /ng/api/user/enable-two-factor-auth Enables two-factor-auth for an user in an account
UserApi GetAccessibleProjectsCount Get /ng/api/user/projects-count Count of projects that are accessible to a user filtered by CreatedAt time
UserApi GetAggregatedUser Get /ng/api/user/aggregate/{userId} Returns the user metadata along with rolesAssignments by userId and scope
UserApi GetAggregatedUsers Post /ng/api/user/aggregate List of all the user's metadata along with rolesAssignments who have access to given scope
UserApi GetCurrentGenUsers Get /ng/api/user/currentgen List of current gen users with the given Account Identifier
UserApi GetCurrentUserInfo Get /ng/api/user/currentUser Gets current logged in User information
UserApi GetTwoFactorAuthSettings Get /ng/api/user/two-factor-auth/{authMechanism} Gets two factor authentication settings information of the current logged in user
UserApi GetUserAllProjectsInfo Get /ng/api/user/all-projects list of project(s) of current user in the passed account Id in form of List
UserApi GetUserProjectInfo Get /ng/api/user/projects Retrieves the list of projects of the current user corresponding to the specified Account Identifier.
UserApi GetUsers Post /ng/api/user/batch List of user's Metadata for a given scope
UserApi RemoveUser Delete /ng/api/user/{userId} Remove user as the collaborator from the scope
UserApi UnlockUser Put /ng/api/user/unlock-user/{userId} unlock user in a given scope
UserApi UpdateUserInfo Put /ng/api/user Updates the User information
UserGroupApi CopyUserGroup Put /ng/api/user-groups/copy Get a User Group in an account/org/project
UserGroupApi DeleteMember Delete /ng/api/user-groups/{identifier}/member/{userIdentifier} Remove a user from the user group in an account/org/project
UserGroupApi DeleteUserGroup Delete /ng/api/user-groups/{identifier} Delete a User Group in an account/org/project
UserGroupApi GetBatchUsersGroupList Post /ng/api/user-groups/batch List the User Groups selected by a filter in an account/org/project
UserGroupApi GetMember Get /ng/api/user-groups/{identifier}/member/{userIdentifier} Check if the user is part of the user group in an account/org/project
UserGroupApi GetUserGroup Get /ng/api/user-groups/{identifier} Get a User Group in an account/org/project
UserGroupApi GetUserGroupList Get /ng/api/user-groups List the User Groups in an account/org/project
UserGroupApi GetUserListInUserGroup Post /ng/api/user-groups/{identifier}/users List the users in a User Group in an account/org/project
UserGroupApi LinkUserGroupToSAML Put /ng/api/user-groups/{userGroupId}/link/saml/{samlId} Link SAML Group to the User Group in an account/org/project
UserGroupApi PostUserGroup Post /ng/api/user-groups Create User Group
UserGroupApi PostUserGroupV2 Post /ng/api/v2/user-groups Create User Group
UserGroupApi PutMember Put /ng/api/user-groups/{identifier}/member/{userIdentifier} Add user to User Group
UserGroupApi PutUserGroup Put /ng/api/user-groups Update User Group
UserGroupApi PutUserGroupV2 Put /ng/api/v2/user-groups Update User Group
UserGroupApi UnlinkUserGroupfromSSO Put /ng/api/user-groups/{userGroupId}/unlink Unlink SSO Group from the User Group in an account/org/project
ValidateHostApi ValidateSshHosts Post /ng/api/host-validation/ssh Validates hosts connectivity using SSH credentials
WebhookEventHandlerApi ProcessWebhookEvent Post /ng/api/webhook Process event payload for webhook triggers.
WebhookTriggersApi FetchWebhookDetails Get /pipeline/api/webhook/triggerProcessingDetails Gets webhook event processing details for input eventId.
WebhookTriggersApi PipelineprocessWebhookEvent Post /pipeline/api/webhook/trigger Handles event payload for webhook triggers.
WebhookTriggersApi ProcessCustomWebhookEvent Post /pipeline/api/webhook/custom Handles event payload for custom webhook triggers.

Documentation For Models

Documentation For Authorization

ApiKey

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

contact@harness.io