---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "orcasecurity_integration_snyk Resource - orcasecurity"
subcategory: ""
description: |-
  Manage a Snyk integration in Orca.
---

# orcasecurity_integration_snyk (Resource)

Manages a [Snyk](https://snyk.io/) integration in Orca Security.

Under the hood this creates an entry under `POST /api/external_service/config`
with `service_name = "snyk"`. The Snyk API token is stored in Orca's secret
store and is never returned by the API.

## Example Usage

### Basic example

```terraform
# Snyk integration
resource "orcasecurity_integration_snyk" "example" {
  template_name = "display_name"
  api_token     = var.snyk_api_token
  # Match what the Orca UI shows in the region dropdown:
  #   "United States"    -> US
  #   "United States 2"  -> US2
  #   "European Union"   -> EU
  #   "Australia"        -> AU
  region     = "US"
  is_enabled = true
  is_default = false
}
```

### Sourcing the token from HashiCorp Vault

```terraform
data "vault_generic_secret" "snyk" {
  path = "secret/snyk/orca"
}

resource "orcasecurity_integration_snyk" "from_vault" {
  template_name = "snyk-prod"
  region        = "EU"
  api_token     = data.vault_generic_secret.snyk.data["api_token"]
}
```

## Argument Reference

* `template_name` — (Required, String) Identifier for the integration as shown
  in the Orca UI. Changing this forces a new resource.
* `api_token` — (Required, String, Sensitive) Snyk service account API token.
* `region` — (Required, String) Snyk tenant region. The Orca UI exposes
  exactly four choices in the region dropdown — pass the matching API code
  here:

    | UI label         | API code (use this) | Snyk tenant URL          |
    |------------------|---------------------|--------------------------|
    | United States    | `US`                | `https://app.snyk.io`    |
    | United States 2  | `US2`               | `https://app.us.snyk.io` |
    | European Union   | `EU`                | `https://app.eu.snyk.io` |
    | Australia        | `AU`                | `https://app.au.snyk.io` |
* `is_enabled` — (Optional, Bool) Defaults to `true`.
* `is_default` — (Optional, Bool) Defaults to `false`.

## Attribute Reference

* `id` — (String) Orca external service config identifier (UUID).

## Notes

* Orca strips `api_token` from `GET` responses (stored in SSM). The provider
  keeps the value already in Terraform state to avoid permanent diffs. Rotate
  through `terraform apply`; for out-of-band rotation use
  `terraform apply -replace=orcasecurity_integration_snyk.example`.
* Use an encrypted remote backend (S3 + KMS, GCS, Terraform Cloud, etc.) and
  restrict read access to the state.

## Import

```bash
terraform import orcasecurity_integration_snyk.example display_name
```

After import, set the `api_token` argument in your configuration — the API
does not return it.