Skip to main content
POST
/
vpcs
/
{vpcName}
/
egressgateways
/
{gatewayName}
/
ips
Allocate a new egress IP from the gateway
curl --request POST \
  --url https://api.blaxel.ai/v0/vpcs/{vpcName}/egressgateways/{gatewayName}/ips \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "my-egress-ip",
    "displayName": "My Egress IP"
  },
  "spec": {
    "ipFamily": "IPv4"
  }
}
'
{
  "metadata": {
    "name": "my-egress-ip",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "My Egress IP",
    "gatewayName": "<string>",
    "vpcName": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "ipFamily": "IPv4",
    "publicIp": "<string>"
  },
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "status": "DELETING"
}

Authorizations

Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

vpcName
string
required
gatewayName
string
required

Body

application/json

An individual IP address allocated from an egress gateway for dedicated outbound traffic

metadata
object
required

Metadata for an egress IP address including gateway association and name

spec
object
required

Specification for an egress IP including IP family and the provisioned address

Response

200 - application/json

successful operation

An individual IP address allocated from an egress gateway for dedicated outbound traffic

metadata
object
required

Metadata for an egress IP address including gateway association and name

spec
object
required

Specification for an egress IP including IP family and the provisioned address

events
object[]

Events happening on a resource deployed on Blaxel

status
enum<string>

Deployment status of a resource deployed on Blaxel

Available options:
DELETING,
TERMINATED,
FAILED,
DEACTIVATED,
DEACTIVATING,
UPLOADING,
BUILDING,
DEPLOYING,
DEPLOYED