Services /
Get service deployment
Required permission
Project > Services > Deployment > View Instances
Path parameters
projectId
string requiredID of the project
serviceId
string requiredID of the service
Response body
- {object}
Response object.
data
(multiple options: oneOf) requiredResult data.
- {object}
Service deploying a Northflank entity
region
stringRegion where this service is deployed and/or built
instances
integerNumber of instances/replicas running
docker
{object}Details about the Docker overrides for this deployment.
configType
string requiredOverride configuration which is used at runtime.
one ofdefault, customEntrypoint, customCommand, customEntrypointCustomCommandcustomEntrypoint
stringThe CMD to run instead of the default if entrypoint override is enabled.
customCommand
stringThe CMD to run instead of the default if CMD override is enabled.
buildpack
{object}Details about the Buildpack overrides for this deployment.
configType
string requiredType of buildpack run configuration.
one ofdefault, customProcess, customCommand, customEntrypointCustomCommand, originalEntrypointCustomCommandcustomProcess
stringCustom process which should be run.
customEntrypoint
stringCustom entrypoint which should be run.
customCommand
stringCustom command which should be run.
storage
{object}Details about storage settings for this deployment.
ephemeralStorage
{object}Details about ephemeral storage settings for this deployment.
storageSize
number requiredEphemeral storage per container in MB
internal
{object} requiredappId
string requiredFull identifier of deployed entity
nfObjectId
string requiredID of deployed entity
nfObjectType
string requiredType of deployed entity
one ofservicerepository
string requiredURL of the repository being deployed
branch
string requiredBranch of the repo being deployed
buildId
string requiredID of the build currently deployed.
buildSHA
string requiredCommit SHA being deployed.
latest
means the latest commit is automatically being deployed.deployedSHA
stringCurrently deployed commit SHA. If buildSHA is set to
latest
, this will show the SHA of the latest commit.- {object}
Service deploying an external image
region
stringRegion where this service is deployed and/or built
instances
integerNumber of instances/replicas running
docker
{object}Details about the Docker overrides for this deployment.
configType
string requiredOverride configuration which is used at runtime.
one ofdefault, customEntrypoint, customCommand, customEntrypointCustomCommandcustomEntrypoint
stringThe CMD to run instead of the default if entrypoint override is enabled.
customCommand
stringThe CMD to run instead of the default if CMD override is enabled.
buildpack
{object}Details about the Buildpack overrides for this deployment.
configType
string requiredType of buildpack run configuration.
one ofdefault, customProcess, customCommand, customEntrypointCustomCommand, originalEntrypointCustomCommandcustomProcess
stringCustom process which should be run.
customEntrypoint
stringCustom entrypoint which should be run.
customCommand
stringCustom command which should be run.
storage
{object}Details about storage settings for this deployment.
ephemeralStorage
{object}Details about ephemeral storage settings for this deployment.
storageSize
number requiredEphemeral storage per container in MB
external
{object} requiredimagePath
string requiredPath of the external image excluding the hostname
registryProvider
string requiredRegistry provider hosting the external image
one ofdockerhub, gcr, gcr-eu, gcr-us, gitlab, github, customprivateImage
boolean requiredDoes the image require authentication
OR
GET /v1/projects/{projectId}/services/{serviceId}/deployment
Example response
200 OK
JSON
{
"data": {
"region": "europe-west",
"instances": 1,
"docker": {
"configType": "default"
},
"buildpack": {
"configType": "default"
},
"storage": {
"ephemeralStorage": {
"storageSize": 1024
}
},
"internal": {
"appId": "/example-user/default-project/example-service",
"nfObjectId": "example-service",
"nfObjectType": "service",
"repository": "https://github.com/northflank/gatsby-with-northflank",
"branch": "master",
"buildId": "incredible-land-3266",
"buildSHA": "latest",
"deployedSHA": "262ed9817b3cad5142fbceabe0c9e371e390d616"
}
}
}
OR
JSON
{
"data": {
"region": "europe-west",
"instances": 1,
"docker": {
"configType": "default"
},
"buildpack": {
"configType": "default"
},
"storage": {
"ephemeralStorage": {
"storageSize": 1024
}
},
"external": {
"imagePath": "nginx:latest",
"registryProvider": "dockerhub",
"privateImage": false
}
}
}