You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 26, 2019. It is now read-only.
The API is usually changed in each release of Docker, so API calls are versioned to ensure that clients don't break.
45
+
The API is usually changed in each release, so API calls are versioned to
46
+
ensure that clients don't break. To lock to a specific version of the API,
47
+
you prefix the URL with its version, for example, call `/v1.30/info` to use
48
+
the v1.30 version of the `/info` endpoint. If the API version specified in
49
+
the URL is not supported by the daemon, a HTTP `400 Bad Request` error message
50
+
is returned.
46
51
47
-
For Docker Engine 17.10, the API version is 1.33. To lock to this version, you prefix the URL with `/v1.33`. For example, calling `/info` is the same as calling `/v1.33/info`.
52
+
If you omit the version-prefix, the current version of the API (v1.35) is used.
53
+
For example, calling `/info` is the same as calling `/v1.35/info`. Using the
54
+
API without a version-prefix is deprecated and will be removed in a future release.
48
55
49
-
Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine.
56
+
Engine releases in the near future should support this version of the API,
57
+
so your client will continue to work even if it is talking to a newer Engine.
50
58
51
-
In previous versions of Docker, it was possible to access the API without providing a version. This behaviour is now deprecated will be removed in a future version of Docker.
59
+
The API uses an open schema model, which means server may add extra properties
60
+
to responses. Likewise, the server will ignore any extra query parameters and
61
+
request body properties. When you write clients, you need to ignore additional
62
+
properties in responses to ensure they do not break when talking to newer
63
+
daemons.
52
64
53
-
If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned.
54
-
55
-
The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer Docker daemons.
56
-
57
-
This documentation is for version 1.34 of the API. Use this table to find documentation for previous versions of the API:
description: "A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`."
257
+
type: "string"
269
258
enum:
270
259
- "private"
271
260
- "rprivate"
@@ -344,6 +333,7 @@ definitions:
344
333
Memory:
345
334
description: "Memory limit in bytes."
346
335
type: "integer"
336
+
format: "int64"
347
337
default: 0
348
338
# Applicable to UNIX platforms
349
339
CgroupParent:
@@ -618,17 +608,7 @@ definitions:
618
608
description: "Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken
619
609
as a custom network's name to which this container should connect to."
620
610
PortBindings:
621
-
type: "object"
622
-
description: "A map of exposed container ports and the host port they should map to."
623
-
additionalProperties:
624
-
type: "object"
625
-
properties:
626
-
HostIp:
627
-
type: "string"
628
-
description: "The host IP address"
629
-
HostPort:
630
-
type: "string"
631
-
description: "The host port number, as a string"
611
+
$ref: "#/definitions/PortMap"
632
612
RestartPolicy:
633
613
$ref: "#/definitions/RestartPolicy"
634
614
AutoRemove:
@@ -844,9 +824,7 @@ definitions:
844
824
type: "string"
845
825
Cmd:
846
826
description: "Command to run specified as a string or an array of strings."
847
-
type:
848
-
- "array"
849
-
- "string"
827
+
type: "array"
850
828
items:
851
829
type: "string"
852
830
Healthcheck:
@@ -874,9 +852,7 @@ definitions:
874
852
The entry point for the container as a string or an array of strings.
875
853
876
854
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
877
-
type:
878
-
- "array"
879
-
- "string"
855
+
type: "array"
880
856
items:
881
857
type: "string"
882
858
NetworkDisabled:
@@ -2688,7 +2664,13 @@ definitions:
2688
2664
ConfigName is the name of the config that this references, but this is just provided for
2689
2665
lookup/display purposes. The config in the reference will be identified by its ID.
2690
2666
type: "string"
2691
-
2667
+
Isolation:
2668
+
type: "string"
2669
+
description: "Isolation technology of the containers running the service. (Windows only)"
2670
+
enum:
2671
+
- "default"
2672
+
- "process"
2673
+
- "hyperv"
2692
2674
Resources:
2693
2675
description: "Resource requirements which apply to each individual container created as part of the service."
2694
2676
type: "object"
@@ -4514,7 +4496,7 @@ paths:
4514
4496
x-nullable: false
4515
4497
Warnings:
4516
4498
description: "Warnings encountered when creating the container"
4517
-
type: ["array", "null"]
4499
+
type: "array"
4518
4500
x-nullable: false
4519
4501
items:
4520
4502
type: "string"
@@ -4962,6 +4944,11 @@ paths:
4962
4944
description: "Only return logs since this time, as a UNIX timestamp"
4963
4945
type: "integer"
4964
4946
default: 0
4947
+
- name: "until"
4948
+
in: "query"
4949
+
description: "Only return logs before this time, as a UNIX timestamp"
4950
+
type: "integer"
4951
+
default: 0
4965
4952
- name: "timestamps"
4966
4953
in: "query"
4967
4954
description: "Add timestamps to every log line"
@@ -6770,6 +6757,28 @@ paths:
6770
6757
schema:
6771
6758
type: "object"
6772
6759
properties:
6760
+
Platform:
6761
+
type: "object"
6762
+
required: [Name]
6763
+
properties:
6764
+
Name:
6765
+
type: "string"
6766
+
Components:
6767
+
type: "array"
6768
+
items:
6769
+
type: "object"
6770
+
x-go-name: ComponentVersion
6771
+
required: [Name, Version]
6772
+
properties:
6773
+
Name:
6774
+
type: "string"
6775
+
Version:
6776
+
type: "string"
6777
+
x-nullable: false
6778
+
Details:
6779
+
type: "object"
6780
+
x-nullable: true
6781
+
6773
6782
Version:
6774
6783
type: "string"
6775
6784
ApiVersion:
@@ -6992,7 +7001,7 @@ paths:
6992
7001
- `network=<string>` network name or ID
6993
7002
- `node=<string>` node ID
6994
7003
- `plugin`=<string> plugin name or ID
6995
-
- `scope`=<string> local or swarm
7004
+
- `scope`=<string> local or swarm
6996
7005
- `secret=<string>` secret name or ID
6997
7006
- `service=<string>` service name or ID
6998
7007
- `type=<string>` object to filter by, one of `container`, `image`, `volume`, `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`
@@ -7265,6 +7274,9 @@ paths:
7265
7274
User:
7266
7275
type: "string"
7267
7276
description: "The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`."
7277
+
WorkingDir:
7278
+
type: "string"
7279
+
description: "The working directory for the exec process inside the container."
Copy file name to clipboardExpand all lines: src/Model/ContainerConfig.php
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ class ContainerConfig
84
84
/**
85
85
* Command to run specified as a string or an array of strings.
86
86
*
87
-
* @var string[]|string
87
+
* @var string[]
88
88
*/
89
89
protected$cmd;
90
90
/**
@@ -123,7 +123,7 @@ class ContainerConfig
123
123
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
124
124
125
125
*
126
-
* @var string[]|string
126
+
* @var string[]
127
127
*/
128
128
protected$entrypoint;
129
129
/**
@@ -442,21 +442,21 @@ public function setEnv(?array $env): self
442
442
/**
443
443
* Command to run specified as a string or an array of strings.
444
444
*
445
-
* @return string[]|string
445
+
* @return string[]
446
446
*/
447
-
publicfunctiongetCmd()
447
+
publicfunctiongetCmd(): ?array
448
448
{
449
449
return$this->cmd;
450
450
}
451
451
452
452
/**
453
453
* Command to run specified as a string or an array of strings.
454
454
*
455
-
* @param string[]|string $cmd
455
+
* @param string[] $cmd
456
456
*
457
457
* @return self
458
458
*/
459
-
publicfunctionsetCmd($cmd): self
459
+
publicfunctionsetCmd(?array$cmd): self
460
460
{
461
461
$this->cmd = $cmd;
462
462
@@ -589,9 +589,9 @@ public function setWorkingDir(?string $workingDir): self
589
589
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
590
590
591
591
*
592
-
* @return string[]|string
592
+
* @return string[]
593
593
*/
594
-
publicfunctiongetEntrypoint()
594
+
publicfunctiongetEntrypoint(): ?array
595
595
{
596
596
return$this->entrypoint;
597
597
}
@@ -602,11 +602,11 @@ public function getEntrypoint()
602
602
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
Copy file name to clipboardExpand all lines: src/Model/ContainersCreatePostBody.php
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ class ContainersCreatePostBody
84
84
/**
85
85
* Command to run specified as a string or an array of strings.
86
86
*
87
-
* @var string[]|string
87
+
* @var string[]
88
88
*/
89
89
protected$cmd;
90
90
/**
@@ -123,7 +123,7 @@ class ContainersCreatePostBody
123
123
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
124
124
125
125
*
126
-
* @var string[]|string
126
+
* @var string[]
127
127
*/
128
128
protected$entrypoint;
129
129
/**
@@ -454,21 +454,21 @@ public function setEnv(?array $env): self
454
454
/**
455
455
* Command to run specified as a string or an array of strings.
456
456
*
457
-
* @return string[]|string
457
+
* @return string[]
458
458
*/
459
-
publicfunctiongetCmd()
459
+
publicfunctiongetCmd(): ?array
460
460
{
461
461
return$this->cmd;
462
462
}
463
463
464
464
/**
465
465
* Command to run specified as a string or an array of strings.
466
466
*
467
-
* @param string[]|string $cmd
467
+
* @param string[] $cmd
468
468
*
469
469
* @return self
470
470
*/
471
-
publicfunctionsetCmd($cmd): self
471
+
publicfunctionsetCmd(?array$cmd): self
472
472
{
473
473
$this->cmd = $cmd;
474
474
@@ -601,9 +601,9 @@ public function setWorkingDir(?string $workingDir): self
601
601
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
602
602
603
603
*
604
-
* @return string[]|string
604
+
* @return string[]
605
605
*/
606
-
publicfunctiongetEntrypoint()
606
+
publicfunctiongetEntrypoint(): ?array
607
607
{
608
608
return$this->entrypoint;
609
609
}
@@ -614,11 +614,11 @@ public function getEntrypoint()
614
614
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
0 commit comments