Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. SSHKey
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

dokploy.SSHKey

dokploy logo Dokploy
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

    A Dokploy SSH key for Git and registry access.

    Create SSHKey Resource

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

    Constructor syntax

    new SSHKey(name: string, args: SSHKeyArgs, opts?: CustomResourceOptions);
    @overload
def SSHKey(resource_name: str,
           args: SSHKeyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def SSHKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           name: Optional[str] = None,
           private_key: Optional[str] = None,
           public_key: Optional[str] = None,
           description: Optional[str] = None)
    func NewSSHKey(ctx *Context, name string, args SSHKeyArgs, opts ...ResourceOption) (*SSHKey, error)
    public SSHKey(string name, SSHKeyArgs args, CustomResourceOptions? opts = null)
    public SSHKey(String name, SSHKeyArgs args)
public SSHKey(String name, SSHKeyArgs args, CustomResourceOptions options)

    type: dokploy:SSHKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "dokploy_s_s_h_key" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SSHKeyArgs
    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 SSHKeyArgs
    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 SSHKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SSHKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SSHKeyArgs
    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 sshkeyResource = new Dokploy.SSHKey("sshkeyResource", new()
{
    Name = "string",
    PrivateKey = "string",
    PublicKey = "string",
    Description = "string",
});

    example, err := dokploy.NewSSHKey(ctx, "sshkeyResource", &dokploy.SSHKeyArgs{
	Name:        pulumi.String("string"),
	PrivateKey:  pulumi.String("string"),
	PublicKey:   pulumi.String("string"),
	Description: pulumi.String("string"),
})

    resource "dokploy_s_s_h_key" "sshkeyResource" {
  pulumi {
    replace_on_changes = [private_key, public_key]
  }
  lifecycle {
    create_before_destroy = true
  }
  name        = "string"
  private_key = "string"
  public_key  = "string"
  description = "string"
}

    var sshkeyResource = new SSHKey("sshkeyResource", SSHKeyArgs.builder()
    .name("string")
    .privateKey("string")
    .publicKey("string")
    .description("string")
    .build());

    sshkey_resource = dokploy.SSHKey("sshkeyResource",
    name="string",
    private_key="string",
    public_key="string",
    description="string")

    const sshkeyResource = new dokploy.SSHKey("sshkeyResource", {
    name: "string",
    privateKey: "string",
    publicKey: "string",
    description: "string",
});

    type: dokploy:SSHKey
properties:
    description: string
    name: string
    privateKey: string
    publicKey: string

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

    Name string
    The SSH key name.
    PrivateKey string
    The private SSH key material.
    PublicKey string
    The public SSH key material.
    Description string
    The optional SSH key description.
    Name string
    The SSH key name.
    PrivateKey string
    The private SSH key material.
    PublicKey string
    The public SSH key material.
    Description string
    The optional SSH key description.
    name string
    The SSH key name.
    private_key string
    The private SSH key material.
    public_key string
    The public SSH key material.
    description string
    The optional SSH key description.
    name String
    The SSH key name.
    privateKey String
    The private SSH key material.
    publicKey String
    The public SSH key material.
    description String
    The optional SSH key description.
    name string
    The SSH key name.
    privateKey string
    The private SSH key material.
    publicKey string
    The public SSH key material.
    description string
    The optional SSH key description.
    name str
    The SSH key name.
    private_key str
    The private SSH key material.
    public_key str
    The public SSH key material.
    description str
    The optional SSH key description.
    name String
    The SSH key name.
    privateKey String
    The private SSH key material.
    publicKey String
    The public SSH key material.
    description String
    The optional SSH key description.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The Dokploy organization ID owning this SSH key.
    SshKeyId string
    The stable Dokploy SSH key ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The Dokploy organization ID owning this SSH key.
    SshKeyId string
    The stable Dokploy SSH key ID.
    id string
    The provider-assigned unique ID for this managed resource.
    organization_id string
    The Dokploy organization ID owning this SSH key.
    ssh_key_id string
    The stable Dokploy SSH key ID.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The Dokploy organization ID owning this SSH key.
    sshKeyId String
    The stable Dokploy SSH key ID.
    id string
    The provider-assigned unique ID for this managed resource.
    organizationId string
    The Dokploy organization ID owning this SSH key.
    sshKeyId string
    The stable Dokploy SSH key ID.
    id str
    The provider-assigned unique ID for this managed resource.
    organization_id str
    The Dokploy organization ID owning this SSH key.
    ssh_key_id str
    The stable Dokploy SSH key ID.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The Dokploy organization ID owning this SSH key.
    sshKeyId String
    The stable Dokploy SSH key ID.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.3.1
    published on Tuesday, Sep 29, 2026 by dimeskigj
    Schema (JSON)
    dimeskigj/pulumi-dokploy

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial