Skip to content

request.md

Latest commit

 

History

History
78 lines (55 loc) · 3.95 KB

request.md

File metadata and controls

78 lines (55 loc) · 3.95 KB
Raw
page_title terracurl_request Data Source - terracurl
subcategory
description TerraCurl request data source

terracurl_request (Data Source)

TerraCurl request data source

Schema

Required

  • method (String) HTTP method to use in the API call
  • name (String) Friendly name for this API call
  • response_codes (List of String) A list of expected response codes
  • url (String) Api endpoint to call

Optional

  • ca_cert_directory (String) Path to a directory on local disk that contains one or more certificate files that will be used to validate the certificate presented by the server
  • ca_cert_file (String) Path to a file on local disk that will be used to validate the certificate presented by the server
  • cert_file (String) Path to a file on local disk that contains the PEM-encoded certificate to present to the server
  • digest_auth (Attributes, Sensitive) HTTP Digest authentication credentials for the request. Overrides provider default_digest_auth when configured. (see below for nested schema)
  • headers (Map of String) Map of headers to attach to the API call. Host (case-insensitive) overrides the HTTP Host header sent on the wire, independent of the URL hostname.
  • key_file (String) Path to a file on local disk that contains the PEM-encoded private key for which the authentication certificate was issued
  • max_retry (Number) Maximum number of tries until it is marked as failed
  • request_body (String) A request body to attach to the API call
  • request_body_file (String) Path to a file on local disk to use as the request body. File bytes are read at request time and are not stored in Terraform state.
  • request_multipart (Attributes) Multipart form request body. The provider sets Content-Type with a generated boundary. (see below for nested schema)
  • request_parameters (Map of String) Map of parameters to attach to the API call
  • response_sensitive (Boolean) Set to true to treat the response as sensitive. When enabled, the response body is written to sensitive_response (a sensitive attribute) and response is left empty so that secret values are not displayed in plan output. Defaults to false to preserve existing behavior.
  • retry_interval (Number) Interval between each attempt
  • skip_tls_verify (Boolean) Set this to true to disable verification of the server's TLS certificate
  • timeout (Number) Time in seconds before each request times out. Defaults to 10

Read-Only

  • id (String) Example identifier
  • request_url_string (String) Request URL includes parameters if request specified
  • response (String) JSON response received from request. Empty when response_sensitive is true; use sensitive_response instead.
  • sensitive_response (String, Sensitive) JSON response received from request, marked as sensitive so it is not displayed in plan output. Populated only when response_sensitive is true.
  • status_code (String) Response status code received from request

Nested Schema for digest_auth

Required:

  • password (String, Sensitive) Password for HTTP Digest authentication.
  • username (String, Sensitive) Username for HTTP Digest authentication.

Nested Schema for request_multipart

Required:

Nested Schema for request_multipart.parts

Required:

  • name (String) Form field name.

Optional:

  • content_type (String) Optional Content-Type for this part. Defaults to text/plain for value parts and application/octet-stream for file parts.
  • file_path (String) Path to a file on local disk for this form field.
  • value (String) Text form field value.