Request and inspect assignments.
The API covers assignment requests and their lifecycle. Confirm public access, authentication, supported environments and entitlements before using the integration.
Inspect the operationsFibmesh Public IPs / CLI & API
Manage the address.
Verify the delivery.
The assignment API records what you want. Reliable integration checks what took effect, tests the application and handles the address through its lifecycle.
Read the assignment operations Integration guide · Confirm platform and deployment support during assisted setup.Available with assisted setup. Confirm the supported platform, serving location, inventory and traffic policy for your deployment.
01 / Management options
An API contract.
A separate CLI milestone.
Public IPs is available with assisted setup. Confirm access to an authorised service integration before building a deployment around the documented operations.
No Public IP quickstart yet.
The checked Fibmesh CLI has no dedicated Public IP command group. List, request, pause, resume and release commands are proposed additions; their names, authentication flow and supported release still need implementation and verification.
Existing CLI commands have a different job.
Device and gateway commands do not supply the complete Public IP lifecycle. Ingress commands manage selected service rules; they do not allocate a Public IP. Egress commands do not establish a complete Public IP management workflow either. No runnable Public IP command syntax is offered here.
02 / Assignment operations
One assignment.
Five operations.
An assignment record connects an eligible target with the requested public address and delivery policy. A lifecycle request still needs an observed result.
| Operation | Contract endpoint | Meaning |
|---|---|---|
| List | GET /v1/public-ip/assignments | Inspect the organisation’s assignments and delivery state. |
| Request | POST /v1/public-ip/assignments | Record a request for an eligible device or gateway. |
| Pause | POST /v1/public-ip/assignments/{id}/pause | Stop delivery while retaining the reservation. |
| Resume | POST /v1/public-ip/assignments/{id}/resume | Request delivery using the same reservation. |
| Release | POST /v1/public-ip/assignments/{id}/release | Remove delivery and relinquish the assignment after cleanup. |
The request identifies
Target. Family. Policy.
Include the device or gateway, address family, requested region, traffic mode and firewall rules. Managed inbound rules start closed. Fully open exposure requires explicit confirmation.
The retry preserves
One logical assignment.
The create operation uses an Idempotency-Key. In the same organisation, retrying with the same key and payload returns the original assignment. Reusing the key for a different payload is a conflict.
Keep the original request and key together so an interrupted response does not turn into a duplicate allocation request.
Explore the developer reference →03 / Requested → observed → tested
Accepted is a record.
Delivered needs evidence.
Creation returns a record. Pause, resume and release accept a change for processing. An HTTP success response does not establish an immediate route change.
- 01 / Workflow
Requested
The service has received the intended configuration.
- 02 / Workflow
Provisioning
Allocation and delivery changes are being applied.
- 03 / Workflow
Observed
Infrastructure and endpoint reports show what actually took effect.
- 04 / Workflow
Verified
Your application test confirms the path you intend to use.
These are explanatory workflow stages, not replacements for the API’s exact status values.
Read the exact fields
status- The assignment’s reported lifecycle state.
delivery_health- The reported health of its delivery.
desired_generation- The generation of the requested configuration.
observed_generation- The generation covered by the observation.
Preference and allocation are separate.
assigned_region and serving_pop identify the established allocation. Changing the requested region does not automatically move the same address.
04 / Integration responsibilities
Automate the lifecycle.
Keep the operator informed.
A useful integration shows the change, applies it safely, waits for delivery and makes removal deliberate. The proposed CLI should eventually expose the same work with readable output and structured results for scripts.
- 01
Preview ownership & exposure
Show the workspace, target, traffic mode and incoming exposure before applying a request. Use an authorised identity with only the access it needs.
- 02
Retry one logical request
Retain the idempotency key and original payload for a retry. Inspect the assignment record instead of treating an interrupted response as a reason to request another address.
- 03
Wait with a limit
Check observed state, stop after a defined timeout and report a clear failure. Keep real application checks separate from control-plane success.
- 04
Prepare the removal
Distinguish pause from release. Update DNS and external allowlists before giving up an address; check how full-tunnel access and administration will recover.
Credential boundary
Endpoint keys stay local.
Keep endpoint private keys on the endpoint. Automation credentials belong in an approved secret store, outside command examples, public configuration and support logs.
05 / Service & editor boundaries
A service can be available.
Its API has its own scope.
Confirm the delivery configuration and its management surface separately. Availability of a service does not mean every operation is exposed in a public API or CLI.
Routed Subnets.
Routed Subnets is available as a separately scoped, invitation-led managed service. The current single-target Public IP assignment contract does not define a complete subnet allocation or floating-prefix API. A device assignment is not a substitute for requesting a block.
Review subnet delivery and requirements →Editors and port mappings.
The traffic-mode contract does not define a complete selected-destination editor or a gateway multi-port mapping workflow. Confirm what the supported delivery configuration exposes before designing automation around it.
Prepare a supported deployment →Next / Your integration requirements
Bring the workflow.
Confirm the access.
Share the target, traffic policy and operations your integration needs. We’ll confirm the supported deployment, serving location, service terms and authorised management options during assisted setup.