1. Packages
  2. GitHub
  3. API Docs
  4. getIpRanges
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

github.getIpRanges

Explore with Pulumi AI

github logo
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

    Use this data source to retrieve information about GitHub’s IP addresses.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const test = github.getIpRanges({});
    
    import pulumi
    import pulumi_github as github
    
    test = github.get_ip_ranges()
    
    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.GetIpRanges(ctx, nil, 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 test = Github.GetIpRanges.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.GithubFunctions;
    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 test = GithubFunctions.getIpRanges();
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: github:getIpRanges
          Arguments: {}
    

    Using getIpRanges

    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 getIpRanges(opts?: InvokeOptions): Promise<GetIpRangesResult>
    function getIpRangesOutput(opts?: InvokeOptions): Output<GetIpRangesResult>
    def get_ip_ranges(opts: Optional[InvokeOptions] = None) -> GetIpRangesResult
    def get_ip_ranges_output(opts: Optional[InvokeOptions] = None) -> Output[GetIpRangesResult]
    func GetIpRanges(ctx *Context, opts ...InvokeOption) (*GetIpRangesResult, error)
    func GetIpRangesOutput(ctx *Context, opts ...InvokeOption) GetIpRangesResultOutput

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

    public static class GetIpRanges 
    {
        public static Task<GetIpRangesResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetIpRangesResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpRangesResult> getIpRanges(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: github:index/getIpRanges:getIpRanges
      arguments:
        # arguments dictionary

    getIpRanges Result

    The following output properties are available:

    Actions List<string>
    An array of IP addresses in CIDR format specifying the addresses that incoming requests from GitHub actions will originate from.
    ActionsIpv4s List<string>
    A subset of the actions array that contains IP addresses in IPv4 CIDR format.
    ActionsIpv6s List<string>
    A subset of the actions array that contains IP addresses in IPv6 CIDR format.
    ApiIpv4s List<string>
    A subset of the api array that contains IP addresses in IPv4 CIDR format.
    ApiIpv6s List<string>
    A subset of the api array that contains IP addresses in IPv6 CIDR format.
    Apis List<string>
    An Array of IP addresses in CIDR format for the GitHub API.
    DependabotIpv4s List<string>
    A subset of the dependabot array that contains IP addresses in IPv4 CIDR format.
    DependabotIpv6s List<string>
    A subset of the dependabot array that contains IP addresses in IPv6 CIDR format.
    Dependabots List<string>
    An array of IP addresses in CIDR format specifying the A records for dependabot.
    GitIpv4s List<string>
    A subset of the git array that contains IP addresses in IPv4 CIDR format.
    GitIpv6s List<string>
    A subset of the git array that contains IP addresses in IPv6 CIDR format.
    Gits List<string>
    An Array of IP addresses in CIDR format specifying the Git servers.
    Hooks List<string>
    An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.
    HooksIpv4s List<string>
    A subset of the hooks array that contains IP addresses in IPv4 CIDR format.
    HooksIpv6s List<string>
    A subset of the hooks array that contains IP addresses in IPv6 CIDR format.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImporterIpv4s List<string>
    A subset of the importer array that contains IP addresses in IPv4 CIDR format.
    ImporterIpv6s List<string>
    A subset of the importer array that contains IP addresses in IPv6 CIDR format.
    Importers List<string>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Importer.
    Packages List<string>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Packages.
    PackagesIpv4s List<string>
    A subset of the packages array that contains IP addresses in IPv4 CIDR format.
    PackagesIpv6s List<string>
    A subset of the packages array that contains IP addresses in IPv6 CIDR format.
    Pages List<string>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Pages.
    PagesIpv4s List<string>
    A subset of the pages array that contains IP addresses in IPv4 CIDR format.
    PagesIpv6s List<string>
    A subset of the pages array that contains IP addresses in IPv6 CIDR format.
    WebIpv4s List<string>
    A subset of the web array that contains IP addresses in IPv4 CIDR format.
    WebIpv6s List<string>
    A subset of the web array that contains IP addresses in IPv6 CIDR format.
    Webs List<string>
    An Array of IP addresses in CIDR format for GitHub Web.
    Actions []string
    An array of IP addresses in CIDR format specifying the addresses that incoming requests from GitHub actions will originate from.
    ActionsIpv4s []string
    A subset of the actions array that contains IP addresses in IPv4 CIDR format.
    ActionsIpv6s []string
    A subset of the actions array that contains IP addresses in IPv6 CIDR format.
    ApiIpv4s []string
    A subset of the api array that contains IP addresses in IPv4 CIDR format.
    ApiIpv6s []string
    A subset of the api array that contains IP addresses in IPv6 CIDR format.
    Apis []string
    An Array of IP addresses in CIDR format for the GitHub API.
    DependabotIpv4s []string
    A subset of the dependabot array that contains IP addresses in IPv4 CIDR format.
    DependabotIpv6s []string
    A subset of the dependabot array that contains IP addresses in IPv6 CIDR format.
    Dependabots []string
    An array of IP addresses in CIDR format specifying the A records for dependabot.
    GitIpv4s []string
    A subset of the git array that contains IP addresses in IPv4 CIDR format.
    GitIpv6s []string
    A subset of the git array that contains IP addresses in IPv6 CIDR format.
    Gits []string
    An Array of IP addresses in CIDR format specifying the Git servers.
    Hooks []string
    An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.
    HooksIpv4s []string
    A subset of the hooks array that contains IP addresses in IPv4 CIDR format.
    HooksIpv6s []string
    A subset of the hooks array that contains IP addresses in IPv6 CIDR format.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImporterIpv4s []string
    A subset of the importer array that contains IP addresses in IPv4 CIDR format.
    ImporterIpv6s []string
    A subset of the importer array that contains IP addresses in IPv6 CIDR format.
    Importers []string
    An Array of IP addresses in CIDR format specifying the A records for GitHub Importer.
    Packages []string
    An Array of IP addresses in CIDR format specifying the A records for GitHub Packages.
    PackagesIpv4s []string
    A subset of the packages array that contains IP addresses in IPv4 CIDR format.
    PackagesIpv6s []string
    A subset of the packages array that contains IP addresses in IPv6 CIDR format.
    Pages []string
    An Array of IP addresses in CIDR format specifying the A records for GitHub Pages.
    PagesIpv4s []string
    A subset of the pages array that contains IP addresses in IPv4 CIDR format.
    PagesIpv6s []string
    A subset of the pages array that contains IP addresses in IPv6 CIDR format.
    WebIpv4s []string
    A subset of the web array that contains IP addresses in IPv4 CIDR format.
    WebIpv6s []string
    A subset of the web array that contains IP addresses in IPv6 CIDR format.
    Webs []string
    An Array of IP addresses in CIDR format for GitHub Web.
    actions List<String>
    An array of IP addresses in CIDR format specifying the addresses that incoming requests from GitHub actions will originate from.
    actionsIpv4s List<String>
    A subset of the actions array that contains IP addresses in IPv4 CIDR format.
    actionsIpv6s List<String>
    A subset of the actions array that contains IP addresses in IPv6 CIDR format.
    apiIpv4s List<String>
    A subset of the api array that contains IP addresses in IPv4 CIDR format.
    apiIpv6s List<String>
    A subset of the api array that contains IP addresses in IPv6 CIDR format.
    apis List<String>
    An Array of IP addresses in CIDR format for the GitHub API.
    dependabotIpv4s List<String>
    A subset of the dependabot array that contains IP addresses in IPv4 CIDR format.
    dependabotIpv6s List<String>
    A subset of the dependabot array that contains IP addresses in IPv6 CIDR format.
    dependabots List<String>
    An array of IP addresses in CIDR format specifying the A records for dependabot.
    gitIpv4s List<String>
    A subset of the git array that contains IP addresses in IPv4 CIDR format.
    gitIpv6s List<String>
    A subset of the git array that contains IP addresses in IPv6 CIDR format.
    gits List<String>
    An Array of IP addresses in CIDR format specifying the Git servers.
    hooks List<String>
    An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.
    hooksIpv4s List<String>
    A subset of the hooks array that contains IP addresses in IPv4 CIDR format.
    hooksIpv6s List<String>
    A subset of the hooks array that contains IP addresses in IPv6 CIDR format.
    id String
    The provider-assigned unique ID for this managed resource.
    importerIpv4s List<String>
    A subset of the importer array that contains IP addresses in IPv4 CIDR format.
    importerIpv6s List<String>
    A subset of the importer array that contains IP addresses in IPv6 CIDR format.
    importers List<String>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Importer.
    packages List<String>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Packages.
    packagesIpv4s List<String>
    A subset of the packages array that contains IP addresses in IPv4 CIDR format.
    packagesIpv6s List<String>
    A subset of the packages array that contains IP addresses in IPv6 CIDR format.
    pages List<String>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Pages.
    pagesIpv4s List<String>
    A subset of the pages array that contains IP addresses in IPv4 CIDR format.
    pagesIpv6s List<String>
    A subset of the pages array that contains IP addresses in IPv6 CIDR format.
    webIpv4s List<String>
    A subset of the web array that contains IP addresses in IPv4 CIDR format.
    webIpv6s List<String>
    A subset of the web array that contains IP addresses in IPv6 CIDR format.
    webs List<String>
    An Array of IP addresses in CIDR format for GitHub Web.
    actions string[]
    An array of IP addresses in CIDR format specifying the addresses that incoming requests from GitHub actions will originate from.
    actionsIpv4s string[]
    A subset of the actions array that contains IP addresses in IPv4 CIDR format.
    actionsIpv6s string[]
    A subset of the actions array that contains IP addresses in IPv6 CIDR format.
    apiIpv4s string[]
    A subset of the api array that contains IP addresses in IPv4 CIDR format.
    apiIpv6s string[]
    A subset of the api array that contains IP addresses in IPv6 CIDR format.
    apis string[]
    An Array of IP addresses in CIDR format for the GitHub API.
    dependabotIpv4s string[]
    A subset of the dependabot array that contains IP addresses in IPv4 CIDR format.
    dependabotIpv6s string[]
    A subset of the dependabot array that contains IP addresses in IPv6 CIDR format.
    dependabots string[]
    An array of IP addresses in CIDR format specifying the A records for dependabot.
    gitIpv4s string[]
    A subset of the git array that contains IP addresses in IPv4 CIDR format.
    gitIpv6s string[]
    A subset of the git array that contains IP addresses in IPv6 CIDR format.
    gits string[]
    An Array of IP addresses in CIDR format specifying the Git servers.
    hooks string[]
    An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.
    hooksIpv4s string[]
    A subset of the hooks array that contains IP addresses in IPv4 CIDR format.
    hooksIpv6s string[]
    A subset of the hooks array that contains IP addresses in IPv6 CIDR format.
    id string
    The provider-assigned unique ID for this managed resource.
    importerIpv4s string[]
    A subset of the importer array that contains IP addresses in IPv4 CIDR format.
    importerIpv6s string[]
    A subset of the importer array that contains IP addresses in IPv6 CIDR format.
    importers string[]
    An Array of IP addresses in CIDR format specifying the A records for GitHub Importer.
    packages string[]
    An Array of IP addresses in CIDR format specifying the A records for GitHub Packages.
    packagesIpv4s string[]
    A subset of the packages array that contains IP addresses in IPv4 CIDR format.
    packagesIpv6s string[]
    A subset of the packages array that contains IP addresses in IPv6 CIDR format.
    pages string[]
    An Array of IP addresses in CIDR format specifying the A records for GitHub Pages.
    pagesIpv4s string[]
    A subset of the pages array that contains IP addresses in IPv4 CIDR format.
    pagesIpv6s string[]
    A subset of the pages array that contains IP addresses in IPv6 CIDR format.
    webIpv4s string[]
    A subset of the web array that contains IP addresses in IPv4 CIDR format.
    webIpv6s string[]
    A subset of the web array that contains IP addresses in IPv6 CIDR format.
    webs string[]
    An Array of IP addresses in CIDR format for GitHub Web.
    actions Sequence[str]
    An array of IP addresses in CIDR format specifying the addresses that incoming requests from GitHub actions will originate from.
    actions_ipv4s Sequence[str]
    A subset of the actions array that contains IP addresses in IPv4 CIDR format.
    actions_ipv6s Sequence[str]
    A subset of the actions array that contains IP addresses in IPv6 CIDR format.
    api_ipv4s Sequence[str]
    A subset of the api array that contains IP addresses in IPv4 CIDR format.
    api_ipv6s Sequence[str]
    A subset of the api array that contains IP addresses in IPv6 CIDR format.
    apis Sequence[str]
    An Array of IP addresses in CIDR format for the GitHub API.
    dependabot_ipv4s Sequence[str]
    A subset of the dependabot array that contains IP addresses in IPv4 CIDR format.
    dependabot_ipv6s Sequence[str]
    A subset of the dependabot array that contains IP addresses in IPv6 CIDR format.
    dependabots Sequence[str]
    An array of IP addresses in CIDR format specifying the A records for dependabot.
    git_ipv4s Sequence[str]
    A subset of the git array that contains IP addresses in IPv4 CIDR format.
    git_ipv6s Sequence[str]
    A subset of the git array that contains IP addresses in IPv6 CIDR format.
    gits Sequence[str]
    An Array of IP addresses in CIDR format specifying the Git servers.
    hooks Sequence[str]
    An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.
    hooks_ipv4s Sequence[str]
    A subset of the hooks array that contains IP addresses in IPv4 CIDR format.
    hooks_ipv6s Sequence[str]
    A subset of the hooks array that contains IP addresses in IPv6 CIDR format.
    id str
    The provider-assigned unique ID for this managed resource.
    importer_ipv4s Sequence[str]
    A subset of the importer array that contains IP addresses in IPv4 CIDR format.
    importer_ipv6s Sequence[str]
    A subset of the importer array that contains IP addresses in IPv6 CIDR format.
    importers Sequence[str]
    An Array of IP addresses in CIDR format specifying the A records for GitHub Importer.
    packages Sequence[str]
    An Array of IP addresses in CIDR format specifying the A records for GitHub Packages.
    packages_ipv4s Sequence[str]
    A subset of the packages array that contains IP addresses in IPv4 CIDR format.
    packages_ipv6s Sequence[str]
    A subset of the packages array that contains IP addresses in IPv6 CIDR format.
    pages Sequence[str]
    An Array of IP addresses in CIDR format specifying the A records for GitHub Pages.
    pages_ipv4s Sequence[str]
    A subset of the pages array that contains IP addresses in IPv4 CIDR format.
    pages_ipv6s Sequence[str]
    A subset of the pages array that contains IP addresses in IPv6 CIDR format.
    web_ipv4s Sequence[str]
    A subset of the web array that contains IP addresses in IPv4 CIDR format.
    web_ipv6s Sequence[str]
    A subset of the web array that contains IP addresses in IPv6 CIDR format.
    webs Sequence[str]
    An Array of IP addresses in CIDR format for GitHub Web.
    actions List<String>
    An array of IP addresses in CIDR format specifying the addresses that incoming requests from GitHub actions will originate from.
    actionsIpv4s List<String>
    A subset of the actions array that contains IP addresses in IPv4 CIDR format.
    actionsIpv6s List<String>
    A subset of the actions array that contains IP addresses in IPv6 CIDR format.
    apiIpv4s List<String>
    A subset of the api array that contains IP addresses in IPv4 CIDR format.
    apiIpv6s List<String>
    A subset of the api array that contains IP addresses in IPv6 CIDR format.
    apis List<String>
    An Array of IP addresses in CIDR format for the GitHub API.
    dependabotIpv4s List<String>
    A subset of the dependabot array that contains IP addresses in IPv4 CIDR format.
    dependabotIpv6s List<String>
    A subset of the dependabot array that contains IP addresses in IPv6 CIDR format.
    dependabots List<String>
    An array of IP addresses in CIDR format specifying the A records for dependabot.
    gitIpv4s List<String>
    A subset of the git array that contains IP addresses in IPv4 CIDR format.
    gitIpv6s List<String>
    A subset of the git array that contains IP addresses in IPv6 CIDR format.
    gits List<String>
    An Array of IP addresses in CIDR format specifying the Git servers.
    hooks List<String>
    An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.
    hooksIpv4s List<String>
    A subset of the hooks array that contains IP addresses in IPv4 CIDR format.
    hooksIpv6s List<String>
    A subset of the hooks array that contains IP addresses in IPv6 CIDR format.
    id String
    The provider-assigned unique ID for this managed resource.
    importerIpv4s List<String>
    A subset of the importer array that contains IP addresses in IPv4 CIDR format.
    importerIpv6s List<String>
    A subset of the importer array that contains IP addresses in IPv6 CIDR format.
    importers List<String>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Importer.
    packages List<String>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Packages.
    packagesIpv4s List<String>
    A subset of the packages array that contains IP addresses in IPv4 CIDR format.
    packagesIpv6s List<String>
    A subset of the packages array that contains IP addresses in IPv6 CIDR format.
    pages List<String>
    An Array of IP addresses in CIDR format specifying the A records for GitHub Pages.
    pagesIpv4s List<String>
    A subset of the pages array that contains IP addresses in IPv4 CIDR format.
    pagesIpv6s List<String>
    A subset of the pages array that contains IP addresses in IPv6 CIDR format.
    webIpv4s List<String>
    A subset of the web array that contains IP addresses in IPv4 CIDR format.
    webIpv6s List<String>
    A subset of the web array that contains IP addresses in IPv6 CIDR format.
    webs List<String>
    An Array of IP addresses in CIDR format for GitHub Web.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi