Skip to main content

Using the nullplatform IaC provider

The nullplatform IaC provider lets you manage your nullplatform resources using infrastructure-as-code (IaC) tools, simplifying how you automate and manage infrastructure.

info

This guide applies to IaC tools such as Terraform and OpenTofu.

Installation​

  1. To use the provider, add the following to your IaC configuration:

    terraform {
      required_providers {
        nullplatform = {
          source  = "nullplatform/nullplatform"
          version = "x.y.z"   // Replace with a specific version or omit to use the latest
        }
      }
    }

  2. Run the following command to install the provider:

    tofu init

  3. Run the following command to check the provider is correctly installed.

    tofu providers | grep nullplatform

    If installed correctly, you should see an output similar to:

    ├── provider[registry.nullplatform.io/nullplatform/nullplatform]

Authentication​

To authenticate, configure the provider with an API key. You can set the API key either as a variable or by using the NULLPLATFORM_API_KEY environment variable.

provider "nullplatform" {
  api_key = var.nullplatform_api_key
}

See our API keys docs for more info.

Next steps​

Refer to our IaC provider plugin for additional documentation, including resource details and configuration examples.