Skip to main content
GET
/
egressips
List all egress IPs across all VPCs and gateways in the workspace
curl --request GET \
  --url https://api.blaxel.ai/v0/egressips \
  --header 'Authorization: Bearer <token>'
[
  {
    "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

Response

200 - application/json

successful operation

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