github.com/safedep/dry@v0.0.0-20241016050132-a15651f0548b/apiguard/tykgen/docs/APIsApi.md (about) 1 # {{classname}} 2 3 All URIs are relative to *http://localhost/* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateApi**](APIsApi.md#CreateApi) | **Post** /tyk/apis | 8 [**DeleteApi**](APIsApi.md#DeleteApi) | **Delete** /tyk/apis/{apiID} | 9 [**GetApi**](APIsApi.md#GetApi) | **Get** /tyk/apis/{apiID} | 10 [**ListApiVersions**](APIsApi.md#ListApiVersions) | **Get** /tyk/apis/{apiID}/versions | 11 [**ListApis**](APIsApi.md#ListApis) | **Get** /tyk/apis | 12 [**UpdateApi**](APIsApi.md#UpdateApi) | **Put** /tyk/apis/{apiID} | 13 14 # **CreateApi** 15 > ApiModifyKeySuccess CreateApi(ctx, optional) 16 17 18 Create API A single Tyk node can have its API Definitions queried, deleted and updated remotely. This functionality enables you to remotely update your Tyk definitions without having to manage the files manually. 19 20 ### Required Parameters 21 22 Name | Type | Description | Notes 23 ------------- | ------------- | ------------- | ------------- 24 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 25 **optional** | ***APIsApiCreateApiOpts** | optional parameters | nil if no parameters 26 27 ### Optional Parameters 28 Optional parameters are passed through a pointer to a APIsApiCreateApiOpts struct 29 Name | Type | Description | Notes 30 ------------- | ------------- | ------------- | ------------- 31 **body** | [**optional.Interface of ApiDefinition**](ApiDefinition.md)| | 32 **baseApiId** | **optional.**| The base API which the new version will be linked to. | 33 **baseApiVersionName** | **optional.**| The version name of the base API while creating the first version. This doesn't have to be sent for the next versions but if it is set, it will override base API version name. | 34 **newVersionName** | **optional.**| The version name of the created version. | 35 **setDefault** | **optional.**| If true, the new version is set as default version. | 36 37 ### Return type 38 39 [**ApiModifyKeySuccess**](apiModifyKeySuccess.md) 40 41 ### Authorization 42 43 [api_key](../README.md#api_key) 44 45 ### HTTP request headers 46 47 - **Content-Type**: application/json 48 - **Accept**: application/json 49 50 [[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) 51 52 # **DeleteApi** 53 > ApiStatusMessage DeleteApi(ctx, apiID) 54 55 56 Deleting an API definition will remove the file from the file store, the API definition will NOT be unloaded, a separate reload request will need to be made to disable the API endpoint. 57 58 ### Required Parameters 59 60 Name | Type | Description | Notes 61 ------------- | ------------- | ------------- | ------------- 62 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 63 **apiID** | **string**| The API ID | 64 65 ### Return type 66 67 [**ApiStatusMessage**](apiStatusMessage.md) 68 69 ### Authorization 70 71 [api_key](../README.md#api_key) 72 73 ### HTTP request headers 74 75 - **Content-Type**: Not defined 76 - **Accept**: application/json 77 78 [[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) 79 80 # **GetApi** 81 > ApiDefinition GetApi(ctx, apiID) 82 83 84 Get API definition Only if used without the Tyk Dashboard 85 86 ### Required Parameters 87 88 Name | Type | Description | Notes 89 ------------- | ------------- | ------------- | ------------- 90 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 91 **apiID** | **string**| The API ID | 92 93 ### Return type 94 95 [**ApiDefinition**](APIDefinition.md) 96 97 ### Authorization 98 99 [api_key](../README.md#api_key) 100 101 ### HTTP request headers 102 103 - **Content-Type**: Not defined 104 - **Accept**: application/json 105 106 [[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) 107 108 # **ListApiVersions** 109 > InlineResponse200 ListApiVersions(ctx, apiID, optional) 110 111 112 Listing versions of an OAS API 113 114 ### Required Parameters 115 116 Name | Type | Description | Notes 117 ------------- | ------------- | ------------- | ------------- 118 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 119 **apiID** | **string**| The API ID | 120 **optional** | ***APIsApiListApiVersionsOpts** | optional parameters | nil if no parameters 121 122 ### Optional Parameters 123 Optional parameters are passed through a pointer to a APIsApiListApiVersionsOpts struct 124 Name | Type | Description | Notes 125 ------------- | ------------- | ------------- | ------------- 126 127 **searchText** | **optional.String**| Search for API version name | 128 **accessType** | **optional.String**| Filter for internal or external API versions | 129 130 ### Return type 131 132 [**InlineResponse200**](inline_response_200.md) 133 134 ### Authorization 135 136 [api_key](../README.md#api_key) 137 138 ### HTTP request headers 139 140 - **Content-Type**: Not defined 141 - **Accept**: application/json 142 143 [[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) 144 145 # **ListApis** 146 > []ApiDefinition ListApis(ctx, ) 147 148 149 List APIs Only if used without the Tyk Dashboard 150 151 ### Required Parameters 152 This endpoint does not need any parameter. 153 154 ### Return type 155 156 [**[]ApiDefinition**](APIDefinition.md) 157 158 ### Authorization 159 160 [api_key](../README.md#api_key) 161 162 ### HTTP request headers 163 164 - **Content-Type**: Not defined 165 - **Accept**: application/json 166 167 [[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) 168 169 # **UpdateApi** 170 > ApiModifyKeySuccess UpdateApi(ctx, apiID, optional) 171 172 173 Updating an API definition uses the same signature an object as a `POST`, however it will first ensure that the API ID that is being updated is the same as the one in the object being `PUT`. Updating will completely replace the file descriptor and will not change an API Definition that has already been loaded, the hot-reload endpoint will need to be called to push the new definition to live. 174 175 ### Required Parameters 176 177 Name | Type | Description | Notes 178 ------------- | ------------- | ------------- | ------------- 179 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 180 **apiID** | **string**| The API ID | 181 **optional** | ***APIsApiUpdateApiOpts** | optional parameters | nil if no parameters 182 183 ### Optional Parameters 184 Optional parameters are passed through a pointer to a APIsApiUpdateApiOpts struct 185 Name | Type | Description | Notes 186 ------------- | ------------- | ------------- | ------------- 187 188 **body** | [**optional.Interface of ApiDefinition**](ApiDefinition.md)| | 189 190 ### Return type 191 192 [**ApiModifyKeySuccess**](apiModifyKeySuccess.md) 193 194 ### Authorization 195 196 [api_key](../README.md#api_key) 197 198 ### HTTP request headers 199 200 - **Content-Type**: application/json 201 - **Accept**: application/json 202 203 [[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) 204