Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update 37-control-plane.md #585

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/30-configuration/37-control-plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Usage of ./containerpilot:
Show version identifier and quit.
```

##### `PutEnv POST /v3/env`
##### `PutEnv POST /v3/environ`

This API allows a client to update the environment variables that ContainerPilot provides to jobs and health checks. The body of the POST must be in JSON format. The keys will be used as the environment variable to set, and the values will be the values to set for those environment variables. The environment variables take effect for all future processes spawned and override any existing environment variables. Unsetting an variable is supporting by passing an empty string or `null` as the JSON value for that key. This API returns HTTP400 if the key is not a valid environment variable name, otherwise HTTP200 with no body.

Expand All @@ -49,7 +49,7 @@ This API allows a client to update the environment variables that ContainerPilot
curl -XPOST \
-d '{"ENV1": "value1", "ENV2": "value2", "ENV_TO_CLEAR": ""}' \
--unix-socket /var/containerpilot.sock \
http:/v3/env
http:/v3/environ
```

##### `PutMetric POST /v3/metric`
Expand All @@ -68,7 +68,7 @@ This API allows a client to update Prometheus metrics. The body of the POST must
curl -XPOST \
-d '{"my_counter_metric": 2, "my_gauge_metric": 42.42}' \
--unix-socket /var/containerpilot.sock \
http:/v3/environ
http:/v3/metric
```

##### `Reload POST /v3/reload`
Expand Down