Viewing docs for DNSimple v5.1.2
published on Tuesday, May 12, 2026 by Pulumi
published on Tuesday, May 12, 2026 by Pulumi
DNSimple Provider: Installation & Configuration
I want to use the Pulumi DNSimple package (dnsimple) in my project.
## Provider details
- Package: dnsimple
- Version: v5.1.2
- Publisher: Pulumi
- Source: pulumi
- Repository: https://github.com/pulumi/pulumi-dnsimple
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/pulumi/dnsimple/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/dnsimple/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/dnsimple/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/dnsimple/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for DNSimple v5.1.2
published on Tuesday, May 12, 2026 by Pulumi
published on Tuesday, May 12, 2026 by Pulumi
Installation
The dnsimple provider is available as a package in all Pulumi languages:
- JavaScript/TypeScript:
@pulumi/dnsimple - Python:
pulumi-dnsimple - Go:
github.com/pulumi/pulumi-dnsimple/sdk/v4/go/dnsimple - .NET:
Pulumi.Dnsimple - Java:
com.pulumi/dnsimple
The DNSimple provider is used to interact with the resources supported by DNSimple. The provider needs to be configured with the proper credentials before it can be used.
Use the navigation to the left to read about the available resources.
Example Usage
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
dnsimple:account:
value: 'TODO: "${var.dnsimple_account}"'
dnsimple:token:
value: 'TODO: "${var.dnsimple_token}"'
import * as pulumi from "@pulumi/pulumi";
import * as dnsimple from "@pulumi/dnsimple";
// Create a record
const www = new dnsimple.ZoneRecord("www", {});
// Create an email forward
const hello = new dnsimple.EmailForward("hello", {});
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
dnsimple:account:
value: 'TODO: "${var.dnsimple_account}"'
dnsimple:token:
value: 'TODO: "${var.dnsimple_token}"'
import pulumi
import pulumi_dnsimple as dnsimple
# Create a record
www = dnsimple.ZoneRecord("www")
# Create an email forward
hello = dnsimple.EmailForward("hello")
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
dnsimple:account:
value: 'TODO: "${var.dnsimple_account}"'
dnsimple:token:
value: 'TODO: "${var.dnsimple_token}"'
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DNSimple = Pulumi.DNSimple;
return await Deployment.RunAsync(() =>
{
// Create a record
var www = new DNSimple.ZoneRecord("www");
// Create an email forward
var hello = new DNSimple.EmailForward("hello");
});
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
dnsimple:account:
value: 'TODO: "${var.dnsimple_account}"'
dnsimple:token:
value: 'TODO: "${var.dnsimple_token}"'
package main
import (
"github.com/pulumi/pulumi-dnsimple/sdk/v4/go/dnsimple"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Create a record
_, err := dnsimple.NewZoneRecord(ctx, "www", nil)
if err != nil {
return err
}
// Create an email forward
_, err = dnsimple.NewEmailForward(ctx, "hello", nil)
if err != nil {
return err
}
return nil
})
}
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
dnsimple:account:
value: 'TODO: "${var.dnsimple_account}"'
dnsimple:token:
value: 'TODO: "${var.dnsimple_token}"'
resources:
# Create a record
www:
type: dnsimple:ZoneRecord
# Create an email forward
hello:
type: dnsimple:EmailForward
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
dnsimple:account:
value: 'TODO: "${var.dnsimple_account}"'
dnsimple:token:
value: 'TODO: "${var.dnsimple_token}"'
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.ZoneRecord;
import com.pulumi.dnsimple.EmailForward;
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) {
// Create a record
var www = new ZoneRecord("www");
// Create an email forward
var hello = new EmailForward("hello");
}
}
Configuration Reference
The following configuration inputs are supported:
token- (Required) The DNSimple API v2 token. It must be provided, but it can also be sourced from theDNSIMPLE_TOKENenvironment variable. Please note that this must be an API v2 token. You can use either an User or Account token, but an Account token is recommended.account- (Required) The ID of the account associated with the token. It must be provided, but it can also be sourced from theDNSIMPLE_ACCOUNTenvironment variable.sandbox- Set to true to connect to the API sandbox environment.DNSIMPLE_SANDBOXenvironment variable can also be used.prefetch- Set to true to enable prefetchingZoneRecordswhen dealing with large configurations. This is useful when you are dealing with API rate limitations given your number of zones and zone records.DNSIMPLE_PREFETCHenvironment variable can also be used.userAgent- (Optional) Custom string to append to the user agent used for sending HTTP requests to the API.
Viewing docs for DNSimple v5.1.2
published on Tuesday, May 12, 2026 by Pulumi
published on Tuesday, May 12, 2026 by Pulumi