1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. GitHubIntegration
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
dokploy logo Dokploy
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj

    Beta. Manages an existing Dokploy GitHub integration after setup and authorization in Dokploy; import-only.

    Create GitHubIntegration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GitHubIntegration(name: string, args: GitHubIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def GitHubIntegration(resource_name: str,
                          args: GitHubIntegrationArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def GitHubIntegration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          github_app_name: Optional[str] = None,
                          name: Optional[str] = None)
    func NewGitHubIntegration(ctx *Context, name string, args GitHubIntegrationArgs, opts ...ResourceOption) (*GitHubIntegration, error)
    public GitHubIntegration(string name, GitHubIntegrationArgs args, CustomResourceOptions? opts = null)
    public GitHubIntegration(String name, GitHubIntegrationArgs args)
    public GitHubIntegration(String name, GitHubIntegrationArgs args, CustomResourceOptions options)
    
    type: dokploy:GitHubIntegration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "dokploy_git_hub_integration" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GitHubIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GitHubIntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GitHubIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GitHubIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GitHubIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gitHubIntegrationResource = new Dokploy.GitHubIntegration("gitHubIntegrationResource", new()
    {
        GithubAppName = "string",
        Name = "string",
    });
    
    example, err := dokploy.NewGitHubIntegration(ctx, "gitHubIntegrationResource", &dokploy.GitHubIntegrationArgs{
    	GithubAppName: pulumi.String("string"),
    	Name:          pulumi.String("string"),
    })
    
    resource "dokploy_git_hub_integration" "gitHubIntegrationResource" {
      lifecycle {
        create_before_destroy = true
      }
      github_app_name = "string"
      name            = "string"
    }
    
    var gitHubIntegrationResource = new GitHubIntegration("gitHubIntegrationResource", GitHubIntegrationArgs.builder()
        .githubAppName("string")
        .name("string")
        .build());
    
    git_hub_integration_resource = dokploy.GitHubIntegration("gitHubIntegrationResource",
        github_app_name="string",
        name="string")
    
    const gitHubIntegrationResource = new dokploy.GitHubIntegration("gitHubIntegrationResource", {
        githubAppName: "string",
        name: "string",
    });
    
    type: dokploy:GitHubIntegration
    properties:
        githubAppName: string
        name: string
    

    GitHubIntegration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GitHubIntegration resource accepts the following input properties:

    GithubAppName string
    The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
    Name string
    The required Dokploy integration display name.
    GithubAppName string
    The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
    Name string
    The required Dokploy integration display name.
    github_app_name string
    The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
    name string
    The required Dokploy integration display name.
    githubAppName String
    The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
    name String
    The required Dokploy integration display name.
    githubAppName string
    The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
    name string
    The required Dokploy integration display name.
    github_app_name str
    The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
    name str
    The required Dokploy integration display name.
    githubAppName String
    The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
    name String
    The required Dokploy integration display name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GitHubIntegration resource produces the following output properties:

    GitProviderId string
    The stable Dokploy Git-provider parent ID.
    GithubId string
    The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The owning Dokploy organization ID.
    GitProviderId string
    The stable Dokploy Git-provider parent ID.
    GithubId string
    The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The owning Dokploy organization ID.
    git_provider_id string
    The stable Dokploy Git-provider parent ID.
    github_id string
    The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
    id string
    The provider-assigned unique ID for this managed resource.
    organization_id string
    The owning Dokploy organization ID.
    gitProviderId String
    The stable Dokploy Git-provider parent ID.
    githubId String
    The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The owning Dokploy organization ID.
    gitProviderId string
    The stable Dokploy Git-provider parent ID.
    githubId string
    The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
    id string
    The provider-assigned unique ID for this managed resource.
    organizationId string
    The owning Dokploy organization ID.
    git_provider_id str
    The stable Dokploy Git-provider parent ID.
    github_id str
    The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
    id str
    The provider-assigned unique ID for this managed resource.
    organization_id str
    The owning Dokploy organization ID.
    gitProviderId String
    The stable Dokploy Git-provider parent ID.
    githubId String
    The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The owning Dokploy organization ID.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.4.4
    published on Thursday, Nov 5, 2026 by dimeskigj

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial