Skip to main content
POST
/
vpcs
/
{vpcName}
/
egressgateways
Create an egress gateway in a VPC
curl --request POST \
  --url https://api.blaxel.ai/v0/vpcs/{vpcName}/egressgateways \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "my-egress-gateway",
    "displayName": "My Egress Gateway"
  },
  "spec": {
    "region": "us-pdx-1"
  }
}
'
{
  "metadata": {
    "name": "my-egress-gateway",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "My Egress Gateway",
    "vpcName": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "region": "us-pdx-1"
  },
  "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

Body

application/json

An egress gateway that manages outbound traffic routing within a VPC. Multiple egress IPs can be allocated from a single gateway.

metadata
object
required

Metadata for an egress gateway resource including workspace, VPC, and name

spec
object
required

Specification for an egress gateway including region and capacity configuration

Response

200 - application/json

successful operation

An egress gateway that manages outbound traffic routing within a VPC. Multiple egress IPs can be allocated from a single gateway.

metadata
object
required

Metadata for an egress gateway resource including workspace, VPC, and name

spec
object
required

Specification for an egress gateway including region and capacity configuration

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