---
title: "Get a Provider configuration"
method: GET
path: "/provider-configurations/{provider_configuration}"
tags: ["provider-configurations"]
---

# Get a Provider configuration

`GET /provider-configurations/{provider_configuration}`

## Request

- Base URL: `https://example.scalr.io/api/iacp/v3`
- URL: `https://example.scalr.io/api/iacp/v3/provider-configurations/{provider_configuration}`
- Auth: HTTP bearer

Show details of a specific Provider configuration.

## Path parameters

- `provider_configuration` string, required

## Query parameters

- `include` string[]

## Response `200`

Success.

- ProviderConfigurationDocument: JSON:API Document. see: https://jsonapi.org/format/#document-structure
  - `data` ProviderConfiguration: The configuration of provider. Provider configuration is managed on the account scope and can be linked to environments or workspaces.
    - `attributes` object, required
      - `apply-only` boolean: Use this provider configuration only for the apply phase. This option is available only for built in AWS providers.
      - `aws-access-key` string, nullable: AWS access key. This option is required with the `access_keys` credential type.
      - `aws-account-type` 'regular' | 'gov-cloud' | 'cn-cloud', nullable: The type of AWS account, available options: `regular`, `gov-cloud`, `cn-cloud`.
      - `aws-audience` string, nullable: The value of the aud claim for the identity token.
      - `aws-credentials-source` 'Ec2InstanceMetadata' | 'EcsContainer', nullable: The credential source for the initial assume-role call. Applicable when the trusted entity type is `aws_service`. Available options: `Ec2InstanceMetadata`, `EcsContainer`. Defaults to `Ec2InstanceMetadata`.
      - `aws-credentials-type` 'role_delegation' | 'access_keys' | 'oidc', nullable: The type of AWS credential, available options: `access_keys`, `role_delegation`, `oidc`.
      - `aws-default-tags` object, nullable: Default tags to be applied to all resources created by this provider configuration.
      - `aws-default-tags-fail-on-merge-error` boolean, nullable: Fail the run when the `default_tags` block of the aws provider in the configuration cannot be evaluated to merge with `aws-default-tags`. When disabled, the run continues without the Scalr default tags and shows a warning.
      - `aws-default-tags-strategy` 'skip' | 'update', nullable: On duplicate key behaviour for default tags. Available options: - `skip`: the existing tags will not be changed - `update`: the existing tags will be replaced with the new one
      - `aws-external-id` string, nullable: External identifier to use when assuming the role. This option is required with the `role_delegation` credential type.
      - `aws-role-arn` string, nullable: Amazon Resource Name (ARN) of the IAM Role to assume. This option is required with the `role_delegation` and `oidc` credential type.
      - `aws-secret-key` string, password, nullable: AWS secret key. This option is required with the `access_keys` credential type.
      - `aws-trusted-entity-type` 'aws_account' | 'aws_service', nullable: Trusted entity type, available options: `aws_account`, `aws_service`. This option is required with the `role_delegation` credential type.
      - `azurerm-audience` string, nullable: The value of the aud claim for the identity token.
      - `azurerm-auth-type` 'client-secrets' | 'oidc', nullable: The type of azurerm credentials, available options: `client-secrets`, `oidc`.
      - `azurerm-client-id` string, nullable: The Client ID which should be used.
      - `azurerm-client-secret` string, password, nullable: The Client Secret which should be used.
      - `azurerm-subscription-id` string, nullable: The Subscription ID which should be used.
      - `azurerm-tenant-id` string, nullable: The Tenant ID should be used.
      - `error-message` string, nullable: Contains the error message if the provider configuration is in an `errored` status.
      - `export-shell-variables` boolean: Export provider variables into the run environment. This option is available only for built in providers.
      - `google-auth-type` 'service-account-key' | 'oidc', nullable: Authentication type to access GCP.
      - `google-credentials` string, password, nullable: Service account key file in JSON format.
      - `google-default-label-strategy` 'skip' | 'update', nullable: On duplicate key behaviour for default labels. Available options: - `skip`: the existing labels will not be changed - `update`: the existing labels will be replaced with the new one
      - `google-default-labels` object, nullable: Default labels to be applied to all resources created by this provider configuration.
      - `google-default-labels-fail-on-merge-error` boolean, nullable: Fail the run when `default_labels` of the google provider in the configuration cannot be evaluated to merge with `google-default-labels`. When disabled, the run continues without the Scalr default labels and shows a warning.
      - `google-project` string, nullable: The default project to manage resources in. If another project is specified on a resource, it will take precedence.
      - `google-service-account-email` string, nullable: The service account email Scalr will use when authenticating to GCP.
      - `google-service-account-name` string, nullable: Service account name.
      - `google-use-default-project` boolean, nullable: If the project will be enforced.
      - `google-workload-provider-name` string, nullable: The canonical name of the workload identity provider.
      - `is-allowed-in-module-test` boolean: Indicates whether the provider configuration can be used in module tests.
      - `is-custom` boolean, nullable: Determines if a provider configuration is custom. Note: custom provider configurations do not support built-in features like exporting as shell variables or on-save validation. Provider configuration will be validated during the run only.
      - `is-shared` boolean: Indicates whether the provider configuration can be used in any workspace of the account without directly linking it to the environment.
      - `is-used-in-module-test` boolean: Indicates whether the provider configuration is currently linked to any module test.
      - `name` string, required: The name of a Scalr provider configuration. This field is unique for the account.
      - `provider-name` union, required: The name of a Terraform provider.
        - 'aws' | 'azurerm' | 'google' | 'scalr'
        - string
      - `scalr-hostname` string, nullable: The Scalr hostname which should be used.
      - `scalr-token` string, password, nullable: The Scalr token which should be used.
      - `status` 'active' | 'errored': Provider configuration status. Can be: `active`, `errored`.
    - `id` string
    - `links` object
      - `self` string
    - `relationships` object, required
      - `account` object, required: The account this provider configuration belongs to.
        - `data` object, required
          - `id` string, required
          - `type` 'accounts' | '', required
      - `environments` object: The list of environments attached to the provider configuration. Can be used to bulk link/unlink environments.
        - `data` object[], nullable, required
          - `id` string, required
          - `type` 'environments' | '', required
      - `owners` object: The teams, the provider configuration belongs to.
        - `data` object[], nullable, required
          - `id` string, required
          - `type` 'teams' | '', required
      - `parameters` object: The list of arguments for provider configurations.
        - `data` object[], nullable, required
          - `id` string, required
          - `type` 'provider-configuration-parameters' | '', required
      - `tags` object
        - `data` object[], nullable, required
          - `id` string, required
          - `type` 'tags' | '', required
    - `type` 'provider-configurations', required
  - `included` object[]
  - `meta` object

## Other responses

- `404`: Provider configuration not found or user unauthorized to perform action.
- `4XX`: Client error.
- `5XX`: Server error.

## Changes

- **2026-11-03** `d3e1dc85657a`: 2 info
  - added the optional property `data/attributes/aws-default-tags-fail-on-merge-error` to the response with the `200` status
  - added the optional property `data/attributes/google-default-labels-fail-on-merge-error` to the response with the `200` status

[Operation history](https://skmtc.dev/scalr/apis/scalr-iacp-api/changes/provider-configurations/:provider_configuration/get.md)

---

[API](https://skmtc.dev/scalr/apis/scalr-iacp-api.md) - [All operations](https://skmtc.dev/scalr/apis/scalr-iacp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scalr/apis/scalr-iacp-api/revisions/d3e1dc85657a?raw)