v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Egress Ips /

Patch egress IP

Updates an egress IP

Required permission

Account > EgressIps > General > Update

Path parameters

    • egressIpId

      string required
      ID of the egress IP

Request body

  • {object}

    • name

      string
      The name of the egress IP.
      min length
      3
      max length
      39
      pattern
      ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$

    • description

      string
      The description of the egress IP.
      max length
      200
      pattern
      ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

    • spec

      {object}
      Egress IP specification

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • id

        string required
        ID of the egress IP
        pattern
        ^[A-Za-z0-9-]+$

      • name

        string required
        The name of the egress IP.
        min length
        3
        max length
        39
        pattern
        ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$

      • description

        string
        The description of the egress IP.
        max length
        200
        pattern
        ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

      • spec

        {object} required
        Egress IP specification

      • state

        {object}

        • ipAddress

          string
          Assigned public IP address

        • status

          string required
          Current status of the egress IP
          one of
          staging, loading, active, error, deleting, deleted

        • lastTransitionTime

          string required
          Time of the last status transition

      • createdAt

        string required
        The time the egress IP was created.

      • updatedAt

        string required
        The time the egress IP was last updated.
API
CLI
JS Client

PATCH /v1/egress-ips/{egressIpId}

Example request

Request body
curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"name":"my-egress-ip","description":"This is a new egress IP.","spec":{"provisioningMode":"shared","region":"europe-west","mode":"include"}}' \
  https://api.northflank.com/v1/egress-ips/{egressIpId}

Example response

200 OK

Details about the updated egress IP.

JSON

{
  "data": {
    "id": "my-egress-ip",
    "name": "my-egress-ip",
    "description": "This is a new egress IP.",
    "spec": {
      "provisioningMode": "shared",
      "region": "europe-west",
      "mode": "include"
    },
    "state": {
      "ipAddress": "34.105.225.71",
      "status": "active"
    },
    "createdAt": "2021-01-20T11:19:53.175Z",
    "updatedAt": "2021-01-20T11:19:53.175Z"
  }
}

© 2026 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com