All URIs are relative to https://app.harness.io/gateway
Method | HTTP request | Description |
---|---|---|
CreateResourceGroup | Post /resourcegroup/api/resourcegroup | Create a resource group |
DeleteResourceGroup | Delete /resourcegroup/api/resourcegroup/{identifier} | Delete a resource group |
GetFilterResourceGroupList | Post /resourcegroup/api/resourcegroup/filter | |
GetResourceGroup | Get /resourcegroup/api/resourcegroup/{identifier} | Get a resource group by identifier |
GetResourceGroupList | Get /resourcegroup/api/resourcegroup | Get list of resource groups |
UpdateResourceGroup | Put /resourcegroup/api/resourcegroup/{identifier} | Update a resource group |
ResponseDtoResourceGroupResponse CreateResourceGroup(ctx, body, accountIdentifier, optional) Create a resource group
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
body | ResourceGroupRequest | This contains the details required to create a Resource Group | |
accountIdentifier | string | Account Identifier for the Entity | |
optional | *HarnessResourceGroupApiCreateResourceGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a HarnessResourceGroupApiCreateResourceGroupOpts struct
Name | Type | Description | Notes |
---|
orgIdentifier | optional.| Organization Identifier for the Entity | projectIdentifier | optional.| Project Identifier for the Entity |
ResponseDtoResourceGroupResponse
- Content-Type: application/json, application/yaml
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoBoolean DeleteResourceGroup(ctx, identifier, accountIdentifier, optional) Delete a resource group
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
identifier | string | ||
accountIdentifier | string | Account Identifier for the Entity | |
optional | *HarnessResourceGroupApiDeleteResourceGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a HarnessResourceGroupApiDeleteResourceGroupOpts struct
Name | Type | Description | Notes |
---|
orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity |
- Content-Type: Not defined
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoPageResponseResourceGroupResponse GetFilterResourceGroupList(ctx, body, optional)
This fetches a filtered list of Resource Groups
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
body | ResourceGroupFilter | Filter Resource Groups based on multiple parameters | |
optional | *HarnessResourceGroupApiGetFilterResourceGroupListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a HarnessResourceGroupApiGetFilterResourceGroupListOpts struct
Name | Type | Description | Notes |
---|
pageIndex | optional.| Indicates the number of pages. Results for these pages will be retrieved. | [default to 0] pageSize | optional.| The number of the elements to fetch | [default to 50] sortOrders | optional.Interface of []SortOrder| Sort criteria for the elements. |
ResponseDtoPageResponseResourceGroupResponse
- Content-Type: application/json, application/yaml
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoResourceGroupResponse GetResourceGroup(ctx, identifier, accountIdentifier, optional) Get a resource group by identifier
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
identifier | string | This is the Identifier of the Entity | |
accountIdentifier | string | Account Identifier for the Entity | |
optional | *HarnessResourceGroupApiGetResourceGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a HarnessResourceGroupApiGetResourceGroupOpts struct
Name | Type | Description | Notes |
---|
orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity |
ResponseDtoResourceGroupResponse
- Content-Type: Not defined
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoPageResponseResourceGroupResponse GetResourceGroupList(ctx, accountIdentifier, optional) Get list of resource groups
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
accountIdentifier | string | Account Identifier for the Entity | |
optional | *HarnessResourceGroupApiGetResourceGroupListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a HarnessResourceGroupApiGetResourceGroupListOpts struct
Name | Type | Description | Notes |
---|
orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity | searchTerm | optional.String| Details of all the resource groups having this string in their name or identifier will be returned. | pageIndex | optional.Int32| Indicates the number of pages. Results for these pages will be retrieved. | [default to 0] pageSize | optional.Int32| The number of the elements to fetch | [default to 50] sortOrders | optional.Interface of []SortOrder| Sort criteria for the elements. |
ResponseDtoPageResponseResourceGroupResponse
- Content-Type: Not defined
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoResourceGroupResponse UpdateResourceGroup(ctx, body, identifier, accountIdentifier, optional) Update a resource group
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
body | ResourceGroupRequest | This contains the details required to create a Resource Group | |
identifier | string | Identifier for the entity | |
accountIdentifier | string | Account Identifier for the Entity | |
optional | *HarnessResourceGroupApiUpdateResourceGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a HarnessResourceGroupApiUpdateResourceGroupOpts struct
Name | Type | Description | Notes |
---|
orgIdentifier | optional.| Organization Identifier for the Entity | projectIdentifier | optional.| Project Identifier for the Entity |
ResponseDtoResourceGroupResponse
- Content-Type: application/json, application/yaml
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]