github.com/launchdarkly/api-client-go@v5.3.0+incompatible/docs/ProjectsApi.md (about)

     1  # \ProjectsApi
     2  
     3  All URIs are relative to *https://app.launchdarkly.com/api/v2*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteProject**](ProjectsApi.md#DeleteProject) | **Delete** /projects/{projectKey} | Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
     8  [**GetProject**](ProjectsApi.md#GetProject) | **Get** /projects/{projectKey} | Fetch a single project by key.
     9  [**GetProjects**](ProjectsApi.md#GetProjects) | **Get** /projects | Returns a list of all projects in the account.
    10  [**PatchProject**](ProjectsApi.md#PatchProject) | **Patch** /projects/{projectKey} | Modify a project by ID.
    11  [**PostProject**](ProjectsApi.md#PostProject) | **Post** /projects | Create a new project with the given key and name.
    12  
    13  
    14  # **DeleteProject**
    15  > DeleteProject(ctx, projectKey)
    16  Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    23    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
    24  
    25  ### Return type
    26  
    27   (empty response body)
    28  
    29  ### Authorization
    30  
    31  [Token](../README.md#Token)
    32  
    33  ### HTTP request headers
    34  
    35   - **Content-Type**: application/json
    36   - **Accept**: application/json
    37  
    38  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    39  
    40  # **GetProject**
    41  > Project GetProject(ctx, projectKey)
    42  Fetch a single project by key.
    43  
    44  ### Required Parameters
    45  
    46  Name | Type | Description  | Notes
    47  ------------- | ------------- | ------------- | -------------
    48   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    49    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
    50  
    51  ### Return type
    52  
    53  [**Project**](Project.md)
    54  
    55  ### Authorization
    56  
    57  [Token](../README.md#Token)
    58  
    59  ### HTTP request headers
    60  
    61   - **Content-Type**: application/json
    62   - **Accept**: application/json
    63  
    64  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    65  
    66  # **GetProjects**
    67  > Projects GetProjects(ctx, )
    68  Returns a list of all projects in the account.
    69  
    70  ### Required Parameters
    71  This endpoint does not need any parameter.
    72  
    73  ### Return type
    74  
    75  [**Projects**](Projects.md)
    76  
    77  ### Authorization
    78  
    79  [Token](../README.md#Token)
    80  
    81  ### HTTP request headers
    82  
    83   - **Content-Type**: application/json
    84   - **Accept**: application/json
    85  
    86  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    87  
    88  # **PatchProject**
    89  > Project PatchProject(ctx, projectKey, patchDelta)
    90  Modify a project by ID.
    91  
    92  ### Required Parameters
    93  
    94  Name | Type | Description  | Notes
    95  ------------- | ------------- | ------------- | -------------
    96   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    97    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
    98    **patchDelta** | [**[]PatchOperation**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' | 
    99  
   100  ### Return type
   101  
   102  [**Project**](Project.md)
   103  
   104  ### Authorization
   105  
   106  [Token](../README.md#Token)
   107  
   108  ### HTTP request headers
   109  
   110   - **Content-Type**: application/json
   111   - **Accept**: application/json
   112  
   113  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   114  
   115  # **PostProject**
   116  > Project PostProject(ctx, projectBody)
   117  Create a new project with the given key and name.
   118  
   119  ### Required Parameters
   120  
   121  Name | Type | Description  | Notes
   122  ------------- | ------------- | ------------- | -------------
   123   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   124    **projectBody** | [**ProjectBody**](ProjectBody.md)| Project keys must be unique within an account. | 
   125  
   126  ### Return type
   127  
   128  [**Project**](Project.md)
   129  
   130  ### Authorization
   131  
   132  [Token](../README.md#Token)
   133  
   134  ### HTTP request headers
   135  
   136   - **Content-Type**: application/json
   137   - **Accept**: application/json
   138  
   139  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   140