v1
Double column
API
CLI
JS Client

Addons /

Update addon network settings

Updates the network settings for the addon.

Required permission

Project > Addons > General > Update

Path parameters

    • projectId

      string required

      ID of the project

    • addonId

      string required

      ID of the addon

Request body

  • {object}
    • tlsEnabled

      boolean

      If true, a TLS certificate will be provisioned for the addon.

    • externalAccessEnabled

      boolean

      If true, the addon will be given a public URL and will be accessible from the internet. tlsEnabled must be true to set this as true.

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

    API
    CLI
    JS Client

    POST /v1/projects/{projectId}/addons/{addonId}/network-settings

    Example request

    Request body

    curl
    curl --header "Content-Type: application/json" \
      --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
      --request POST \
      --data '{"tlsEnabled":true,"externalAccessEnabled":true}' \
      https://api.northflank.com/v1/projects/{projectId}/addons/{addonId}/network-settings

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
      "data": {}
    }

    © 2022 Northflank Ltd. All rights reserved.