Get details from a workflow deployment group
GET
/v1/workflow_deployment_groups/{org_uuid}/{workflow_deployment_group_id}
Get details from a workflow deployment group.
Authorizations
apiKey
API key as username in Basic Authorization with
empty password.
TypeAPI Key (header: Authorization)
or
jwtToken
TypeHTTP (bearer)
Parameters
Path Parameters
org_uuid*
UUID of the organization
Typestring
Requiredformat
"uuid"workflow_deployment_group_id*
Unique identifier for the workflow deployment group
Typeinteger
RequiredExample
42format
"int64"Responses
OK
application/json
JSON
{
"id": 42,
"status": "string",
"commit_title": "Fix this",
"commit_sha": "deadc0decafebabecafed00ddeadbeeff00dface",
"repository": "github.com/terramate-io/iac-gcloud",
"auth_type": "string",
"auth_id": "string",
"auth_user": {
"display_name": "Marius Tolzmann",
"position": "CTPO",
"user_picture_url": "https://lh3.googleusercontent.com/a/AAcHTtcBqudpP0hVoQyjDv-v5b4lP6e0vN_92zi_aPp90hE=s96-c"
},
"canceled_count": 8,
"failed_count": 1,
"ok_count": 7,
"pending_count": 23,
"running_count": 1,
"stack_deployment_total_count": 40,
"created_at": "string",
"started_at": "string",
"finished_at": "string",
"metadata": {
"additionalProperties": "string"
},
"review_request": {
"review_request_id": 42,
"platform": "github",
"repository": "github.com/terramate-io/iac-gcloud",
"commit_sha": "deadc0decafebabecafed00ddeadbeeff00dface",
"number": 23,
"title": "feat: Add feature X",
"description": "My Change Description
with a lot of details.
",
"url": "https://github.com/terramate-io/iac-gcloud/pull/666",
"author": {
"login": "hacker",
"avatar_url": "https://avatar.url/hacker",
"id": "id"
},
"status": "string",
"platform_updated_at": "string",
"platform_created_at": "string",
"platform_pushed_at": "string",
"platform_merged_at": "string",
"reviewers": [
{
"login": "hacker",
"avatar_url": "https://avatar.url/hacker",
"id": "id"
}
],
"branch": "my_awesome_feature",
"base_branch": "main",
"draft": true,
"review_decision": "approved",
"changes_requested_count": 1,
"approved_count": 1,
"checks_total_count": 1,
"checks_failure_count": 1,
"checks_success_count": 1,
"labels": [
{
"name": "label1",
"color": "#000000",
"description": "label description"
}
],
"preview": {
"id": 232,
"status": "outdated",
"affected_count": 1,
"pending_count": 1,
"running_count": 1,
"changed_count": 1,
"unchanged_count": 1,
"failed_count": 1,
"canceled_count": 0,
"resource_changes": {
"create_count": 3,
"delete_count": 2,
"noop_count": 5,
"read_count": 4,
"replace_count": 7,
"update_count": 0
}
},
"metrics": {
"last_drafted_at": "string",
"last_ready_for_review_at": "string",
"ready_for_review_count": 1,
"review_total_duration_seconds": 1,
"last_mergeable_at": "string",
"mergeable_count": 1,
"mergeable_total_duration_seconds": 2323,
"last_closed_at": "string",
"deployment": {
"started_at": "string",
"finished_at": "string",
"failed_at": "string",
"fixed_at": "string",
"wait_time_total_duration_seconds": 2323,
"status": "string",
"time_to_restore_seconds": 2323,
"lead_time_for_change_seconds": 2342,
"stack_deployment_ok_count": 34,
"stack_deployment_failed_count": 23
}
},
"collaborators": [
{
"id": 232,
"platform": "github",
"display_name": "hacker",
"avatar_url": "https://avatar.url/hacker",
"linked_user": {
"user_uuid": "683e0589-65a8-48b8-bd90-6ee89e0682ab",
"display_name": "Marius Tolzmann",
"user_picture_url": "https://lh3.googleusercontent.com/a/AAcHTtcBqudpP0hVoQyjDv-v5b4lP6e0vN_92zi_aPp90hE=s96-c"
},
"roles": [
"string"
]
}
]
},
"branch": "main",
"workflow_triggered_by": "hacker",
"workflow_name": "deploy to prod",
"grouping_key": "string",
"triggered_by": {
"id": 232,
"platform": "github",
"display_name": "hacker",
"avatar_url": "https://avatar.url/hacker",
"linked_user": {
"user_uuid": "683e0589-65a8-48b8-bd90-6ee89e0682ab",
"display_name": "Marius Tolzmann",
"user_picture_url": "https://lh3.googleusercontent.com/a/AAcHTtcBqudpP0hVoQyjDv-v5b4lP6e0vN_92zi_aPp90hE=s96-c"
}
}
}