A Fly API token with access to the requested organization or resource. Send it as Authorization: Bearer <Fly API token>.
Path Parameters
app_name
string
required
Fly App Name
Body
application/json
Assign IP request
network
string
Only for private_v6: name of the private network to allocate the Flycast address in.
Defaults to the organization's default network.
org_slug
string
Only for private_v6: slug of the organization whose private network the Flycast address
is allocated in, to make the app reachable from that organization. Defaults to the app's
organization.
region
string
Region to scope the address to. Required for egress types. Optional for v4 and v6,
which default to global (announced in all regions). Must be empty or global for
shared_v4 and private_v6.
service_name
string
Scope the address to a single service of the app. Not supported for egress types.
type
any
Response
OK
created_at
string
When the address was assigned to the app, in RFC 3339 format.
egress
boolean
Whether this is an egress address.
ip
string
The allocated IP address. Null for egress_pair; see ip_pair.
ip_pair
object
The allocated IPv4 and IPv6 addresses when the egress_pair type was requested; null
otherwise.
Show child attributes
network
object
The 6PN network a Flycast (private_v6) address belongs to. Null for all other IP types.
Show child attributes
region
string
Region the address is scoped to, or global for addresses announced in all regions.
service_name
string
Name of the service the address is scoped to, if any.