project_pages_deployments

Gets or lists a project_pages_deployments resource.

Overview

Name	project_pages_deployments
Type	Resource
Id	gitlab.projects.project_pages_deployments

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the Pages Deployment.
ci_build_id	string	ID of the CI build that created the deployment.
active	boolean	Whether the deployment is currently active.
created_at	string	Time the deployment was created.
deleted_at	string	Time the deployment was deleted.
expires_at	string	Time the deployment will expire.
file_count	integer	Number of files that were published with the deployment.
path_prefix	string	URL path Prefix that points to the deployment.
project	object	Project identity (id, full_path, name)
root_directory	string	Path within the build assets that functions as the root directory for Pages sites.
size	integer	Size of the storage used.
updated_at	string	Time the deployment was last updated.
url	string	Publicly accessible URL of the deployment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	active, sort, versioned	List of the project's Pages Deployments. Generated from the GitLab GraphQL schema field Project.pagesDeployments (connection of PagesDeployment nodes).

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)
active	boolean	Filter by active or inactive state.
sort	string	Sort results.
versioned	boolean	Filter deployments that are versioned or unversioned.

SELECT examples

list

List of the project's Pages Deployments. Generated from the GitLab GraphQL schema field Project.pagesDeployments (connection of PagesDeployment nodes).

SELECT
id,
ci_build_id,
active,
created_at,
deleted_at,
expires_at,
file_count,
path_prefix,
project,
root_directory,
size,
updated_at,
url
FROM gitlab.projects.project_pages_deployments
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND active = '{{ active }}'
AND sort = '{{ sort }}'
AND versioned = '{{ versioned }}'
;