nexus: update documenation for EphemeralIpCreate
#8030
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sudomateo
force-pushed
the
ephemeral-ip-create-docs
branch
from
a1cc828 to
b135c83
Compare
david-crespo
approved these changes
Apr 23, 2025
Passing an empty request body (i.e., `{}`) to the
[instance_ephemeral_ip_attach](https://docs.oxide.computer/api/instance_ephemeral_ip_attach)
API results in the API allocating an ephemeral IP from the silo's
default IP pool. However, the documentation did not describe that
behavior and now it does.
Here's an example request showing the behavior.
```sh
> echo "{}" | oxide api /v1/instances/$INSTANCE_ID/external-ips/ephemeral --method POST --input -
{
"ip": "192.168.0.99",
"kind": "ephemeral"
}
```
Co-authored-by: Jordan Raub <jraub@switch.com>
sudomateo
force-pushed
the
ephemeral-ip-create-docs
branch
from
b135c83 to
129cd9e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Passing an empty request body (i.e.,
{}) to the instance_ephemeral_ip_attach API results in the API allocating an ephemeral IP from the silo's default IP pool. However, the documentation did not describe that behavior and now it does.Here's an example request showing the behavior.