outscale_api 1.17.0

Outscale API SDK
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

# \ApiAccessRuleApi

All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_api_access_rule**](ApiAccessRuleApi.md#create_api_access_rule) | **POST** /CreateApiAccessRule | 
[**delete_api_access_rule**](ApiAccessRuleApi.md#delete_api_access_rule) | **POST** /DeleteApiAccessRule | 
[**read_api_access_rules**](ApiAccessRuleApi.md#read_api_access_rules) | **POST** /ReadApiAccessRules | 
[**update_api_access_rule**](ApiAccessRuleApi.md#update_api_access_rule) | **POST** /UpdateApiAccessRule | 



## create_api_access_rule

> crate::models::CreateApiAccessRuleResponse create_api_access_rule(create_api_access_rule_request)


Creates a rule to allow access to the API from your account.<br /> You need to specify at least the `CaIds` or the `IpRanges` parameter.<br /><br />  **[NOTE]**<br /> By default, your account has a set of rules allowing global access, that you can delete.<br /><br /> For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_api_access_rule_request** | Option<[**CreateApiAccessRuleRequest**](CreateApiAccessRuleRequest.md)> |  |  |

### Return type

[**crate::models::CreateApiAccessRuleResponse**](CreateApiAccessRuleResponse.md)

### Authorization

[ApiKeyAuthSec](../README.md#ApiKeyAuthSec), [BasicAuth](../README.md#BasicAuth)

### 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_api_access_rule

> crate::models::DeleteApiAccessRuleResponse delete_api_access_rule(delete_api_access_rule_request)


Deletes a specified API access rule.<br /><br />  **[IMPORTANT]**<br /> You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**delete_api_access_rule_request** | Option<[**DeleteApiAccessRuleRequest**](DeleteApiAccessRuleRequest.md)> |  |  |

### Return type

[**crate::models::DeleteApiAccessRuleResponse**](DeleteApiAccessRuleResponse.md)

### Authorization

[ApiKeyAuthSec](../README.md#ApiKeyAuthSec), [BasicAuth](../README.md#BasicAuth)

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


## read_api_access_rules

> crate::models::ReadApiAccessRulesResponse read_api_access_rules(read_api_access_rules_request)


Lists one or more API access rules.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**read_api_access_rules_request** | Option<[**ReadApiAccessRulesRequest**](ReadApiAccessRulesRequest.md)> |  |  |

### Return type

[**crate::models::ReadApiAccessRulesResponse**](ReadApiAccessRulesResponse.md)

### Authorization

[ApiKeyAuthSec](../README.md#ApiKeyAuthSec), [BasicAuth](../README.md#BasicAuth)

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


## update_api_access_rule

> crate::models::UpdateApiAccessRuleResponse update_api_access_rule(update_api_access_rule_request)


Modifies a specified API access rule.<br /><br />  **[WARNING]**<br /> - The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.<br /> - If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see [Technical Support](https://docs.outscale.com/en/userguide/Technical-Support.html).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_api_access_rule_request** | Option<[**UpdateApiAccessRuleRequest**](UpdateApiAccessRuleRequest.md)> |  |  |

### Return type

[**crate::models::UpdateApiAccessRuleResponse**](UpdateApiAccessRuleResponse.md)

### Authorization

[ApiKeyAuthSec](../README.md#ApiKeyAuthSec), [BasicAuth](../README.md#BasicAuth)

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