github.com/kaisawind/go-swagger@v0.19.0/fixtures/canary/docker-fixed/swagger.json (about) 1 { 2 "swagger": "2.0", 3 "info": { 4 "title": "Docker Remote API", 5 "description": "The API for each docker installation.", 6 "termsOfService": "http://example.com/tos/", 7 "version": "v1.21" 8 }, 9 "host": "localhost", 10 "basePath": "/v1.21", 11 "schemes": ["http", "https"], 12 "produces": ["application/json", "text/plain"], 13 "consumes": ["application/json", "text/plain"], 14 "definitions": { 15 "Version": { 16 "type": "object", 17 "properties": { 18 "Version": { 19 "type": "string" 20 }, 21 "Os": { 22 "type": "string" 23 }, 24 "KernelVersion": { 25 "type": "string" 26 }, 27 "GoVersion": { 28 "type": "string" 29 }, 30 "GitCommit": { 31 "type": "string" 32 }, 33 "Arch": { 34 "type": "string" 35 }, 36 "ApiVersion": { 37 "type": "string" 38 }, 39 "Experimental": { 40 "type": "boolean" 41 } 42 } 43 }, 44 "port": { 45 "type": "object", 46 "properties": { 47 "PrivatePort": { 48 "type": "integer" 49 }, 50 "PublicPort": { 51 "type": "integer" 52 }, 53 "Type": { 54 "type": "string" 55 } 56 } 57 }, 58 "mount": { 59 "type": "object", 60 "properties": { 61 "Source": { 62 "type": "string" 63 }, 64 "Destination": { 65 "type": "string" 66 }, 67 "Mode": { 68 "type": "string" 69 }, 70 "RW": { 71 "type": "boolean" 72 } 73 } 74 }, 75 "LogConfig": { 76 "type": "object", 77 "properties": { 78 "Type": { 79 "type": "string" 80 }, 81 "Config": { 82 "type": "object", 83 "additionalProperties": { 84 "type": "string" 85 } 86 } 87 } 88 }, 89 "Ulimit": { 90 "type": "object", 91 "properties": { 92 "Name": { 93 "type": "string" 94 }, 95 "Soft": { 96 "type": "integer" 97 }, 98 "Hard": { 99 "type": "integer" 100 } 101 } 102 }, 103 "Device": { 104 "type": "object", 105 "properties": { 106 "PathOnHost": { 107 "type": "string" 108 }, 109 "PathInContainer": { 110 "type": "string" 111 }, 112 "CgroupPermissions": { 113 "type": "string" 114 } 115 } 116 }, 117 "RestartPolicy": { 118 "type": "object", 119 "properties": { 120 "Name": { 121 "type": "string", 122 "enum": ["always", "on-failure"] 123 }, 124 "MaximumRetryCount": { 125 "type": "integer" 126 } 127 }, 128 "default": {} 129 }, 130 "PortBinding": { 131 "type": "object", 132 "properties": { 133 "HostPort": { 134 "type": "string" 135 } 136 } 137 }, 138 "HostConfig": { 139 "type": "object", 140 "properties": { 141 "Binds": { 142 "type": "array", 143 "items": { 144 "type": "string" 145 } 146 }, 147 "Links": { 148 "type": "array", 149 "items": { 150 "type": "string" 151 } 152 }, 153 "LxcConf": { 154 "type": "object", 155 "additionalProperties": { 156 "type": "string" 157 } 158 }, 159 "Memory": { 160 "type": "integer", 161 "default": 0 162 }, 163 "MemorySwap": { 164 "type": "integer", 165 "default": 0 166 }, 167 "CpuShares": { 168 "type": "integer" 169 }, 170 "CpuPeriod": { 171 "type": "integer" 172 }, 173 "CpusetCpus": { 174 "type": "string" 175 }, 176 "CpusetMems": { 177 "type": "string" 178 }, 179 "BlkioWeight": { 180 "type": "integer" 181 }, 182 "MemorySwappiness": { 183 "type": "integer" 184 }, 185 "OomKillDisable": { 186 "type": "boolean" 187 }, 188 "PortBindings": { 189 "type": "object", 190 "additionalProperties": { 191 "$ref": "#/definitions/PortBinding" 192 } 193 }, 194 "PublishAllPorts": { 195 "type": "boolean" 196 }, 197 "Privileged": { 198 "type": "boolean" 199 }, 200 "ReadonlyRootfs": { 201 "type": "boolean" 202 }, 203 "Dns": { 204 "type": "array", 205 "items": { 206 "type": "string" 207 } 208 }, 209 "DnsSearch": { 210 "type": "array", 211 "items": { 212 "type": "string" 213 } 214 }, 215 "ExtraHosts": { 216 "type": "array", 217 "items": { 218 "type": "string" 219 } 220 }, 221 "VolumesFrom": { 222 "type": "array", 223 "items": { 224 "type": "string" 225 } 226 }, 227 "CapAdd": { 228 "type": "array", 229 "items": { 230 "type": "string" 231 } 232 }, 233 "CapDrop": { 234 "type": "array", 235 "items": { 236 "type": "string" 237 } 238 }, 239 "RestartPolicy": { 240 "$ref": "#/definitions/RestartPolicy" 241 }, 242 "NetworkMode": { 243 "type": "string" 244 }, 245 "Devices": { 246 "type": "array", 247 "items": { 248 "$ref": "#/definitions/Device" 249 } 250 }, 251 "Ulimits": { 252 "type": "array", 253 "items": { 254 "$ref": "#/definitions/Ulimit" 255 } 256 }, 257 "SecurityOpt": { 258 "type": "array", 259 "items": { 260 "type": "string" 261 } 262 }, 263 "LogConfig": { 264 "$ref": "#/definitions/LogConfig" 265 }, 266 "CgroupParent": { 267 "type": "string" 268 } 269 } 270 }, 271 "ContainerConfig": { 272 "type": "object", 273 "properties": { 274 "Id": { 275 "type": "string" 276 }, 277 "Names": { 278 "type": "array", 279 "items": { 280 "type": "string" 281 } 282 }, 283 "Image": { 284 "type": "string" 285 }, 286 "Command": { 287 "type": "string" 288 }, 289 "Created": { 290 "type": "integer" 291 }, 292 "Status": { 293 "type": "string" 294 }, 295 "Ports": { 296 "type": "array", 297 "items": { 298 "$ref": "#/definitions/port" 299 } 300 }, 301 "Labels": { 302 "type": "object", 303 "additionalProperties": { 304 "type": "string" 305 } 306 }, 307 "SizeRw": { 308 "type": "integer" 309 }, 310 "SizeRootFs": { 311 "type": "integer" 312 }, 313 "Hostname": { 314 "type": "integer" 315 }, 316 "Domainname": { 317 "type": "integer" 318 }, 319 "User": { 320 "type": "integer" 321 }, 322 "AttachStdin": { 323 "type": "boolean", 324 "default": false 325 }, 326 "AttachStdout": { 327 "type": "boolean", 328 "default": true 329 }, 330 "AttachStderr": { 331 "type": "boolean", 332 "default": true 333 }, 334 "Tty": { 335 "type": "boolean", 336 "default": false 337 }, 338 "OpenStdin": { 339 "type": "boolean", 340 "default": false 341 }, 342 "StdinOnce": { 343 "type": "boolean", 344 "default": false 345 }, 346 "Env": { 347 "type": "array", 348 "items": { 349 "type": "string" 350 } 351 }, 352 "Cmd": { 353 "type": ["array", "string"], 354 "items": { 355 "type": "string" 356 } 357 }, 358 "Entrypoint": { 359 "type": ["array", "string"], 360 "items": { 361 "type": "string" 362 } 363 }, 364 "Mounts": { 365 "type": "array", 366 "items": { 367 "$ref": "#/definitions/mount" 368 } 369 }, 370 "WorkingDir": { 371 "type": "string" 372 }, 373 "NetworkDisabled": { 374 "type": "boolean" 375 }, 376 "MacAddress": { 377 "type": "string" 378 }, 379 "ExposedPorts": { 380 "type": "object", 381 "additionalProperties": { 382 "type": "object", 383 "enum": [{}], 384 "default": {} 385 } 386 }, 387 "HostConfig": { 388 "$ref": "#/definitions/HostConfig" 389 } 390 } 391 }, 392 "NetworkConfig": { 393 "type": "object", 394 "properties": { 395 "Bridge": { 396 "type": "string" 397 }, 398 "Gateway": { 399 "type": "string" 400 }, 401 "IPAddress": { 402 "type": "string" 403 }, 404 "IPPrefixLen": { 405 "type": "integer" 406 }, 407 "MacAddress": { 408 "type": "string" 409 }, 410 "PortMapping": { 411 "type": "string" 412 }, 413 "Ports": { 414 "type": "array", 415 "items": { 416 "$ref": "#/definitions/port" 417 } 418 } 419 } 420 }, 421 "ContainerState": { 422 "type": "object", 423 "properties": { 424 "Error": { 425 "type": "string" 426 }, 427 "ExitCode": { 428 "type": "integer" 429 }, 430 "FinishedAt": { 431 "type": "string" 432 }, 433 "OOMKilled": { 434 "type": "boolean" 435 }, 436 "Paused": { 437 "type": "boolean" 438 }, 439 "Pid": { 440 "type": "integer" 441 }, 442 "Restarting": { 443 "type": "boolean" 444 }, 445 "Running": { 446 "type": "boolean" 447 }, 448 "StartedAt": { 449 "type": "string" 450 } 451 } 452 }, 453 "Container": { 454 "type": "object", 455 "properties": { 456 "AppArmorProfile": { 457 "type": "string" 458 }, 459 "Args": { 460 "type": "array", 461 "items": { 462 "type": "string" 463 } 464 }, 465 "Config": { 466 "$ref": "#/definitions/ContainerConfig" 467 }, 468 "Created": { 469 "type": "string" 470 }, 471 "Driver": { 472 "type": "string" 473 }, 474 "ExecDriver": { 475 "type": "string" 476 }, 477 "ExecIDs": { 478 "type": "string" 479 }, 480 "HostConfig": { 481 "$ref": "#/definitions/HostConfig" 482 }, 483 "HostnamePath": { 484 "type": "string" 485 }, 486 "HostsPath": { 487 "type": "string" 488 }, 489 "LogPath": { 490 "type": "string" 491 }, 492 "Id": { 493 "type": "string" 494 }, 495 "Image": { 496 "type": "string" 497 }, 498 "MountLabel": { 499 "type": "string" 500 }, 501 "Name": { 502 "type": "string" 503 }, 504 "NetworkSettings": { 505 "$ref": "#/definitions/NetworkConfig" 506 }, 507 "Path": { 508 "type": "string" 509 }, 510 "ProcessLabel": { 511 "type": "string" 512 }, 513 "ResolvConfPath": { 514 "type": "string" 515 }, 516 "RestartCount": { 517 "type": "integer" 518 }, 519 "State": { 520 "$ref": "#/definitions/ContainerState" 521 }, 522 "Mounts": { 523 "type": "array", 524 "items": { 525 "$ref": "#/definitions/mount" 526 } 527 } 528 } 529 }, 530 "ContainerTop": { 531 "type": "object", 532 "properties": { 533 "Titles": { 534 "type": "array", 535 "items": { 536 "type": "string" 537 } 538 }, 539 "Processes": { 540 "type": "array", 541 "items": { 542 "type": "array", 543 "items": { 544 "type": "string" 545 } 546 } 547 } 548 } 549 }, 550 "ContainerChange": { 551 "type": "object", 552 "properties": { 553 "Path": { 554 "type": "string" 555 }, 556 "Kind": { 557 "type": "integer" 558 } 559 } 560 }, 561 "ContainerWait": { 562 "type": "object", 563 "properties": { 564 "StatusCode": { 565 "type": "integer" 566 } 567 } 568 }, 569 "GraphDriver": { 570 "type": "object", 571 "properties": { 572 "Name": { 573 "type": "string" 574 }, 575 "Data": { 576 "type": "object" 577 } 578 } 579 }, 580 "ImageItem": { 581 "type": "object", 582 "properties": { 583 "RepoTags": { 584 "type": "array", 585 "items": { 586 "type": "string" 587 } 588 }, 589 "Id": { 590 "type": "string" 591 }, 592 "ParentId": { 593 "type": "string" 594 }, 595 "Created": { 596 "type": "integer" 597 }, 598 "Size": { 599 "type": "integer" 600 }, 601 "VirtualSize": { 602 "type": "integer" 603 }, 604 "Labels": { 605 "type": "object", 606 "additionalProperties": { 607 "type": "string" 608 } 609 }, 610 "RepoDigests": { 611 "type": "array", 612 "items": { 613 "type": "string" 614 } 615 } 616 } 617 }, 618 "Image": { 619 "type": "object", 620 "properties": { 621 "Id": { 622 "type": "string" 623 }, 624 "Container": { 625 "type": "string" 626 }, 627 "Comment": { 628 "type": "string" 629 }, 630 "Os": { 631 "type": "string" 632 }, 633 "Architecture": { 634 "type": "string" 635 }, 636 "Parent": { 637 "type": "string" 638 }, 639 "ContainerConfig": { 640 "$ref": "#/definitions/ContainerConfig" 641 }, 642 "DockerVersion": { 643 "type": "string" 644 }, 645 "VirtualSize": { 646 "type": "integer" 647 }, 648 "Size": { 649 "type": "integer" 650 }, 651 "Author": { 652 "type": "string" 653 }, 654 "Created": { 655 "type": "string" 656 }, 657 "GraphDriver": { 658 "$ref": "#/definitions/GraphDriver" 659 }, 660 "RepoDigests": { 661 "type": "array", 662 "items": { 663 "type": "string" 664 } 665 }, 666 "RepoTags": { 667 "type": "array", 668 "items": { 669 "type": "string" 670 } 671 }, 672 "Config": { 673 "$ref": "#/definitions/ContainerConfig" 674 } 675 } 676 }, 677 "ImageHistoryItem": { 678 "type": "object", 679 "properties": { 680 "Id": { 681 "type": "string" 682 }, 683 "Created": { 684 "type": "integer" 685 }, 686 "CreatedBy": { 687 "type": "string" 688 }, 689 "Tags": { 690 "type": "array", 691 "items": { 692 "type": "string" 693 } 694 }, 695 "Size": { 696 "type": "integer" 697 }, 698 "Comment": { 699 "type": "string" 700 } 701 } 702 }, 703 "ImageSearchResult": { 704 "type": "object", 705 "properties": { 706 "description": { 707 "type": "string" 708 }, 709 "is_official": { 710 "type": "boolean" 711 }, 712 "is_automated": { 713 "type": "boolean" 714 }, 715 "name": { 716 "type": "string" 717 }, 718 "star_count": { 719 "type": "integer" 720 } 721 } 722 }, 723 "AuthConfig": { 724 "type": "object", 725 "properties": { 726 "username": { 727 "type": "string" 728 }, 729 "password": { 730 "type": "string" 731 }, 732 "email": { 733 "type": "string" 734 }, 735 "serveraddress": { 736 "type": "string" 737 } 738 } 739 }, 740 "SystemInformation": { 741 "type": "object", 742 "properties": { 743 "Containers": { 744 "type": "integer" 745 }, 746 "CpuCfsPeriod": { 747 "type": "boolean" 748 }, 749 "CpuCfsQuota": { 750 "type": "boolean" 751 }, 752 "Debug": { 753 "type": "boolean" 754 }, 755 "DiscoveryBackend": { 756 "type": "string" 757 }, 758 "DockerRootDir": { 759 "type": "string" 760 }, 761 "Driver": { 762 "type": "string" 763 }, 764 "DriverStatus": { 765 "type": "array", 766 "items": { 767 "type": "array", 768 "items": { 769 "type": "string" 770 } 771 } 772 }, 773 "ExecutionDriver": { 774 "type": "string" 775 }, 776 "ExperimentalBuild": { 777 "type": "boolean" 778 }, 779 "HttpProxy": { 780 "type": "string" 781 }, 782 "HttpsProxy": { 783 "type": "string" 784 }, 785 "ID": { 786 "type": "string" 787 }, 788 "IPv4Forwarding": { 789 "type": "boolean" 790 }, 791 "Images": { 792 "type": "integer" 793 }, 794 "IndexServerAddress": { 795 "type": "string" 796 }, 797 "InitPath": { 798 "type": "string" 799 }, 800 "InitSha1": { 801 "type": "string" 802 }, 803 "KernelVersion": { 804 "type": "string" 805 }, 806 "Labels": { 807 "type": "array", 808 "items": { 809 "type": "string" 810 } 811 }, 812 "MemTotal": { 813 "type": "integer" 814 }, 815 "MemoryLimit": { 816 "type": "boolean" 817 }, 818 "NCPU": { 819 "type": "integer" 820 }, 821 "NEventsListener": { 822 "type": "integer" 823 }, 824 "NFd": { 825 "type": "integer" 826 }, 827 "NGoroutines": { 828 "type": "integer" 829 }, 830 "Name": { 831 "type": "string" 832 }, 833 "NoProxy": { 834 "type": "string" 835 }, 836 "OomKillDisable": { 837 "type": "boolean" 838 }, 839 "OperatingSystem": { 840 "type": "string" 841 }, 842 "RegistryConfig": { 843 "$ref": "#/definitions/RegistryConfig" 844 }, 845 "SwapLimit": { 846 "type": "boolean" 847 }, 848 "SystemTime": { 849 "type": "string" 850 }, 851 "ServerVersion": { 852 "type": "string" 853 } 854 } 855 }, 856 "RegistryConfig": { 857 "type": "object", 858 "properties": { 859 "IndexConfigs": { 860 "type": "object", 861 "additionalProperties": { 862 "$ref": "#/definitions/Registry" 863 } 864 }, 865 "InsecureRegistryCIDRs": { 866 "type": "array", 867 "items": { 868 "type": "string" 869 } 870 } 871 } 872 }, 873 "Registry": { 874 "type": "object", 875 "properties": { 876 "Mirrors": { 877 "type": "array", 878 "items": { 879 "type": "string" 880 } 881 }, 882 "Name": { 883 "type": "string" 884 }, 885 "Official": { 886 "type": "boolean" 887 }, 888 "Secure": { 889 "type": "boolean" 890 } 891 } 892 }, 893 "CommitResult": { 894 "type": "object", 895 "properties": { 896 "Id": { 897 "type": "string" 898 } 899 } 900 }, 901 "ExecCreateResult": { 902 "type": "object", 903 "properties": { 904 "Id": { 905 "type": "string" 906 }, 907 "Warnings": { 908 "type": "array", 909 "items": { 910 "type": "string" 911 } 912 } 913 } 914 }, 915 "ExecConfig": { 916 "type": "object", 917 "properties": { 918 "AttachStdin": { 919 "type": "boolean" 920 }, 921 "AttachStdout": { 922 "type": "boolean" 923 }, 924 "AttachStderr": { 925 "type": "boolean" 926 }, 927 "Tty": { 928 "type": "boolean" 929 }, 930 "Cmd": { 931 "type": "array", 932 "items": { 933 "type": "string" 934 } 935 } 936 } 937 }, 938 "ExecStartConfig": { 939 "type": "object", 940 "properties": { 941 "Detach": { 942 "type": "boolean" 943 }, 944 "Tty": { 945 "type": "boolean" 946 } 947 } 948 }, 949 "ExecCommand": { 950 "type": "object", 951 "properties": { 952 "ID": { 953 "type": "string" 954 }, 955 "Running": { 956 "type": "boolean" 957 }, 958 "ExitCode": { 959 "type": "integer" 960 }, 961 "ProcessConfig": { 962 "$ref": "#/definitions/ProcessConfig" 963 }, 964 "OpenStdin": { 965 "type": "boolean" 966 }, 967 "OpenStderr": { 968 "type": "boolean" 969 }, 970 "OpenStdout": { 971 "type": "boolean" 972 }, 973 "Container": { 974 "$ref": "#/definitions/Container" 975 } 976 } 977 }, 978 "ProcessConfig": { 979 "type": "object", 980 "properties": { 981 "privileged": { 982 "type": "boolean" 983 }, 984 "user": { 985 "type": "string" 986 }, 987 "tty": { 988 "type": "boolean" 989 }, 990 "entrypoint": { 991 "type": "string" 992 }, 993 "arguments": { 994 "type": "array", 995 "items": { 996 "type": "string" 997 } 998 } 999 } 1000 }, 1001 "VolumeList": { 1002 "type": "object", 1003 "properties": { 1004 "Volumes": { 1005 "type": "array", 1006 "items": { 1007 "$ref": "#/definitions/Volume" 1008 } 1009 } 1010 } 1011 }, 1012 "Volume": { 1013 "type": "object", 1014 "properties": { 1015 "Name": { 1016 "type": "string" 1017 }, 1018 "Driver": { 1019 "type": "string" 1020 }, 1021 "Mountpoint": { 1022 "type": "string" 1023 } 1024 } 1025 }, 1026 "VolumeConfig": { 1027 "type": "object", 1028 "properties": { 1029 "Name": { 1030 "type": "string" 1031 }, 1032 "Driver": { 1033 "type": "string" 1034 }, 1035 "DriverOpts": { 1036 "type": "object", 1037 "additionalProperties": { 1038 "type": "string" 1039 } 1040 } 1041 } 1042 }, 1043 "Network": { 1044 "type": "object", 1045 "properties": { 1046 "Name": { 1047 "type": "string" 1048 }, 1049 "Id": { 1050 "type": "string" 1051 }, 1052 "Scope": { 1053 "type": "string" 1054 }, 1055 "Driver": { 1056 "type": "string" 1057 }, 1058 "IPAM": { 1059 "$ref": "#/definitions/IPAM" 1060 }, 1061 "Containers": { 1062 "type": "object", 1063 "additionalProperties": { 1064 "$ref": "#/definitions/NetworkContainer" 1065 } 1066 }, 1067 "Options": { 1068 "type": "object", 1069 "additionalProperties": { 1070 "type": "string" 1071 } 1072 } 1073 } 1074 }, 1075 "IPAM": { 1076 "type": "object", 1077 "properties": { 1078 "Driver": { 1079 "type": "string" 1080 }, 1081 "Config": { 1082 "type": "array", 1083 "items": { 1084 "type": "object", 1085 "additionalProperties": { 1086 "type": "string" 1087 } 1088 } 1089 } 1090 } 1091 }, 1092 "NetworkContainer": { 1093 "type": "object", 1094 "properties": { 1095 "EndpointID": { 1096 "type": "string" 1097 }, 1098 "MacAddress": { 1099 "type": "string" 1100 }, 1101 "IPv4Address": { 1102 "type": "string" 1103 }, 1104 "IPv6Address": { 1105 "type": "string" 1106 } 1107 } 1108 }, 1109 "NetworkCreateResult": { 1110 "type": "object", 1111 "properties": { 1112 "Id": { 1113 "type": "string" 1114 }, 1115 "Warning": { 1116 "type": "string" 1117 } 1118 } 1119 }, 1120 "NetworkCreateConfig": { 1121 "type": "object", 1122 "properties": { 1123 "Name": { 1124 "type": "string" 1125 }, 1126 "Driver": { 1127 "type": "string" 1128 }, 1129 "IPAM": { 1130 "$ref": "#/definitions/IPAM" 1131 } 1132 } 1133 }, 1134 "ContainerConnect": { 1135 "type": "object", 1136 "properties": { 1137 "Container": { 1138 "type": "string" 1139 } 1140 } 1141 }, 1142 "ContainerCreateResult": { 1143 "type": "object", 1144 "properties": { 1145 "Id": { 1146 "type": "string" 1147 }, 1148 "Warnings": { 1149 "type": "array", 1150 "items": { 1151 "type": "string" 1152 } 1153 } 1154 } 1155 }, 1156 "BuildInfo": { 1157 "type": "object", 1158 "properties": { 1159 "id": { 1160 "type": "string" 1161 }, 1162 "stream": { 1163 "type": "string" 1164 }, 1165 "error": { 1166 "type": "string" 1167 }, 1168 "errorDetail": { 1169 "$ref": "#/definitions/ErrorDetail" 1170 }, 1171 "status": { 1172 "type": "string" 1173 }, 1174 "progress": { 1175 "type": "string" 1176 }, 1177 "progressDetail": { 1178 "$ref": "#/definitions/ProgressDetail" 1179 } 1180 } 1181 }, 1182 "CreateImageInfo": { 1183 "type": "object", 1184 "properties": { 1185 "error": { 1186 "type": "string" 1187 }, 1188 "status": { 1189 "type": "string" 1190 }, 1191 "progress": { 1192 "type": "string" 1193 }, 1194 "progressDetail": { 1195 "$ref": "#/definitions/ProgressDetail" 1196 } 1197 } 1198 }, 1199 "PushImageInfo": { 1200 "type": "object", 1201 "properties": { 1202 "error": { 1203 "type": "string" 1204 }, 1205 "status": { 1206 "type": "string" 1207 }, 1208 "progress": { 1209 "type": "string" 1210 }, 1211 "progressDetail": { 1212 "$ref": "#/definitions/ProgressDetail" 1213 } 1214 } 1215 }, 1216 "ErrorDetail": { 1217 "type": "object", 1218 "properties": { 1219 "code": { 1220 "type": "integer" 1221 }, 1222 "message": { 1223 "type": "string" 1224 } 1225 } 1226 }, 1227 "ProgressDetail": { 1228 "type": "object", 1229 "properties": { 1230 "code": { 1231 "type": "integer" 1232 }, 1233 "message": { 1234 "type": "integer" 1235 } 1236 } 1237 }, 1238 "Event": { 1239 "type": "object", 1240 "properties": { 1241 "status": { 1242 "type": "string" 1243 }, 1244 "id": { 1245 "type": "string" 1246 }, 1247 "from": { 1248 "type": "string" 1249 }, 1250 "time": { 1251 "type": "integer" 1252 }, 1253 "timeNano": { 1254 "type": "integer" 1255 } 1256 } 1257 } 1258 }, 1259 "paths": { 1260 "/containers/json": { 1261 "get": { 1262 "summary": "List containers", 1263 "description": "List containers", 1264 "operationId": "findAllContainers", 1265 "parameters": [{ 1266 "name": "all", 1267 "in": "query", 1268 "description": "Show all containers. Only running containers are shown by default (i.e., this defaults to false)", 1269 "type": "boolean", 1270 "default": false 1271 }, { 1272 "name": "limit", 1273 "in": "query", 1274 "description": "Show <limit> last created containers, include non-running ones.", 1275 "type": "integer" 1276 }, { 1277 "name": "since", 1278 "in": "query", 1279 "description": "Show only containers created since Id, include non-running ones.", 1280 "type": "string" 1281 }, { 1282 "name": "before", 1283 "in": "query", 1284 "description": "Show only containers created before Id, include non-running ones.", 1285 "type": "string" 1286 }, { 1287 "name": "size", 1288 "in": "query", 1289 "description": "1/True/true or 0/False/false, Show the containers sizes.", 1290 "type": "boolean" 1291 }, { 1292 "name": "filters", 1293 "in": "query", 1294 "description": "A JSON encoded value of the filters (a map[string][]string) to process on the containers list", 1295 "type": "array", 1296 "items": { 1297 "type": "string" 1298 } 1299 }], 1300 "responses": { 1301 "200": { 1302 "description": "no error", 1303 "schema": { 1304 "type": "array", 1305 "items": { 1306 "$ref": "#/definitions/ContainerConfig" 1307 } 1308 } 1309 }, 1310 "400": { 1311 "description": "bad parameter" 1312 }, 1313 "500": { 1314 "description": "server error" 1315 } 1316 }, 1317 "tags": ["Container"] 1318 } 1319 }, 1320 "/containers/create": { 1321 "post": { 1322 "summary": "Create a container", 1323 "description": "Create a container", 1324 "operationId": "createContainer", 1325 "parameters": [{ 1326 "name": "name", 1327 "in": "query", 1328 "description": "Assign the specified name to the container. Must match /?[a-zA-Z0-9_-]+.", 1329 "type": "string", 1330 "pattern": "/?[a-zA-Z0-9_-]+" 1331 }, { 1332 "name": "container", 1333 "in": "body", 1334 "description": "Container to create", 1335 "schema": { 1336 "$ref": "#/definitions/ContainerConfig" 1337 } 1338 }, { 1339 "name": "Content-Type", 1340 "required": true, 1341 "in": "header", 1342 "type": "string", 1343 "default": "application/json", 1344 "description": "Content Type of input" 1345 }], 1346 "responses": { 1347 "201": { 1348 "description": "no error", 1349 "schema": { 1350 "$ref": "#/definitions/ContainerCreateResult" 1351 } 1352 }, 1353 "404": { 1354 "description": "no such container" 1355 }, 1356 "406": { 1357 "description": "impossible to attach" 1358 }, 1359 "500": { 1360 "description": "server error" 1361 } 1362 }, 1363 "tags": ["Container"] 1364 } 1365 }, 1366 "/containers/{id}/json": { 1367 "get": { 1368 "summary": "Inspect a container", 1369 "description": "Return low-level information on the container id", 1370 "operationId": "findContainer", 1371 "responses": { 1372 "200": { 1373 "description": "no error", 1374 "schema": { 1375 "$ref": "#/definitions/Container" 1376 } 1377 }, 1378 "404": { 1379 "description": "no such container" 1380 }, 1381 "500": { 1382 "description": "server error" 1383 } 1384 }, 1385 "parameters": [{ 1386 "name": "id", 1387 "in": "path", 1388 "required": true, 1389 "description": "The container id or name", 1390 "type": "string" 1391 }], 1392 "tags": ["Container"] 1393 } 1394 }, 1395 "/containers/{id}/top": { 1396 "get": { 1397 "summary": "List processes running inside a container", 1398 "description": "List processes running inside the container id", 1399 "operationId": "listProcesses", 1400 "responses": { 1401 "200": { 1402 "description": "no error", 1403 "schema": { 1404 "$ref": "#/definitions/ContainerTop" 1405 } 1406 }, 1407 "404": { 1408 "description": "no such container" 1409 }, 1410 "500": { 1411 "description": "server error" 1412 } 1413 }, 1414 "parameters": [{ 1415 "name": "id", 1416 "in": "path", 1417 "required": true, 1418 "description": "The container id or name", 1419 "type": "string" 1420 }, { 1421 "name": "ps_args", 1422 "in": "query", 1423 "description": "ps arguments to use (e.g., aux)", 1424 "type": "string" 1425 }], 1426 "tags": ["Container"] 1427 } 1428 }, 1429 "/containers/{id}/logs": { 1430 "get": { 1431 "summary": "Get container logs", 1432 "description": "Get stdout and stderr logs from the container id. Note: This endpoint works only for containers with json-file logging driver.", 1433 "operationId": "logs", 1434 "responses": { 1435 "101": { 1436 "description": "no error, hints proxy about hijacking", 1437 "schema": { 1438 "type": "string" 1439 } 1440 }, 1441 "200": { 1442 "description": "no error, no upgrade header found", 1443 "schema": { 1444 "type": "string" 1445 } 1446 }, 1447 "404": { 1448 "description": "no such container" 1449 }, 1450 "500": { 1451 "description": "server error" 1452 } 1453 }, 1454 "parameters": [{ 1455 "name": "id", 1456 "in": "path", 1457 "required": true, 1458 "description": "The container id or name", 1459 "type": "string" 1460 }, { 1461 "name": "follow", 1462 "in": "query", 1463 "description": "1/True/true or 0/False/false, return stream. Default false.", 1464 "type": "boolean", 1465 "default": false 1466 }, { 1467 "name": "stdout", 1468 "in": "query", 1469 "description": "1/True/true or 0/False/false, show stdout log. Default false.", 1470 "type": "boolean", 1471 "default": false 1472 }, { 1473 "name": "stderr", 1474 "in": "query", 1475 "description": "1/True/true or 0/False/false, show stderr log. Default false.", 1476 "type": "boolean", 1477 "default": false 1478 }, { 1479 "name": "since", 1480 "in": "query", 1481 "description": "UNIX timestamp (integer) to filter logs. Specifying a timestamp will only output log-entries since that timestamp. Default: 0 (unfiltered)", 1482 "type": "integer", 1483 "default": 0 1484 }, { 1485 "name": "timestamps", 1486 "in": "query", 1487 "description": "1/True/true or 0/False/false, print timestamps for every log line. ", 1488 "type": "boolean", 1489 "default": false 1490 }, { 1491 "name": "tail", 1492 "in": "query", 1493 "description": "Output specified number of lines at the end of logs: all or <number>. Default all.", 1494 "type": "string" 1495 }], 1496 "tags": ["Container"] 1497 } 1498 }, 1499 "/containers/{id}/changes": { 1500 "get": { 1501 "summary": "Inspect changes on a container’s filesystem", 1502 "description": "Inspect changes on a container’s filesystem", 1503 "operationId": "changes", 1504 "responses": { 1505 "200": { 1506 "description": "no error", 1507 "schema": { 1508 "type": "array", 1509 "items": { 1510 "$ref": "#/definitions/ContainerChange" 1511 } 1512 } 1513 }, 1514 "404": { 1515 "description": "no such container" 1516 }, 1517 "500": { 1518 "description": "server error" 1519 } 1520 }, 1521 "parameters": [{ 1522 "name": "id", 1523 "in": "path", 1524 "required": true, 1525 "description": "The container id or name", 1526 "type": "string" 1527 }, { 1528 "name": "kind", 1529 "in": "query", 1530 "description": "Kind of changes", 1531 "type": "integer", 1532 "enum": [0, 1, 2] 1533 }], 1534 "tags": ["Container"] 1535 } 1536 }, 1537 "/containers/{id}/export": { 1538 "get": { 1539 "summary": "Export a container", 1540 "description": "Export the contents of container id", 1541 "operationId": "export", 1542 "responses": { 1543 "200": { 1544 "description": "no error", 1545 "schema": { 1546 "type": "string" 1547 } 1548 }, 1549 "404": { 1550 "description": "no such container" 1551 }, 1552 "500": { 1553 "description": "server error" 1554 } 1555 }, 1556 "parameters": [{ 1557 "name": "id", 1558 "in": "path", 1559 "required": true, 1560 "description": "The container id or name", 1561 "type": "string" 1562 }], 1563 "tags": ["Container"] 1564 } 1565 }, 1566 "/containers/{id}/stats": { 1567 "get": { 1568 "summary": "Get container stats based on resource usage", 1569 "description": "This endpoint returns a live stream of a container’s resource usage statistics.", 1570 "operationId": "stats", 1571 "responses": { 1572 "200": { 1573 "description": "no error", 1574 "schema": { 1575 "type": "object" 1576 } 1577 }, 1578 "404": { 1579 "description": "no such container" 1580 }, 1581 "500": { 1582 "description": "server error" 1583 } 1584 }, 1585 "parameters": [{ 1586 "name": "id", 1587 "in": "path", 1588 "required": true, 1589 "description": "The container id or name", 1590 "type": "string" 1591 }, { 1592 "name": "stream", 1593 "in": "query", 1594 "description": "Stream stats", 1595 "type": "boolean" 1596 }], 1597 "tags": ["Container"] 1598 } 1599 }, 1600 "/containers/{id}/resize": { 1601 "post": { 1602 "summary": "Resize a container TTY", 1603 "description": "Resize the TTY for container with id. The unit is number of characters. You must restart the container for the resize to take effect.", 1604 "operationId": "resizeContainer", 1605 "responses": { 1606 "200": { 1607 "description": "no error" 1608 }, 1609 "404": { 1610 "description": "no such container" 1611 }, 1612 "500": { 1613 "description": "cannot resize container" 1614 } 1615 }, 1616 "parameters": [{ 1617 "name": "id", 1618 "in": "path", 1619 "required": true, 1620 "description": "The container id or name", 1621 "type": "string" 1622 }, { 1623 "name": "h", 1624 "in": "query", 1625 "description": "Height of the tty session", 1626 "type": "integer" 1627 }, { 1628 "name": "w", 1629 "in": "query", 1630 "description": "Width of the tty session", 1631 "type": "integer" 1632 }], 1633 "tags": ["Container"] 1634 } 1635 }, 1636 "/containers/{id}/start": { 1637 "post": { 1638 "summary": "Start a container", 1639 "description": "Start the container id", 1640 "operationId": "startContainer", 1641 "responses": { 1642 "204": { 1643 "description": "no error" 1644 }, 1645 "304": { 1646 "description": "container already started" 1647 }, 1648 "404": { 1649 "description": "no such container" 1650 }, 1651 "500": { 1652 "description": "server error" 1653 } 1654 }, 1655 "parameters": [{ 1656 "name": "id", 1657 "in": "path", 1658 "required": true, 1659 "description": "The container id or name", 1660 "type": "string" 1661 }], 1662 "tags": ["Container"] 1663 } 1664 }, 1665 "/containers/{id}/stop": { 1666 "post": { 1667 "summary": "Stop a container", 1668 "description": "Stop the container id", 1669 "operationId": "stop", 1670 "responses": { 1671 "204": { 1672 "description": "no error" 1673 }, 1674 "304": { 1675 "description": "container already stopped" 1676 }, 1677 "404": { 1678 "description": "no such container" 1679 }, 1680 "500": { 1681 "description": "server error" 1682 } 1683 }, 1684 "parameters": [{ 1685 "name": "id", 1686 "in": "path", 1687 "required": true, 1688 "description": "The container id or name", 1689 "type": "string" 1690 }, { 1691 "name": "t", 1692 "in": "query", 1693 "description": "number of seconds to wait before killing the container", 1694 "type": "integer" 1695 }], 1696 "tags": ["Container"] 1697 } 1698 }, 1699 "/containers/{id}/restart": { 1700 "post": { 1701 "summary": "Restart a container", 1702 "description": "Restart the container id", 1703 "operationId": "restart", 1704 "responses": { 1705 "204": { 1706 "description": "no error" 1707 }, 1708 "404": { 1709 "description": "no such container" 1710 }, 1711 "500": { 1712 "description": "server error" 1713 } 1714 }, 1715 "parameters": [{ 1716 "name": "id", 1717 "in": "path", 1718 "required": true, 1719 "description": "The container id or name", 1720 "type": "string" 1721 }, { 1722 "name": "t", 1723 "in": "query", 1724 "description": "number of seconds to wait before killing the container", 1725 "type": "integer" 1726 }], 1727 "tags": ["Container"] 1728 } 1729 }, 1730 "/containers/{id}/kill": { 1731 "post": { 1732 "summary": "Kill a container", 1733 "description": "Send a posix signal to a container", 1734 "operationId": "kill", 1735 "responses": { 1736 "204": { 1737 "description": "no error" 1738 }, 1739 "404": { 1740 "description": "no such container" 1741 }, 1742 "500": { 1743 "description": "server error" 1744 } 1745 }, 1746 "parameters": [{ 1747 "name": "id", 1748 "in": "path", 1749 "required": true, 1750 "description": "The container id or name", 1751 "type": "string" 1752 }, { 1753 "name": "signal", 1754 "in": "query", 1755 "description": "Signal to send to the container, integer or string like SIGINT, defaults to SIGKILL", 1756 "type": "string" 1757 }], 1758 "tags": ["Container"] 1759 } 1760 }, 1761 "/containers/{id}/rename": { 1762 "post": { 1763 "summary": "Rename a container", 1764 "description": "Rename the container id to a new_name", 1765 "operationId": "rename", 1766 "responses": { 1767 "204": { 1768 "description": "no error" 1769 }, 1770 "404": { 1771 "description": "no such container" 1772 }, 1773 "409": { 1774 "description": "conflict, name already assigned" 1775 }, 1776 "500": { 1777 "description": "server error" 1778 } 1779 }, 1780 "parameters": [{ 1781 "name": "id", 1782 "in": "path", 1783 "required": true, 1784 "description": "The container id or name", 1785 "type": "string" 1786 }, { 1787 "name": "name", 1788 "in": "query", 1789 "required": true, 1790 "description": "New name for the container", 1791 "type": "string" 1792 }], 1793 "tags": ["Container"] 1794 } 1795 }, 1796 "/containers/{id}/pause": { 1797 "post": { 1798 "summary": "Pause a container", 1799 "description": "Pause the container id", 1800 "operationId": "pause", 1801 "responses": { 1802 "204": { 1803 "description": "no error" 1804 }, 1805 "404": { 1806 "description": "no such container" 1807 }, 1808 "500": { 1809 "description": "server error" 1810 } 1811 }, 1812 "parameters": [{ 1813 "name": "id", 1814 "in": "path", 1815 "required": true, 1816 "description": "The container id or name", 1817 "type": "string" 1818 }], 1819 "tags": ["Container"] 1820 } 1821 }, 1822 "/containers/{id}/unpause": { 1823 "post": { 1824 "summary": "Unpause a container", 1825 "description": "Unpause the container id", 1826 "operationId": "unpause", 1827 "responses": { 1828 "204": { 1829 "description": "no error" 1830 }, 1831 "404": { 1832 "description": "no such container" 1833 }, 1834 "500": { 1835 "description": "server error" 1836 } 1837 }, 1838 "parameters": [{ 1839 "name": "id", 1840 "in": "path", 1841 "required": true, 1842 "description": "The container id or name", 1843 "type": "string" 1844 }], 1845 "tags": ["Container"] 1846 } 1847 }, 1848 "/containers/{id}/attach": { 1849 "post": { 1850 "summary": "Attach to a container", 1851 "description": "Attach to the container id", 1852 "operationId": "attach", 1853 "responses": { 1854 "200": { 1855 "description": "no error" 1856 }, 1857 "400": { 1858 "description": "bad parameter" 1859 }, 1860 "404": { 1861 "description": "no such container" 1862 }, 1863 "500": { 1864 "description": "server error" 1865 } 1866 }, 1867 "parameters": [{ 1868 "name": "id", 1869 "in": "path", 1870 "required": true, 1871 "description": "The container id or name", 1872 "type": "string" 1873 }, { 1874 "name": "logs", 1875 "in": "query", 1876 "description": "1/True/true or 0/False/false, return logs. Default false", 1877 "type": "string" 1878 }, { 1879 "name": "stream", 1880 "in": "query", 1881 "description": "1/True/true or 0/False/false, return stream. Default false", 1882 "type": "string" 1883 }, { 1884 "name": "stdin", 1885 "in": "query", 1886 "description": "1/True/true or 0/False/false, if stream=true, attach to stdin. Default false.", 1887 "type": "string" 1888 }, { 1889 "name": "stdout", 1890 "in": "query", 1891 "description": "1/True/true or 0/False/false, if logs=true, return stdout log, if stream=true, attach to stdout. Default false.", 1892 "type": "string" 1893 }, { 1894 "name": "stderr", 1895 "in": "query", 1896 "description": "1/True/true or 0/False/false, if logs=true, return stderr log, if stream=true, attach to stderr. Default false.", 1897 "type": "string" 1898 }], 1899 "tags": ["Container"] 1900 } 1901 }, 1902 "/containers/{id}/attach/ws": { 1903 "get": { 1904 "summary": "Attach to a container (websocket)", 1905 "description": "Attach to the container id with a websocket.", 1906 "operationId": "attachWebsocket", 1907 "responses": { 1908 "101": { 1909 "description": "no error, hints proxy about hijacking" 1910 }, 1911 "200": { 1912 "description": "no error, no upgrade header found" 1913 }, 1914 "400": { 1915 "description": "bad parameter" 1916 }, 1917 "404": { 1918 "description": "no such container" 1919 }, 1920 "500": { 1921 "description": "server error" 1922 } 1923 }, 1924 "parameters": [{ 1925 "name": "id", 1926 "in": "path", 1927 "required": true, 1928 "description": "The container id or name", 1929 "type": "string" 1930 }, { 1931 "name": "logs", 1932 "in": "query", 1933 "description": "1/True/true or 0/False/false, return logs. Default false", 1934 "type": "string" 1935 }, { 1936 "name": "stream", 1937 "in": "query", 1938 "description": "1/True/true or 0/False/false, return stream. Default false", 1939 "type": "string" 1940 }, { 1941 "name": "stdin", 1942 "in": "query", 1943 "description": "1/True/true or 0/False/false, if stream=true, attach to stdin. Default false.", 1944 "type": "string" 1945 }, { 1946 "name": "stdout", 1947 "in": "query", 1948 "description": "1/True/true or 0/False/false, if logs=true, return stdout log, if stream=true, attach to stdout. Default false.", 1949 "type": "string" 1950 }, { 1951 "name": "stderr", 1952 "in": "query", 1953 "description": "1/True/true or 0/False/false, if logs=true, return stderr log, if stream=true, attach to stderr. Default false.", 1954 "type": "string" 1955 }], 1956 "tags": ["Container"] 1957 } 1958 }, 1959 "/containers/{id}/wait": { 1960 "post": { 1961 "summary": "Wait a container", 1962 "description": "Block until container id stops, then returns the exit code", 1963 "operationId": "wait", 1964 "responses": { 1965 "200": { 1966 "description": "no error", 1967 "schema": { 1968 "$ref": "#/definitions/ContainerWait" 1969 } 1970 }, 1971 "404": { 1972 "description": "no such container" 1973 }, 1974 "500": { 1975 "description": "server error" 1976 } 1977 }, 1978 "parameters": [{ 1979 "name": "id", 1980 "in": "path", 1981 "required": true, 1982 "description": "The container id or name", 1983 "type": "string" 1984 }], 1985 "tags": ["Container"] 1986 } 1987 }, 1988 "/containers/{id}": { 1989 "delete": { 1990 "summary": "Remove a container", 1991 "description": "Remove the container id from the filesystem", 1992 "operationId": "removeContainer", 1993 "responses": { 1994 "204": { 1995 "description": "no error" 1996 }, 1997 "400": { 1998 "description": "bad parameter" 1999 }, 2000 "404": { 2001 "description": "no such container" 2002 }, 2003 "500": { 2004 "description": "server error" 2005 } 2006 }, 2007 "parameters": [{ 2008 "name": "id", 2009 "in": "path", 2010 "required": true, 2011 "description": "The container id or name", 2012 "type": "string" 2013 }, { 2014 "name": "v", 2015 "in": "query", 2016 "description": "1/True/true or 0/False/false, Remove the volumes associated to the container. Default false.", 2017 "type": "string" 2018 }, { 2019 "name": "force", 2020 "in": "query", 2021 "description": "1/True/true or 0/False/false, Kill then remove the container. Default false.", 2022 "type": "string" 2023 }], 2024 "tags": ["Container"] 2025 } 2026 }, 2027 "/containers/{id}/archive": { 2028 "head": { 2029 "summary": "Retrieving information about files and folders in a container", 2030 "description": "Retrieving information about files and folders in a container", 2031 "operationId": "getArchiveInformation", 2032 "responses": { 2033 "204": { 2034 "description": "no error" 2035 }, 2036 "404": { 2037 "description": "no such container" 2038 }, 2039 "500": { 2040 "description": "server error" 2041 } 2042 }, 2043 "parameters": [{ 2044 "name": "id", 2045 "in": "path", 2046 "required": true, 2047 "description": "The container id or name", 2048 "type": "string" 2049 }, { 2050 "name": "path", 2051 "in": "query", 2052 "required": true, 2053 "description": "Resource in the container’s filesystem to archive.", 2054 "type": "string" 2055 }], 2056 "tags": ["Container"] 2057 }, 2058 "get": { 2059 "summary": "Get an archive of a filesystem resource in a container", 2060 "description": "Get an tar archive of a resource in the filesystem of container id.", 2061 "operationId": "getArchive", 2062 "responses": { 2063 "200": { 2064 "description": "no error" 2065 }, 2066 "400": { 2067 "description": "client error, bad parameter, details in JSON response body, one of: must specify path parameter (path cannot be empty) not a directory (path was asserted to be a directory but exists as a file)" 2068 }, 2069 "404": { 2070 "description": "no such container or path does not exist inside the container" 2071 }, 2072 "500": { 2073 "description": "server error" 2074 } 2075 }, 2076 "parameters": [{ 2077 "name": "id", 2078 "in": "path", 2079 "required": true, 2080 "description": "The container id or name", 2081 "type": "string" 2082 }, { 2083 "name": "path", 2084 "in": "query", 2085 "required": true, 2086 "description": "Resource in the container’s filesystem to archive.", 2087 "type": "string" 2088 }], 2089 "tags": ["Container"] 2090 }, 2091 "put": { 2092 "summary": "Extract an archive of files or folders to a directory in a container", 2093 "description": "Upload a tar archive to be extracted to a path in the filesystem of container id.", 2094 "operationId": "putArchive", 2095 "responses": { 2096 "200": { 2097 "description": "The content was extracted successfully" 2098 }, 2099 "400": { 2100 "description": "Bad parameter" 2101 }, 2102 "403": { 2103 "description": "Permission denied, the volume or container rootfs is marked as read-only." 2104 }, 2105 "404": { 2106 "description": "No such container or path does not exist inside the container" 2107 }, 2108 "500": { 2109 "description": "Server error" 2110 } 2111 }, 2112 "parameters": [{ 2113 "name": "id", 2114 "in": "path", 2115 "required": true, 2116 "description": "The container id or name", 2117 "type": "string" 2118 }, { 2119 "name": "path", 2120 "in": "query", 2121 "required": true, 2122 "description": "Path to a directory in the container to extract the archive’s contents into. ", 2123 "type": "string" 2124 }, { 2125 "name": "noOverwriteDirNonDir", 2126 "in": "query", 2127 "description": "If “1”, “true”, or “True” then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa.", 2128 "type": "string" 2129 }, { 2130 "name": "inputStream", 2131 "in": "body", 2132 "required": true, 2133 "description": "The input stream must be a tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz.", 2134 "schema": { 2135 "type": "string" 2136 } 2137 }], 2138 "tags": ["Container"] 2139 } 2140 }, 2141 "/images/json": { 2142 "get": { 2143 "summary": "List Images", 2144 "description": "List Images", 2145 "operationId": "findAllImages", 2146 "responses": { 2147 "200": { 2148 "description": "no error", 2149 "schema": { 2150 "type": "array", 2151 "items": { 2152 "$ref": "#/definitions/ImageItem" 2153 } 2154 } 2155 }, 2156 "500": { 2157 "description": "server error" 2158 } 2159 }, 2160 "parameters": [{ 2161 "name": "all", 2162 "in": "query", 2163 "description": "Show all images. Only images from a final layer (no children) are shown by default.", 2164 "type": "boolean", 2165 "default": false 2166 }, { 2167 "name": "filters", 2168 "in": "query", 2169 "description": "A JSON encoded value of the filters (a map[string][]string) to process on the containers list", 2170 "type": "string" 2171 }, { 2172 "name": "filter", 2173 "in": "query", 2174 "description": "Only return images with the specified name.", 2175 "type": "string" 2176 }, { 2177 "name": "digests", 2178 "in": "query", 2179 "description": "Show digest information, default to false", 2180 "type": "boolean" 2181 }], 2182 "tags": ["Image"] 2183 } 2184 }, 2185 "/build": { 2186 "post": { 2187 "summary": "Build an image from Dockerfile via stdin", 2188 "description": "Build an image from Dockerfile via stdin", 2189 "operationId": "build", 2190 "parameters": [{ 2191 "name": "inputStream", 2192 "in": "body", 2193 "description": "The input stream must be a tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz.", 2194 "schema": { 2195 "type": "string" 2196 } 2197 }, { 2198 "name": "dockerfile", 2199 "in": "query", 2200 "description": "Path within the build context to the Dockerfile. This is ignored if remote is specified and points to an individual filename.", 2201 "type": "string" 2202 }, { 2203 "name": "t", 2204 "in": "query", 2205 "description": "A repository name (and optionally a tag) to apply to the resulting image in case of success.", 2206 "type": "string" 2207 }, { 2208 "name": "remote", 2209 "in": "query", 2210 "description": "A Git repository URI or HTTP/HTTPS URI build source. If the URI specifies a filename, the file’s contents are placed into a file called Dockerfile.", 2211 "type": "string" 2212 }, { 2213 "name": "q", 2214 "in": "query", 2215 "description": "Suppress verbose build output.", 2216 "type": "boolean", 2217 "default": false 2218 }, { 2219 "name": "nocache", 2220 "in": "query", 2221 "description": "Do not use the cache when building the image.", 2222 "type": "boolean", 2223 "default": false 2224 }, { 2225 "name": "pull", 2226 "in": "query", 2227 "description": "Attempt to pull the image even if an older image exists locally", 2228 "type": "string" 2229 }, { 2230 "name": "rm", 2231 "in": "query", 2232 "description": "Remove intermediate containers after a successful build (default behavior).", 2233 "type": "boolean", 2234 "default": true 2235 }, { 2236 "name": "forcerm", 2237 "in": "query", 2238 "description": "always remove intermediate containers (includes rm)", 2239 "type": "boolean", 2240 "default": false 2241 }, { 2242 "name": "memory", 2243 "in": "query", 2244 "description": "Set memory limit for build.", 2245 "type": "integer" 2246 }, { 2247 "name": "memswap", 2248 "in": "query", 2249 "description": "Total memory (memory + swap), -1 to disable swap.", 2250 "type": "integer" 2251 }, { 2252 "name": "cpushares", 2253 "in": "query", 2254 "description": "CPU shares (relative weight).", 2255 "type": "integer" 2256 }, { 2257 "name": "cpusetcpus", 2258 "in": "query", 2259 "description": "CPUs in which to allow execution (e.g., 0-3, 0,1).", 2260 "type": "string" 2261 }, { 2262 "name": "cpuperiod", 2263 "in": "query", 2264 "description": "The length of a CPU period in microseconds.", 2265 "type": "integer" 2266 }, { 2267 "name": "cpuquota", 2268 "in": "query", 2269 "description": "Microseconds of CPU time that the container can get in a CPU period.", 2270 "type": "integer" 2271 }, { 2272 "name": "buildargs", 2273 "in": "query", 2274 "description": "Total memory (memory + swap), -1 to disable swap.", 2275 "type": "integer" 2276 }, { 2277 "name": "Content-type", 2278 "in": "header", 2279 "description": " Set to 'application/tar'.", 2280 "type": "string", 2281 "enum": ["application/tar"], 2282 "default": "application/tar" 2283 }, { 2284 "name": "X-Registry-Config", 2285 "in": "header", 2286 "description": "A base64-url-safe-encoded Registry Auth Config JSON object", 2287 "type": "string" 2288 }], 2289 "responses": { 2290 "200": { 2291 "description": "no error" 2292 }, 2293 "500": { 2294 "description": "server error" 2295 } 2296 }, 2297 "tags": ["Image"] 2298 } 2299 }, 2300 "/images/create": { 2301 "post": { 2302 "summary": "Create an image", 2303 "description": "Create an image either by pulling it from the registry or by importing it", 2304 "operationId": "createImage", 2305 "consumes": ["application/octet-stream"], 2306 "responses": { 2307 "200": { 2308 "description": "no error" 2309 }, 2310 "500": { 2311 "description": "server error" 2312 } 2313 }, 2314 "parameters": [{ 2315 "name": "fromImage", 2316 "in": "query", 2317 "description": "Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image.", 2318 "type": "string" 2319 }, { 2320 "name": "fromSrc", 2321 "in": "query", 2322 "description": "Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used when importing an image.", 2323 "type": "string" 2324 }, { 2325 "name": "repo", 2326 "in": "query", 2327 "description": "Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.", 2328 "type": "string" 2329 }, { 2330 "name": "tag", 2331 "in": "query", 2332 "description": "Tag or digest.", 2333 "type": "string" 2334 }, { 2335 "name": "inputImage", 2336 "in": "body", 2337 "description": "Image content if the value - has been specified in fromSrc query parameter", 2338 "schema": { 2339 "type": "string", 2340 "format": "binary" 2341 }, 2342 "required": false 2343 }, { 2344 "name": "X-Registry-Config", 2345 "in": "header", 2346 "description": "A base64-encoded AuthConfig object", 2347 "type": "string" 2348 }], 2349 "tags": ["Image"] 2350 } 2351 }, 2352 "/images/{name}/json": { 2353 "get": { 2354 "summary": "Inspect an image", 2355 "description": "Return low-level information on the image name", 2356 "operationId": "findImage", 2357 "responses": { 2358 "200": { 2359 "description": "No error", 2360 "schema": { 2361 "$ref": "#/definitions/Image" 2362 } 2363 }, 2364 "404": { 2365 "description": "No such image" 2366 }, 2367 "500": { 2368 "description": "Server error" 2369 } 2370 }, 2371 "parameters": [{ 2372 "name": "name", 2373 "in": "path", 2374 "description": "Image name or id", 2375 "type": "string", 2376 "required": true 2377 }], 2378 "tags": ["Image"] 2379 } 2380 }, 2381 "/images/{name}/history": { 2382 "get": { 2383 "summary": "Get the history of an image", 2384 "description": "Return the history of the image name", 2385 "operationId": "history", 2386 "responses": { 2387 "200": { 2388 "description": "No error", 2389 "schema": { 2390 "type": "array", 2391 "items": { 2392 "$ref": "#/definitions/ImageHistoryItem" 2393 } 2394 } 2395 }, 2396 "404": { 2397 "description": "No such image" 2398 }, 2399 "500": { 2400 "description": "Server error" 2401 } 2402 }, 2403 "parameters": [{ 2404 "name": "name", 2405 "in": "path", 2406 "description": "Image name or id", 2407 "type": "string", 2408 "required": true 2409 }], 2410 "tags": ["Image"] 2411 } 2412 }, 2413 "/images/{name}/push": { 2414 "post": { 2415 "summary": "Push an image to the registry", 2416 "description": "Push the image name on the registry", 2417 "operationId": "push", 2418 "responses": { 2419 "200": { 2420 "description": "No error" 2421 }, 2422 "404": { 2423 "description": "No such image" 2424 }, 2425 "500": { 2426 "description": "Server error" 2427 } 2428 }, 2429 "parameters": [{ 2430 "name": "name", 2431 "in": "path", 2432 "description": "Image name or id", 2433 "type": "string", 2434 "required": true 2435 }, { 2436 "name": "tag", 2437 "in": "query", 2438 "description": "The tag to associate with the image on the registry.", 2439 "type": "string" 2440 }, { 2441 "name": "X-Registry-Auth", 2442 "in": "header", 2443 "description": "A base64-encoded AuthConfig object", 2444 "type": "string", 2445 "required": true 2446 }], 2447 "tags": ["Image"] 2448 } 2449 }, 2450 "/images/{name}/tag": { 2451 "post": { 2452 "summary": "Tag an image into a repository", 2453 "description": "Tag the image name into a repository", 2454 "operationId": "tag", 2455 "responses": { 2456 "201": { 2457 "description": "No error" 2458 }, 2459 "400": { 2460 "description": "Bad parameter" 2461 }, 2462 "404": { 2463 "description": "No such image" 2464 }, 2465 "409": { 2466 "description": "Conflict" 2467 }, 2468 "500": { 2469 "description": "Server error" 2470 } 2471 }, 2472 "parameters": [{ 2473 "name": "name", 2474 "in": "path", 2475 "description": "Image name or id", 2476 "type": "string", 2477 "required": true 2478 }, { 2479 "name": "repo", 2480 "in": "query", 2481 "description": "The repository to tag in.", 2482 "type": "string" 2483 }, { 2484 "name": "force", 2485 "in": "query", 2486 "description": "1/True/true or 0/False/false, default false", 2487 "type": "string" 2488 }, { 2489 "name": "tag", 2490 "in": "query", 2491 "description": "The new tag name.", 2492 "type": "string" 2493 }], 2494 "tags": ["Image"] 2495 } 2496 }, 2497 "/images/{name}": { 2498 "delete": { 2499 "summary": "Remove an image", 2500 "description": "Remove the image name from the filesystem", 2501 "operationId": "removeImage", 2502 "responses": { 2503 "200": { 2504 "description": "No error" 2505 }, 2506 "404": { 2507 "description": "No such image" 2508 }, 2509 "409": { 2510 "description": "Conflict" 2511 }, 2512 "500": { 2513 "description": "Server error" 2514 } 2515 }, 2516 "parameters": [{ 2517 "name": "name", 2518 "in": "path", 2519 "description": "Image name or id", 2520 "type": "string", 2521 "required": true 2522 }, { 2523 "name": "force", 2524 "in": "query", 2525 "description": "1/True/true or 0/False/false, default false", 2526 "type": "string" 2527 }, { 2528 "name": "noprune", 2529 "in": "query", 2530 "description": "1/True/true or 0/False/false, default false.", 2531 "type": "string" 2532 }], 2533 "tags": ["Image"] 2534 } 2535 }, 2536 "/images/search": { 2537 "get": { 2538 "summary": "Search images", 2539 "description": "Search for an image on Docker Hub.", 2540 "operationId": "search", 2541 "responses": { 2542 "200": { 2543 "description": "No error", 2544 "schema": { 2545 "type": "array", 2546 "items": { 2547 "$ref": "#/definitions/ImageSearchResult" 2548 } 2549 } 2550 }, 2551 "500": { 2552 "description": "Server error" 2553 } 2554 }, 2555 "parameters": [{ 2556 "name": "term", 2557 "in": "query", 2558 "description": "Term to search", 2559 "type": "string" 2560 }], 2561 "tags": ["Image"] 2562 } 2563 }, 2564 "/auth": { 2565 "post": { 2566 "summary": "Check auth configuration", 2567 "description": "Check auth configuration.", 2568 "operationId": "checkAuthentication", 2569 "responses": { 2570 "200": { 2571 "description": "No error" 2572 }, 2573 "204": { 2574 "description": "No error" 2575 }, 2576 "500": { 2577 "description": "Server error" 2578 } 2579 }, 2580 "parameters": [{ 2581 "name": "authConfig", 2582 "in": "body", 2583 "description": "Authentication to check", 2584 "schema": { 2585 "$ref": "#/definitions/AuthConfig" 2586 } 2587 }], 2588 "tags": ["Misc"] 2589 } 2590 }, 2591 "/info": { 2592 "get": { 2593 "summary": "Display system-wide information", 2594 "description": "Display system-wide information.", 2595 "operationId": "getSystemInformation", 2596 "responses": { 2597 "200": { 2598 "description": "No error", 2599 "schema": { 2600 "$ref": "#/definitions/SystemInformation" 2601 } 2602 }, 2603 "500": { 2604 "description": "Server error" 2605 } 2606 }, 2607 "tags": ["Misc"] 2608 } 2609 }, 2610 "/version": { 2611 "get": { 2612 "summary": "Show the docker version information", 2613 "description": "Show the docker version information", 2614 "operationId": "getVersion", 2615 "responses": { 2616 "200": { 2617 "description": "no error", 2618 "schema": { 2619 "$ref": "#/definitions/Version" 2620 } 2621 }, 2622 "500": { 2623 "description": "server error" 2624 } 2625 }, 2626 "tags": ["Misc"] 2627 } 2628 }, 2629 "/_ping": { 2630 "get": { 2631 "summary": "Ping the docker server", 2632 "description": "Ping the docker server", 2633 "operationId": "ping", 2634 "produces": ["text/plain"], 2635 "responses": { 2636 "200": { 2637 "description": "no error", 2638 "schema": { 2639 "type": "string" 2640 } 2641 }, 2642 "500": { 2643 "description": "server error" 2644 } 2645 }, 2646 "tags": ["Misc"] 2647 } 2648 }, 2649 "/commit": { 2650 "post": { 2651 "summary": "Create a new image from a container’s changes", 2652 "description": "Create a new image from a container’s changes", 2653 "operationId": "commit", 2654 "responses": { 2655 "201": { 2656 "description": "no error", 2657 "schema": { 2658 "$ref": "#/definitions/CommitResult" 2659 } 2660 }, 2661 "500": { 2662 "description": "server error" 2663 } 2664 }, 2665 "parameters": [{ 2666 "name": "containerConfig", 2667 "in": "body", 2668 "description": "The container configuration", 2669 "schema": { 2670 "$ref": "#/definitions/ContainerConfig" 2671 } 2672 }, { 2673 "name": "container", 2674 "in": "query", 2675 "description": "Container id or name to commit", 2676 "type": "string" 2677 }, { 2678 "name": "repo", 2679 "in": "query", 2680 "description": "Repository name for the created image", 2681 "type": "string" 2682 }, { 2683 "name": "tag", 2684 "in": "query", 2685 "description": "Tag name for the create image", 2686 "type": "string" 2687 }, { 2688 "name": "comment", 2689 "in": "query", 2690 "description": "Commit message", 2691 "type": "string" 2692 }, { 2693 "name": "author", 2694 "in": "query", 2695 "description": "author (e.g., “John Hannibal Smith <hannibal@a-team.com>“)", 2696 "type": "string" 2697 }, { 2698 "name": "pause", 2699 "in": "query", 2700 "description": "1/True/true or 0/False/false, whether to pause the container before committing", 2701 "type": "string" 2702 }, { 2703 "name": "changes", 2704 "in": "query", 2705 "description": "Dockerfile instructions to apply while committing", 2706 "type": "string" 2707 }], 2708 "tags": ["Image"] 2709 } 2710 }, 2711 "/events": { 2712 "get": { 2713 "summary": "Monitor Docker’s events", 2714 "description": "Get container events from docker, either in real time via streaming, or via polling (using since).", 2715 "operationId": "getEvents", 2716 "responses": { 2717 "200": { 2718 "description": "no error" 2719 }, 2720 "500": { 2721 "description": "server error" 2722 } 2723 }, 2724 "parameters": [{ 2725 "name": "since", 2726 "in": "query", 2727 "description": "Timestamp used for polling", 2728 "type": "integer" 2729 }, { 2730 "name": "until", 2731 "in": "query", 2732 "description": "Timestamp used for polling", 2733 "type": "integer" 2734 }, { 2735 "name": "filters", 2736 "in": "query", 2737 "description": "A json encoded value of the filters (a map[string][]string) to process on the event list.", 2738 "type": "string" 2739 }], 2740 "tags": ["Misc"] 2741 } 2742 }, 2743 "/images/{name}/get": { 2744 "get": { 2745 "summary": "Get a tarball containing all images in a repository", 2746 "description": "Get a tarball containing all images and metadata for the repository specified by name.", 2747 "operationId": "save", 2748 "responses": { 2749 "200": { 2750 "description": "no error", 2751 "schema": { 2752 "type": "string" 2753 } 2754 }, 2755 "500": { 2756 "description": "server error" 2757 } 2758 }, 2759 "parameters": [{ 2760 "name": "name", 2761 "in": "path", 2762 "description": "Image name or id", 2763 "type": "string", 2764 "required": true 2765 }], 2766 "tags": ["Image"] 2767 } 2768 }, 2769 "/images/get": { 2770 "get": { 2771 "summary": "Get a tarball containing all images.", 2772 "description": "Get a tarball containing all images and metadata for one or more repositories.", 2773 "operationId": "saveAll", 2774 "responses": { 2775 "200": { 2776 "description": "no error", 2777 "schema": { 2778 "type": "string" 2779 } 2780 }, 2781 "500": { 2782 "description": "server error" 2783 } 2784 }, 2785 "parameters": [{ 2786 "name": "names", 2787 "in": "query", 2788 "description": "Image names to filter", 2789 "type": "array", 2790 "items": { 2791 "type": "string" 2792 } 2793 }], 2794 "tags": ["Image"] 2795 } 2796 }, 2797 "/images/load": { 2798 "post": { 2799 "summary": "Load a tarball with a set of images and tags into docker.", 2800 "description": "Load a set of images and tags into a Docker repository. See the image tarball format for more details.", 2801 "operationId": "load", 2802 "responses": { 2803 "200": { 2804 "description": "no error" 2805 }, 2806 "500": { 2807 "description": "server error" 2808 } 2809 }, 2810 "parameters": [{ 2811 "name": "imagesTarball", 2812 "in": "body", 2813 "description": "Tar archive containing images", 2814 "schema": { 2815 "type": "string" 2816 } 2817 }], 2818 "tags": ["Image"] 2819 } 2820 }, 2821 "/containers/{id}/exec": { 2822 "post": { 2823 "summary": "Exec Create", 2824 "description": "Sets up an exec instance in a running container id", 2825 "operationId": "createExec", 2826 "responses": { 2827 "201": { 2828 "description": "no error", 2829 "schema": { 2830 "$ref": "#/definitions/ExecCreateResult" 2831 } 2832 }, 2833 "404": { 2834 "description": "no such container" 2835 }, 2836 "500": { 2837 "description": "Server error" 2838 } 2839 }, 2840 "parameters": [{ 2841 "name": "execConfig", 2842 "in": "body", 2843 "description": "Exec configuration", 2844 "schema": { 2845 "$ref": "#/definitions/ExecConfig" 2846 }, 2847 "required": true 2848 }, { 2849 "name": "Content-Type", 2850 "in": "header", 2851 "description": "Content Type Header", 2852 "required": true, 2853 "type": "string", 2854 "default": "application/json" 2855 }, { 2856 "name": "id", 2857 "in": "path", 2858 "description": "Container name or id", 2859 "type": "string", 2860 "required": true 2861 }], 2862 "tags": ["Exec"] 2863 } 2864 }, 2865 "/exec/{id}/start": { 2866 "post": { 2867 "summary": "Exec Start", 2868 "description": "Starts a previously set up exec instance id. If detach is true, this API returns after starting the exec command. Otherwise, this API sets up an interactive session with the exec command.", 2869 "operationId": "startExec", 2870 "responses": { 2871 "200": { 2872 "description": "No error" 2873 }, 2874 "404": { 2875 "description": "No such exec instance" 2876 }, 2877 "409": { 2878 "description": "Container is stopped or paused" 2879 }, 2880 "500": { 2881 "description": "Server error" 2882 } 2883 }, 2884 "parameters": [{ 2885 "name": "execStartConfig", 2886 "in": "body", 2887 "description": "Exec configuration", 2888 "schema": { 2889 "$ref": "#/definitions/ExecStartConfig" 2890 } 2891 }, { 2892 "name": "Content-Type", 2893 "in": "header", 2894 "description": "Content Type Header", 2895 "required": true, 2896 "type": "string", 2897 "default": "application/json" 2898 }, { 2899 "name": "id", 2900 "in": "path", 2901 "description": "Exec instance id", 2902 "required": true, 2903 "type": "string" 2904 }], 2905 "tags": ["Exec"] 2906 } 2907 }, 2908 "/exec/{id}/resize": { 2909 "post": { 2910 "summary": "Exec Resize", 2911 "description": "Resize the tty session used by the exec command id.", 2912 "operationId": "resizeTty", 2913 "responses": { 2914 "201": { 2915 "description": "No error" 2916 }, 2917 "404": { 2918 "description": "No such exec instance" 2919 }, 2920 "500": { 2921 "description": "Server error" 2922 } 2923 }, 2924 "parameters": [{ 2925 "name": "id", 2926 "in": "path", 2927 "description": "Exec instance id", 2928 "required": true, 2929 "type": "string" 2930 }, { 2931 "name": "h", 2932 "in": "query", 2933 "description": "Height of the tty session", 2934 "type": "integer", 2935 "format": "int64" 2936 }, { 2937 "name": "w", 2938 "in": "query", 2939 "description": "Width of the tty session", 2940 "type": "integer", 2941 "format": "int64" 2942 }], 2943 "tags": ["Exec"] 2944 } 2945 }, 2946 "/exec/{id}/json": { 2947 "post": { 2948 "summary": "Exec Inspect", 2949 "description": "Return low-level information about the exec command id.", 2950 "operationId": "findExec", 2951 "responses": { 2952 "200": { 2953 "description": "No error", 2954 "schema": { 2955 "$ref": "#/definitions/ExecCommand" 2956 } 2957 }, 2958 "404": { 2959 "description": "No such exec instance" 2960 }, 2961 "500": { 2962 "description": "Server error" 2963 } 2964 }, 2965 "parameters": [{ 2966 "name": "id", 2967 "in": "path", 2968 "description": "Exec instance id", 2969 "required": true, 2970 "type": "string" 2971 }], 2972 "tags": ["Exec"] 2973 } 2974 }, 2975 "/volumes": { 2976 "get": { 2977 "summary": "List volumes", 2978 "description": "List volumes.", 2979 "operationId": "findAllVolumes", 2980 "responses": { 2981 "200": { 2982 "description": "No error", 2983 "schema": { 2984 "$ref": "#/definitions/VolumeList" 2985 } 2986 }, 2987 "500": { 2988 "description": "Server error" 2989 } 2990 }, 2991 "parameters": [{ 2992 "name": "filters", 2993 "in": "query", 2994 "description": "JSON encoded value of the filters (a map[string][]string) to process on the volumes list", 2995 "type": "string" 2996 }], 2997 "tags": ["Volume"] 2998 } 2999 }, 3000 "/volumes/create": { 3001 "post": { 3002 "summary": "Create a volume", 3003 "description": "Create a volume.", 3004 "operationId": "createVolume", 3005 "responses": { 3006 "201": { 3007 "description": "No error", 3008 "schema": { 3009 "$ref": "#/definitions/Volume" 3010 } 3011 }, 3012 "500": { 3013 "description": "Server error" 3014 } 3015 }, 3016 "parameters": [{ 3017 "name": "volumeConfig", 3018 "in": "body", 3019 "required": true, 3020 "description": "Volume configuration", 3021 "schema": { 3022 "$ref": "#/definitions/VolumeConfig" 3023 } 3024 }], 3025 "tags": ["Volume"] 3026 } 3027 }, 3028 "/volumes/{name}": { 3029 "get": { 3030 "summary": "Inspect a volume", 3031 "description": "Inspect a volume.", 3032 "operationId": "findVolume", 3033 "responses": { 3034 "200": { 3035 "description": "No error", 3036 "schema": { 3037 "$ref": "#/definitions/Volume" 3038 } 3039 }, 3040 "404": { 3041 "description": "No such volume" 3042 }, 3043 "500": { 3044 "description": "Server error" 3045 } 3046 }, 3047 "parameters": [{ 3048 "name": "name", 3049 "in": "path", 3050 "required": true, 3051 "description": "Volume name or id", 3052 "type": "string" 3053 }], 3054 "tags": ["Volume"] 3055 }, 3056 "delete": { 3057 "summary": "Remove a volume", 3058 "description": "Instruct the driver to remove the volume.", 3059 "operationId": "removeVolume", 3060 "responses": { 3061 "204": { 3062 "description": "No error" 3063 }, 3064 "404": { 3065 "description": "No such volume or volume driver" 3066 }, 3067 "409": { 3068 "description": "Volume is in use and cannot be removed" 3069 }, 3070 "500": { 3071 "description": "Server error" 3072 } 3073 }, 3074 "parameters": [{ 3075 "name": "name", 3076 "in": "path", 3077 "required": true, 3078 "description": "Volume name or id", 3079 "type": "string" 3080 }], 3081 "tags": ["Volume"] 3082 } 3083 }, 3084 "/networks": { 3085 "get": { 3086 "summary": "List networks", 3087 "description": "List networks.", 3088 "operationId": "findAllNetworks", 3089 "responses": { 3090 "200": { 3091 "description": "No error", 3092 "schema": { 3093 "type": "array", 3094 "items": { 3095 "$ref": "#/definitions/Network" 3096 } 3097 } 3098 }, 3099 "500": { 3100 "description": "Server error" 3101 } 3102 }, 3103 "parameters": [{ 3104 "name": "filters", 3105 "in": "query", 3106 "description": "JSON encoded value of the filters (a map[string][]string) to process on the networks list.", 3107 "type": "string" 3108 }], 3109 "tags": ["Network"] 3110 } 3111 }, 3112 "/networks/{id}": { 3113 "get": { 3114 "summary": "Inspect network", 3115 "description": "Inspect network.", 3116 "operationId": "findNetwork", 3117 "responses": { 3118 "200": { 3119 "description": "No error", 3120 "schema": { 3121 "$ref": "#/definitions/Network" 3122 } 3123 }, 3124 "404": { 3125 "description": "Network not found" 3126 }, 3127 "500": { 3128 "description": "Server error" 3129 } 3130 }, 3131 "parameters": [{ 3132 "name": "id", 3133 "in": "path", 3134 "description": "Network id or name", 3135 "required": true, 3136 "type": "string" 3137 }], 3138 "tags": ["Network"] 3139 }, 3140 "delete": { 3141 "summary": "Remove a network", 3142 "description": "Remove a network", 3143 "operationId": "removeNetwork", 3144 "responses": { 3145 "204": { 3146 "description": "No error" 3147 }, 3148 "404": { 3149 "description": "Network not found" 3150 }, 3151 "500": { 3152 "description": "Server error" 3153 } 3154 }, 3155 "parameters": [{ 3156 "name": "id", 3157 "in": "path", 3158 "description": "Network id or name", 3159 "required": true, 3160 "type": "string" 3161 }], 3162 "tags": ["Network"] 3163 } 3164 }, 3165 "/networks/create": { 3166 "post": { 3167 "summary": "Create network", 3168 "description": "Create network.", 3169 "operationId": "createNetwork", 3170 "responses": { 3171 "201": { 3172 "description": "No error", 3173 "schema": { 3174 "$ref": "#/definitions/NetworkCreateResult" 3175 } 3176 }, 3177 "404": { 3178 "description": "Driver not found" 3179 }, 3180 "500": { 3181 "description": "Server error" 3182 } 3183 }, 3184 "parameters": [{ 3185 "name": "networkConfig", 3186 "in": "body", 3187 "description": "Network configuration", 3188 "required": true, 3189 "schema": { 3190 "$ref": "#/definitions/NetworkCreateConfig" 3191 } 3192 }], 3193 "tags": ["Network"] 3194 } 3195 }, 3196 "/networks/{id}/connect": { 3197 "post": { 3198 "summary": "Connect a container to a network", 3199 "description": "Connect a container to a network.", 3200 "operationId": "connect", 3201 "responses": { 3202 "201": { 3203 "description": "No error" 3204 }, 3205 "404": { 3206 "description": "Network or container not found" 3207 }, 3208 "500": { 3209 "description": "Server error" 3210 } 3211 }, 3212 "parameters": [{ 3213 "name": "id", 3214 "in": "path", 3215 "description": "Network id or name", 3216 "required": true, 3217 "type": "string" 3218 }, { 3219 "name": "container", 3220 "in": "body", 3221 "description": "Container", 3222 "required": true, 3223 "schema": { 3224 "$ref": "#/definitions/ContainerConnect" 3225 } 3226 }], 3227 "tags": ["Network"] 3228 } 3229 }, 3230 "/networks/{id}/disconnect": { 3231 "post": { 3232 "summary": "Disconnect a container to a network", 3233 "description": "Disconnect a container to a network.", 3234 "operationId": "disconnect", 3235 "responses": { 3236 "201": { 3237 "description": "No error" 3238 }, 3239 "404": { 3240 "description": "Network or container not found" 3241 }, 3242 "500": { 3243 "description": "Server error" 3244 } 3245 }, 3246 "parameters": [{ 3247 "name": "id", 3248 "in": "path", 3249 "description": "Network id or name", 3250 "required": true, 3251 "type": "string" 3252 }, { 3253 "name": "container", 3254 "in": "body", 3255 "description": "Container", 3256 "required": true, 3257 "schema": { 3258 "$ref": "#/definitions/ContainerConnect" 3259 } 3260 }], 3261 "tags": ["Network"] 3262 } 3263 } 3264 } 3265 }