2.0 KiB

Executable File

Raw Blame History

layout	page_title	sidebar_current	description
api	Terraform Configuration API	docs-enterprise-api-configurations	A configuration respresents settings associated with a resource that runs Terraform with versions of Terraform configuration..

Terraform Configuration API

A configuration respresents settings associated with a resource that runs Terraform with versions of Terraform configuration.

Configurations have many configuration versions which represent versions of Terraform configuration templates and other associated configuration.

Configuration Attributes

Attribute	Description	Required
`name`	The name of the configuration, used to identify it. It has a maximum length of 50 characters and must contain only letters, numbers, dashes, underscores or periods.	Yes
`username`	The username to assign the configuration to. You must be a member of the organization and have the ability to create the resource.	Yes

Actions

The following actions can be perfomed on this resource.

Show: GET /api/v1/terraform/configurations/:username/:name/versions/latest
Create: POST /api/v1/terraform/configurations

Examples

Creating a configuration

Creates a configuration with the provided attributes.

$ curl %{ATLAS_URL}/api/v1/terraform/configurations \
    -X POST \
    -H "X-Atlas-Token: $ATLAS_TOKEN" \
    -d configuration[name]='test' \
    -d configuration[username]='%{DEFAULT_USERNAME}'

Retrieving a configuration

Returns the JSON respresentation of the latest configuration.

$ curl %{ATLAS_URL}/api/v1/terraform/configurations/%{DEFAULT_USERNAME}/test/versions/latest \
    -H "X-Atlas-Token: $ATLAS_TOKEN"

2.0 KiB Executable File Raw Blame History