1. Packages
  2. Gitlab Provider
  3. API Docs
  4. getInstanceDeployKeys
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

gitlab.getInstanceDeployKeys

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

The gitlab.getInstanceDeployKeys data source allows to retrieve a list of deploy keys for a GitLab instance.

This data source requires administration privileges.

Upstream API: GitLab REST API docs

Using getInstanceDeployKeys

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstanceDeployKeys(args: GetInstanceDeployKeysArgs, opts?: InvokeOptions): Promise<GetInstanceDeployKeysResult>
function getInstanceDeployKeysOutput(args: GetInstanceDeployKeysOutputArgs, opts?: InvokeOptions): Output<GetInstanceDeployKeysResult>
Copy
def get_instance_deploy_keys(public: Optional[bool] = None,
                             opts: Optional[InvokeOptions] = None) -> GetInstanceDeployKeysResult
def get_instance_deploy_keys_output(public: Optional[pulumi.Input[bool]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetInstanceDeployKeysResult]
Copy
func GetInstanceDeployKeys(ctx *Context, args *GetInstanceDeployKeysArgs, opts ...InvokeOption) (*GetInstanceDeployKeysResult, error)
func GetInstanceDeployKeysOutput(ctx *Context, args *GetInstanceDeployKeysOutputArgs, opts ...InvokeOption) GetInstanceDeployKeysResultOutput
Copy

> Note: This function is named GetInstanceDeployKeys in the Go SDK.

public static class GetInstanceDeployKeys 
{
    public static Task<GetInstanceDeployKeysResult> InvokeAsync(GetInstanceDeployKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceDeployKeysResult> Invoke(GetInstanceDeployKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetInstanceDeployKeysResult> getInstanceDeployKeys(GetInstanceDeployKeysArgs args, InvokeOptions options)
public static Output<GetInstanceDeployKeysResult> getInstanceDeployKeys(GetInstanceDeployKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gitlab:index/getInstanceDeployKeys:getInstanceDeployKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Public bool
Only return deploy keys that are public.
Public bool
Only return deploy keys that are public.
public_ Boolean
Only return deploy keys that are public.
public boolean
Only return deploy keys that are public.
public bool
Only return deploy keys that are public.
public Boolean
Only return deploy keys that are public.

getInstanceDeployKeys Result

The following output properties are available:

DeployKeys List<Pulumi.GitLab.Outputs.GetInstanceDeployKeysDeployKey>
The list of all deploy keys across all projects of the GitLab instance.
Id string
The provider-assigned unique ID for this managed resource.
Public bool
Only return deploy keys that are public.
DeployKeys []GetInstanceDeployKeysDeployKey
The list of all deploy keys across all projects of the GitLab instance.
Id string
The provider-assigned unique ID for this managed resource.
Public bool
Only return deploy keys that are public.
deployKeys List<GetInstanceDeployKeysDeployKey>
The list of all deploy keys across all projects of the GitLab instance.
id String
The provider-assigned unique ID for this managed resource.
public_ Boolean
Only return deploy keys that are public.
deployKeys GetInstanceDeployKeysDeployKey[]
The list of all deploy keys across all projects of the GitLab instance.
id string
The provider-assigned unique ID for this managed resource.
public boolean
Only return deploy keys that are public.
deploy_keys Sequence[GetInstanceDeployKeysDeployKey]
The list of all deploy keys across all projects of the GitLab instance.
id str
The provider-assigned unique ID for this managed resource.
public bool
Only return deploy keys that are public.
deployKeys List<Property Map>
The list of all deploy keys across all projects of the GitLab instance.
id String
The provider-assigned unique ID for this managed resource.
public Boolean
Only return deploy keys that are public.

Supporting Types

GetInstanceDeployKeysDeployKey

CreatedAt This property is required. string
The creation date of the deploy key. In RFC3339 format.
Fingerprint This property is required. string
The fingerprint of the deploy key.
Id This property is required. int
The ID of the deploy key.
Key This property is required. string
The deploy key.
ProjectsWithWriteAccesses This property is required. List<Pulumi.GitLab.Inputs.GetInstanceDeployKeysDeployKeyProjectsWithWriteAccess>
The list of projects that the deploy key has write access to.
Title This property is required. string
The title of the deploy key.
CreatedAt This property is required. string
The creation date of the deploy key. In RFC3339 format.
Fingerprint This property is required. string
The fingerprint of the deploy key.
Id This property is required. int
The ID of the deploy key.
Key This property is required. string
The deploy key.
ProjectsWithWriteAccesses This property is required. []GetInstanceDeployKeysDeployKeyProjectsWithWriteAccess
The list of projects that the deploy key has write access to.
Title This property is required. string
The title of the deploy key.
createdAt This property is required. String
The creation date of the deploy key. In RFC3339 format.
fingerprint This property is required. String
The fingerprint of the deploy key.
id This property is required. Integer
The ID of the deploy key.
key This property is required. String
The deploy key.
projectsWithWriteAccesses This property is required. List<GetInstanceDeployKeysDeployKeyProjectsWithWriteAccess>
The list of projects that the deploy key has write access to.
title This property is required. String
The title of the deploy key.
createdAt This property is required. string
The creation date of the deploy key. In RFC3339 format.
fingerprint This property is required. string
The fingerprint of the deploy key.
id This property is required. number
The ID of the deploy key.
key This property is required. string
The deploy key.
projectsWithWriteAccesses This property is required. GetInstanceDeployKeysDeployKeyProjectsWithWriteAccess[]
The list of projects that the deploy key has write access to.
title This property is required. string
The title of the deploy key.
created_at This property is required. str
The creation date of the deploy key. In RFC3339 format.
fingerprint This property is required. str
The fingerprint of the deploy key.
id This property is required. int
The ID of the deploy key.
key This property is required. str
The deploy key.
projects_with_write_accesses This property is required. Sequence[GetInstanceDeployKeysDeployKeyProjectsWithWriteAccess]
The list of projects that the deploy key has write access to.
title This property is required. str
The title of the deploy key.
createdAt This property is required. String
The creation date of the deploy key. In RFC3339 format.
fingerprint This property is required. String
The fingerprint of the deploy key.
id This property is required. Number
The ID of the deploy key.
key This property is required. String
The deploy key.
projectsWithWriteAccesses This property is required. List<Property Map>
The list of projects that the deploy key has write access to.
title This property is required. String
The title of the deploy key.

GetInstanceDeployKeysDeployKeyProjectsWithWriteAccess

CreatedAt This property is required. string
The creation date of the project. In RFC3339 format.
Description This property is required. string
The description of the project.
Id This property is required. int
The ID of the project.
Name This property is required. string
The name of the project.
NameWithNamespace This property is required. string
The name of the project with namespace.
Path This property is required. string
The path of the project.
PathWithNamespace This property is required. string
The path of the project with namespace.
CreatedAt This property is required. string
The creation date of the project. In RFC3339 format.
Description This property is required. string
The description of the project.
Id This property is required. int
The ID of the project.
Name This property is required. string
The name of the project.
NameWithNamespace This property is required. string
The name of the project with namespace.
Path This property is required. string
The path of the project.
PathWithNamespace This property is required. string
The path of the project with namespace.
createdAt This property is required. String
The creation date of the project. In RFC3339 format.
description This property is required. String
The description of the project.
id This property is required. Integer
The ID of the project.
name This property is required. String
The name of the project.
nameWithNamespace This property is required. String
The name of the project with namespace.
path This property is required. String
The path of the project.
pathWithNamespace This property is required. String
The path of the project with namespace.
createdAt This property is required. string
The creation date of the project. In RFC3339 format.
description This property is required. string
The description of the project.
id This property is required. number
The ID of the project.
name This property is required. string
The name of the project.
nameWithNamespace This property is required. string
The name of the project with namespace.
path This property is required. string
The path of the project.
pathWithNamespace This property is required. string
The path of the project with namespace.
created_at This property is required. str
The creation date of the project. In RFC3339 format.
description This property is required. str
The description of the project.
id This property is required. int
The ID of the project.
name This property is required. str
The name of the project.
name_with_namespace This property is required. str
The name of the project with namespace.
path This property is required. str
The path of the project.
path_with_namespace This property is required. str
The path of the project with namespace.
createdAt This property is required. String
The creation date of the project. In RFC3339 format.
description This property is required. String
The description of the project.
id This property is required. Number
The ID of the project.
name This property is required. String
The name of the project.
nameWithNamespace This property is required. String
The name of the project with namespace.
path This property is required. String
The path of the project.
pathWithNamespace This property is required. String
The path of the project with namespace.

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi