Skip to main content

project_available_deploy_keys

Gets or lists a project_available_deploy_keys resource.

Overview​

Nameproject_available_deploy_keys
TypeResource
Idgitlab.projects.project_available_deploy_keys

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringID of the deploy key.
expires_atstringExpiration date of the deploy key.
titlestringTitle of the deploy key.
userobjectAccessLevelUser identity (id, username, name)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectfull_path, hosttitle_queryList of available deploy keys Generated from the GitLab GraphQL schema field Project.availableDeployKeys (connection of AccessLevelDeployKey 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.

NameDatatypeDescription
full_pathstringFull path of the project, for example gitlab-org/gitlab
hoststringGitLab 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)
title_querystringTerm by which to search deploy key titles.

SELECT examples​

List of available deploy keys Generated from the GitLab GraphQL schema field Project.availableDeployKeys (connection of AccessLevelDeployKey nodes).

SELECT
id,
expires_at,
title,
user
FROM gitlab.projects.project_available_deploy_keys
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND title_query = '{{ title_query }}'
;