Skip to content

docs(flexible-ip): update docs #3125

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 2, 2025
Merged

docs(flexible-ip): update docs #3125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 7 additions & 14 deletions docs/data-sources/flexible_ip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,26 @@ Gets information about a Flexible IP.

```hcl
# Get info by IP address
data "scaleway_flexible_ip" "my_ip" {
data "scaleway_flexible_ip" "with_ip" {
ip_address = "1.2.3.4"
}

# Get info by IP ID
data "scaleway_flexible_ip" "my_ip" {
ip_id = "11111111-1111-1111-1111-111111111111"
data "scaleway_flexible_ip" "with_id" {
flexible_ip_id = "11111111-1111-1111-1111-111111111111"
}
```

## Argument Reference

- `ip_address` - (Optional) The IP address.
Only one of `ip_address` and `ip_id` should be specified.
Only one of `ip_address` and `flexible_ip_id` should be specified.

- `flexible_ip_id` - (Optional) The IP ID.
Only one of `ip_address` and `flexible_ip_id` should be specified.

## Attributes Reference

In addition to all above arguments, the following attributes are exported:
- `project_id` - (Optional. Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Flexible IP is associated with.

- `id` - The ID of the flexible IP.

~> **Important:** Flexible IPs' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
## Attributes Reference

- `reverse` - The reverse domain associated with this IP.
- `server_id` - The associated server ID if any
- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the organization the IP is in.
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the IP is in.
Exported attributes are the ones from `flexible_ip` [resource](../resources/flexible_ip.md)
3 changes: 1 addition & 2 deletions docs/resources/flexible_ip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The following arguments are supported:
- `reverse` - (Optional) The reverse domain associated with this flexible IP.
- `is_ipv6` - (Optional) Defines whether the flexible IP has an IPv6 address.
- `zone` -(Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) of the Flexible IP.

- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Flexible IP is associated with.

## Attributes Reference

Expand All @@ -94,7 +94,6 @@ In addition to all arguments above, the following attributes are exported:
- `created_at` - The date and time of the creation of the Flexible IP (Format ISO 8601).
- `updated_at` - The date and time of the last update of the Flexible IP (Format ISO 8601).
- `organization_id` - The organization of the Flexible IP.
- `project_id` - The project of the Flexible IP.

## Import

Expand Down
Loading