Added API docs to FTE
This commit is contained in:
Chris Riley
Seth Vargo
parent
c7f8db3dba
commit
ced173d248
|
|
@ -1,5 +1,9 @@
|
|||
---
|
||||
title: "Build Configuration Versions API"
|
||||
layout: "api"
|
||||
page_title: "Configuration Versions API"
|
||||
sidebar_current: "docs-enterprise-api-configversions"
|
||||
description: |-
|
||||
A configuration version represents versions of Terrraform configuration.
|
||||
---
|
||||
|
||||
# Configuration Versions API
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
---
|
||||
title: "Terraform Configuration API"
|
||||
layout: "api"
|
||||
page_title: "Terraform Configuration API"
|
||||
sidebar_current: "docs-enterprise-api-configurations"
|
||||
description: |-
|
||||
A configuration respresents settings associated with a resource that runs Terraform with versions of Terraform configuration..
|
||||
---
|
||||
|
||||
# Terraform Configuration API
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
---
|
||||
title: "Environments API"
|
||||
layout: "api"
|
||||
page_title: "Environments API"
|
||||
sidebar_current: "docs-enterprise-api-environments"
|
||||
description: |-
|
||||
Environments represent running infrastructure managed by Terraform.
|
||||
---
|
||||
|
||||
# Environments API
|
||||
|
|
|
|||
|
|
@ -1,33 +1,21 @@
|
|||
---
|
||||
title: "Atlas API Documentation"
|
||||
layout: "api"
|
||||
page_title: "API Documentation"
|
||||
sidebar_current: "docs-enterprise-api"
|
||||
description: |-
|
||||
Terraform Enterprise provides an API for a **subset of features**.
|
||||
---
|
||||
|
||||
# Atlas API Documentation
|
||||
# Terraform Enterprise API Documentation
|
||||
|
||||
Atlas provides an API for a **subset of features** available. For questions
|
||||
Terraform Enterprise provides an API for a **subset of features** available. For questions
|
||||
or requests for new API features please email [support@hashicorp.com](mailto:support@hashicorp.com).
|
||||
|
||||
## Available Endpoints
|
||||
## Available Endpoints Terraform Enterprise
|
||||
|
||||
These are the currently supported API endpoints for each product:
|
||||
|
||||
### Vagrant
|
||||
|
||||
- [Boxes](/help/api/vagrant/boxes)
|
||||
- [Box Versions](/help/api/vagrant/box-versions)
|
||||
- [Box Providers](/help/api/vagrant/box-providers)
|
||||
|
||||
### Packer
|
||||
|
||||
- [Build configurations](/help/api/packer/build-configurations)
|
||||
- [Build configuration versions](/help/api/packer/build-configuration-versions)
|
||||
- [Builds](/help/api/packer/builds)
|
||||
|
||||
### Terraform
|
||||
|
||||
- [Environments](/help/api/terraform/environments)
|
||||
- [Runs](/help/api/terraform/runs)
|
||||
- [States](/help/api/terraform/states)
|
||||
- [Environments](/docs/enterprise/api/environments.html)
|
||||
- [Runs](/docs/enterprise/api/runs.html)
|
||||
- [States](/docs/enterprise/api/states.html)
|
||||
|
||||
## Authentication
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,16 @@
|
|||
---
|
||||
title: "Runs API"
|
||||
layout: "api"
|
||||
page_title: "Runs API"
|
||||
sidebar_current: "docs-enterprise-api-runs"
|
||||
description: |-
|
||||
Runs in Terraform Enterprise represents a two step Terraform plan and a subsequent apply.
|
||||
---
|
||||
|
||||
# Runs API
|
||||
|
||||
Runs in Atlas represents a two step Terraform plan and a subsequent apply.
|
||||
Runs in Terraform Enterprise represents a two step Terraform plan and a subsequent apply.
|
||||
|
||||
Runs are queued under [environments](/help/api/terraform/environments)
|
||||
Runs are queued under [environments](/docs/enterprise/api/environments.html)
|
||||
and require a two-step confirmation workflow. However, environments
|
||||
can be configured to auto-apply to avoid this.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,14 @@
|
|||
---
|
||||
title: "State API"
|
||||
layout: "api"
|
||||
page_title: "State API"
|
||||
sidebar_current: "docs-enterprise-api-states"
|
||||
description: |-
|
||||
State represents the status of your infrastructure at the last time Terraform was run.
|
||||
---
|
||||
|
||||
# State API
|
||||
|
||||
State represents the status of your infrastructure at the last time Terraform was run. States can be pushed to Atlas from Terraform's CLI after an apply is done locally, or state is automatically stored in Atlas if the apply is done in Atlas.
|
||||
State represents the status of your infrastructure at the last time Terraform was run. States can be pushed to Terraform Enterprise from Terraform's CLI after an apply is done locally, or state is automatically stored if the apply is done in Terraform Enterprise.
|
||||
|
||||
### State Attributes
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,14 @@
|
|||
---
|
||||
title: "Users API"
|
||||
layout: "api"
|
||||
page_title: "Users API"
|
||||
sidebar_current: "docs-enterprise-api-users"
|
||||
description: |-
|
||||
Users are both users and organizations in Terraform Enterprise. They are the parent resource of all resources.
|
||||
---
|
||||
|
||||
# Users API
|
||||
|
||||
Users are both users and organizations in Atlas. They are the
|
||||
Users are both users and organizations in Terraform Enterprise. They are the
|
||||
parent resource of all resources.
|
||||
|
||||
Currently, only the retrieval of users is avaiable on the API. Additionally,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
<% wrap_layout :inner do %>
|
||||
<% content_for :sidebar do %>
|
||||
<div class="docs-sidebar hidden-print affix-top" role="complementary">
|
||||
<ul class="nav docs-sidenav">
|
||||
<li>
|
||||
<a href="/docs/enterprise/index.html">« Terraform Enterprise</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current(/^docs-enterprise-api-/) %>>
|
||||
<a href="/docs/enterprise/api/index.html">API</a>
|
||||
<ul class="nav nav-visible">
|
||||
<li<%= sidebar_current("docs-enterprise-api-environments") %>>
|
||||
<a href="/docs/enterprise/api/environments.html">Environments</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-enterprise-api-runs") %>>
|
||||
<a href="/docs/enterprise/api/runs.html">Runs</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-enterprise-api-states") %>>
|
||||
<a href="/docs/enterprise/api/states.html">States</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-enterprise-api-configurations") %>>
|
||||
<a href="/docs/enterprise/api/configurations.html">Configurations</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-enterprise-api-configversions") %>>
|
||||
<a href="/docs/enterprise/api/configuration-versions.html">Configuration Versions</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-enterprise-api-users") %>>
|
||||
<a href="/docs/enterprise/api/users.html">Users</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<%= yield %>
|
||||
<% end %>
|
||||
|
|
@ -564,6 +564,9 @@
|
|||
<li<%= sidebar_current("docs-enterprise-organizations") %>>
|
||||
<a href="/docs/enterprise/organizations/index.html">Organizations</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-enterprise-api") %>>
|
||||
<a href="/docs/enterprise/api/index.html">API</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-enterprise-billing") %>>
|
||||
<a href="/docs/enterprise/billing/index.html">Billing</a>
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Reference in New Issue