summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index fa1987a..2415cc2 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -209,6 +209,7 @@ from. Optionally a single string joining container id's with commas
* memswap_limit (int):
* host_config (dict): A [HostConfig](hostconfig.md) dictionary
* mac_address (str): The Mac Address to assign the container
+* labels (dict or list): A dictionary of name-value labels (e.g. `{"label1": "value1", "label2": "value2"}`) or a list of names of labels to set with empty values (e.g. `["label1", "label2"]`)
**Returns** (dict): A dictionary with an image 'Id' key and a 'Warnings' key.