Services /
Edit service build arguments
Deprecated
This endpoint is deprecated and will be removed in the future. Please avoid making requests to this endpoint.
Requests should instead use the relevant PATCH endpoint.
Sets the build arguments for the given service.
Required permission
Project > Secrets > Services > Update
Path parameters
projectId
string requiredID of the projectserviceId
string requiredID of the service
Request body
- {object}
buildArguments
{object}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 absolutedockerSecretMounts
{object}Docker secret mount contents as JSON object, encrypted at rest. Must be a valid Docker secret mount identifier
Response body
- {object}Response object.
data
{object} requiredResult 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"}},"dockerSecretMounts":{"example-secret-mount_1":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}}}' \
https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/build-argumentsExample response
200 OK
The operation was performed successfully.
JSON
{
"data": {}
}