edgegap 0.1.0

Auto-generated client library for the Edgegap API, used by the arbctl tool
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

# \DeploymentTagsApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**deployments_tags_create**](DeploymentTagsApi.md#deployments_tags_create) | **POST** /v1/deployments/{request_id}/tags | Create Tag for a Deployment
[**deployments_tags_delete**](DeploymentTagsApi.md#deployments_tags_delete) | **DELETE** /v1/deployments/{request_id}/tags/{tag_name} | Delete Tag for a Deployment
[**deployments_tags_list**](DeploymentTagsApi.md#deployments_tags_list) | **GET** /v1/deployments/{request_id}/tags | List tags for a Deployment
[**deployments_tags_read**](DeploymentTagsApi.md#deployments_tags_read) | **GET** /v1/deployments/{request_id}/tags/{tag_name} | Get tag for a Deployment
[**deployments_tags_update**](DeploymentTagsApi.md#deployments_tags_update) | **PATCH** /v1/deployments/{request_id}/tags/{tag_name} | Update Tag for a Deployment



## deployments_tags_create

> models::DeploymentTagResponse deployments_tags_create(request_id, payload)
Create Tag for a Deployment

Create a tag for a deployment. The tag will however not be injected into a running container.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_id** | **String** |  | [required] |
**payload** | [**DeploymentTagPayload**](DeploymentTagPayload.md) |  | [required] |

### Return type

[**models::DeploymentTagResponse**](DeploymentTagResponse.md)

### Authorization

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

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


## deployments_tags_delete

> deployments_tags_delete(request_id, tag_name)
Delete Tag for a Deployment

Delete a tag for a deployment. The tag will however not be removed from the environment of a running container.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_id** | **String** |  | [required] |
**tag_name** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## deployments_tags_list

> models::DeploymentTagListResponse deployments_tags_list(request_id)
List tags for a Deployment

List tags for a deployment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_id** | **String** |  | [required] |

### Return type

[**models::DeploymentTagListResponse**](DeploymentTagListResponse.md)

### Authorization

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

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


## deployments_tags_read

> models::DeploymentTagResponse deployments_tags_read(request_id, tag_name)
Get tag for a Deployment

Get tag for a deployment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_id** | **String** |  | [required] |
**tag_name** | **String** |  | [required] |

### Return type

[**models::DeploymentTagResponse**](DeploymentTagResponse.md)

### Authorization

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

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


## deployments_tags_update

> models::DeploymentTagResponse deployments_tags_update(request_id, tag_name, payload)
Update Tag for a Deployment

Update a tag for a deployment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_id** | **String** |  | [required] |
**tag_name** | **String** |  | [required] |
**payload** | [**DeploymentTagPayload**](DeploymentTagPayload.md) |  | [required] |

### Return type

[**models::DeploymentTagResponse**](DeploymentTagResponse.md)

### Authorization

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

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