Viewing docs for GitHub v6.12.1
published on Thursday, Feb 12, 2026 by Pulumi
published on Thursday, Feb 12, 2026 by Pulumi
Viewing docs for GitHub v6.12.1
published on Thursday, Feb 12, 2026 by Pulumi
published on Thursday, Feb 12, 2026 by Pulumi
Use this data source to retrieve information about a GitHub Codespaces public key. This data source is required to be used with other GitHub secrets interactions.
Note that the provider token must have admin rights to a repository to retrieve it’s Codespaces public key.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = github.getCodespacesPublicKey({
repository: "example_repo",
});
import pulumi
import pulumi_github as github
example = github.get_codespaces_public_key(repository="example_repo")
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := github.GetCodespacesPublicKey(ctx, &github.GetCodespacesPublicKeyArgs{
Repository: "example_repo",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = Github.GetCodespacesPublicKey.Invoke(new()
{
Repository = "example_repo",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.inputs.GetCodespacesPublicKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = GithubFunctions.getCodespacesPublicKey(GetCodespacesPublicKeyArgs.builder()
.repository("example_repo")
.build());
}
}
variables:
example:
fn::invoke:
function: github:getCodespacesPublicKey
arguments:
repository: example_repo
Using getCodespacesPublicKey
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 getCodespacesPublicKey(args: GetCodespacesPublicKeyArgs, opts?: InvokeOptions): Promise<GetCodespacesPublicKeyResult>
function getCodespacesPublicKeyOutput(args: GetCodespacesPublicKeyOutputArgs, opts?: InvokeOptions): Output<GetCodespacesPublicKeyResult>def get_codespaces_public_key(repository: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCodespacesPublicKeyResult
def get_codespaces_public_key_output(repository: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCodespacesPublicKeyResult]func GetCodespacesPublicKey(ctx *Context, args *GetCodespacesPublicKeyArgs, opts ...InvokeOption) (*GetCodespacesPublicKeyResult, error)
func GetCodespacesPublicKeyOutput(ctx *Context, args *GetCodespacesPublicKeyOutputArgs, opts ...InvokeOption) GetCodespacesPublicKeyResultOutput> Note: This function is named GetCodespacesPublicKey in the Go SDK.
public static class GetCodespacesPublicKey
{
public static Task<GetCodespacesPublicKeyResult> InvokeAsync(GetCodespacesPublicKeyArgs args, InvokeOptions? opts = null)
public static Output<GetCodespacesPublicKeyResult> Invoke(GetCodespacesPublicKeyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCodespacesPublicKeyResult> getCodespacesPublicKey(GetCodespacesPublicKeyArgs args, InvokeOptions options)
public static Output<GetCodespacesPublicKeyResult> getCodespacesPublicKey(GetCodespacesPublicKeyArgs args, InvokeOptions options)
fn::invoke:
function: github:index/getCodespacesPublicKey:getCodespacesPublicKey
arguments:
# arguments dictionaryThe following arguments are supported:
- Repository string
- Name of the repository to get public key from.
- Repository string
- Name of the repository to get public key from.
- repository String
- Name of the repository to get public key from.
- repository string
- Name of the repository to get public key from.
- repository str
- Name of the repository to get public key from.
- repository String
- Name of the repository to get public key from.
getCodespacesPublicKey Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- Actual key retrieved.
- Key
Id string - ID of the key that has been retrieved.
- Repository string
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- Actual key retrieved.
- Key
Id string - ID of the key that has been retrieved.
- Repository string
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- Actual key retrieved.
- key
Id String - ID of the key that has been retrieved.
- repository String
- id string
- The provider-assigned unique ID for this managed resource.
- key string
- Actual key retrieved.
- key
Id string - ID of the key that has been retrieved.
- repository string
- id str
- The provider-assigned unique ID for this managed resource.
- key str
- Actual key retrieved.
- key_
id str - ID of the key that has been retrieved.
- repository str
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- Actual key retrieved.
- key
Id String - ID of the key that has been retrieved.
- repository String
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
githubTerraform Provider.
Viewing docs for GitHub v6.12.1
published on Thursday, Feb 12, 2026 by Pulumi
published on Thursday, Feb 12, 2026 by Pulumi
