github.com/safedep/dry@v0.0.0-20241016050132-a15651f0548b/apiguard/tykgen/docs/CertsApi.md (about)

     1  # {{classname}}
     2  
     3  All URIs are relative to *http://localhost/*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**AddCert**](CertsApi.md#AddCert) | **Post** /tyk/certs | Add a certificate
     8  [**DeleteCerts**](CertsApi.md#DeleteCerts) | **Delete** /tyk/certs | Delete Certificate
     9  [**ListCerts**](CertsApi.md#ListCerts) | **Get** /tyk/certs | List Certificates
    10  
    11  # **AddCert**
    12  > ApiCertificateStatusMessage AddCert(ctx, orgId, optional)
    13  Add a certificate
    14  
    15  Add a certificate to the Tyk Gateway
    16  
    17  ### Required Parameters
    18  
    19  Name | Type | Description  | Notes
    20  ------------- | ------------- | ------------- | -------------
    21   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    22    **orgId** | **string**| Organisation ID to list the certificates | 
    23   **optional** | ***CertsApiAddCertOpts** | optional parameters | nil if no parameters
    24  
    25  ### Optional Parameters
    26  Optional parameters are passed through a pointer to a CertsApiAddCertOpts struct
    27  Name | Type | Description  | Notes
    28  ------------- | ------------- | ------------- | -------------
    29  
    30   **body** | [**optional.Interface of string**](string.md)|  | 
    31  
    32  ### Return type
    33  
    34  [**ApiCertificateStatusMessage**](APICertificateStatusMessage.md)
    35  
    36  ### Authorization
    37  
    38  [api_key](../README.md#api_key)
    39  
    40  ### HTTP request headers
    41  
    42   - **Content-Type**: text/plain
    43   - **Accept**: application/json
    44  
    45  [[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)
    46  
    47  # **DeleteCerts**
    48  > ApiStatusMessage DeleteCerts(ctx, certID, orgId)
    49  Delete Certificate
    50  
    51  Delete certificate by id
    52  
    53  ### Required Parameters
    54  
    55  Name | Type | Description  | Notes
    56  ------------- | ------------- | ------------- | -------------
    57   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    58    **certID** | **string**| Certifiicate ID to be deleted | 
    59    **orgId** | **string**| Organisation ID to list the certificates | 
    60  
    61  ### Return type
    62  
    63  [**ApiStatusMessage**](apiStatusMessage.md)
    64  
    65  ### Authorization
    66  
    67  [api_key](../README.md#api_key)
    68  
    69  ### HTTP request headers
    70  
    71   - **Content-Type**: Not defined
    72   - **Accept**: application/json
    73  
    74  [[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)
    75  
    76  # **ListCerts**
    77  > InlineResponse2001 ListCerts(ctx, orgId, optional)
    78  List Certificates
    79  
    80  List All Certificates in the Tyk Gateway
    81  
    82  ### Required Parameters
    83  
    84  Name | Type | Description  | Notes
    85  ------------- | ------------- | ------------- | -------------
    86   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    87    **orgId** | **string**| Organisation ID to list the certificates | 
    88   **optional** | ***CertsApiListCertsOpts** | optional parameters | nil if no parameters
    89  
    90  ### Optional Parameters
    91  Optional parameters are passed through a pointer to a CertsApiListCertsOpts struct
    92  Name | Type | Description  | Notes
    93  ------------- | ------------- | ------------- | -------------
    94  
    95   **mode** | **optional.String**| Mode to list the certificate details | 
    96   **certID** | **optional.String**| Comma separated list of certificates to list | 
    97  
    98  ### Return type
    99  
   100  [**InlineResponse2001**](inline_response_200_1.md)
   101  
   102  ### Authorization
   103  
   104  [api_key](../README.md#api_key)
   105  
   106  ### HTTP request headers
   107  
   108   - **Content-Type**: Not defined
   109   - **Accept**: application/json
   110  
   111  [[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)
   112