Edit service build arguments | Services | Northflank API docs
v1
Double column
API
CLI
JS Client

Services /

Edit service build arguments

Sets the build arguments for the given service.

Required permission

Project > Services > Configuration > Update Build Parameters

Path parameters

    • projectId

      string required

      ID of the project

    • serviceId

      string required

      ID of the service

Request body

  • {object}
    • buildArguments

      {object} required

      An object containing the all of the build arguments to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots.

      • buildFiles

        {object}

        Secret files as JSON object, encrypted at rest. File path must be absolute

      Response body

      • {object}

        Response object.

        • data

          {object} required

          Result data.

        API
        CLI
        JS Client

        POST /v1/projects/{projectId}/services/{serviceId}/build-arguments

        Example request

        Request body
        curl
        curl --header "Content-Type: application/json" \
          --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
          --request POST \
          --data '{"buildArguments":{"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"},"buildFiles":{"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}}}' \
          https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/build-arguments

        Example response

        200 OK

        The operation was performed successfully.

        JSON

        {
          "data": {}
        }

        © 2024 Northflank Ltd. All rights reserved.