scaleway_api_rs 0.1.8

Generated library to interact with Scaleway API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# \EndpointsApi

All URIs are relative to *https://api.scaleway.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_endpoint**](EndpointsApi.md#create_endpoint) | **POST** /rdb/v1/regions/{region}/instances/{instance_id}/endpoints | Create a new instance endpoint
[**delete_endpoint**](EndpointsApi.md#delete_endpoint) | **DELETE** /rdb/v1/regions/{region}/endpoints/{endpoint_id} | Delete an instance endpoint
[**get_endpoint**](EndpointsApi.md#get_endpoint) | **GET** /rdb/v1/regions/{region}/endpoints/{endpoint_id} | Get an instance endpoint



## create_endpoint

> crate::models::ScalewayPeriodRdbPeriodV1PeriodEndpoint create_endpoint(region, instance_id, create_endpoint_request)
Create a new instance endpoint

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**instance_id** | **String** | UUID of the instance you want to add endpoint to | [required] |
**create_endpoint_request** | [**CreateEndpointRequest**](CreateEndpointRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodEndpoint**](scaleway.rdb.v1.Endpoint.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## delete_endpoint

> delete_endpoint(region, endpoint_id)
Delete an instance endpoint

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**endpoint_id** | **String** | This endpoint can also be used to delete a read replica endpoint. | [required] |

### Return type

 (empty response body)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## get_endpoint

> crate::models::ScalewayPeriodRdbPeriodV1PeriodEndpoint get_endpoint(region, endpoint_id)
Get an instance endpoint

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**endpoint_id** | **String** | UUID of the endpoint you want to get | [required] |

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodEndpoint**](scaleway.rdb.v1.Endpoint.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)