terraform/website/source/docs/providers/ns1/index.html.markdown

37 lines
811 B
Markdown

---
layout: "ns1"
page_title: "Provider: NS1"
sidebar_current: "docs-ns1-index"
description: |-
The [NS1](https://ns1.com/) provider is used to interact with the resources supported by NS1.
---
# NS1 Provider
The NS1 provider exposes resources to interact with the NS1 REST API. 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
```hcl
# Configure the NS1 provider
provider "ns1" {
apikey = "${var.ns1_apikey}"
}
# Create a new zone
resource "ns1_zone" "foobar" {
# ...
}
```
## Argument Reference
The following arguments are supported:
* `apikey` - (Required) NS1 API token. It must be provided, but it can also
be sourced from the `NS1_API_KEY` environment variable.