1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. GitLabIntegration
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. A Dokploy GitLab OAuth integration. Configure OAuth manually in GitLab and Dokploy; readiness does not verify connectivity or authorization.

    Create GitLabIntegration Resource

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

    Constructor syntax

    new GitLabIntegration(name: string, args: GitLabIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def GitLabIntegration(resource_name: str,
                          args: GitLabIntegrationArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def GitLabIntegration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          application_id: Optional[str] = None,
                          application_secret: Optional[str] = None,
                          name: Optional[str] = None,
                          redirect_uri: Optional[str] = None,
                          gitlab_internal_url: Optional[str] = None,
                          gitlab_url: Optional[str] = None,
                          group_name: Optional[str] = None)
    func NewGitLabIntegration(ctx *Context, name string, args GitLabIntegrationArgs, opts ...ResourceOption) (*GitLabIntegration, error)
    public GitLabIntegration(string name, GitLabIntegrationArgs args, CustomResourceOptions? opts = null)
    public GitLabIntegration(String name, GitLabIntegrationArgs args)
    public GitLabIntegration(String name, GitLabIntegrationArgs args, CustomResourceOptions options)
    
    type: dokploy:GitLabIntegration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "dokploy_git_lab_integration" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GitLabIntegrationArgs
    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 GitLabIntegrationArgs
    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 GitLabIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GitLabIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GitLabIntegrationArgs
    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 gitLabIntegrationResource = new Dokploy.GitLabIntegration("gitLabIntegrationResource", new()
    {
        ApplicationId = "string",
        ApplicationSecret = "string",
        Name = "string",
        RedirectUri = "string",
        GitlabInternalUrl = "string",
        GitlabUrl = "string",
        GroupName = "string",
    });
    
    example, err := dokploy.NewGitLabIntegration(ctx, "gitLabIntegrationResource", &dokploy.GitLabIntegrationArgs{
    	ApplicationId:     pulumi.String("string"),
    	ApplicationSecret: pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	RedirectUri:       pulumi.String("string"),
    	GitlabInternalUrl: pulumi.String("string"),
    	GitlabUrl:         pulumi.String("string"),
    	GroupName:         pulumi.String("string"),
    })
    
    resource "dokploy_git_lab_integration" "gitLabIntegrationResource" {
      lifecycle {
        create_before_destroy = true
      }
      application_id      = "string"
      application_secret  = "string"
      name                = "string"
      redirect_uri        = "string"
      gitlab_internal_url = "string"
      gitlab_url          = "string"
      group_name          = "string"
    }
    
    var gitLabIntegrationResource = new GitLabIntegration("gitLabIntegrationResource", GitLabIntegrationArgs.builder()
        .applicationId("string")
        .applicationSecret("string")
        .name("string")
        .redirectUri("string")
        .gitlabInternalUrl("string")
        .gitlabUrl("string")
        .groupName("string")
        .build());
    
    git_lab_integration_resource = dokploy.GitLabIntegration("gitLabIntegrationResource",
        application_id="string",
        application_secret="string",
        name="string",
        redirect_uri="string",
        gitlab_internal_url="string",
        gitlab_url="string",
        group_name="string")
    
    const gitLabIntegrationResource = new dokploy.GitLabIntegration("gitLabIntegrationResource", {
        applicationId: "string",
        applicationSecret: "string",
        name: "string",
        redirectUri: "string",
        gitlabInternalUrl: "string",
        gitlabUrl: "string",
        groupName: "string",
    });
    
    type: dokploy:GitLabIntegration
    properties:
        applicationId: string
        applicationSecret: string
        gitlabInternalUrl: string
        gitlabUrl: string
        groupName: string
        name: string
        redirectUri: string
    

    GitLabIntegration 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 GitLabIntegration resource accepts the following input properties:

    ApplicationId string
    The GitLab OAuth application ID.
    ApplicationSecret string
    The GitLab OAuth application secret.
    Name string
    The integration name.
    RedirectUri string
    The OAuth callback URI configured for the application.
    GitlabInternalUrl string
    An optional internal GitLab URL override, which may include basic-auth credentials.
    GitlabUrl string
    The public GitLab base URL; defaults to https://gitlab.com.
    GroupName string
    The optional GitLab group name; defaults to an empty string.
    ApplicationId string
    The GitLab OAuth application ID.
    ApplicationSecret string
    The GitLab OAuth application secret.
    Name string
    The integration name.
    RedirectUri string
    The OAuth callback URI configured for the application.
    GitlabInternalUrl string
    An optional internal GitLab URL override, which may include basic-auth credentials.
    GitlabUrl string
    The public GitLab base URL; defaults to https://gitlab.com.
    GroupName string
    The optional GitLab group name; defaults to an empty string.
    application_id string
    The GitLab OAuth application ID.
    application_secret string
    The GitLab OAuth application secret.
    name string
    The integration name.
    redirect_uri string
    The OAuth callback URI configured for the application.
    gitlab_internal_url string
    An optional internal GitLab URL override, which may include basic-auth credentials.
    gitlab_url string
    The public GitLab base URL; defaults to https://gitlab.com.
    group_name string
    The optional GitLab group name; defaults to an empty string.
    applicationId String
    The GitLab OAuth application ID.
    applicationSecret String
    The GitLab OAuth application secret.
    name String
    The integration name.
    redirectUri String
    The OAuth callback URI configured for the application.
    gitlabInternalUrl String
    An optional internal GitLab URL override, which may include basic-auth credentials.
    gitlabUrl String
    The public GitLab base URL; defaults to https://gitlab.com.
    groupName String
    The optional GitLab group name; defaults to an empty string.
    applicationId string
    The GitLab OAuth application ID.
    applicationSecret string
    The GitLab OAuth application secret.
    name string
    The integration name.
    redirectUri string
    The OAuth callback URI configured for the application.
    gitlabInternalUrl string
    An optional internal GitLab URL override, which may include basic-auth credentials.
    gitlabUrl string
    The public GitLab base URL; defaults to https://gitlab.com.
    groupName string
    The optional GitLab group name; defaults to an empty string.
    application_id str
    The GitLab OAuth application ID.
    application_secret str
    The GitLab OAuth application secret.
    name str
    The integration name.
    redirect_uri str
    The OAuth callback URI configured for the application.
    gitlab_internal_url str
    An optional internal GitLab URL override, which may include basic-auth credentials.
    gitlab_url str
    The public GitLab base URL; defaults to https://gitlab.com.
    group_name str
    The optional GitLab group name; defaults to an empty string.
    applicationId String
    The GitLab OAuth application ID.
    applicationSecret String
    The GitLab OAuth application secret.
    name String
    The integration name.
    redirectUri String
    The OAuth callback URI configured for the application.
    gitlabInternalUrl String
    An optional internal GitLab URL override, which may include basic-auth credentials.
    gitlabUrl String
    The public GitLab base URL; defaults to https://gitlab.com.
    groupName String
    The optional GitLab group name; defaults to an empty string.

    Outputs

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

    GitProviderId string
    The Dokploy Git provider ID associated with this integration.
    GitlabId string
    The stable GitLab integration ID used as the Pulumi resource identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsConfigured bool
    Whether access and refresh tokens are present; this does not indicate connectivity or authorization validity.
    OrganizationId string
    The Dokploy organization ID associated with this integration.
    GitProviderId string
    The Dokploy Git provider ID associated with this integration.
    GitlabId string
    The stable GitLab integration ID used as the Pulumi resource identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsConfigured bool
    Whether access and refresh tokens are present; this does not indicate connectivity or authorization validity.
    OrganizationId string
    The Dokploy organization ID associated with this integration.
    git_provider_id string
    The Dokploy Git provider ID associated with this integration.
    gitlab_id string
    The stable GitLab integration ID used as the Pulumi resource identity.
    id string
    The provider-assigned unique ID for this managed resource.
    is_configured bool
    Whether access and refresh tokens are present; this does not indicate connectivity or authorization validity.
    organization_id string
    The Dokploy organization ID associated with this integration.
    gitProviderId String
    The Dokploy Git provider ID associated with this integration.
    gitlabId String
    The stable GitLab integration ID used as the Pulumi resource identity.
    id String
    The provider-assigned unique ID for this managed resource.
    isConfigured Boolean
    Whether access and refresh tokens are present; this does not indicate connectivity or authorization validity.
    organizationId String
    The Dokploy organization ID associated with this integration.
    gitProviderId string
    The Dokploy Git provider ID associated with this integration.
    gitlabId string
    The stable GitLab integration ID used as the Pulumi resource identity.
    id string
    The provider-assigned unique ID for this managed resource.
    isConfigured boolean
    Whether access and refresh tokens are present; this does not indicate connectivity or authorization validity.
    organizationId string
    The Dokploy organization ID associated with this integration.
    git_provider_id str
    The Dokploy Git provider ID associated with this integration.
    gitlab_id str
    The stable GitLab integration ID used as the Pulumi resource identity.
    id str
    The provider-assigned unique ID for this managed resource.
    is_configured bool
    Whether access and refresh tokens are present; this does not indicate connectivity or authorization validity.
    organization_id str
    The Dokploy organization ID associated with this integration.
    gitProviderId String
    The Dokploy Git provider ID associated with this integration.
    gitlabId String
    The stable GitLab integration ID used as the Pulumi resource identity.
    id String
    The provider-assigned unique ID for this managed resource.
    isConfigured Boolean
    Whether access and refresh tokens are present; this does not indicate connectivity or authorization validity.
    organizationId String
    The Dokploy organization ID associated with this integration.

    Look up Existing GitLabIntegration Resource

    Get an existing GitLabIntegration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): GitLabIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> GitLabIntegration
    func GetGitLabIntegration(ctx *Context, name string, id IDInput, state *GitLabIntegrationState, opts ...ResourceOption) (*GitLabIntegration, error)
    public static GitLabIntegration Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static GitLabIntegration get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingGitLabIntegration:    type: dokploy:GitLabIntegration    get:      id: ${id}
    import {
      to = dokploy_git_lab_integration.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state GitLabIntegrationState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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