Services /
List services
Required permission
Project > Services > General > Read
Path parameters
projectId
string requiredID of the project
Query parameters
per_page
integerThe number of results to display per request. Maximum of 100 results per page.
page
integerThe page number to access.
cursor
stringThe cursor returned from the previous page of results, used to request the next page.
Response body
- {object}
Response object.
data
{object} requiredResult data.
services
[array] requiredAn array of services.
- {object}
A service object.
id
string requiredIdentifier for the service
appId
string requiredFull identifier used for service deployment
projectId
string requiredID of the project the service belongs to.
name
string requiredService name
description
stringA short description of the service
serviceType
string requiredType of the service (combined, build or deployment)
one ofcombined, build, deploymentdisabledCI
boolean requiredWhether Continuous Integration is disabled
disabledCD
boolean requiredWhether Continuous Deployment is disabled
status
{object} requiredDetails about the current service status.
build
{object}Details about the status of the most recent build.
status
string requiredThe current status of the build.
one ofQUEUED, PENDING, STARTING, CLONING, BUILDING, UPLOADING, ABORTED, FAILURE, SUBMISSION_FAILURE, SUCCESS, CRASHEDlastTransitionTime
stringThe timestamp of when the build reached this status.
deployment
{object}Details about the current deployment status.
status
string requiredThe current status of the deployment.
one ofPENDING, IN_PROGRESS, COMPLETED, FAILEDreason
string requiredThe reason the current deployment was started.
one ofSCALING, DEPLOYINGlastTransitionTime
stringThe timestamp of when the deployment reached this status.
pagination
{object} requiredData about the endpoint pagination.
hasNextPage
boolean requiredIs there another page of results available?
cursor
stringThe cursor to access the next page of results.
count
number requiredThe number of results returned by this request.
GET /v1/projects/{projectId}/services
Example response
200 OK
JSON
{
"data": {
"services": [
{
"id": "example-service",
"appId": "/example-user/default-project/example-service",
"projectId": "default-project",
"name": "Example Service",
"tags": [
"my-tag"
],
"description": "This is the service description",
"serviceType": "combined",
"disabledCI": false,
"disabledCD": false,
"status": {
"build": {
"status": "SUCCESS",
"lastTransitionTime": "2021-11-29T11:47:16.624Z"
},
"deployment": {
"status": "COMPLETED",
"reason": "DEPLOYING",
"lastTransitionTime": "2021-11-29T11:47:16.624Z"
}
}
}
]
},
"pagination": {
"hasNextPage": false,
"count": 1
}
}