For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get module example file

Download a single file from a module version's examples/ tree. The path must begin with "examples/" and identify a file (not a directory).

get
Path parameters
module_idstringRequired

module id

Example: Alias nulla laudantium expedita.
Query parameters
versionstringRequired

version of the module

Example: Qui iusto repudiandae.
scope_orgstringOptional

org name

Example: Est illo quia et molestias.
scope_projectstringOptional

project name

Example: Et pariatur sed quidem maxime.
pathstring · min: 1 · max: 1024Required

relative path under the module root; must begin with "examples/" and identify a file (e.g. "examples/iam-account/main.tf" or "examples/iam-account/modules/foo/main.tf")

Example: ePattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$
Header parameters
Harness-AccountstringRequired

account name

Example: Molestias dolore consequatur voluptatem voluptas.
Responses
200

OK response.

application/json
string · binaryOptional
get/api/modules/{module_id}/examples/file
GET /api/modules/{module_id}/examples/file?version=Qui+iusto+repudiandae.&path=e HTTP/1.1
Host: localhost:80
Harness-Account: Molestias dolore consequatur voluptatem voluptas.
Accept: */*
binary

Last updated

Was this helpful?