project_deployment

Gets or lists a project_deployment resource.

Overview

Name	project_deployment
Type	Resource
Id	gitlab.projects.project_deployment

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	Global ID of the deployment.
created_at	string	When the deployment record was created.
finished_at	string	When the deployment finished.
iid	string	Project-level internal ID of the deployment.
pending_approval_count	integer	Number of pending unified approvals on the deployment.
ref	string	Git-Ref that the deployment ran on.
ref_path	string	Path to the Git-Ref that the deployment ran on.
sha	string	Git-SHA that the deployment ran on.
status	string	Status of the deployment. (CREATED, RUNNING, SUCCESS, FAILED, CANCELED, SKIPPED, BLOCKED)
tag	boolean	True or false if the deployment ran on a Git-tag.
updated_at	string	When the deployment record was updated.
web_path	string	Web path to the deployment page.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, iid, host		Details of the deployment of the project. Generated from the GitLab GraphQL schema field Project.deployment (Deployment).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
full_path	string	Full path of the project, for example gitlab-org/gitlab
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
iid	string	Project-level internal ID of the Deployment.

SELECT examples

get

Details of the deployment of the project. Generated from the GitLab GraphQL schema field Project.deployment (Deployment).

SELECT
id,
created_at,
finished_at,
iid,
pending_approval_count,
ref,
ref_path,
sha,
status,
tag,
updated_at,
web_path
FROM gitlab.projects.project_deployment
WHERE full_path = '{{ full_path }}' -- required
AND iid = '{{ iid }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;