Scalr

https://docs.scalr.io/
Admin
Scalr is a cost-effective, drop-in replacement for Terraform Cloud that serves as a remote...
Tokens:627,612
Snippets:3,146
Trust Score:6.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Agent Software Installation Log

Source: https://docs.scalr.io/docs/run-environment

Example output showing the binary installation process during the run initialization phase.

```console
Installing software binaries...
Installed software binaries in 224.27ms
```

--------------------------------

### View Provider Cache Warm-Up Logs

Source: https://docs.scalr.io/docs/providers-cache

Example output showing the concurrent download and installation of plugins from the dependency lock file.

```bash
Installing 20 plugins from the dependency lock file...
Installed 20 plugins from the dependency lock file in 42.47s (20 downloaded)
Initializing plugins and modules...
Initialized 20 plugins and 0 modules in 7.25s (20 plugins used from cache)
Validating configuration files...
```

--------------------------------

### Workspace Creation Request Body Example

Source: https://docs.scalr.io/reference/create_workspace

Example configuration for creating a workspace with tags.

```json
"examples": {
                "tags": {
                  "summary": "Create a workspace with tags",
                  "description": "To create a workspace with tags, the [Tag](tags.html#the-tag-resource) resources\nshould be created first in the account.\nThen Tags can be passed as relationship objects in create workspace payload."
```

--------------------------------

### Configuration Version Inputs Example

Source: https://docs.scalr.io/reference/create_configuration_version

Example structure for input variable definitions within a configuration version.

```js
[
  {
    "description": "The name of the CloudSQL database.",
    "name": "cloudsql_database",
    "type": "string"
  },
  {"...": ""..."}
]
```

--------------------------------

### Install Scalr CLI via Direct Download

Source: https://docs.scalr.io/docs/vcs

Manual installation method for Linux and macOS systems.

```bash
# Download latest release
SCALR_CLI_LATEST=$(curl -sL https://api.github.com/repos/Scalr/scalr-cli/releases/latest | grep -o 'https://github.com/Scalr/scalr-cli/releases/download/[^"]*linux_amd64.tar.gz')
curl -sL "$SCALR_CLI_LATEST" --output scalr-cli.tar.gz
tar -xzf scalr-cli.tar.gz
sudo mv scalr /usr/local/bin/
```

--------------------------------

### Configuration Version Response Example

Source: https://docs.scalr.io/reference/get_configuration_version

Example JSON response body for a successful configuration version retrieval request.

```json
{
  "data": {
    "attributes": {
      "auto-queue-runs": true,
      "created-at": "2020-03-11T00:16:02Z",
      "error-message": null,
      "inputs":
      [
        {
          "description": "The name of the CloudSQL database.",
          "name": "cloudsql_database",
          "type": "string"
        },
        {
          "default": [
            "admin@example.com"
          ],
          "description": "Default superadmins for the app (HCL list).",
          "name": "flask_superadmins",
          "type": "list(string)"
        }
      ],
      "source": "github",
      "is-dry": false,
      "status": "uploaded",
      "status-timestamps": {
        "pending-at": "2020-03-11T00:16:02Z",
        "uploaded-at": "2020-03-11T00:16:03Z"
      },
    },
    "id": "cv-spu5fdevjv5jng0",
    "links": {
      "self": "https://my.scalr.io/api/iacp/v3/configuration-versions/cv-spu5fdevjv5jng0"
    },
    "relationships": {
      "vcs-revision": {
        "data": {
          "id": "vrb-spu5fddhk1h1j1g",
          "type": "vcs-revisions"
        }
      },
      "workspace": {
        "data": {
          "id": "ws-spturhj1dckd8so",
          "type": "workspaces"
        }
      }
    },
    "type": "configuration-versions"
  },
  "included": null,
  "meta": null
}
```

--------------------------------

### Get an Apply Response Example

Source: https://docs.scalr.io/reference/get_apply

Example JSON response body returned when successfully retrieving an apply resource.

```json
{
  "data": {
    "attributes": {
      "resource-additions": 0,
      "resource-changes": 1,
      "resource-destructions": 0,
      "status": "finished",
      "status-timestamps": {
        "finished-at": "2020-03-11T00:37:37Z",
        "queued-at": "2020-03-11T00:37:33Z",
        "started-at": "2020-03-11T00:37:34Z"
      }
    },
    "id": "apply-spu6782ukhum1kg",
    "links": {
      "self": "https://my.scalr.io/api/iacp/v3/applies/apply-spu6782ukhum1kg",
      "output": "https://my.scalr.io/api/iacp/v3/blobs/eyJhbGciOiJQQkVTMi1IUzUxMitBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwicDJjIjo4MTkyLCJwMnMiOiI0a1N6dG9DaGJBOW9YdE1LSHFJVnpRIn0.cWDFB1elRHQtPT9MYKUO2RYBiQVyFI1iYlfcP8TlWfXf6_59Z1e9OOHmeGw7jijKa5rbpPPDejcYEiaTb29qvFBG-v0CjgoP.gRv_VcQJLxvdds91-O6LZQ.5JAefkr7xP-G_S-BJQt-MysPX6ioVPIPHem94KXhOH_mTbrMaPzCqB95WmcNIgsFSPZe6KplaUuqeiduQBQZiL1eIxfq0Sbo1iJqUB-NUJ3jpX5UclxOOpfnbQ6GLQus.kCLZjZdRfDlQ9_HmQ6Y6vSEbuXuh5m86VSG7dJVat4A"
    },
    "relationships": {},
    "type": "applies"
  },
  "included": null,
  "meta": null
}
```

--------------------------------

### Module Details Response Example

Source: https://docs.scalr.io/reference/get_module

A sample JSON response body returned by the GET /modules/{module} endpoint.

```json
{
    "data": {
        "attributes": {
            "created-at": "2021-03-08T17:17:30Z",
            "description": "Terraform module for vpc on provider aws.",
            "error-message": null,
            "name": "vpc",
            "path": null,
            "permissions": {
                "can-delete": true,
                "can-resync": true,
                "can-retry": true
            },
            "provider": "aws",
            "source": "https://github.com/Scalr/terraform-aws-vpc",
            "status": "setup_complete",
            "tag-prefix": null,
            "updated-at": "2021-03-08T17:17:30Z",
            "vcs-repo": {
                "display-identifier": null,
                "identifier": "Perepyolka/terraform-aws-vpc",
                "path": null,
                "tag-prefix": null
            }
        },
        "id": "mod-tc5se0n0dirb90o",
        "links": {
            "self": "https://my.scalr.io/api/iacp/v3/modules/mod-tc5se0n0dirb90o"
        },
        "relationships": {
            "account": {
                "data": {
                    "id": "acc-svrcncgh453bi8g",
                    "type": "accounts"
                }
            },
            "created-by": {
                "data": {
                    "id": "user-svrcmmpcrkmit1g",
                    "type": "users"
                }
            },
            "environment": null,
            "last-active-version": {
                "data": {
                    "id": "modver-tc5se25e31ope30",
                    "type": "module-versions"
                }
            },
            "last-version": {
                "data": {
                    "id": "modver-tc5se25e31ope30",
                    "type": "module-versions"
                }
            },
            "module-versions": {
                "data": [
                    {
                        "id": "modver-tc5se25e31ope30",
                        "type": "module-versions"
                    },
                    {
                        "id": "modver-tc5se2g5a5kno2o",
                        "type": "module-versions"
                    }
                ]
            },
            "organization": null,
            "vcs-provider": {
                "data": {
                    "id": "vcs-tc5scfesq268838",
                    "type": "vcs-providers"
                }
            }
        },
        "type": "modules"
    },
    "included": null,
    "meta": null
}
```

--------------------------------

### Install and execute TFLint in pre-plan phase

Source: https://docs.scalr.io/docs/hooks

Install TFLint to a temporary directory and execute it as part of the hook process.

```shell
#Install TFLint to /tmp
curl -s https://raw.githubusercontent.com/terraform-linters/tflint/master/install_linux.sh | TFLINT_INSTALL_PATH=/tmp bash

#Call TFLint
/tmp/tflint
```

--------------------------------

### Get a Plan Response Example

Source: https://docs.scalr.io/reference/get_plan

The JSON response structure for a successful plan retrieval request.

```json
{
  "data": {
    "attributes": {
      "has-changes": true,
      "resource-additions": 10,
      "resource-changes": 0,
      "resource-destructions": 0,
      "status": "finished",
      "status-timestamps": {
        "finished-at": "2020-10-05T10:39:09Z",
        "queued-at": "2020-10-05T10:38:34Z",
        "started-at": "2020-10-05T10:38:38Z"
      }
    },
    "id": "plan-t4djd75nc170hhg",
    "links": {
      "self": "https://my.scalr.io/api/iacp/v3/plans/plan-t4djd75nc170hhg",
      "output": "https://my.scalr.io/api/iacp/v3/blobs/eyJhbGciOiJQQkVTMi1IUzUxMitBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwicDJjIjo4MTkyLCJwMnMiOiI2UzllOVJGdGJjNnNpVmx5VllMY1lnIn0.DUal2j6Btnu9Ji7x6mw-gJ86Hnu80fxUqivacQHoTQgjPUxZh4dhkWNR_MjMJ8R69qOJBOugne4M2Vkg7Eqwu8JAJ9HYr43v.XusmYBeTnbO1vIH4HYf78w.E4qiD2CMSw8j9bY67i-4hq6GWJkfkKS8aYEIAUTKvGgrRF7MswpXozOgsejWr-vjLEEHJzOnQ3O929VVe9brG4xSXTxUsnwPy0um1De80kPt7mrZoiT9c_vhhEIIZjSC.weG6Pglv55efpn-haFrgTLPEPcoRC6Otwz4wyVkLuQM"
    },
    "relationships": {},
    "type": "plans"
  },
  "included": null,
  "meta": null
}
```

--------------------------------

### Start the Scalr MCP Server with Docker

Source: https://docs.scalr.io/docs/mcp-server

Deploys the MCP server container. Omit the SCALR_API_TOKEN environment variable for multi-user setups to enforce per-user authentication.

```bash
docker run -d \
  --pull always \
  --name scalr-mcp-server \
  -p 8000:8000 \
  -e SCALR_API_URL=https://your-account.scalr.io \
  -e MCP_TRANSPORT=http \
  -e MCP_HTTP_HOST=0.0.0.0 \
  -e MCP_LOG_FILE=/var/log/mcp/server.log \
  -v ~/mcp-logs:/var/log/mcp \
  scalr/mcp-server:latest
```

--------------------------------

### Example VCS Task Usage

Source: https://docs.scalr.io/docs/vcs

Example of executing a VCS task with specific repository, branch, and commit SHA parameters.

```bash
scalr create-vcs-task \
  --repository-id "myorg/infrastructure-repo" \
  --branch "main" \
  --commit-sha "a1b2c3d4e5f6789012345678901234567890abcd"
```

--------------------------------

### Start Docker Compose service

Source: https://docs.scalr.io/docs/installation

Execute this command in the directory containing the docker-compose.yml file to start the agent.

```shell
docker compose up -d
```

--------------------------------

### Module Versions API Response Example

Source: https://docs.scalr.io/reference/list_module_versions

Example JSON response for a module-versions resource request, showing attributes like inputs, outputs, and links.

```json
{
    "data": [
        {
            "attributes": {
                "created-at": "2021-03-08T17:17:33Z",
                "dependencies": null,
                "details": "Readme",
                "error-message": null,
                "inputs": [
                    {
                        "default": "64512",
                        "description": "Description",
                        "name": "input",
                        "type": ""
                    },
                    {
                        "default": false,
                        "description": "Description",
                        "name": "input_bool",
                        "type": "bool"
                    },
                ],
                "outputs": [
                    {
                        "name": "output",
                        "sensitive": false,
                        "description": "description",
                        "value": "value"
                    },
                    {
                        "name": "output_hash",
                        "sensitive": false,
                        "description": "",
                        "value": "value"
                    }
                ],
                "resources": [
                    {
                        "address": "this",
                        "type": "resource"
                    }
                ],
                "source": "vcs",
                "status": "ok",
                "updated-at": "2021-03-08T17:17:34Z",
                "version": "2.33.0"
            },
            "id": "modver-tc5se25e31ope30",
            "links": {
                "download": "https://my.scalr.io/api/tfe/v1/blobs/eyJhbGciOiJQQkVTMi1IUzUxMitBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwicDJjIjo4MTkyLCJwMnMiOiJBVEU5cmdvYnZhOE1fY3BURGh1V05BIn0.rD4n_R9uD6Ft6I744CpsR6wryQfE87I6ZhjzJYulPiVCZ6fvg5w-ZkpsxT2UAEtH-d-IkwpZ7dpDwakt1tR83FPo3XgCvXd0.3npxoRR9AtHnkN9r9alqfA.x9IfrsqIVgLeggswY1NsWIX6JtuvZNAmHHsBwfWbKVyL2T015z4ov9Xwr-cJjSQ3Wm86ptKuuyA9AAe0OpmndRmN1cs1NjySB3LCtX2pxdquL6AsoRS-QL9NiVQ-P0rV.7kOsXKrbKCI8LQQX7KVGKPc4xWo1XrYeljXwVisrRgU",
                "self": "https://my.scalr.io/api/iacp/v3/module-versions/modver-tc5se25e31ope30",
                "upload": "https://my.scalr.io/api/tfe/v1/blobs/eyJhbGciOiJQQkVTMi1IUzUxMitBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwicDJjIjo4MTkyLCJwMnMiOiIxdHVNVmEzbGo2RjMyNGE4UnhQdlpBIn0.7k5G1a9x8dWfmjsbUZ6okpwaX84Pp_GwR_orrLsENBw8IMTAwhqX0hgLKTWRDNcuYLX9I8gLt6fvO1EX1ctyaeRQg-l4fwCS.qBHmtESZD3lw7oPwmcFEgQ.uMaq6n4HQ7XbX3swiHzAmqhPGutn0HoTxkO-AOOXwHdKwulr5yht9XdG-weHQmP0OzaKSW9QCH__4maIuEmPt0cHxZKbm7lGdeOfB5NxS8lZpPJ_1wZDF9PwjdMtz_Ct.AJeQzbFdN0dYKZg1gWejyakKCdqhhN2_mV10AWpTwU4"
            },
            "relationships": {
                "registry-module": {
                    "data": {
                        "id": "mod-tc5se0n0dirb90o",
                        "type": "modules"
                    }
                },
                "submodules": null,
                "vcs-revision": {
                    "data": {
                        "id": "vrb-tc5se25juq2h92o",
                        "type": "vcs-revisions"
                    }
                }
            },
            "type": "module-versions"
        },
        {
            "attributes": {
                "created-at": "2021-03-08T17:17:33Z",
                "dependencies": null,
                "details": "Readme",
                "error-message": null,
                "inputs": [
                    {
                        "default": "64512",
                        "description": "Description",
                        "name": "input",
                        "type": ""
                    },
                    {
                        "default": false,
```

--------------------------------

### GET /api/iacp/v3/runs

Source: https://docs.scalr.io/reference

Retrieves a list of runs with support for filtering and pagination.

```APIDOC
## GET /api/iacp/v3/runs

### Description
Retrieves a list of runs, supporting filtering by workspace and pagination.

### Method
GET

### Endpoint
/api/iacp/v3/runs

### Parameters
#### Query Parameters
- **filter[workspace]** (string) - Optional - Filter runs by workspace ID.
- **page[number]** (integer) - Optional - The page number to retrieve.
- **page[size]** (integer) - Optional - The number of items per page.
```

--------------------------------

### Get Team Response Example

Source: https://docs.scalr.io/reference/get_team

A sample JSON response returned by the GET /teams/{team} endpoint.

```json
{
  "data": {
    "attributes": {
      "description": null,
      "name": "Users"
    },
    "id": "team-t67mjtnokncjpd8",
    "links": {
      "self": "https://my.scalr.io/api/iacp/v3/teams/team-t67mjtnokncjpd8"
    },
    "relationships": {
      "account": {
        "data": {
          "id": "acc-svrcncgh453bi8g",
          "type": "accounts"
        }
      },
      "identity-provider": {
        "data": {
          "id": "idp-sohkb0o1phrdmr8",
          "type": "identity-providers"
        }
      },
      "users": {
        "data": [
          {
            "id": "user-suh84u6vuvidtbg",
            "type": "users"
          },
          {
            "id": "user-suh84u72gfrbd30",
            "type": "users"
          }
        ]
      }
    },
    "type": "teams"
  },
  "included": null,
  "meta": null
}
```

--------------------------------

### View initial module download logs

Source: https://docs.scalr.io/docs/modules-cache

Example output showing the initial download and initialization of modules during the first workspace run.

```console
Initializing modules...
Downloading registry.opentofu.org/terraform-aws-modules/iam/aws 6.2.3 for iam_account...
- iam_account in .terraform/modules/iam_account/modules/iam-account
Downloading registry.opentofu.org/terraform-aws-modules/iam/aws 6.2.3 for iam_oidc_provider...
- iam_oidc_provider in .terraform/modules/iam_oidc_provider/modules/iam-oidc-provider
Downloading registry.opentofu.org/terraform-aws-modules/lambda/aws 8.1.2 for lambda_function...
- lambda_function in .terraform/modules/lambda_function
Downloading registry.opentofu.org/terraform-aws-modules/s3-bucket/aws 5.9.0 for s3-bucket_example_account-public-access...
- s3-bucket_example_account-public-access in .terraform/modules/s3-bucket_example_account-public-access/examples/account-public-access
- s3-bucket_example_account-public-access.account_public_access in .terraform/modules/s3-bucket_example_account-public-access/modules/account-public-access
Downloading registry.opentofu.org/terraform-aws-modules/s3-bucket/aws 5.9.0 for s3-bucket_example_table-bucket...
- s3-bucket_example_table-bucket in .terraform/modules/s3-bucket_example_table-bucket/examples/table-bucket
Downloading registry.opentofu.org/terraform-aws-modules/kms/aws 3.1.1 for s3-bucket_example_table-bucket.kms...
- s3-bucket_example_table-bucket.kms in .terraform/modules/s3-bucket_example_table-bucket.kms
- s3-bucket_example_table-bucket.table_bucket in .terraform/modules/s3-bucket_example_table-bucket/modules/table-bucket

Initialized 6 modules in 8.45s (6 downloaded, 6 cached)
Initializing plugins...sa
Initialized 6 plugins in 2.85s (6 used from cache)
```

--------------------------------

### Get Run Parameter Example

Source: https://docs.scalr.io/reference/get_run

Example value for the run ID parameter used in the get_run operation.

```json
"run-t61gbtqgg8553h8"
```

--------------------------------

### Get Run API Response

Source: https://docs.scalr.io/reference/get_run

Example JSON response for a successful retrieval of a run object.

```json
{
  "data": {
    "attributes": {
      "created-at": "2020-11-06T16:42:18Z",
      "error-message": null,
      "has-changes": true,
      "inputs": [
        {
          "description": "The branch or revision of the scalr repository to pull changes from.",
          "name": "revision",
          "sensitive": false,
          "value": "master"
        },
        {
          "description": "The machine type of the Scalr node",
          "name": "machine_type",
          "sensitive": false,
          "value": "n1-standard-2"
        }
      ],
      "is-destroy": false,
      "message": "Deploy test environment to work on CORE-17409",
      "position-in-queue": null,
      "source": "ui",
      "status": "applied",
      "status-timestamps": {
        "applied-at": "2020-11-06T16:44:23Z",
        "apply-queued-at": "2020-11-06T16:43:00Z",
        "applying-at": "2020-11-06T16:43:01Z",
        "confirmed-at": "2020-11-06T16:43:00Z",
        "cost-estimated-at": "2020-11-06T16:42:55Z",
        "cost-estimating-at": "2020-11-06T16:42:54Z",
        "plan-queueable-at": "2020-11-06T16:42:18Z",
        "plan-queued-at": "2020-11-06T16:42:19Z",
        "planned-at": "2020-11-06T16:42:53Z",
        "planning-at": "2020-11-06T16:42:19Z",
        "policy-checked-at": "2020-11-06T16:42:56Z",
        "policy-checking-at": "2020-11-06T16:42:55Z"
      }
    },
    "id": "run-t61gbtqgg8553h8",
    "links": {
      "self": "https://my.scalr.io/api/iacp/v3/runs/run-t61gbtqgg8553h8"
    },
    "relationships": {
      "apply": {
        "data": {
          "id": "apply-t61gbtquugkhm40",
          "type": "applies"
        }
      },
      "configuration-version": {
        "data": {
          "id": "cv-t61g5phg8e4f49o",
          "type": "configuration-versions"
        }
      },
      "cost-estimate": {
        "data": {
          "id": "ce-t61gbtr3grklu2g",
          "type": "cost-estimates"
        }
      },
      "created-by": {
        "data": {
          "id": "user-stp8qjfonavseg0",
          "type": "users"
        }
      },
      "plan": {
        "data": {
          "id": "plan-t61gbtqutu417p0",
          "type": "plans"
        }
      },
      "policy-checks": {
        "data": [
          {
            "id": "pchk-t61gbtus33m5eu8",
            "type": "policy-checks"
          }
        ]
      },
      "status-transitions": {
        "data": [
          {
            "id": "23a18e19-23f2-64ec-9f10-f0dbf8e26a7b",
            "type": "status-transitions"
          },
          {
            "id": "23a18e19-7773-64f4-681c-ffe2004fec87",
            "type": "status-transitions"
          },
          {
            "id": "23a18e19-8635-617c-ea8d-d30a826a50e5",
            "type": "status-transitions"
          },
          {
            "id": "23a18e26-19b6-673c-64ea-4cb71181b9f6",
            "type": "status-transitions"
          },
          {
            "id": "23a18e26-614d-6618-9c16-e88f9aa13a7c",
            "type": "status-transitions"
          },
          {
            "id": "23a18e26-afc6-67e0-e8b3-f9401c85c7b3",
            "type": "status-transitions"
          },
          {
            "id": "23a18e26-b111-65a0-dc08-39a9dec9301a",
            "type": "status-transitions"
          },
          {
            "id": "23a18e27-2b5e-6560-a187-65e87a51859c",
            "type": "status-transitions"
          },
          {
            "id": "23a18e28-d12d-6904-5ce7-f83e7125a812",
            "type": "status-transitions"
          },
          {
            "id": "23a18e28-d73b-6454-83af-59e8ceda6f65",
            "type": "status-transitions"
          },
          {
            "id": "23a18e28-e309-6510-dfbd-33d68862ddf0",
            "type": "status-transitions"
          },
          {
            "id": "23a18e47-aa61-6284-bc8e-9ee876c9bbc9",
            "type": "status-transitions"
          }
        ]
      },
      "vcs-revision": {
        "data": {
          "id": "vrb-t61g5pftks1ibl0",
          "type": "vcs-revisions"
        }
      },
      "workspace": {
        "data": {
          "id": "ws-t61fnk5nffoujpg",
          "type": "workspaces"
        }
      }
    },
    "type": "runs"
  }
}
```

--------------------------------

### Access CLI Help

Source: https://docs.scalr.io/docs/vcs

Retrieve parameter documentation for the create-vcs-task command.

```bash
scalr -help create-vcs-task
```

--------------------------------

### Create Environment Response Example

Source: https://docs.scalr.io/reference/create_environment

Successful response returned after creating an environment, containing the resource ID and metadata.

```json
{
  "data": {
    "attributes": {
      "created-at": "2020-11-05T05:11:21Z",
      "name": "staging",
      "status": "Active"
    },
    "id": "env-t5v458aus4r7fc8",
    "links": {
      "self": "https://my.scalr.io/api/iacp/v3/environments/env-t5v458aus4r7fc8"
    },
    "relationships": {
      "account": {
        "data": {
          "id": "acc-t2fcrq6h1v3nf0g",
          "type": "accounts"
        }
      },
      "created-by": {
        "data": {
          "id": "user-stp8qjcvjljlo1o",
          "type": "users"
        }
      },
    },
    "type": "environments"
  },
  "included": null,
  "meta": null
}
```

--------------------------------

### Get User Response Example

Source: https://docs.scalr.io/reference/get_user

The JSON response structure returned when successfully querying a user by ID.

```json
{
  "data": {
    "attributes": {
      "created-at": "2021-09-29T22:02:45Z",
      "email": "test_user@scalr.com",
      "full-name": "",
      "iam-type": "TeamUser",
      "last-login-at": null,
      "status": "Active",
      "username": "test_user@scalr.com"
    },
    "id": "user-tmg3q1oanl65tho",
    "links": {
      "self": "https://my.scalr.io/api/iacp/v3/users/user-tmg3q1oanl65tho"
    },
    "relationships": {
      "identity-providers": null,
      "teams": null
    },
    "type": "users"
  },
  "included": null,
  "meta": null
}
```

--------------------------------

### Create environment using flags

Source: https://docs.scalr.io/docs/overview-2

Use flags for simple command calls.

```bash
scalr create-environment -name=development
```

--------------------------------

### Start the agent

Source: https://docs.scalr.io/docs/installation

Command to initialize the agent using Docker Compose.

```shell
cd /opt/scalr-agent/
docker compose up -d
```

--------------------------------

### Policy Check Response Example

Source: https://docs.scalr.io/reference/get_policy_check

Example JSON response for a successful retrieval of a specific policy check.

```json
{
  "data": {
    "attributes": {
      "result": {
        "advisory-failed": 1,
        "duration-ms": 74,
        "hard-failed": 0,
        "passed": 2,
        "policies": [
          {
            "messages": [
              "Plan is too expensive: $733.35, while up to $500 is allowed"
            ],
            "name": "cost-check",
            "result": "advisory_failed"
          },
          {
            "messages": [],
            "name": "credential-limit",
            "result": "passed"
          },
          {
            "messages": [],
            "name": "instance_types",
            "result": "passed"
          }
        ],
        "result": false,
        "soft-failed": 0,
        "total-failed": 1
      },
      "status": "passed",
      "status-timestamps": {
        "passed-at": "2020-11-06T16:37:40Z",
        "pending-at": "2020-11-06T16:37:00Z",
        "queued-at": "2020-11-06T16:37:39Z"
      }
    },
    "id": "pchk-t61g5rsa61i18c8",
    "links": {
      "output": "https://my.scalr.io/api/iacp/v3/policy-checks/pchk-t61g5rsa61i18c8/output",
      "self": "https://my.scalr.io/api/iacp/v3/policy-checks/pchk-t61g5rsa61i18c8"
    },
    "relationships": {},
    "type": "policy-checks"
  },
  "included": null,
  "meta": null
}
```

--------------------------------

### View cached module initialization logs

Source: https://docs.scalr.io/docs/modules-cache

Example output showing faster initialization times when modules are successfully retrieved from the cache.

```console
Initializing modules...
Initialized 6 modules in 1.01s (6 used from cache)
Initializing plugins...
Initialized 6 plugins in 3.05s (6 used from cache)
```

--------------------------------

### Create Workspace and Execute Run via API

Source: https://docs.scalr.io/docs/creating-a-workspace-1

This Python script demonstrates the workflow for creating a configuration version, uploading a tar.gz archive, and triggering a run using the Scalr API. Ensure all placeholder variables like token, base_url, and file paths are updated before execution.

```python
import requests

token = "<secret>"
base_url = 'https://example.scalr.io/'
headers = {
    'Prefer': 'profile=preview',
    'accept': 'application/vnd.api+json',
    'content-type': 'application/vnd.api+json',
    'Authorization': f'Bearer {token}'
}

env_id = "<env-123>"
ws_id = "<ws-123>"
is_dry_run = True
upload_archive_path = '<example.tar.gz>'


## create CV
url = f'{base_url}/api/iacp/v3/configuration-versions'
data = {
    'data': {
        'attributes': {
            "auto-queue-runs": False,
        },
        'relationships': {
            'workspace': {
                'data': {
                    'type': 'workspaces',
                    'id': ws_id
                }
            }
        },
        'type': 'configuration-versions'
    }
}

response = requests.post(url, headers=headers, json=data)

cv_id = None
if response.status_code == 201:
    # Successful request
    result = response.json()
    # Process the response data
    print(result)
    cv_id = result['data']['id']
else:
    # Request failed
    raise Exception(f"Error: {response.status_code} - {response.text}")


upload_url = result['data']['links']['upload']
print(upload_url)


upload = requests.put(upload_url, headers={'Content-Type': 'application/octet-stream'}, data=open(upload_archive_path, 'rb'))
print(upload.status_code)


## create run
url = f'{base_url}/api/iacp/v3/runs'
data = {
    'data': {
        'attributes': {
            "is-dry": is_dry_run,
        },
        'relationships': {
            'configuration-version': {
                'data': {
                    'type': 'configuration-versions',
                    'id': cv_id
                }
            },
            'workspace': {
                'data': {
                    'type': 'workspaces',
                    'id': ws_id
                }
            }
        },
        'type': 'runs'
    }
}

response = requests.post(url, headers=headers, json=data)
if response.status_code == 201:
    # Successful request
    result = response.json()
    # Process the response data
    print(result)
else:
    # Request failed
    raise Exception(f"Error: {response.status_code} - {response.text}")
```

--------------------------------

### Example State File with Serial 2

Source: https://docs.scalr.io/docs/state-management

Example of a state file structure with a serial value of 2.

```json
{
  "version": 2,
  "terraform_version": "1.0.0",
  "serial": 2,
...
```

--------------------------------

### Initial Run Log Output

Source: https://docs.scalr.io/docs/providers-cache

Example console output during the first run when providers are being downloaded and cached.

```console
Initializing plugins and modules...
Initialized 20 plugins and 0 modules in 79.39s (20 plugins downloaded)
Caching 20 locked plugins after changes to the HCL lockfile...
Cached 20 plugins in 7.26s
Validating configuration files...
```

--------------------------------

### Example Updated State Serial

Source: https://docs.scalr.io/docs/state-management

Example of a state file structure with an incremented serial value of 4.

```json
{
  "version": 4,
  "terraform_version": "1.5.7",
  "serial": 4,
...
```

--------------------------------

### Example Remote State Serial

Source: https://docs.scalr.io/docs/state-management

Example of a state file structure showing a serial value of 3.

```json
{
  "version": 4,
  "terraform_version": "1.5.7",
  "serial": 3,
...
```

--------------------------------

### Retrieve Provider Configuration Examples

Source: https://docs.scalr.io/docs/provider_datasource_scalr_provider_configuration

Demonstrates fetching provider configurations using different identifiers such as ID, name, or provider name.

```terraform
data "scalr_provider_configuration" "aws" {
  id = "pcfg-xxxxxxxxxx"
}

data "scalr_provider_configuration" "aws_dev" {
  name = "aws_dev"
}

data "scalr_provider_configuration" "azure" {
  provider_name = "azurerm"
}
```

--------------------------------

### Configure Scalr CLI Interactively

Source: https://docs.scalr.io/docs/overview-2

Run the interactive wizard to generate the configuration file at ~/.scalr/scalr.conf.

```bash
$ scalr -configure
Scalr Hostname [ex: example.scalr.io]: example.scalr.io
Scalr Token (not echoed!):
Default Scalr Account-ID [ex: acc-tq8cgt2hu6hpfuj]: acc-tq8cgt2hu6h1234
Configuration saved in /home/user/.scalr/scalr.conf
```

--------------------------------

### Configure CLI

Source: https://docs.scalr.io/docs/vcs

Initialize or update the local CLI configuration file.

```bash
scalr -configure
```

--------------------------------

### Build and Zip Provider Binaries

Source: https://docs.scalr.io/docs/private-provider-registry

Compile the provider for specific OS and architecture targets and package them into zip files following the required naming convention.

```shell
# macOS arm64
GOOS=darwin GOARCH=arm64 go build -o terraform-provider-acme
zip terraform-provider-acme_1.0.0_darwin_arm64.zip terraform-provider-acme

# Linux amd64
GOOS=linux GOARCH=amd64 go build -o terraform-provider-acme
zip terraform-provider-acme_1.0.0_linux_amd64.zip terraform-provider-acme
```

--------------------------------

### Install Scalr CLI via Homebrew

Source: https://docs.scalr.io/docs/overview-2

Use Homebrew to install the Scalr CLI on macOS or Linux systems.

```bash
brew tap Scalr/scalr
brew install scalr
```

--------------------------------

### Create VM systemd drop-in directory

Source: https://docs.scalr.io/docs/run-agents

Initializes the directory required for systemd service overrides on a VM.

```shell
mkdir -p  /etc/systemd/system/scalr-agent.service.d/
```

--------------------------------

### Configuration Version List Response

Source: https://docs.scalr.io/reference/get_configuration_versions

Example JSON response for a successful request to list configuration versions, including pagination metadata and resource relationships.

```json
{
  "data": [
    {
      "attributes": {
        "auto-queue-runs": true,
        "created-at": "2020-03-11T00:36:49Z",
        "error-message": null,
        "inputs":
        [
          {
            "description": "The name of the CloudSQL database.",
            "name": "cloudsql_database",
            "type": "string"
          },
          {
            "default": [
              "admin@example.com"
            ],
            "description": "Default superadmins for the app (HCL list).",
            "name": "flask_superadmins",
            "type": "list(string)"
          }
        ],
        "is-dry": false,
        "source": "github",
        "status": "uploaded",
        "status-timestamps": {
          "pending-at": "2020-03-11T00:36:49Z",
          "uploaded-at": "2020-03-11T00:36:50Z"
        }
      },
      "id": "cv-spu676hvmfh4kp0",
      "links": {
        "self": "https://my.scalr.io/api/iacp/v3/configuration-versions/cv-spu676hvmfh4kp0"
      },
      "relationships": {
        "vcs-revision": {
          "data": {
            "id": "vrb-spu676eh2a45gn8",
            "type": "vcs-revisions"
          }
        },
        "workspace": {
          "data": {
            "id": "ws-spturhj1dckd8so",
            "type": "workspaces"
          }
        }
      },
      "type": "configuration-versions"
    },
    {"...": "..."}
  ],
  "included": null,
  "links": {
    "first": "https://my.scalr.io/api/iacp/v3/configuration-versions?filter%workspace%5D=ws-spturhj1dckd8so&page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://my.scalr.io/api/iacp/v3/configuration-versions?filter%workspace%5D=ws-spturhj1dckd8so&page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "next": "https://my.scalr.io/api/iacp/v3/configuration-versions?filter%workspace%5D=ws-spturhj1dckd8so&page%5Bnumber%5D=2&page%5Bsize%5D=20",
    "prev": null,
    "self": "https://my.scalr.io/api/iacp/v3/configuration-versions?filter%workspace%5D=ws-spturhj1dckd8so&page%5Bnumber%5D=1&page%5Bsize%5D=20"
  },
  "meta": {
    "pagination": {
      "current-page": 1,
      "next-page": 2,
      "prev-page": null,
      "total-count": 23,
      "total-pages": 2
    }
  }
}
```
Tokens:
Raw