Services /
Get service deployment details
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) requiredResult data.
- {object}
Service deploying a Northflank entity
region
stringRegion where this service is deployed and/or built
instances
integerNumber of instances/replicas running
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
buildSHA
string requiredCommit SHA being deployed. 'latest' means the latest commit is automatically being deployed.
- {object}
Service deploying an external image
region
stringRegion where this service is deployed and/or built
instances
integerNumber of instances/replicas running
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,
"internal": {
"appId": "/example-user/default-project/example-service",
"nfObjectId": "example-service",
"nfObjectType": "service",
"repository": "https://github.com/northflank/gatsby-with-northflank",
"branch": "master",
"buildSHA": "latest"
}
}
}
OR
JSON
{
"data": {
"region": "europe-west",
"instances": 1,
"external": {
"imagePath": "nginx:latest",
"registryProvider": "dockerhub",
"privateImage": false
}
}
}