getRestApi

Use this data source to retrieve information about a GitHub resource through REST API.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = github.getRestApi({
endpoint: "repos/example_repo/git/refs/heads/main",
});
import pulumi
import pulumi_github as github
example = github.get_rest_api(endpoint="repos/example_repo/git/refs/heads/main")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = Github.GetRestApi.Invoke(new()
{
Endpoint = "repos/example_repo/git/refs/heads/main",
});
});
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.GetRestApi(ctx, &github.GetRestApiArgs{
Endpoint: "repos/example_repo/git/refs/heads/main",
}, nil)
if err != nil {
return err
}
return nil
})
}
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.GetRestApiArgs;
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.getRestApi(GetRestApiArgs.builder()
.endpoint("repos/example_repo/git/refs/heads/main")
.build());
}
}
variables:
example:
fn::invoke:
function: github:getRestApi
arguments:
endpoint: repos/example_repo/git/refs/heads/main

Return

A collection of values returned by getRestApi.

Parameters

argument

A collection of arguments for invoking getRestApi.


suspend fun getRestApi(endpoint: String): GetRestApiResult

Return

A collection of values returned by getRestApi.

Parameters

endpoint

REST API endpoint to send the GET request to.

See also


suspend fun getRestApi(argument: suspend GetRestApiPlainArgsBuilder.() -> Unit): GetRestApiResult

Return

A collection of values returned by getRestApi.

Parameters

argument

Builder for com.pulumi.github.kotlin.inputs.GetRestApiPlainArgs.

See also