summaryrefslogtreecommitdiff
path: root/api-ref/source/dns-api-v2-tsigkey.inc
blob: 3e489562e2364d41843c8fa37aaf0ebd194044e5 (plain)
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
=======
Tsigkey
=======

Transaction signatures (TSIG) is a mechanism used to secure DNS messages and
to provide secure server-to-server communication (usually between master and
slave server, but can be extended for dynamic updates as well).

Create Tsigkeys
===============

.. rest_method::  POST /v2/tsigkeys

Create a new Tsigkey

Normal response codes: 201

Error response codes: 409, 405,404,403,401,400,503


Request
-------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - name: tsigkey_name
   - algorithm: tsigkey_algorithm
   - secret: tsigkey_secret
   - scope: tsigkey_scope
   - resource_id: resource_id


Request Example
---------------

.. literalinclude:: samples/tsigkeys/create-tsigkey-request.json
   :language: javascript

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id
   - id: id
   - resource_id: resource_id
   - name: tsigkey_name
   - scope: tsigkey_scope
   - secret: tsigkey_secret
   - algorithm: tsigkey_algorithm
   - created_at: created_at
   - updated_at: updated_at
   - links: links


Response Example
----------------

.. literalinclude:: samples/tsigkeys/tsigkey-response.json
   :language: javascript



List Tsigkeys
=============

.. rest_method::  GET /v2/tsigkeys

List all tsigkeys


Normal response codes: 200

Error response codes: 405,404,403,401,400,503


Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - limit: limit
   - marker: marker
   - sort_dir: sort_dir
   - sort_key: sort_key
   - name: tsigkey_name_filter
   - algorithm: tsigkey_algorithm_filter
   - scope: tsigkey_scope_filter


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id
   - id: id
   - resource_id: resource_id
   - name: tsigkey_name
   - scope: tsigkey_scope
   - secret: tsigkey_secret
   - algorithm: tsigkey_algorithm
   - created_at: created_at
   - updated_at: updated_at
   - links: links


Response Example
----------------

.. literalinclude:: samples/tsigkeys/list-tsigkeys-response.json
   :language: javascript



Show a Tsigkey
==============

.. rest_method::  GET /v2/tsigkeys/{tsigkey_id}

Show a tsigkey


Normal response codes: 200

Error response codes: 405,404,403,401,400,503


Request
-------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - tsigkey_id: tsigkey_id


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id
   - id: id
   - resource_id: resource_id
   - name: tsigkey_name
   - scope: tsigkey_scope
   - secret: tsigkey_secret
   - algorithm: tsigkey_algorithm
   - created_at: created_at
   - updated_at: updated_at
   - links: links


Response Example
----------------

.. literalinclude:: samples/tsigkeys/tsigkey-response.json
   :language: javascript



Update Tsigkey
================

.. rest_method::  PATCH /v2/tsigkeys/{tsigkey_id}

Update the attribute(s) of an existing tsigkey


Normal response codes: 200

Error response codes: 405,404,403,401,400,503


Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - name: tsigkey_name
   - algorithm: tsigkey_algorithm
   - secret: tsigkey_secret
   - scope: tsigkey_scope
   - resource_id: resource_id
   - tsigkey_id: tsigkey_id


Request Example
---------------

.. literalinclude:: samples/tsigkeys/update-tsigkey-request.json
   :language: javascript


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id
   - id: id
   - resource_id: resource_id
   - name: tsigkey_name
   - scope: tsigkey_scope
   - secret: tsigkey_secret
   - algorithm: tsigkey_algorithm
   - created_at: created_at
   - updated_at: updated_at
   - links: links


Response Example
----------------

.. literalinclude:: samples/tsigkeys/update-tsigkey-response.json
   :language: javascript



Delete a Tsigkey
================

.. rest_method::  DELETE /v2/tsigkeys/{tsigkey_id}

Delete a tsigkey


Normal response codes: 204

Error response codes: 405,404,403,401,400,503


Request
-------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - tsigkey_id: tsigkey_id


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id