Services /
Update service deployment
Required permission
Project > Services > Deployment > Update Deployment
Path parameters
projectId
string requiredID of the project
serviceId
string requiredID of the service
Request body
- {object}
An external deployment
external
{object} requiredimagePath
string requiredImage to be deployed. When not deploying from Dockerhub the URL must be specified.
pattern^(?:(?:https?:\/\/)?([a-zA-Z0-9\-]+\.[a-zA-Z0-9\.\-]+)(\/v1)?)?(?:\/)?([a-zA-Z/-9\.\-_]+)(?:\:([a-zA-Z/-9\.\-_\:]+)|\@([a-zA-Z/-9\.\-_\:]+))$credentials
stringID of the saved credentials to use to access this external image.
pattern^[A-Za-z0-9-]+$docker
{object}Allows for customization of docker runtime
configType
string requiredType of entrypoint & command override configuration
one ofdefault, customEntrypoint, customCommand, customEntrypointCustomCommandcustomEntrypoint
stringCustom entrypoint which should be used. Required in case where
configType
iscustomEntrypoint
orcustomEntrypointCustomCommand
customCommand
stringCustom command which should be used. Required in case where
configType
iscustomCommand
orcustomEntrypointCustomCommand
- {object}
An internal deployment
internal
{object} requiredid
stringID of the build service to deploy
pattern^[A-Za-z0-9-]+$branch
stringBranch to deploy
buildSHA
(multiple options: oneOf)Commit SHA to deploy, or 'latest' to deploy the most recent commit
- stringmin length40max length40
- stringone oflatest
buildId
stringID of the build that should be deployed
buildpack
{object}Allows for customization of buildpack runtime
configType
string requiredType of buildpack run configuration
one ofdefault, customProcess, customCommand, customEntrypointCustomCommand, originalEntrypointCustomCommandcustomProcess
stringCustom process which should be run. Required in case where
configType
iscustomProcess
customEntrypoint
stringCustom entrypoint which should be run. Required in case where
configType
iscustomEntrypointCustomCommand
customCommand
stringCustom command which should be run. Required in case where
configType
iscustomCommand
,customEntrypointCustomCommand
ororiginalEntrypointCustomCommand
docker
{object}Allows for customization of docker runtime
configType
string requiredType of entrypoint & command override configuration
one ofdefault, customEntrypoint, customCommand, customEntrypointCustomCommandcustomEntrypoint
stringCustom entrypoint which should be used. Required in case where
configType
iscustomEntrypoint
orcustomEntrypointCustomCommand
customCommand
stringCustom command which should be used. Required in case where
configType
iscustomCommand
orcustomEntrypointCustomCommand
OR
- {object}
Don't modify the deployment
buildpack
{object}Allows for customization of buildpack runtime
configType
string requiredType of buildpack run configuration
one ofdefault, customProcess, customCommand, customEntrypointCustomCommand, originalEntrypointCustomCommandcustomProcess
stringCustom process which should be run. Required in case where
configType
iscustomProcess
customEntrypoint
stringCustom entrypoint which should be run. Required in case where
configType
iscustomEntrypointCustomCommand
customCommand
stringCustom command which should be run. Required in case where
configType
iscustomCommand
,customEntrypointCustomCommand
ororiginalEntrypointCustomCommand
docker
{object}Allows for customization of docker runtime
configType
string requiredType of entrypoint & command override configuration
one ofdefault, customEntrypoint, customCommand, customEntrypointCustomCommandcustomEntrypoint
stringCustom entrypoint which should be used. Required in case where
configType
iscustomEntrypoint
orcustomEntrypointCustomCommand
customCommand
stringCustom command which should be used. Required in case where
configType
iscustomCommand
orcustomEntrypointCustomCommand
Response body
- {object}
Response object.
data
{object} requiredResult data.
POST /v1/projects/{projectId}/services/{serviceId}/deployment
Example request
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"external":{"imagePath":"nginx:latest","credentials":"example-credentials"},"docker":{"configType":"default"}}' \
https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/deployment
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"internal":{"id":"example-build-service","branch":"master","buildId":"premium-guide-6393"},"docker":{"configType":"default"}}' \
https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/deployment
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"docker":{"configType":"default"}}' \
https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/deployment
Example response
200 OK
JSON
{
"data": {}
}