Jobs
Get a Job
GET
/
v1
/
jobs
/
{jobId}
curl --request GET \
--url https://api.ctrlplane.dev/api/v1/jobs/{jobId}
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "successful",
"externalId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"jobAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentConfig": {},
"message": "<string>",
"reason": "<string>",
"release": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>",
"config": {},
"jobAgentConfig": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {}
},
"deploymentVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tag": "<string>",
"config": {},
"jobAgentConfig": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {}
},
"deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentConfig": {},
"retryCount": 123,
"timeout": 123
},
"runbook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>",
"kind": "<string>",
"identifier": "<string>",
"config": {},
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceSelector": {},
"directory": "my/env/path",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {},
"policy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"approvalRequirement": "manual",
"successType": "some",
"successMinimum": 123,
"concurrencyLimit": 123,
"rolloutDuration": 123,
"minimumReleaseInterval": 123,
"releaseSequencing": "wait"
}
},
"variables": {},
"approval": {
"id": "<string>",
"status": "pending",
"approver": {
"id": "<string>",
"name": "<string>"
}
}
}
Path Parameters
The job ID
Response
200
application/json
OK
The response is of type object
.
curl --request GET \
--url https://api.ctrlplane.dev/api/v1/jobs/{jobId}
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "successful",
"externalId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"jobAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentConfig": {},
"message": "<string>",
"reason": "<string>",
"release": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>",
"config": {},
"jobAgentConfig": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {}
},
"deploymentVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tag": "<string>",
"config": {},
"jobAgentConfig": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {}
},
"deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentConfig": {},
"retryCount": 123,
"timeout": 123
},
"runbook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>",
"kind": "<string>",
"identifier": "<string>",
"config": {},
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceSelector": {},
"directory": "my/env/path",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {},
"policy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"approvalRequirement": "manual",
"successType": "some",
"successMinimum": 123,
"concurrencyLimit": 123,
"rolloutDuration": 123,
"minimumReleaseInterval": 123,
"releaseSequencing": "wait"
}
},
"variables": {},
"approval": {
"id": "<string>",
"status": "pending",
"approver": {
"id": "<string>",
"name": "<string>"
}
}
}