← Back to branch summary

~ubuntu-branches/ubuntu/saucy/rabbitmq-server/saucy

« back to all changes in this revision

Viewing changes to plugins-src/rabbitmq-management/priv/www/api/index.html

  • Committer: Package Import Robot
  • Author(s): Emile Joubert
  • Date: 2012-11-19 11:42:31 UTC
  • mfrom: (0.2.18) (0.1.32 sid)
  • Revision ID: package-import@ubuntu.com-20121119114231-hvapkn4akng09etr
Tags: 3.0.0-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins-src/rabbitmq-management/priv/www/api/index.html
61
61
    <ul>
62
62
      <li>
63
63
        Get a list of vhosts:
64
 
<pre>$ curl -i -u guest:guest http://localhost:55672/api/vhosts
 
64
<pre>$ curl -i -u guest:guest http://localhost:15672/api/vhosts
65
65
HTTP/1.1 200 OK
66
66
Server: MochiWeb/1.1 WebMachine/1.7 (participate in the frantic)
67
67
Date: Tue, 31 Aug 2010 15:46:59 GMT
73
73
      <li>
74
74
        Get a list of channels, fast publishers first, restricting the info
75
75
        items we get back:
76
 
<pre>$ curl -i -u guest:guest 'http://localhost:55672/api/channels?sort=message_stats.publish_details.rate&amp;sort_reverse=true&amp;columns=name,message_stats.publish_details.rate,message_stats.deliver_get_details.rate'
 
76
<pre>$ curl -i -u guest:guest 'http://localhost:15672/api/channels?sort=message_stats.publish_details.rate&amp;sort_reverse=true&amp;columns=name,message_stats.publish_details.rate,message_stats.deliver_get_details.rate'
77
77
HTTP/1.1 200 OK
78
78
Server: MochiWeb/1.1 WebMachine/1.7 (participate in the frantic)
79
79
Date: Tue, 12 Oct 2010 10:03:21 GMT
86
86
      <li>
87
87
        Create a new vhost:
88
88
<pre>$ curl -i -u guest:guest -H "content-type:application/json" \
89
 
  -XPUT http://localhost:55672/api/vhosts/foo
 
89
  -XPUT http://localhost:15672/api/vhosts/foo
90
90
HTTP/1.1 204 No Content
91
91
Server: MochiWeb/1.1 WebMachine/1.7 (participate in the frantic)
92
92
Date: Fri, 27 Aug 2010 16:56:00 GMT
103
103
        Create a new exchange in the default virtual host:
104
104
<pre>$ curl -i -u guest:guest -H "content-type:application/json" \
105
105
  -XPUT -d'{"type":"direct","durable":true}' \
106
 
  http://localhost:55672/api/exchanges/%2f/my-new-exchange
 
106
  http://localhost:15672/api/exchanges/%2f/my-new-exchange
107
107
HTTP/1.1 204 No Content
108
108
Server: MochiWeb/1.1 WebMachine/1.7 (participate in the frantic)
109
109
Date: Fri, 27 Aug 2010 17:04:29 GMT
115
115
      <li>
116
116
        And delete it again:
117
117
<pre>$ curl -i -u guest:guest -H "content-type:application/json" \
118
 
  -XDELETE http://localhost:55672/api/exchanges/%2f/my-new-exchange
 
118
  -XDELETE http://localhost:15672/api/exchanges/%2f/my-new-exchange
119
119
HTTP/1.1 204 No Content
120
120
Server: MochiWeb/1.1 WebMachine/1.7 (participate in the frantic)
121
121
Date: Fri, 27 Aug 2010 17:05:30 GMT
140
140
        <td></td>
141
141
        <td></td>
142
142
        <td></td>
143
 
        <td class="path"><a href="/api/overview">/api/overview</a></td>
 
143
        <td class="path">/api/overview</td>
144
144
        <td>Various random bits of information that describe the whole
145
145
        system.</td>
146
146
      </tr>
149
149
        <td></td>
150
150
        <td></td>
151
151
        <td></td>
152
 
        <td class="path"><a href="/api/nodes">/api/nodes</a></td>
 
152
        <td class="path">/api/nodes</td>
153
153
        <td>A list of nodes in the RabbitMQ cluster.</td>
154
154
      </tr>
155
155
      <tr>
158
158
        <td></td>
159
159
        <td></td>
160
160
        <td class="path">/api/nodes/<i>name</i></td>
161
 
        <td>An individual node in the RabbitMQ cluster.</td>
 
161
        <td>
 
162
          An individual node in the RabbitMQ cluster. Add
 
163
          "?memory=true" to get memory statistics.
 
164
        </td>
162
165
      </tr>
163
166
      <tr>
164
167
        <td>X</td>
173
176
        <td></td>
174
177
        <td></td>
175
178
        <td>X</td>
176
 
        <td class="path"><a href="/api/definitions">/api/definitions</a><br/>
177
 
                                                    /api/all-configuration
178
 
                                                    <em>(deprecated)</em>
 
179
        <td class="path">/api/definitions<br/>
 
180
                         /api/all-configuration <em>(deprecated)</em>
179
181
        </td>
180
182
        <td>
181
183
          The server definitions - exchanges, queues, bindings, users,
182
 
          virtual hosts, permissions. Everything apart from
 
184
          virtual hosts, permissions and parameters. Everything apart from
183
185
          messages. POST to upload an existing set of definitions. Note
184
186
          that:
185
187
          <ul>
201
203
        <td></td>
202
204
        <td></td>
203
205
        <td></td>
204
 
        <td class="path"><a href="/api/connections">/api/connections</a></td>
 
206
        <td class="path">/api/connections</td>
205
207
        <td>A list of all open connections.</td>
206
208
      </tr>
207
209
      <tr>
218
220
        <td></td>
219
221
        <td></td>
220
222
        <td></td>
221
 
        <td class="path"><a href="/api/channels">/api/channels</a></td>
 
223
        <td class="path">/api/channels</td>
222
224
        <td>A list of all open channels.</td>
223
225
      </tr>
224
226
      <tr>
234
236
        <td></td>
235
237
        <td></td>
236
238
        <td></td>
237
 
        <td class="path"><a href="/api/exchanges">/api/exchanges</a></td>
 
239
        <td class="path">/api/exchanges</td>
238
240
        <td>A list of all exchanges.</td>
239
241
      </tr>
240
242
      <tr>
302
304
        <td></td>
303
305
        <td></td>
304
306
        <td></td>
305
 
        <td class="path"><a href="/api/queues">/api/queues</a></td>
 
307
        <td class="path">/api/queues</td>
306
308
        <td>A list of all queues.</td>
307
309
      </tr>
308
310
      <tr>
376
378
        <td></td>
377
379
        <td></td>
378
380
        <td></td>
379
 
        <td class="path"><a href="/api/bindings">/api/bindings</a></td>
 
381
        <td class="path">/api/bindings</td>
380
382
        <td>A list of all bindings.</td>
381
383
      </tr>
382
384
      <tr>
405
407
      </tr>
406
408
      <tr>
407
409
        <td>X</td>
408
 
        <td>X</td>
 
410
        <td></td>
409
411
        <td>X</td>
410
412
        <td></td>
411
413
        <td class="path">/api/bindings/<i>vhost</i>/e/<i>exchange</i>/q/<i>queue</i>/<i>props</i></td>
412
414
        <td>An individual binding between an exchange and a queue.
413
415
        The <i>props</i> part of the URI is a "name" for the binding
414
 
        composed of its routing key and properties. While you can
415
 
        create a binding by PUTing to this URI, it may be more
416
 
        convenient to POST to the URI above.</td>
 
416
        composed of its routing key and a hash of its arguments.</td>
417
417
      </tr>
418
418
      <tr>
419
419
        <td>X</td>
420
420
        <td></td>
421
421
        <td></td>
422
422
        <td></td>
423
 
        <td class="path"><a href="/api/vhosts">/api/vhosts</a></td>
 
423
        <td class="path">/api/vhosts</td>
424
424
        <td>A list of all vhosts.</td>
425
425
      </tr>
426
426
      <tr>
446
446
        <td></td>
447
447
        <td></td>
448
448
        <td></td>
449
 
        <td class="path"><a href="/api/users">/api/users</a></td>
 
449
        <td class="path">/api/users</td>
450
450
        <td>A list of all users.</td>
451
451
      </tr>
452
452
      <tr>
480
480
        <td></td>
481
481
        <td></td>
482
482
        <td></td>
483
 
        <td class="path"><a href="/api/whoami">/api/whoami</a></td>
 
483
        <td class="path">/api/whoami</td>
484
484
        <td>Details of the currently authenticated user.</td>
485
485
      </tr>
486
486
      <tr>
488
488
        <td></td>
489
489
        <td></td>
490
490
        <td></td>
491
 
        <td class="path"><a href="/api/permissions">/api/permissions</a></td>
 
491
        <td class="path">/api/permissions</td>
492
492
        <td>A list of all permissions for all users.</td>
493
493
      </tr>
494
494
      <tr>
506
506
        <td></td>
507
507
        <td></td>
508
508
        <td></td>
 
509
        <td class="path">/api/parameters</td>
 
510
        <td>A list of all parameters.</td>
 
511
      </tr>
 
512
      <tr>
 
513
        <td>X</td>
 
514
        <td></td>
 
515
        <td></td>
 
516
        <td></td>
 
517
        <td class="path">/api/parameters/<i>component</i></td>
 
518
        <td>A list of all parameters for a given component.</td>
 
519
      </tr>
 
520
      <tr>
 
521
        <td>X</td>
 
522
        <td></td>
 
523
        <td></td>
 
524
        <td></td>
 
525
        <td class="path">/api/parameters/<i>component</i>/<i>vhost</i></td>
 
526
        <td>A list of all parameters for a given component and virtual host.</td>
 
527
      </tr>
 
528
      <tr>
 
529
        <td>X</td>
 
530
        <td>X</td>
 
531
        <td>X</td>
 
532
        <td></td>
 
533
        <td class="path">/api/parameters/<i>component</i>/<i>vhost</i>/<i>name</i></td>
 
534
        <td>An individual parameter. To PUT a parameter, you will need a body looking something like this:
 
535
<pre>{"vhost": "/","component":"federation","name":"local_username","value":"guest"}</pre>
 
536
</td>
 
537
      </tr>
 
538
      <tr>
 
539
        <td>X</td>
 
540
        <td></td>
 
541
        <td></td>
 
542
        <td></td>
 
543
        <td class="path">/api/policies</td>
 
544
        <td>A list of all policies.</td>
 
545
      </tr>
 
546
      <tr>
 
547
        <td>X</td>
 
548
        <td></td>
 
549
        <td></td>
 
550
        <td></td>
 
551
        <td class="path">/api/policies/<i>vhost</i></td>
 
552
        <td>A list of all policies in a given virtual host.</td>
 
553
      </tr>
 
554
      <tr>
 
555
        <td>X</td>
 
556
        <td>X</td>
 
557
        <td>X</td>
 
558
        <td></td>
 
559
        <td class="path">/api/policies/<i>vhost</i>/<i>name</i></td>
 
560
        <td>An individual policy. To PUT a policy, you will need a body looking something like this:
 
561
<pre>{"pattern":"^amq.", "definition": {"federation-upstream-set":"all"}, "priority":0}</pre>
 
562
</td>
 
563
      </tr>
 
564
      <tr>
 
565
        <td>X</td>
 
566
        <td></td>
 
567
        <td></td>
 
568
        <td></td>
509
569
        <td class="path">/api/aliveness-test/<i>vhost</i></td>
510
570
        <td>
511
571
          Declares a test queue, then publishes and consumes a