-
Notifications
You must be signed in to change notification settings - Fork 14
/
rax-cloudFiles-api-v1-rst.wadl
2494 lines (2441 loc) · 161 KB
/
rax-cloudFiles-api-v1-rst.wadl
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../wadl/common.ent">
%common;
]>
<application
xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:files="http://docs.openstack.org/api/openstack-object-storage/1.0">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://storage101.ord1.clouddrive.com/">
<resource id="versions" path="v1">
<resource id="account" path="{account}">
<param name="account" style="template"
type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">Your
unique account identifier.</p>
</doc>
</param>
<method href="#listcontainers"/>
<method href="#updateaccountmeta"/>
<method href="#retrieveaccountmeta"/>
<method href="#deleteaccountmeta"/>
<resource id="container" path="{container}">
<param name="container" style="template"
type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the
container.</p>
</doc>
</param>
<method href="#listcontainerobjects"/>
<method href="#createcontainer"/>
<method href="#deletecontainer"/>
<method href="#updateacontainermeta"/>
<method href="#retrievecontainermeta"/>
<method href="#deletecontainermeta"/>
<resource id="object" path="{object}">
<param name="object" style="template"
type="xsd:string">
<doc>
<p
xmlns="http://www.w3.org/1999/xhtml"
>The unique identifier of the
object.</p>
</doc>
</param>
<method href="#getobjectdata"/>
<method href="#createobject"/>
<method href="#deleteobject"/>
<method href="#copyobject"/>
<method href="#retrieveobjectmeta"/>
<method href="#updateaobjmeta"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--***************************************************************-->
<!-- Resource Types -->
<!-- These were in the OpenStack WADL. I'm not sure what they do. -->
<!--***************************************************************-->
<!--
<resource_type id="ContainersList">
<method href="#listContainers"/>
</resource_type>
<resource_type id="ObjectsList">
<method href="#listObjects"/>
</resource_type>
<resource_type id="RetrieveObject">
<method href="#retrieveobject"/>
</resource_type>
-->
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Storage Account Services Methods -->
<method name="GET" id="listcontainers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show account details and list containers">
<para role="shortdesc">
Shows details for a specified account and lists containers, sorted by name, in the account.
</para>
<para>This operation lists the storage containers in your account and sorts them by name. You perform the operation against your storage account URL.</para>
<para>The list is limited to 10,000 containers at a time. For information on limiting and navigating the list, see the following section, "Controlling a Large List of Containers". </para>
<para>Container names are sorted based on a binary comparison, a built-in collating function
that compares string data by using SQLite's <code>memcmp()</code> function,
regardless of text encoding. For more information, see <link
xlink:href="http://www.sqlite.org/datatype3.html#collation"
>http://www.sqlite.org/datatype3.html#collation</link>.</para>
<para>A list of containers is returned in the response body, one container per line. </para>
<para>The character sequence used to create the newline that separates the container names is a single \n. If you want to parse these listings,
you send an <code>Accept: application/json</code> or <code>Accept: application/xml</code> header with the request to get the results in JSON or XML.</para>
<para>An HTTP response status code of 200 through 299 indicates success. A 200 (OK) code is returned if there are containers, and a 204 (No Content) code is returned if there are no containers.</para>
<para><emphasis role="bold">Format Container List</emphasis> </para>
<para>If you append the <code>?format=xml</code> or <code>?format=json</code> query parameter to the storage account URL, the service returns container information serialized in the specified format. To format your results, you must place this query parameter before any other parameters. </para>
<para>The example responses in this section are formatted for readability. </para>
<para><emphasis role="bold">Controlling a Large List of Containers</emphasis></para>
<para>A <command>GET</command> operation on the storage account URL returns a list of up to 10,000 container names. You can control and limit this list of results by using the <code>marker</code>, <code>end_marker</code>, and <code>limit</code> parameters. These parameters provide a mechanism for iterating through the entire list of containers. </para>
<para>The <code>marker</code> parameter tells Cloud Files where to begin your list of containers, and the <code>end_marker</code> parameter specifies where to end the list. You can use them independently or together, separated by an ampersand (<code>&</code>). If you do not specify them, your list displays up to 10,000 containers. Note that the <code>marker</code> and <code>end_marker</code> values must be URL-encoded before you send the HTTP request.</para>
<para>You can use the <code>limit</code> parameter to reduce the number of returned objects. </para>
<para>If the number of returned items equals the <code>limit</code> used (or 10,000 if no <code>limit</code> was specified), you can assume there are more object names.</para>
<note><para>At this time, a <code>prefix</code> query parameter is not supported at the account level.</para></note>
<para>As an example, start with an account that has five container names, as follows:</para>
<para><programlisting language="bash"> apples
bananas
kiwis
oranges
pears</programlisting></para>
<para>Use a limit of 2 to show how things work:</para>
<para><programlisting language="bash"> GET /v1/MossoCloudFS_0672d7fa-9f85-4a81-a3ab-adb66a880123?limit=2
Host: storage.clouddrive.com
X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
apples
bananas</programlisting></para>
<para>Because the operation returned two items, assume there are more container names to list and make another request with a marker of the last item returned:</para>
<para><programlisting language="bash"> GET /v1/MossoCloudFS_0672d7fa-9f85-4a81-a3ab-adb66a880123?limit=2&marker=bananas
Host: storage.clouddrive.com
X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
kiwis
oranges</programlisting></para>
<para>Again, two items are returned, and you assume that there might be more. So you make another GET request for two more:</para>
<para><programlisting language="bash"> GET /v1/MossoCloudFS_0672d7fa-9f85-4a81-a3ab-adb66a880123?limit=2&marker=oranges
Host: storage.clouddrive.com
X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
pears</programlisting></para>
<para>This one-item response shows fewer than the limit of 2 container names requested, and indicates that this is the end of the list.</para>
<para>By using the <code>end_marker</code> parameter, you can limit the result set to container names less than the given value.</para>
<para><programlisting language="bash"> GET /v1/MossoCloudFS_0672d7fa-9f85-4a81-a3ab-adb66a880123?end_marker=oranges
Host: storage.clouddrive.com
X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
apples
bananas
kiwis</programlisting></para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="Accept"
style="header" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Instead of using the <code>format</code> query
parameter, set this header to
<code>application/json</code>,
<code>application/xml</code>, or
<code>text/xml</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" required="false"
type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">For an integer value n, limits the number of results to n values.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="marker" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Given a string value x, returns container names greater in value than the specified marker. Only strings using UTF-8 encoding are valid.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="end_marker" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Given a string value x, returns container names lesser in value than the specified marker. Only strings using UTF-8 encoding are valid.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="format" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Value of
the serialized response format, either JSON or
XML.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="prefix"
style="query" required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Prefix value. Object
names in the response begin with this value.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="delimiter"
style="query" required="false" type="xsd:char">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Delimiter value, which returns the object names
that are nested in the container.
</p></doc>
</param>
<representation mediaType="application/xml" element="files:Files" >
<doc>
<xsdxt:code href="../wadl/samples/cf-getAccountContainers_request.xml"/>
</doc>
</representation>
<representation mediaType="application/json" element="files:Files" >
<doc>
<xsdxt:code href="../wadl/samples/cf-getAccountContainers_request.json"/>
</doc>
</representation>
</request>
<response status="200" xmlns="http://wadl.dev.java.net/2009/02">
<doc title="OK">The request succeeded. The information returned with the response is dependent on the method used in the request.</doc>
<representation mediaType="application/json">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true" type="xsd:string" path="/account/container/Content-Length">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The length of the response body that contains the
list of names. If the operation fails, this value is the
length of the error text in the response
body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="Content-Type"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The MIME type of the list of names. If the
operation fails, this value is the MIME type of the error
text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Object-Count" style="header" required="true"
type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The number of objects in the account.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Bytes-Used" style="header" required="true"
type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The total number of bytes that are stored in Cloud Files for the account.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Container-Count" style="header" required="true"
type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The number of containers.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-name" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The custom account metadata item, where
<code>name</code> is the name of the metadata
item. One <code>X-Account-Meta-name</code> response header
appears for each metadata item (for each
<code>name</code>).
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The secret key value for temporary URLs. If not set,
this header is not returned by this operation.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key-2" style="header"
required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A second secret key value for temporary URLs. If not set,
this header is not returned by this operation.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Trans-Id"
style="header" required="true" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A unique transaction identifier for this request.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"
type="xsd:datetime">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The transaction date and time.
</p></doc>
</param>
</representation>
<representation mediaType="application/xml" xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="../wadl/samples/cf-getAccountContainers_response.xml"/>
</wadl:doc>
<param name="name" style="plain" required="true" type="xsd:string" path="/account/container/name">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Name of the container.
</wadl:doc>
</param>
<param name="count" style="plain" required="true" type="xsd:int" path="/account/container/count">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Number of objects in the container.
</wadl:doc>
</param>
<param name="bytes" style="plain" required="true" type="xsd:int" path="/account/container/bytes">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Number of bytes in the container.
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../wadl/samples/cf-getAccountContainers_response.json"/>
</doc>
<param name="name" style="plain" required="true" type="xsd:string" path="$.*.name">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Name of the container.
</wadl:doc>
</param>
<param name="count" style="plain" required="true" type="xsd:int" path="$.*.count">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Number of objects in the container.
</wadl:doc>
</param>
<param name="bytes" style="plain" required="true" type="xsd:int" path="$.*.bytes">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Number of bytes in the container.
</wadl:doc>
</param>
</representation>
</response>
<response status="204">
<doc title="No Content">The request succeeded. The server fulfilled the request but does not need to return a body.</doc>
</response>
&only404Fault;
</method>
<method name="HEAD" id="retrieveaccountmeta">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get account metadata">
<para role="shortdesc">
Gets account metadata.</para>
<para>Perform a <command>HEAD</command> operation on your storage account URL to get the following information: </para>
<itemizedlist spacing="compact">
<listitem>
<para>The number of containers that you have in your account (<code>X-Account-Container-Count</code>)</para>
</listitem>
<listitem>
<para>The number of objects that are stored in the containers in your account (<code>X-Account-Object-Count</code>)</para>
</listitem>
<listitem>
<para>The total bytes that are stored for your account (<code>X-Account-Bytes-Used</code>)</para>
</listitem>
</itemizedlist>
<para>An HTTP status code of 200 through 299 indicates success. In the example, a 204 (No Content) status code is returned. A 401 (Unauthorized) status code is returned for an invalid account or authentication token. </para>
<para>This operation does not require a request body and does not return a response body.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
<representation mediaType="text/xml" element="files:Files">
<doc title="Get account metadata: HTTP request" >
<xsdxt:code href="../wadl/samples/cf-getAccountMetadata_request.txt"/>
</doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
</representation>
</request>
<response status="204">
<doc title="No Content">The request succeeded. The server fulfilled the request but does not need to return a body.</doc>
<representation>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Object-Count" style="header" required="true" type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The total number of objects that are stored in Cloud Files for the account.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Bytes-Used" style="header"
required="true" type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The total number of bytes that are stored in Cloud Files for the account.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Container-Count" style="header"
required="true" type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The total
number of containers that are stored in the Cloud Files for the account.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">If the operation succeeds, this value is zero (0).
If the operation fails, this value is the length of the
error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="Content-Type"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">If the operation fails, this value is the MIME type
of the error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Trans-Id"
style="header" required="true" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A unique transaction identifier for this request.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"
type="xsd:datetime">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The transaction date and time.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Accept-Ranges" style="header" required="true"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The type of ranges accepted.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-name" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The custom account metadata item, where
<code>name</code> is the name of the metadata
item. One <code>X-Account-Meta-name</code> response header
appears for each metadata item (for each
<code>name</code>).
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The secret key value for temporary URLs. If not set,
this header is not returned by this operation.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key-2" style="header"
required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A second secret key value for temporary URLs. If not set,
this header is not returned by this operation.
</p></doc>
</param>
</representation>
<representation mediaType="text/xml" element="files:Files">
<doc title="Get account metadata: HTTP response" >
<xsdxt:code href="../wadl/samples/cf-getAccountMetadata_response.txt"/>
</doc>
</representation>
</response>
&headAcctMetaFaults;
</method>
<method name="POST" id="updateaccountmeta">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create or update account metadata">
<para role="shortdesc">
Creates or updates account metadata.
</para>
<para>You can associate custom metadata headers with the account level URI. To create or update an account metadata header, submit a <command>POST</command> operation. These headers must have the format <code>X-Account-Meta-name</code>. Replace <code>name</code> with name of your metadata. (In the following example request, the metadata headers are <code>X-Account-Meta-Book</code> and <code>X-Account_Meta-Subject</code>.) </para>
<para>Subsequent <command>POST</command> operations for the same key/value pair overwrite the previous value.</para>
<para>A status code of 200 through 299 indicates success. </para>
<para>This operation does not require a request body and does not return a response body.</para>
<para>To confirm your metadata changes, you can perform a <command>HEAD</command> operation on the account. (For information, see <link
xlink:href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/HEAD_retrieveaccountmeta_v1__account__accountServicesOperations_d1e000.html">Get account metadata</link>.) Do not send the metadata in your <command>HEAD</command> operation.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The secret key value for temporary URLs.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key-2" style="header"
required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A second secret key value for temporary URLs. The second key enables you to rotate keys by having an old and new key active at the same time.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-name" style="header" required="true"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Account metadata that you want to create or update. Replace <code>name</code> at the end of the header with the name for your metadata.
You must specify a <code>X-Account-Meta-name</code> header for each metadata item (for each <code>name</code>) that you want to add or update.
</p></doc>
</param>
<representation mediaType="text/xml" element="files:Files" >
<doc title="Create or update account metadata: HTTP request">
<xsdxt:code href="../wadl/samples/cf-updateAccountMetadata_request.txt"/>
</doc>
</representation>
</request>
<response status="204">
<doc title="No Content">The request succeeded. The server fulfilled the request but does not need to return a body.</doc>
<representation>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">If the operation succeeds, this value is zero (0).
If the operation fails, this value is the length of the
error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="Content-Type"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">If the operation fails, this value is the MIME type
of the error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Trans-Id"
style="header" required="true" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A unique transaction identifier for this request.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"
type="xsd:datetime">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The transaction date and time.
</p></doc>
</param>
</representation>
<representation mediaType="text/xml" element="files:Files">
<doc title="Create or update account metadata: HTTP response">
<xsdxt:code href="../wadl/samples/cf-updateAccountMetadata_response.txt"/>
</doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="deleteaccountmeta">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete account metadata">
<para role="shortdesc">
Deletes account metadata.</para>
<para>To delete a metadata header, use the <command>POST</command> operation to send
an empty value for that particular header.</para>
<para>If the tool that you use to communicate with Cloud Files does not support empty headers, such as an older version of cURL, send the <code>X-Remove-Account-Meta-name: arbitrary value</code> header. The <code>arbitrary value</code> is ignored. In the following example request, <code>X-Remove-Account-Meta-Book: x</code> is used.</para>
<para>A status code of 200 through 299 indicates
success.</para>
<para>This operation does not require a request body and does not return a response body.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The secret key value for temporary URLs.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-Temp-URL-Key-2" style="header"
required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A second secret key value for temporary URLs. The second key enables you to rotate keys by having an old and new key active at the same time.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Remove-Account-Meta-name" style="header"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Header to send to delete account metadata. Replace <code>name</code> at the end of the header with the name for your metadata.</para></wadl:doc>
</param>
<representation mediaType="text/xml" element="files:Files" >
<doc title="Delete account metadata: HTTP request">
<xsdxt:code href="../wadl/samples/cf-deleteAccountMetadata_request.txt"/>
</doc>
</representation>
</request>
<response status="204">
<doc title="No Content">The request succeeded. The server fulfilled the request but does not need to return a body.</doc>
<representation>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">If the operation succeeds, this value is zero (0).
If the operation fails, this value is the length of the
error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="Content-Type"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">If the operation fails, this value is the MIME type
of the error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Trans-Id"
style="header" required="true" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A unique transaction identifier for this request.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"
type="xsd:datetime">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The transaction date and time.
</p></doc>
</param>
</representation>
<representation mediaType="text/xml" element="files:Files">
<doc title="Delete account metadata: HTTP response">
<xsdxt:code href="../wadl/samples/cf-deleteAccountMetadata_response.txt"/>
</doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- Storage Container Services Methods -->
<method name="GET" id="listcontainerobjects">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show container details and list objects">
<para role="shortdesc">Shows details for a specified container and lists objects, sorted by name, in the container.</para>
<para>This operation against a storage container name retrieves a list of the objects
stored in the container. You can use optional query parameters to refine the list results.</para>
<para>A request with no query parameters returns the full list of object names stored in the
container, up to 10,000 names. The response body shows the object names as one object name per line. Specifying the query parameters filters the full
list and returns a subset of objects. For information about limiting and controlling the list, see the following “Controlling a Large List of Objects” section.</para>
<para>An HTTP response status code of 200 through 299 indicates success. A status code of 200 (OK) is returned if there are objects, and a 204 (No Content) is returned if there are no objects. If the container does not
exist, or if an incorrect account is specified, a status code 404 (Not Found) is returned.</para>
<para><emphasis role="bold">Format Object List</emphasis></para>
<para>If you append the <code>format=xml</code> or the <code>format=json</code> query parameter to the storage account URL, the service returns additional object information serialized in the specified format. The status codes are the same for <code>format=xml</code> and <code>format=json</code>. However, <code>Content-Type</code> matches the specified format. The example responses in this section are formatted for readability.</para>
<para><emphasis role="bold">Controlling a Large List of Objects</emphasis></para>
<para>A <command>GET</command> request against the container account URL returns a list of up to 10,000 objects. You can limit and control this list of results by using the <code>marker</code>, <code>end_marker</code>, and <code>limit</code> parameters.</para>
<para>The <code>marker</code> parameter tells Cloud Files where to begin your list of objects, and the <code>end_marker</code> parameter tells where to end the list. You can use them either independently or together, separated by an ampersand (<code>&</code>). If you do not specify them, your list displays up to 10,000 objects. Note that the <code>marker</code> and <code>end_marker</code> values must be URL-encoded before you send the HTTP request.</para>
<para>You can use the <code>limit</code> parameter to reduce the number of returned objects.</para>
<para>If the number of returned items equals the <code>limit</code> used (or 10,000 if no <code>limit</code> was specified), you can assume there are more object names.</para>
<para>As an example, use a listing of 5 object names, as follows:</para>
<para><programlisting language="bash" > gala
grannysmith
honeycrisp
jonagold
reddelicious</programlisting></para>
<para>Use a <code>limit</code> of 2 to show how things work:</para>
<para><programlisting language="bash"> GET /v1/MossoCloudFS_0672d7fa-9f85-4a81-a3ab-adb66a880123/AppleType?limit=2
Host: storage.clouddrive.com
X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
gala
grannysmith</programlisting></para>
<para>Because the request returned two items, assume there are more object names to list and make another request with a <code>marker</code> of the last item returned:</para>
<para><programlisting language="bash"> GET /v1/MossoCloudFS_0672d7fa-9f85-4a81-a3ab-adb66a880123/AppleType?limit=2&marker=grannysmith
Host: storage.clouddrive.com
X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
honeycrisp
jonagold</programlisting></para>
<para>Again, two items are returned, and you assume that there might be more. So you make another <command>GET</command> request for two more:</para>
<para><programlisting language="bash"> GET /v1/MossoCloudFS_0672d7fa-9f85-4a81-a3ab-adb66a880123/AppleType?limit=2&marker=jonagold
Host: storage.clouddrive.com
X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
reddelicious</programlisting></para>
<para>This one-item response shows fewer than the limit of two object names requested, and indicates that this is the end of the list.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="Accept"
style="header" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Instead of using the <code>format</code> query
parameter, set this header to
<code>application/json</code>,
<code>application/xml</code>, or
<code>text/xml</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" required="false"
type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">For an integer n, limits the number of results to n values.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="marker" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Given a string value x, returns object names greater in value than the
specified marker.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="end_marker" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Given a string value x, returns object names lesser in value than the specified
marker.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="prefix" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">For a string value x, causes the results to be limited to object names
beginning with the substring x.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="format" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Specifies either JSON or XML
to return the respective serialized response.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="delimiter" style="query" required="false"
type="xsd:char">
<doc><p xmlns="http://www.w3.org/1999/xhtml">For a character c, returns the object names nested in the container
(without the need for the directory marker objects).</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="path" style="query" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">For a string x, returns the object names nested in the pseudo path. This parameter is equivalent to setting the delimiter parameter to / and the prefix to the path with a / on the end.
For more information about pseudo paths, see the section on pseudo hierarchical folders and directories.
</p></doc>
</param>
<!--
<representation mediaType="text/xml" element="files:Files" >
<doc title="List container objects request">
<xsdxt:code href="../wadl/samples/cf-getContainerObjects_request.txt"/>
</doc>
</representation>
-->
<representation mediaType="application/xml" element="files:Files" >
<doc>
<xsdxt:code href="../wadl/samples/cf-getContainerObjects_request.xml"/>
</doc>
</representation>
<representation mediaType="application/json" element="files:Files" >
<doc>
<xsdxt:code href="../wadl/samples/cf-getContainerObjects_request.json"/>
</doc>
</representation>
</request>
<response status="200">
<doc title="OK">The request succeeded. The information returned with the response is dependent on the method used in the request.</doc>
<representation>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true" type="xsd:string" path="/account/container/Content-Length">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The length of the response body that contains the
list of names. If the operation fails, this value is the
length of the error text in the response
body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Object-Count" style="header" required="true"
type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The number of objects.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Accept-Ranges" style="header" required="true"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The type of ranges that the object accepts.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Bytes-Used" style="header" required="true"
type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The count of bytes used in total.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Meta-name" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The custom container metadata item, where
<code>name</code> is the name of the metadata
item. One <code>X-Container-Meta-name</code> response header
appears for each metadata item (for each
<code>name</code>).
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Type" style="header" required="true"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The MIME type of the list of names. If the operation fails, this value is the MIME type of the error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Trans-Id"
style="header" required="true" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A unique transaction identifier for this request.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"
type="xsd:datetime">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The transaction date and time.
</p></doc>
</param>
</representation>
<!--
<representation mediaType="text/xml" xml:lang="EN">
<doc title="Show container details and list objects response">
<xsdxt:code href="../wadl/samples/cf-getContainerObjects_response.txt"/>
</doc>
</representation>
-->
<representation mediaType="application/xml" xml:lang="EN">
<doc>
<xsdxt:code href="../wadl/samples/cf-getContainerObjects_response.xml"/>
</doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the object.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bytes" style="plain" required="true" type="xsd:int">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Number of bytes in the container.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="content-type" style="plain"
required="true" type="xsd:string" path="/account/container/content-type">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The content type of the container.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="last-modified" style="plain"
required="true" type="xsd:string" path="/account/container/last-modified">
<doc><p xmlns="http://www.w3.org/1999/xhtml">An internal variable that indicates the last time an entity (account, container, or object) was modified. <code>last-modified</code> has resolution up to one second. For <code>last-modified</code>, the time zone is UTC.
</p></doc>
</param>
</representation>
<representation mediaType="application/json" xml:lang="EN">
<doc>
<xsdxt:code href="../wadl/samples/cf-getContainerObjects_response.json"/>
</doc>
</representation>
</response>
<response status="204">
<doc title="No Content" xml:lang="EN">The request succeeded. The server fulfilled the request but does not need to return a body.</doc>
<representation mediaType="application/json"/>
</response>
&deleteContainerFaults;
</method>
<method name="PUT" id="createcontainer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create container">
<para role="shortdesc">
Creates a container.
</para>
<para>This operation creates a Cloud Files container. Containers are storage compartments for your data. The URL-encoded name must be no more than 256 bytes and cannot contain a forward slash character (/). You can create up to 500,000 containers in your Cloud Files account.</para>
<para>You can assign custom metadata for containers by including additional HTTP headers with an <code>X-Container-Meta-</code> prefix on the <command>POST</command> request. For details on setting custom metadata, see <link
xlink:href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/POST_updateaccountmeta_v1__account__accountServicesOperations_d1e000.html">Create or update account metadata</link>. </para>
<para>Using custom container metadata, you can create information in the header to effectively tag a container. The container metadata restrictions are the same as the restrictions for object metadata. You can have a maximum of 4096 bytes of metadata for the container, with a maximum of 90 distinct metadata items. Each distinct metadata item can have a name length of up to 128 characters with a maximum of 256 bytes in the value. Any valid UTF-8 encoded string value is allowed for metadata. In addition for custom metadata, we recommend that you URL-encode any non-ASCII values by using a % symbol followed by the two-digit hexadecimal ISO-Latin code for the character.</para>
<para>A status code of 201 (Created) indicates that the container was created as requested. Container <command>PUT</command> requests are idempotent, and a code of 202 (Accepted) is returned if the container existed prior to the request. If you make a <command>PUT</command> request to a container with an <code>X-Container-Meta-</code> prefix in the header, your <command>GET</command> or <command>HEAD</command> request responses carry the metadata prefix from the container in subsequent requests.</para>
<para>This operation does not require a request body and does not return a response body.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Meta-name" style="header"
required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Custom container metadata. Replace <code>name</code> at the end of the header with the name for your metadata.</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Read" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Sets an access control list (ACL) that grants read access. This header can contain a comma-delimited list of users that can read the container (allows the GET method for all objects in the container).
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Write" style="header" required="false"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Sets an ACL that grants write access. This header can contain a comma-delimited list of users that can write to the container (allows PUT, POST, COPY, and DELETE methods for all objects in the container).
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Container-Sync-Key"
style="header" required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Sets the secret key for container synchronization. For container synchronization, you must set <code>X-Container-Sync-Key</code> on the source container and the destination container.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Container-Sync-To"
style="header" required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Sets the destination for container synchronization. For container synchronization, the <code>X-Container-Sync-To</code> value must follow the form //realmName/clusterName/accountName/containerName.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Versions-Location"
style="header" required="false" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enables versioning on this container. The value is the name of another container. You must UTF-8-encode and then URL-encode the name before you include it in the header. To disable versioning, set the header to an empty string.
</p></doc>
</param>
<representation mediaType="text/xml" element="files:Files" >
<doc title="Create container: HTTP request">
<xsdxt:code href="../wadl/samples/cf-createContainer_request.txt"/>
</doc>
</representation>
<representation mediaType="text/xml" element="files:Files" >
<doc title="Create container with metadata: HTTP request">
<xsdxt:code href="../wadl/samples/cf-createContainerWithMetadata_request.txt"/>
</doc>
</representation>
</request>
<response status="201 202">
<doc title="Created or Accepted">The request has been fulfilled. For 201 Created, the new container has been created. For 202 Accepted, the request has been accepted for processing.</doc>
<representation>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true" type="xsd:string" path="/account/container/Content-Length">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The length of the response body that contains the
list of names. If the operation fails, this value is the
length of the error text in the response
body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Type" style="header" required="true"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The MIME type of the list of names. If the operation fails, this value is the MIME type of the error text in the response body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Trans-Id"
style="header" required="true" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A unique transaction identifier for this request.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"
type="xsd:datetime">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The transaction date and time.
</p></doc>
</param>
</representation>
<representation mediaType="application/xml" element="files:Files" >
<doc title="Create container: HTTP response">
<xsdxt:code href="../wadl/samples/cf-createContainer_response.txt"/>
</doc>
</representation>
<representation mediaType="text/xml" element="files:Files" >
<doc title="Create container with metadata: HTTP response">
<xsdxt:code href="../wadl/samples/cf-createContainerWithMetadata_response.txt"/>
</doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deletecontainer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete container">
<para role="shortdesc">Deletes an empty container.</para>
<para>A <command>DELETE</command> operation against a storage container permanently removes it. The container must be empty before it can be deleted.</para>
<para>Before using <command>DELETE</command>, you can use a <command>GET</command> operation against the container to list any objects that it contains. (See
<link
xlink:href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/GET_listcontainerobjects_v1__account___container__containerServicesOperations_d1e000.html">Show container details and list objects</link>.)</para>
<para>A status code of 204 (No Content) indicates
success. A status code of 404 (Not Found) is returned if the requested container is not found. A status code of 409
(Conflict) is returned if the container is not empty.</para>
<para>This operation does not require a request body and does not return a response body.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token"
style="header" required="true" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Authentication token.
</p></doc>
</param>
<representation mediaType="text/xml" element="files:Files" >
<doc title="Delete container: HTTP request">
<xsdxt:code href="../wadl/samples/cf-deleteContainer_request.txt"/>
</doc>
</representation>
</request>
<response status="204">
<doc title="No Content">The request succeeded. The server fulfilled the request but does not need to return a body.</doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true" type="xsd:string" path="/account/container/Content-Length">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The length of the response body that contains the
list of names. If the operation fails, this value is the
length of the error text in the response
body.
</p></doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Type" style="header" required="true"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The MIME type of the list of names. If the operation fails, this value is the MIME type of the error text in the response body.