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
|
GNUnet Namestore API Service
============================
Variables in single quotes ``'...'`` can or must be changed according to your specific case.
Namestore communicates with GNS records:
``type`` is the type of the record, e.g. "PKEY" for private key. Possible types are listed in :ref:`ref-type`.
``value`` is the value of the specific type of the record, e.g. the private key of an identity.
``time`` is the expiration time of the record either "never" or fancy time (see GNUNET_STRINGS_fancy_time_to_absolute)
``flag`` is the option of the record. Either 0 for none, 2 for private, 8 for relative expiration or 16 if all other records have expired. ``flag`` must be a number
``label`` is the name of the record. No duplicates are allowed.
Other variables used in the requests:
``error_desc`` is the description of the returned error.
``public_key`` is the public key of an identity.
``name`` is the name of an identity.
GET Request
------------
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Title** |Returns all namestore entries from all zones |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**URL** |:literal:`/namestore` |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Method** |**GET** |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**URL Params** |none |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Data Params** |none |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Success Response**|[{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"},...] |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Error Response** |{"error":"*error_desc*"} |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Title** |Returns all namestore entries for one zone specified by its public key |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**URL** |:literal:`/namestore?pubkey='pubkey'` |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Method** |**GET** |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**URL Params** |none |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Data Params** |none |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Success Response**|[{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"},...] |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Error Response** |{"error":"*error_desc*"} |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Title** |Returns all namestore entries for one zone specified by its name |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**URL** |:literal:`/namestore?name='name'` |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Method** |**GET** |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**URL Params** |none |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Data Params** |none |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Success Response**|[{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"},...] |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
|**Error Response** |{"error":"*error_desc*"} |
+--------------------+---------------------------------------------------------------------------------------------------------------------------+
POST Request
------------
+--------------------+------------------------------------------------------------------------------------------------------+
|**Title** |Creates a namestore entry |
+--------------------+------------------------------------------------------------------------------------------------------+
|**URL** |:literal:`/namestore` |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Method** |**POST** |
+--------------------+------------------------------------------------------------------------------------------------------+
|**URL Params** |none |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Data Params** |{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"}|
+--------------------+------------------------------------------------------------------------------------------------------+
|**Success Response**|Response Code: :literal:`204` (No Content) |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Error Response** | | {"error":"*error_desc*"} |
| | | *or* |
| | | Response Code: :literal:`409` (Conflict) |
+--------------------+------------------------------------------------------------------------------------------------------+
|
+--------------------+------------------------------------------------------------------------------------------------------+
|**Title** |Creates a namestore entry for one zone specified by its public key |
+--------------------+------------------------------------------------------------------------------------------------------+
|**URL** |:literal:`/namestore?pubkey='pubkey'` |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Method** |**POST** |
+--------------------+------------------------------------------------------------------------------------------------------+
|**URL Params** |none |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Data Params** |{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"}|
+--------------------+------------------------------------------------------------------------------------------------------+
|**Success Response**|Response Code: :literal:`204` (No Content) |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Error Response** | | {"error":"*error_desc*"} |
| | | *or* |
| | | Response Code: :literal:`409` (Conflict) |
+--------------------+------------------------------------------------------------------------------------------------------+
|
+--------------------+------------------------------------------------------------------------------------------------------+
|**Title** |Creates a namestore entry for one zone specified by its name |
+--------------------+------------------------------------------------------------------------------------------------------+
|**URL** |:literal:`/namestore?name='name'` |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Method** |**POST** |
+--------------------+------------------------------------------------------------------------------------------------------+
|**URL Params** |none |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Data Params** |{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"}|
+--------------------+------------------------------------------------------------------------------------------------------+
|**Success Response**|Response Code: :literal:`204` (No Content) |
+--------------------+------------------------------------------------------------------------------------------------------+
|**Error Response** | | {"error":"*error_desc*"} |
| | | *or* |
| | | Response Code: :literal:`409` (Conflict) |
+--------------------+------------------------------------------------------------------------------------------------------+
DELETE Request
--------------
+--------------------+----------------------------------------------------+
| **Title** | Deletes specific namestore entry |
+--------------------+----------------------------------------------------+
|**URL** |:literal:`/namestore?label='label'` |
+--------------------+----------------------------------------------------+
|**Method** | **DELETE** |
+--------------------+----------------------------------------------------+
|**URL Params** | none |
+--------------------+----------------------------------------------------+
|**Data Params** | none |
+--------------------+----------------------------------------------------+
|**Success Response**| Response Code: :literal:`204` (No Content) |
+--------------------+----------------------------------------------------+
|**Error Response** | {"error":"*error_desc*"} |
+--------------------+----------------------------------------------------+
|
+--------------------+----------------------------------------------------+
| **Title** | Deletes specific namestore entry in specific zone |
+--------------------+----------------------------------------------------+
|**URL** |:literal:`/namestore?label='label'&pubkey='pubkey'` |
+--------------------+----------------------------------------------------+
|**Method** | **DELETE** |
+--------------------+----------------------------------------------------+
|**URL Params** | none |
+--------------------+----------------------------------------------------+
|**Data Params** | none |
+--------------------+----------------------------------------------------+
|**Success Response**| Response Code: :literal:`204` (No Content) |
+--------------------+----------------------------------------------------+
|**Error Response** | {"error":"*error_desc*"} |
+--------------------+----------------------------------------------------+
|
+--------------------+----------------------------------------------------+
| **Title** | Deletes specific namestore entry in specific zone |
+--------------------+----------------------------------------------------+
|**URL** |:literal:`/namestore?label='label'&name='name'` |
+--------------------+----------------------------------------------------+
|**Method** | **DELETE** |
+--------------------+----------------------------------------------------+
|**URL Params** | none |
+--------------------+----------------------------------------------------+
|**Data Params** | none |
+--------------------+----------------------------------------------------+
|**Success Response**| Response Code: :literal:`204` (No Content) |
+--------------------+----------------------------------------------------+
|**Error Response** | {"error":"*error_desc*"} |
+--------------------+----------------------------------------------------+
|
