project_available_deploy_keys
Gets or lists a project_available_deploy_keys resource.
Overview​
| Name | project_available_deploy_keys |
| Type | Resource |
| Id | gitlab.projects.project_available_deploy_keys |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the deploy key. |
expires_at | string | Expiration date of the deploy key. |
title | string | Title of the deploy key. |
user | object | AccessLevelUser identity (id, username, name) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | full_path, host | title_query | List 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.
| 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) |
title_query | string | Term by which to search deploy key titles. |
SELECT examples​
- list
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 }}'
;