summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSerg Melikyan <smelikyan@mirantis.com>2013-04-08 10:25:51 +0400
committerSerg Melikyan <smelikyan@mirantis.com>2013-04-08 10:26:17 +0400
commit48b670d043f190ae5c23f7d55860dcac1393a17d (patch)
tree8a9e8049484630ef6fba263c3d8e084de9743f22
parent6ce6e42eea413d8e5e039b0fec8df7e0a8a03ef4 (diff)
Finished converting API Specification
-rw-r--r--docs/src/glazier-manual/src/docbkx/glazier-manual.xml1473
1 files changed, 1469 insertions, 4 deletions
diff --git a/docs/src/glazier-manual/src/docbkx/glazier-manual.xml b/docs/src/glazier-manual/src/docbkx/glazier-manual.xml
index 9994936..042a257 100644
--- a/docs/src/glazier-manual/src/docbkx/glazier-manual.xml
+++ b/docs/src/glazier-manual/src/docbkx/glazier-manual.xml
@@ -349,7 +349,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
349 <tbody> 349 <tbody>
350 <row> 350 <row>
351 <entry>id</entry> 351 <entry>id</entry>
352 <entry>GUID</entry> 352 <entry>guid</entry>
353 <entry>Unique ID</entry> 353 <entry>Unique ID</entry>
354 </row> 354 </row>
355 <row> 355 <row>
@@ -369,7 +369,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
369 </row> 369 </row>
370 <row> 370 <row>
371 <entry>tenant_id</entry> 371 <entry>tenant_id</entry>
372 <entry>GUID</entry> 372 <entry>guid</entry>
373 <entry>Open Stack tenant id</entry> 373 <entry>Open Stack tenant id</entry>
374 </row> 374 </row>
375 <row> 375 <row>
@@ -385,7 +385,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
385 <section> 385 <section>
386 <title>Call</title> 386 <title>Call</title>
387 <table frame='all'> 387 <table frame='all'>
388 <title> </title> 388 <title>GET /environments Call</title>
389 <tgroup cols='3' align='left' colsep='1' rowsep='1'> 389 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
390 <colspec colnum="1" colname="col1" colwidth="1*"/> 390 <colspec colnum="1" colname="col1" colwidth="1*"/>
391 <colspec colnum="2" colname="col2" colwidth="4*"/> 391 <colspec colnum="2" colname="col2" colwidth="4*"/>
@@ -413,7 +413,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
413 </section> 413 </section>
414 <section> 414 <section>
415 <title>Returns</title> 415 <title>Returns</title>
416 <para>This call returns list of environments. Only the basic properties are returned. For details see “Get Environment Detailed Information”: 416 <para>This call returns list of environments. Only the basic properties are returned. For details see "Get Environment Detailed Information":
417 <programlisting> 417 <programlisting>
418 <![CDATA[ 418 <![CDATA[
419 { 419 {
@@ -439,6 +439,1471 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
439 </para> 439 </para>
440 </section> 440 </section>
441 </section> 441 </section>
442 <section>
443 <title>Create Environment instance</title>
444 <section>
445 <title>Call</title>
446 <table frame='all'>
447 <title>POST /environments Call</title>
448 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
449 <colspec colnum="1" colname="col1" colwidth="1*"/>
450 <colspec colnum="2" colname="col2" colwidth="4*"/>
451 <colspec colnum="3" colname="col3" colwidth="4*"/>
452 <thead>
453 <row>
454 <entry>Method</entry>
455 <entry>URI</entry>
456 <entry>Description</entry>
457 </row>
458 </thead>
459 <tbody>
460 <row>
461 <entry>POST</entry>
462 <entry>/environments</entry>
463 <entry>Create new Environment</entry>
464 </row>
465 </tbody>
466 </tgroup>
467 </table>
468 </section>
469 <section>
470 <title>Payload</title>
471 <programlisting>
472 <![CDATA[
473{
474 "name": "env1"
475}
476 ]]>
477 </programlisting>
478 </section>
479 <section>
480 <title>Returns</title>
481 <para>This call returns created environment:
482 <programlisting>
483 <![CDATA[
484{
485 "id": "ce373a477f211e187a55404a662f968",
486 "name": "env1",
487 "created": "2010-11-30T03:23:42Z",
488 "updated": "2010-11-30T03:23:44Z",
489 "tenant_id": "0849006f7ce94961b3aab4e46d6f229a"
490}
491 ]]>
492 </programlisting>
493 </para>
494 </section>
495 </section>
496 <section>
497 <title>Update Environment Instance</title>
498 <section>
499 <title>Call</title>
500 <table frame='all'>
501 <title>PUT /environments/&lt;id&gt; Call</title>
502 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
503 <colspec colnum="1" colname="col1" colwidth="1*"/>
504 <colspec colnum="2" colname="col2" colwidth="4*"/>
505 <colspec colnum="3" colname="col3" colwidth="4*"/>
506 <thead>
507 <row>
508 <entry>Method</entry>
509 <entry>URI</entry>
510 <entry>Description</entry>
511 </row>
512 </thead>
513 <tbody>
514 <row>
515 <entry>PUT</entry>
516 <entry>/environments/&lt;id&gt;</entry>
517 <entry>Update properties of Environment instance</entry>
518 </row>
519 </tbody>
520 </tgroup>
521 </table>
522 </section>
523 <section>
524 <title>Payload</title>
525 <programlisting>
526 <![CDATA[
527{
528 "name": "env1-changed"
529}
530 ]]>
531 </programlisting>
532 </section>
533 <section>
534 <title>Returns</title>
535 <para>This call returns modified environment object:
536 <programlisting>
537 <![CDATA[
538{
539 "id": "ce373a477f211e187a55404a662f968",
540 "name": "env1-changed",
541 "created": "2010-11-30T03:23:42Z",
542 "updated": "2010-11-30T03:23:44Z",
543 "tenant_id": "0849006f7ce94961b3aab4e46d6f229a"
544}
545 ]]>
546 </programlisting>
547 </para>
548 </section>
549 </section>
550 <section>
551 <title>Get Environment Instance Detailed Information</title>
552 <section>
553 <title>Call</title>
554 <table frame='all'>
555 <title>GET /environments/&lt;id&gt; Call</title>
556 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
557 <colspec colnum="1" colname="col1" colwidth="1*"/>
558 <colspec colnum="2" colname="col2" colwidth="4*"/>
559 <colspec colnum="3" colname="col3" colwidth="4*"/>
560 <thead>
561 <row>
562 <entry>Method</entry>
563 <entry>URI</entry>
564 <entry>Description</entry>
565 </row>
566 </thead>
567 <tbody>
568 <row>
569 <entry>GET</entry>
570 <entry>/environments/&lt;id&gt;</entry>
571 <entry>Returns detailed information about Environment including child entities</entry>
572 </row>
573 </tbody>
574 </tgroup>
575 </table>
576 </section>
577 <section>
578 <title>Payload</title>
579 <para>None</para>
580 </section>
581 <section>
582 <title>Returns</title>
583 <para>This call returns modified environment object:
584 <programlisting>
585 <![CDATA[
586{
587 "id": "ce373a477f211e187a55404a662f968",
588 "name": "env1",
589 "created": "2010-11-30T03:23:42Z",
590 "updated": "2010-11-30T03:23:44Z",
591 "tenant_id": "0849006f7ce94961b3aab4e46d6f229a",
592 "status": "pending"
593}
594 ]]>
595 </programlisting>
596 </para>
597 </section>
598 </section>
599 <section>
600 <title>Remove Environment</title>
601 <section>
602 <title>Call</title>
603 <table frame='all'>
604 <title>DELETE /environments/&lt;id&gt; Call</title>
605 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
606 <colspec colnum="1" colname="col1" colwidth="1*"/>
607 <colspec colnum="2" colname="col2" colwidth="4*"/>
608 <colspec colnum="3" colname="col3" colwidth="4*"/>
609 <thead>
610 <row>
611 <entry>Method</entry>
612 <entry>URI</entry>
613 <entry>Description</entry>
614 </row>
615 </thead>
616 <tbody>
617 <row>
618 <entry>DELETE</entry>
619 <entry>/environments/&lt;id&gt;</entry>
620 <entry>Remove specified Environment.</entry>
621 </row>
622 </tbody>
623 </tgroup>
624 </table>
625 </section>
626 <section>
627 <title>Payload</title>
628 <para>None</para>
629 </section>
630 <section>
631 <title>Returns</title>
632 <para>None</para>
633 </section>
634 </section>
635 </section>
636 <section>
637 <title>Environment Configuration API</title>
638 <para>Only one Environment can be configured at a time by only one user. This behavior archived by opening "configuration session" for some Environment by user, and locking this Environment for changes by other users. Only one open session per Environment is available.</para>
639 <table frame='all'>
640 <title>Configuration Session Object</title>
641 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
642 <colspec colnum="1" colname="col1" colwidth="1*"/>
643 <colspec colnum="2" colname="col2" colwidth="1*"/>
644 <colspec colnum="3" colname="col3" colwidth="4*"/>
645 <thead>
646 <row>
647 <entry>Attribute</entry>
648 <entry>Type</entry>
649 <entry>Description</entry>
650 </row>
651 </thead>
652 <tbody>
653 <row>
654 <entry>id</entry>
655 <entry>guid</entry>
656 <entry>Session unique ID</entry>
657 </row>
658 <row>
659 <entry>environment_id</entry>
660 <entry>guid</entry>
661 <entry>Environment that going to be modified during this session</entry>
662 </row>
663 <row>
664 <entry>created</entry>
665 <entry>datetime</entry>
666 <entry>Creation date and time in ISO format</entry>
667 </row>
668 <row>
669 <entry>updated</entry>
670 <entry>datetime</entry>
671 <entry>Modification date and time in ISO format</entry>
672 </row>
673 <row>
674 <entry>user_id</entry>
675 <entry>guid</entry>
676 <entry>Session owner guid</entry>
677 </row>
678 <row>
679 <entry>state</entry>
680 <entry>string</entry>
681 <entry>Session state. Could be: open, deploying, deployed</entry>
682 </row>
683 </tbody>
684 </tgroup>
685 </table>
686 <section>
687 <title>Get a List of Sessions</title>
688 <para>Only one open session can be for one Environment.</para>
689 <section>
690 <title>Call</title>
691 <table frame='all'>
692 <title>GET /environments/&lt;id&gt;/sessions Call</title>
693 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
694 <colspec colnum="1" colname="col1" colwidth="1*"/>
695 <colspec colnum="2" colname="col2" colwidth="4*"/>
696 <colspec colnum="3" colname="col3" colwidth="4*"/>
697 <thead>
698 <row>
699 <entry>Method</entry>
700 <entry>URI</entry>
701 <entry>Description</entry>
702 </row>
703 </thead>
704 <tbody>
705 <row>
706 <entry>GET</entry>
707 <entry>/environments/&lt;id&gt;/sessions</entry>
708 <entry>Get a list of open sessions</entry>
709 </row>
710 </tbody>
711 </tgroup>
712 </table>
713 </section>
714 <section>
715 <title>Payload</title>
716 <para>None</para>
717 </section>
718 <section>
719 <title>Returns</title>
720 <para>This call returns list of open sessions:
721 <programlisting>
722 <![CDATA[
723 {
724 "sessions": [
725 {
726 "id": "108bbd04084d4dc8a2e8986fa8fa5bf2",
727 "environment_id": "4dc8a2e8986fa8fa5bf24dc8a2e8986fa8",
728 "created": "2010-11-30T03:23:42Z",
729 "updated": "2010-11-30T03:23:54Z",
730 "user_id": "d7b501094caf4daab08469663a9e1a2b",
731 "state": "deployed"
732 },
733 {
734 "id": "4aecdc2178b9430cbbb8db44fb7ac384",
735 "environment_id": "4dc8a2e8986fa8fa5bf24dc8a2e8986fa8",
736 "created": "2010-11-30T03:23:42Z",
737 "updated": "2010-11-30T03:23:54Z",
738 "user_id": "d7b501094caf4daab08469663a9e1a2b",
739 "state": "open"
740 }
741 ]
742}
743 ]]>
744 </programlisting>
745 </para>
746 </section>
747 </section>
748 <section>
749 <title>Open session</title>
750 <para>During this call new working session is created, and session ID should be sent in header (X-Configuration-Session) to all next API calls.</para>
751 <section>
752 <title>Call</title>
753 <table frame='all'>
754 <title>POST /environments/&lt;id&gt;/configure Call</title>
755 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
756 <colspec colnum="1" colname="col1" colwidth="1*"/>
757 <colspec colnum="2" colname="col2" colwidth="4*"/>
758 <colspec colnum="3" colname="col3" colwidth="4*"/>
759 <thead>
760 <row>
761 <entry>Method</entry>
762 <entry>URI</entry>
763 <entry>Description</entry>
764 </row>
765 </thead>
766 <tbody>
767 <row>
768 <entry>POST</entry>
769 <entry>/environments/&lt;id&gt;/configure</entry>
770 <entry>Creating new configuration change session</entry>
771 </row>
772 </tbody>
773 </tgroup>
774 </table>
775 </section>
776 <section>
777 <title>Payload</title>
778 <para>None</para>
779 </section>
780 <section>
781 <title>Returns</title>
782 <para>This call returns created session:
783 <programlisting>
784 <![CDATA[
785{
786 "id": "4aecdc2178b9430cbbb8db44fb7ac384",
787 "environment_id": "4dc8a2e8986fa8fa5bf24dc8a2e8986fa8",
788 "created": "2010-11-30T03:23:42Z",
789 "updated": "2010-11-30T03:23:54Z",
790 "user_id": "d7b501094caf4daab08469663a9e1a2b",
791 "state": "open"
792}
793 ]]>
794 </programlisting>
795 </para>
796 </section>
797 </section>
798 <section>
799 <title>Deploy changes from Session</title>
800 <section>
801 <title>Call</title>
802 <table frame='all'>
803 <title>POST /environments/&lt;id&gt;/sessions/&lt;sessionId&gt;/deploy Call</title>
804 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
805 <colspec colnum="1" colname="col1" colwidth="1*"/>
806 <colspec colnum="2" colname="col2" colwidth="4*"/>
807 <colspec colnum="3" colname="col3" colwidth="4*"/>
808 <thead>
809 <row>
810 <entry>Method</entry>
811 <entry>URI</entry>
812 <entry>Description</entry>
813 </row>
814 </thead>
815 <tbody>
816 <row>
817 <entry>POST</entry>
818 <entry>/environments/&lt;id&gt;/sessions/&lt;sessionId&gt;/deploy</entry>
819 <entry>Deploying changes made in session with specified &lt;sessionId&gt;</entry>
820 </row>
821 </tbody>
822 </tgroup>
823 </table>
824 </section>
825 <section>
826 <title>Payload</title>
827 <para>None</para>
828 </section>
829 <section>
830 <title>Returns</title>
831 <para>This call returns deployed session:
832 <programlisting>
833 <![CDATA[
834{
835 "id": "4aecdc2178b9430cbbb8db44fb7ac384",
836 "environment_id": "4dc8a2e8986fa8fa5bf24dc8a2e8986fa8",
837 "created": "2010-11-30T03:23:42Z",
838 "updated": "2010-11-30T03:23:54Z",
839 "user_id": "d7b501094caf4daab08469663a9e1a2b",
840 "state": "deploying"
841}
842 ]]>
843 </programlisting>
844 </para>
845 </section>
846 </section>
847 <section>
848 <title>Get session information</title>
849 <section>
850 <title>Call</title>
851 <table frame='all'>
852 <title>GET /environments/&lt;id&gt;/sessions/&lt;sessionId&gt; Call</title>
853 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
854 <colspec colnum="1" colname="col1" colwidth="1*"/>
855 <colspec colnum="2" colname="col2" colwidth="4*"/>
856 <colspec colnum="3" colname="col3" colwidth="4*"/>
857 <thead>
858 <row>
859 <entry>Method</entry>
860 <entry>URI</entry>
861 <entry>Description</entry>
862 </row>
863 </thead>
864 <tbody>
865 <row>
866 <entry>GET</entry>
867 <entry>/environments/&lt;id&gt;/sessions/&lt;sessionId&gt;</entry>
868 <entry>Getting details about session with specified &lt;sessionId&gt;</entry>
869 </row>
870 </tbody>
871 </tgroup>
872 </table>
873 </section>
874 <section>
875 <title>Payload</title>
876 <para>None</para>
877 </section>
878 <section>
879 <title>Returns</title>
880 <para>This call returns session information:
881 <programlisting>
882 <![CDATA[
883{
884 "id": "4aecdc2178b9430cbbb8db44fb7ac384",
885 "environment_id": "4dc8a2e8986fa8fa5bf24dc8a2e8986fa8",
886 "created": "2010-11-30T03:23:42Z",
887 "updated": "2010-11-30T03:23:54Z",
888 "user_id": "d7b501094caf4daab08469663a9e1a2b",
889 "state": "deploying"
890}
891 ]]>
892 </programlisting>
893 </para>
894 </section>
895 </section>
896 <section>
897 <title>Delete Session </title>
898 <section>
899 <title>Call</title>
900 <table frame='all'>
901 <title>DELETE /environments/&lt;id&gt;/sessions/&lt;sessionId&gt; Call</title>
902 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
903 <colspec colnum="1" colname="col1" colwidth="1*"/>
904 <colspec colnum="2" colname="col2" colwidth="4*"/>
905 <colspec colnum="3" colname="col3" colwidth="4*"/>
906 <thead>
907 <row>
908 <entry>Method</entry>
909 <entry>URI</entry>
910 <entry>Description</entry>
911 </row>
912 </thead>
913 <tbody>
914 <row>
915 <entry>DELETE</entry>
916 <entry>/environments/&lt;id&gt;/sessions/&lt;sessionId&gt;</entry>
917 <entry>Delete session with specified &lt;sessionId&gt;</entry>
918 </row>
919 </tbody>
920 </tgroup>
921 </table>
922 </section>
923 <section>
924 <title>Payload</title>
925 <para>None</para>
926 </section>
927 <section>
928 <title>Returns</title>
929 <para>None</para>
930 </section>
931 </section>
932 </section>
933 <section>
934 <title>Active Directory API</title>
935 <para>This section describes API calls for Active Directory service management.</para>
936 <section>
937 <title>Get a List of existing Active Directory instances</title>
938 <table frame='all'>
939 <title>Active Directory Object</title>
940 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
941 <colspec colnum="1" colname="col1" colwidth="1*"/>
942 <colspec colnum="2" colname="col2" colwidth="1*"/>
943 <colspec colnum="3" colname="col3" colwidth="4*"/>
944 <thead>
945 <row>
946 <entry>Attribute</entry>
947 <entry>Type</entry>
948 <entry>Description</entry>
949 </row>
950 </thead>
951 <tbody>
952 <row>
953 <entry>id</entry>
954 <entry>guid</entry>
955 <entry>Unique ID</entry>
956 </row>
957 <row>
958 <entry>name</entry>
959 <entry>string</entry>
960 <entry>Domain name</entry>
961 </row>
962 <row>
963 <entry>created</entry>
964 <entry>datetime</entry>
965 <entry>Creation date and time in ISO format</entry>
966 </row>
967 <row>
968 <entry>updated</entry>
969 <entry>datetime</entry>
970 <entry>Modification date and time in ISO format</entry>
971 </row>
972 <row>
973 <entry>configuration</entry>
974 <entry>string</entry>
975 <entry>AD configuration: site, standalone, inTree</entry>
976 </row>
977 <row>
978 <entry>domain</entry>
979 <entry>string</entry>
980 <entry>Domain name (same as name)</entry>
981 </row>
982 <row>
983 <entry>units</entry>
984 <entry>object</entry>
985 <entry>Active Directory Unit object</entry>
986 </row>
987 </tbody>
988 </tgroup>
989 </table>
990 <table frame='all'>
991 <title>Active Directory Unit Object</title>
992 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
993 <colspec colnum="1" colname="col1" colwidth="1*"/>
994 <colspec colnum="2" colname="col2" colwidth="1*"/>
995 <colspec colnum="3" colname="col3" colwidth="4*"/>
996 <thead>
997 <row>
998 <entry>Attribute</entry>
999 <entry>Type</entry>
1000 <entry>Description</entry>
1001 </row>
1002 </thead>
1003 <tbody>
1004 <row>
1005 <entry>id</entry>
1006 <entry>guid</entry>
1007 <entry>Unique ID</entry>
1008 </row>
1009 <row>
1010 <entry>isMaster</entry>
1011 <entry>boolean</entry>
1012 <entry>Is unit is master domain?</entry>
1013 </row>
1014 <row>
1015 <entry>location</entry>
1016 <entry>string</entry>
1017 <entry>AvailabilityZone or specific physical datacenter.</entry>
1018 </row>
1019 </tbody>
1020 </tgroup>
1021 </table>
1022 <section>
1023 <title>Call</title>
1024 <table frame='all'>
1025 <title>GET /environments/&lt;id&gt;/activeDirectories Call</title>
1026 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1027 <colspec colnum="1" colname="col1" colwidth="1*"/>
1028 <colspec colnum="2" colname="col2" colwidth="4*"/>
1029 <colspec colnum="3" colname="col3" colwidth="4*"/>
1030 <thead>
1031 <row>
1032 <entry>Method</entry>
1033 <entry>URI</entry>
1034 <entry>Description</entry>
1035 </row>
1036 </thead>
1037 <tbody>
1038 <row>
1039 <entry>GET</entry>
1040 <entry>/environments/&lt;id&gt;/activeDirectories</entry>
1041 <entry>Get a list of Active Directory instances</entry>
1042 </row>
1043 </tbody>
1044 </tgroup>
1045 </table>
1046 </section>
1047 <section>
1048 <title>Payload</title>
1049 <para>None</para>
1050 </section>
1051 <section>
1052 <title>Returns</title>
1053 <para>This call returns list of Active Directory instances:
1054 <programlisting>
1055 <![CDATA[
1056{
1057 "activeDirectories": [{
1058 "id": "96365940588b479294fe8e6dc073db04",
1059 "name": "acme.dc",
1060 "created": "2010-11-30T03:23:42Z",
1061 "updated": "2010-11-30T03:23:44Z",
1062 "configuration": "standalone",
1063 "units": [{
1064 "id": "d08887df15b94178b244904b506fe85b",
1065 "isMaster": true,
1066 "location": "west-dc"
1067 }, {
1068 "id": "dcf0de317e7046bea555539f19b8ea84",
1069 "isMaster": false,
1070 "location": "west-dc"
1071 }]
1072 }]
1073}
1074 ]]>
1075 </programlisting>
1076 </para>
1077 </section>
1078 </section>
1079 <section>
1080 <title>Create Active Directory instance</title>
1081 <table frame='all'>
1082 <title>Active Directory Object</title>
1083 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1084 <colspec colnum="1" colname="col1" colwidth="1*"/>
1085 <colspec colnum="2" colname="col2" colwidth="1*"/>
1086 <colspec colnum="3" colname="col3" colwidth="4*"/>
1087 <thead>
1088 <row>
1089 <entry>Attribute</entry>
1090 <entry>Type</entry>
1091 <entry>Description</entry>
1092 </row>
1093 </thead>
1094 <tbody>
1095 <row>
1096 <entry>name</entry>
1097 <entry>string</entry>
1098 <entry>Domain name</entry>
1099 </row>
1100 <row>
1101 <entry>configuration</entry>
1102 <entry>string</entry>
1103 <entry>AD configuration: site, standalone, inTree</entry>
1104 </row>
1105 <row>
1106 <entry>adminPassword</entry>
1107 <entry>string</entry>
1108 <entry>Password from domain administrator account</entry>
1109 </row>
1110 <row>
1111 <entry>domain</entry>
1112 <entry>string</entry>
1113 <entry>Domain name (same as name)</entry>
1114 </row>
1115 <row>
1116 <entry>units</entry>
1117 <entry>object</entry>
1118 <entry>Active Directory Unit object</entry>
1119 </row>
1120 </tbody>
1121 </tgroup>
1122 </table>
1123 <table frame='all'>
1124 <title>Active Directory Unit Object</title>
1125 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1126 <colspec colnum="1" colname="col1" colwidth="1*"/>
1127 <colspec colnum="2" colname="col2" colwidth="1*"/>
1128 <colspec colnum="3" colname="col3" colwidth="4*"/>
1129 <thead>
1130 <row>
1131 <entry>Attribute</entry>
1132 <entry>Type</entry>
1133 <entry>Description</entry>
1134 </row>
1135 </thead>
1136 <tbody>
1137 <row>
1138 <entry>isMaster</entry>
1139 <entry>boolean</entry>
1140 <entry>Is unit is master domain?</entry>
1141 </row>
1142 <row>
1143 <entry>recoveryPassword</entry>
1144 <entry>string</entry>
1145 <entry>Recovery password</entry>
1146 </row>
1147 <row>
1148 <entry>location</entry>
1149 <entry>string</entry>
1150 <entry>AvailabilityZone or specific physical datacenter.</entry>
1151 </row>
1152 </tbody>
1153 </tgroup>
1154 </table>
1155 <section>
1156 <title>Call</title>
1157 <table frame='all'>
1158 <title>POST /environments/&lt;id&gt;/activeDirectories Call</title>
1159 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1160 <colspec colnum="1" colname="col1" colwidth="1*"/>
1161 <colspec colnum="2" colname="col2" colwidth="4*"/>
1162 <colspec colnum="3" colname="col3" colwidth="4*"/>
1163 <thead>
1164 <row>
1165 <entry>Method</entry>
1166 <entry>URI</entry>
1167 <entry>Description</entry>
1168 </row>
1169 </thead>
1170 <tbody>
1171 <row>
1172 <entry>POST</entry>
1173 <entry>/environments/&lt;id&gt;/activeDirectories</entry>
1174 <entry>Create new Active Directory</entry>
1175 </row>
1176 </tbody>
1177 </tgroup>
1178 </table>
1179 </section>
1180 <section>
1181 <title>Payload</title>
1182 <programlisting>
1183 <![CDATA[
1184{
1185 "name": "acme.dc",
1186 "configuration": "standalone",
1187 "adminPassword": "password",
1188 "domain": "acme.dc",
1189 "units": [
1190 {
1191 "isMaster": true,
1192 "recoveryPassword": "password",
1193 "location": "west-dc"
1194 },
1195 {
1196 "isMaster": false,
1197 "recoveryPassword": "password",
1198 "location": "west-dc"
1199 }
1200 ]
1201}
1202 ]]>
1203 </programlisting>
1204 </section>
1205 <section>
1206 <title>Returns</title>
1207 <para>This call returns created active directory domain:
1208 <programlisting>
1209 <![CDATA[
1210{
1211 "id": "96365940588b479294fe8e6dc073db04",
1212 "name": "acme.dc",
1213 "created": "2010-11-30T03:23:42Z",
1214 "updated": "2010-11-30T03:23:44Z",
1215 "domain": "acme.dc",
1216 "configuration": "standalone",
1217 "units": [{
1218 "id": "d08887df15b94178b244904b506fe85b",
1219 "isMaster": true,
1220 "location": "west-dc"
1221 }, {
1222 "id": "dcf0de317e7046bea555539f19b8ea84",
1223 "isMaster": false,
1224 "location": "west-dc"
1225 }]
1226}
1227 ]]>
1228 </programlisting>
1229 </para>
1230 </section>
1231 </section>
1232 <section>
1233 <title>Update Active Directory instance</title>
1234 <table frame='all'>
1235 <title>Active Directory Object</title>
1236 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1237 <colspec colnum="1" colname="col1" colwidth="1*"/>
1238 <colspec colnum="2" colname="col2" colwidth="1*"/>
1239 <colspec colnum="3" colname="col3" colwidth="4*"/>
1240 <thead>
1241 <row>
1242 <entry>Attribute</entry>
1243 <entry>Type</entry>
1244 <entry>Description</entry>
1245 </row>
1246 </thead>
1247 <tbody>
1248 <row>
1249 <entry>id</entry>
1250 <entry>guid</entry>
1251 <entry>Unique ID</entry>
1252 </row>
1253 <row>
1254 <entry>name</entry>
1255 <entry>string</entry>
1256 <entry>Domain name</entry>
1257 </row>
1258 <row>
1259 <entry>configuration</entry>
1260 <entry>string</entry>
1261 <entry>AD configuration: site, standalone, inTree</entry>
1262 </row>
1263 <row>
1264 <entry>adminPassword</entry>
1265 <entry>string</entry>
1266 <entry>Password from domain administrator account</entry>
1267 </row>
1268 <row>
1269 <entry>domain</entry>
1270 <entry>string</entry>
1271 <entry>Domain name (same as name)</entry>
1272 </row>
1273 <row>
1274 <entry>units</entry>
1275 <entry>object</entry>
1276 <entry>Active Directory Unit object</entry>
1277 </row>
1278 </tbody>
1279 </tgroup>
1280 </table>
1281 <table frame='all'>
1282 <title>Active Directory Unit Object</title>
1283 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1284 <colspec colnum="1" colname="col1" colwidth="1*"/>
1285 <colspec colnum="2" colname="col2" colwidth="1*"/>
1286 <colspec colnum="3" colname="col3" colwidth="4*"/>
1287 <thead>
1288 <row>
1289 <entry>Attribute</entry>
1290 <entry>Type</entry>
1291 <entry>Description</entry>
1292 </row>
1293 </thead>
1294 <tbody>
1295 <row>
1296 <entry>id</entry>
1297 <entry>guid</entry>
1298 <entry>Unique ID</entry>
1299 </row>
1300 <row>
1301 <entry>isMaster</entry>
1302 <entry>boolean</entry>
1303 <entry>Is unit is master domain?</entry>
1304 </row>
1305 <row>
1306 <entry>recoveryPassword</entry>
1307 <entry>string</entry>
1308 <entry>Recovery password</entry>
1309 </row>
1310 <row>
1311 <entry>location</entry>
1312 <entry>string</entry>
1313 <entry>AvailabilityZone or specific physical datacenter.</entry>
1314 </row>
1315 </tbody>
1316 </tgroup>
1317 </table>
1318 <section>
1319 <title>Call</title>
1320 <table frame='all'>
1321 <title>PUT /environments/&lt;id&gt;/activeDirectories/&lt;serviceId&gt; Call</title>
1322 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1323 <colspec colnum="1" colname="col1" colwidth="1*"/>
1324 <colspec colnum="2" colname="col2" colwidth="4*"/>
1325 <colspec colnum="3" colname="col3" colwidth="4*"/>
1326 <thead>
1327 <row>
1328 <entry>Method</entry>
1329 <entry>URI</entry>
1330 <entry>Description</entry>
1331 </row>
1332 </thead>
1333 <tbody>
1334 <row>
1335 <entry>PUT</entry>
1336 <entry>/environments/&lt;id&gt;/activeDirectories/&lt;serviceId&gt;</entry>
1337 <entry>Update existing Active Directory</entry>
1338 </row>
1339 </tbody>
1340 </tgroup>
1341 </table>
1342 </section>
1343 <section>
1344 <title>Payload</title>
1345 <programlisting>
1346 <![CDATA[
1347{
1348 "name": "acme.dc",
1349 "configuration": "standalone",
1350 "adminPassword": "password",
1351 "domain": "acme.dc",
1352 "units": [
1353 {
1354 "isMaster": true,
1355 "recoveryPassword": "new-rpassword",
1356 "location": "west-dc"
1357 },
1358 {
1359 "isMaster": false,
1360 "recoveryPassword": "new-rpassword",
1361 "location": "west-dc"
1362 }
1363 ]
1364}
1365 ]]>
1366 </programlisting>
1367 </section>
1368 <section>
1369 <title>Returns</title>
1370 <para>This call returns updated active directory domain:
1371 <programlisting>
1372 <![CDATA[
1373{
1374 "id": "96365940588b479294fe8e6dc073db04",
1375 "name": "acme.dc",
1376 "created": "2010-11-30T03:23:42Z",
1377 "updated": "2010-11-30T03:23:44Z",
1378 "configuration": "standalone",
1379 "domain": "acme.dc",
1380 "units": [{
1381 "id": "d08887df15b94178b244904b506fe85b",
1382 "isMaster": true,
1383 "location": "west-dc"
1384 }, {
1385 "id": "dcf0de317e7046bea555539f19b8ea84",
1386 "isMaster": false,
1387 "location": "west-dc"
1388 }]
1389}
1390 ]]>
1391 </programlisting>
1392 </para>
1393 </section>
1394 </section>
1395 <section>
1396 <title>Get Information about Active Directory instance</title>
1397 <table frame='all'>
1398 <title>Active Directory Object</title>
1399 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1400 <colspec colnum="1" colname="col1" colwidth="1*"/>
1401 <colspec colnum="2" colname="col2" colwidth="1*"/>
1402 <colspec colnum="3" colname="col3" colwidth="4*"/>
1403 <thead>
1404 <row>
1405 <entry>Attribute</entry>
1406 <entry>Type</entry>
1407 <entry>Description</entry>
1408 </row>
1409 </thead>
1410 <tbody>
1411 <row>
1412 <entry>id</entry>
1413 <entry>guid</entry>
1414 <entry>Unique ID</entry>
1415 </row>
1416 <row>
1417 <entry>name</entry>
1418 <entry>string</entry>
1419 <entry>Domain name</entry>
1420 </row>
1421 <row>
1422 <entry>created</entry>
1423 <entry>datetime</entry>
1424 <entry>Creation date and time in ISO format</entry>
1425 </row>
1426 <row>
1427 <entry>updated</entry>
1428 <entry>datetime</entry>
1429 <entry>Modification date and time in ISO format</entry>
1430 </row>
1431 <row>
1432 <entry>configuration</entry>
1433 <entry>string</entry>
1434 <entry>AD configuration: site, standalone, inTree</entry>
1435 </row>
1436 <row>
1437 <entry>domain</entry>
1438 <entry>string</entry>
1439 <entry>Domain name (same as name)</entry>
1440 </row>
1441 <row>
1442 <entry>units</entry>
1443 <entry>object</entry>
1444 <entry>Active Directory Unit object</entry>
1445 </row>
1446 </tbody>
1447 </tgroup>
1448 </table>
1449 <table frame='all'>
1450 <title>Active Directory Unit Object</title>
1451 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1452 <colspec colnum="1" colname="col1" colwidth="1*"/>
1453 <colspec colnum="2" colname="col2" colwidth="1*"/>
1454 <colspec colnum="3" colname="col3" colwidth="4*"/>
1455 <thead>
1456 <row>
1457 <entry>Attribute</entry>
1458 <entry>Type</entry>
1459 <entry>Description</entry>
1460 </row>
1461 </thead>
1462 <tbody>
1463 <row>
1464 <entry>id</entry>
1465 <entry>guid</entry>
1466 <entry>Unique ID</entry>
1467 </row>
1468 <row>
1469 <entry>isMaster</entry>
1470 <entry>boolean</entry>
1471 <entry>Is unit is master domain?</entry>
1472 </row>
1473 <row>
1474 <entry>location</entry>
1475 <entry>string</entry>
1476 <entry>AvailabilityZone or specific physical datacenter.</entry>
1477 </row>
1478 </tbody>
1479 </tgroup>
1480 </table>
1481 <section>
1482 <title>Call</title>
1483 <table frame='all'>
1484 <title>GET /environments/&lt;id&gt;/activeDirectories/&lt;serviceId&gt; Call</title>
1485 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1486 <colspec colnum="1" colname="col1" colwidth="1*"/>
1487 <colspec colnum="2" colname="col2" colwidth="4*"/>
1488 <colspec colnum="3" colname="col3" colwidth="4*"/>
1489 <thead>
1490 <row>
1491 <entry>Method</entry>
1492 <entry>URI</entry>
1493 <entry>Description</entry>
1494 </row>
1495 </thead>
1496 <tbody>
1497 <row>
1498 <entry>GET</entry>
1499 <entry>/environments/&lt;id&gt;/activeDirectories/&lt;serviceId&gt;</entry>
1500 <entry>Return specified Active Directory instance</entry>
1501 </row>
1502 </tbody>
1503 </tgroup>
1504 </table>
1505 </section>
1506 <section>
1507 <title>Payload</title>
1508 <para>None</para>
1509 </section>
1510 <section>
1511 <title>Returns</title>
1512 <para>This call returns modified environment object:
1513 <programlisting>
1514 <![CDATA[
1515{
1516 "id": "96365940588b479294fe8e6dc073db04",
1517 "name": "acme.dc",
1518 "created": "2010-11-30T03:23:42Z",
1519 "updated": "2010-11-30T03:23:44Z",
1520 "configuration": "standalone",
1521 "domain": "acme.dc",
1522 "units": [{
1523 "id": "d08887df15b94178b244904b506fe85b",
1524 "isMaster": true,
1525 "location": "west-dc"
1526 }, {
1527 "id": "dcf0de317e7046bea555539f19b8ea84",
1528 "isMaster": false,
1529 "location": "west-dc"
1530 }]
1531}
1532 ]]>
1533 </programlisting>
1534 </para>
1535 </section>
1536 </section>
1537 </section>
1538 <section>
1539 <title>Web Server API</title>
1540 <para>This section describes API calls for managing Windows web-server software – IIS.</para>
1541 <table frame='all'>
1542 <title>Web Server Object</title>
1543 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1544 <colspec colnum="1" colname="col1" colwidth="1*"/>
1545 <colspec colnum="2" colname="col2" colwidth="1*"/>
1546 <colspec colnum="3" colname="col3" colwidth="4*"/>
1547 <thead>
1548 <row>
1549 <entry>Attribute</entry>
1550 <entry>Type</entry>
1551 <entry>Description</entry>
1552 </row>
1553 </thead>
1554 <tbody>
1555 <row>
1556 <entry>id</entry>
1557 <entry>guid</entry>
1558 <entry>Unique ID</entry>
1559 </row>
1560 <row>
1561 <entry>name</entry>
1562 <entry>string</entry>
1563 <entry>User-friendly name</entry>
1564 </row>
1565 <row>
1566 <entry>created</entry>
1567 <entry>datetime</entry>
1568 <entry>Creation date and time in ISO format</entry>
1569 </row>
1570 <row>
1571 <entry>updated</entry>
1572 <entry>datetime</entry>
1573 <entry>Modification date and time in ISO format</entry>
1574 </row>
1575 <row>
1576 <entry>domain</entry>
1577 <entry>string</entry>
1578 <entry>Domain name (same as name)</entry>
1579 </row>
1580 <row>
1581 <entry>units</entry>
1582 <entry>object</entry>
1583 <entry>Web Server Unit object</entry>
1584 </row>
1585 </tbody>
1586 </tgroup>
1587 </table>
1588 <table frame='all'>
1589 <title>Web Server Unit Object</title>
1590 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1591 <colspec colnum="1" colname="col1" colwidth="1*"/>
1592 <colspec colnum="2" colname="col2" colwidth="1*"/>
1593 <colspec colnum="3" colname="col3" colwidth="4*"/>
1594 <thead>
1595 <row>
1596 <entry>Attribute</entry>
1597 <entry>Type</entry>
1598 <entry>Description</entry>
1599 </row>
1600 </thead>
1601 <tbody>
1602 <row>
1603 <entry>id</entry>
1604 <entry>guid</entry>
1605 <entry>Unique ID</entry>
1606 </row>
1607 <row>
1608 <entry>endpoint</entry>
1609 <entry>object</entry>
1610 <entry>Unit Endpoint</entry>
1611 </row>
1612 <row>
1613 <entry>location</entry>
1614 <entry>string</entry>
1615 <entry>AvailabilityZone or specific physical datacenter.</entry>
1616 </row>
1617 </tbody>
1618 </tgroup>
1619 </table>
1620 <table frame='all'>
1621 <title>Web Server Unit Endpoint Object</title>
1622 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1623 <colspec colnum="1" colname="col1" colwidth="1*"/>
1624 <colspec colnum="2" colname="col2" colwidth="1*"/>
1625 <colspec colnum="3" colname="col3" colwidth="4*"/>
1626 <thead>
1627 <row>
1628 <entry>Attribute</entry>
1629 <entry>Type</entry>
1630 <entry>Description</entry>
1631 </row>
1632 </thead>
1633 <tbody>
1634 <row>
1635 <entry>host</entry>
1636 <entry>string</entry>
1637 <entry>Host address for IIS Management Console connection</entry>
1638 </row>
1639 </tbody>
1640 </tgroup>
1641 </table>
1642 <section>
1643 <title>Get a List of existing Web Servers</title>
1644 <section>
1645 <title>Call</title>
1646 <table frame='all'>
1647 <title>GET /environments/&lt;id&gt;/webServers Call</title>
1648 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1649 <colspec colnum="1" colname="col1" colwidth="1*"/>
1650 <colspec colnum="2" colname="col2" colwidth="4*"/>
1651 <colspec colnum="3" colname="col3" colwidth="4*"/>
1652 <thead>
1653 <row>
1654 <entry>Method</entry>
1655 <entry>URI</entry>
1656 <entry>Description</entry>
1657 </row>
1658 </thead>
1659 <tbody>
1660 <row>
1661 <entry>GET</entry>
1662 <entry>/environments/&lt;id&gt;/webServers</entry>
1663 <entry>Get a list of existing Web Servers</entry>
1664 </row>
1665 </tbody>
1666 </tgroup>
1667 </table>
1668 </section>
1669 <section>
1670 <title>Payload</title>
1671 <para>None</para>
1672 </section>
1673 <section>
1674 <title>Returns</title>
1675 <para>This call returns list of web servers:
1676 <programlisting>
1677 <![CDATA[
1678{
1679 "webServers":
1680 [
1681 {
1682 "id": "0ce373a477f211e187a55404a662f968",
1683 "name": "frontend",
1684 "created": "2010-11-30T03:23:42Z",
1685 "updated": "2010-11-30T03:23:44Z",
1686 "domain": "ACME",
1687 "units": [{
1688 "id": "1bf3491c409b4541b6f18ea5988a6437",
1689 "endpoint": {
1690 "host": "10.0.0.2"
1691 },
1692 "location": "west-dc"
1693 }]
1694 },
1695 {
1696 "id": "c697bd2429304820a928d145aa42af59",
1697 "name": "backend",
1698 "created": "2010-11-30T03:23:42Z",
1699 "updated": "2010-11-30T03:23:44Z",
1700 "domain": "ACME" ,
1701 "units": [{
1702 "id": "eb32f97866d24001baa430cb34e4049f",
1703 "endpoint": {
1704 "host": "10.0.0.3"
1705 },
1706 "location": "west-dc"
1707 }]
1708 }
1709 ]
1710} ]]>
1711 </programlisting>
1712 </para>
1713 </section>
1714 </section>
1715 <section>
1716 <title>Create Web Server instance</title>
1717 <section>
1718 <title>Call</title>
1719 <table frame='all'>
1720 <title>POST /environments/&lt;id&gt;/webServers Call</title>
1721 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1722 <colspec colnum="1" colname="col1" colwidth="1*"/>
1723 <colspec colnum="2" colname="col2" colwidth="4*"/>
1724 <colspec colnum="3" colname="col3" colwidth="4*"/>
1725 <thead>
1726 <row>
1727 <entry>Method</entry>
1728 <entry>URI</entry>
1729 <entry>Description</entry>
1730 </row>
1731 </thead>
1732 <tbody>
1733 <row>
1734 <entry>POST</entry>
1735 <entry>/environments/&lt;id&gt;/webServers</entry>
1736 <entry>Create new Web Server</entry>
1737 </row>
1738 </tbody>
1739 </tgroup>
1740 </table>
1741 </section>
1742 <section>
1743 <title>Payload</title>
1744 <programlisting>
1745 <![CDATA[
1746{
1747 "name": "frontend",
1748 "domain": {
1749 "name": "ACME",
1750 "credentials": {
1751 "username": "admin",
1752 "password": "password"
1753 }
1754 },
1755 "credentials": {
1756 "username": "admin",
1757 "password": "password"
1758 }
1759 "location": "west-dc"
1760}
1761 ]]>
1762 </programlisting>
1763 </section>
1764 <section>
1765 <title>Returns</title>
1766 <para>This call returns created web server:
1767 <programlisting>
1768 <![CDATA[
1769{
1770 "id": "ce373a477f211e187a55404a662f968",
1771 "name": "frontend",
1772 "created": "2010-11-30T03:23:42Z",
1773 "updated": "2010-11-30T03:23:44Z",
1774 "domain": "ACME",
1775 "units": [{
1776 "id": "1bf3491c409b4541b6f18ea5988a6437",
1777 "location": "west-dc"
1778 }]
1779}
1780 ]]>
1781 </programlisting>
1782 </para>
1783 </section>
1784 </section>
1785 <section>
1786 <title>Update Web Server Instance</title>
1787 <section>
1788 <title>Call</title>
1789 <table frame='all'>
1790 <title>PUT /environments/&lt;id&gt;/webServers/&lt;serviceId&gt; Call</title>
1791 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1792 <colspec colnum="1" colname="col1" colwidth="1*"/>
1793 <colspec colnum="2" colname="col2" colwidth="4*"/>
1794 <colspec colnum="3" colname="col3" colwidth="4*"/>
1795 <thead>
1796 <row>
1797 <entry>Method</entry>
1798 <entry>URI</entry>
1799 <entry>Description</entry>
1800 </row>
1801 </thead>
1802 <tbody>
1803 <row>
1804 <entry>PUT</entry>
1805 <entry>/environments/&lt;id&gt;/webServers/&lt;serviceId&gt;</entry>
1806 <entry>Update properties of WebServer instance</entry>
1807 </row>
1808 </tbody>
1809 </tgroup>
1810 </table>
1811 </section>
1812 <section>
1813 <title>Payload</title>
1814 <programlisting>
1815 <![CDATA[
1816{
1817 "name": "frontend-changed",
1818 "domain": {
1819 "name": "ACME",
1820 "username": "admin",
1821 "password": "password"
1822 },
1823 "credentials": {
1824 "username": "admin",
1825 "password": "password"
1826 }
1827}
1828 ]]>
1829 </programlisting>
1830 </section>
1831 <section>
1832 <title>Returns</title>
1833 <para>This call returns modified web server object:
1834 <programlisting>
1835 <![CDATA[
1836{
1837 "id": "ce373a477f211e187a55404a662f968",
1838 "name": "frontend",
1839 "created": "2010-11-30T03:23:42Z",
1840 "updated": "2010-11-30T03:23:44Z",
1841 "domain": "ACME",
1842 "units": [{
1843 "id": "1bf3491c409b4541b6f18ea5988a6437",
1844 "location": "west-dc"
1845 }]
1846}
1847 ]]>
1848 </programlisting>
1849 </para>
1850 </section>
1851 </section>
1852 <section>
1853 <title>Get Web Server Instance Detailed Information</title>
1854 <section>
1855 <title>Call</title>
1856 <table frame='all'>
1857 <title>GET /environments/&lt;id&gt;/webServers/&lt;serviceId&gt; Call</title>
1858 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
1859 <colspec colnum="1" colname="col1" colwidth="1*"/>
1860 <colspec colnum="2" colname="col2" colwidth="4*"/>
1861 <colspec colnum="3" colname="col3" colwidth="4*"/>
1862 <thead>
1863 <row>
1864 <entry>Method</entry>
1865 <entry>URI</entry>
1866 <entry>Description</entry>
1867 </row>
1868 </thead>
1869 <tbody>
1870 <row>
1871 <entry>GET</entry>
1872 <entry>/environments/&lt;id&gt;/webServers/&lt;serviceId&gt;</entry>
1873 <entry>Returns detailed information about Web Server</entry>
1874 </row>
1875 </tbody>
1876 </tgroup>
1877 </table>
1878 </section>
1879 <section>
1880 <title>Payload</title>
1881 <para>None</para>
1882 </section>
1883 <section>
1884 <title>Returns</title>
1885 <para>This call returns modified environment object:
1886 <programlisting>
1887 <![CDATA[
1888{
1889 "id": "c697bd2429304820a928d145aa42af59",
1890 "name": "backend",
1891 "created": "2010-11-30T03:23:42Z",
1892 "updated": "2010-11-30T03:23:44Z",
1893 "domain": "ACME" ,
1894 "units": [{
1895 "id": "eb32f97866d24001baa430cb34e4049f",
1896 "endpoint": {
1897 "host": "10.0.0.3"
1898 },
1899 "location": "west-dc"
1900 }]
1901}
1902 ]]>
1903 </programlisting>
1904 </para>
1905 </section>
1906 </section>
442 </section> 1907 </section>
443 </section> 1908 </section>
444 </chapter> 1909 </chapter>