All URIs are relative to https://app.harness.io/gateway
| Method | HTTP request | Description |
|---|---|---|
| DeleteProject | Delete /ng/api/projects/{identifier} | Deletes the Project corresponding to the specified Project ID. |
| GetProject | Get /ng/api/projects/{identifier} | Gets a Project by ID |
| GetProjectList | Get /ng/api/projects | List user's project |
| PostProject | Post /ng/api/projects | Creates a Project |
| PutProject | Put /ng/api/projects/{identifier} | Update Project by ID |
ResponseDtoBoolean DeleteProject(ctx, identifier, accountIdentifier, optional) Deletes the Project corresponding to the specified Project ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| identifier | string | Project Identifier for the Entity | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ProjectApiDeleteProjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ProjectApiDeleteProjectOpts struct
| Name | Type | Description | Notes |
|---|
ifMatch | optional.String| Version number of Project | orgIdentifier | optional.String| This is the Organization Identifier for the Project. By default, the Default Organization's Identifier is considered. | [default to default]
- Content-Type: Not defined
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoProjectResponse GetProject(ctx, identifier, accountIdentifier, optional) Gets a Project by ID
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| identifier | string | Project Identifier for the Entity | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ProjectApiGetProjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ProjectApiGetProjectOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.String| Organization identifier for the project. If left empty, Default Organization is assumed | [default to default]
- Content-Type: Not defined
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoPageResponseProjectResponse GetProjectList(ctx, accountIdentifier, optional) List user's project
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ProjectApiGetProjectListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ProjectApiGetProjectListOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.String| Organization Identifier for the Entity | hasModule | optional.Bool| 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 | [default to true] identifiers | optional.Interface of []string| This is the list of Project IDs. Details specific to these IDs would be fetched. | moduleType | optional.String| Filter Projects by module type | searchTerm | optional.String| This would be used to filter Projects. Any Project having the specified string in its Name, ID and Tag would be filtered. | 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. |
ResponseDtoPageResponseProjectResponse
- Content-Type: Not defined
- Accept: application/json, application/yaml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoProjectResponse PostProject(ctx, body, accountIdentifier, optional) Creates a Project
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ProjectRequest | Details of the Project to create | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ProjectApiPostProjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ProjectApiPostProjectOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.| Organization identifier for the Project. If left empty, the Project is created under Default Organization | [default to default]
- 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]
ResponseDtoProjectResponse PutProject(ctx, body, identifier, accountIdentifier, optional) Update Project by ID
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ProjectRequest | This is the updated Project. Please provide values for all fields, not just the fields you are updating | |
| identifier | string | Project Identifier for the Entity | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ProjectApiPutProjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ProjectApiPutProjectOpts struct
| Name | Type | Description | Notes |
|---|
ifMatch | optional.| Version number of Project | orgIdentifier | optional.| Organization identifier for the Project. If left empty, Default Organization is assumed | [default to default]
- 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]