A new platform for documentation and tutorials is launching soon.
We are migrating Terraform documentation into HashiCorp Developer, our new developer experience.
Search Terraform documentation » Assessment Results APIAn Assessment Result is the record of an instance of continuous validation.
» Show Assessment ResultGET api/v2/assessment-results/:assessment_result_id
Parameter Description :assessment_result_id
The assessment result ID
» Sample Request$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm
$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm
» Sample Response{
"id" : "asmtres-UG5rE9L1373hMYMA" ,
"type" : "assessment-results" ,
"data" : {
"attributes" : {
"drifted" : true ,
"succeeded" : true ,
"error-msg" : null ,
"created-at" : "2022-07-02T22:29:58+00:00" ,
} ,
"links" : {
"self" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/"
"json-output" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/json-output"
"json-schema" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/json-schema"
"log-output" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/log-output"
}
}
}
{
"id" : "asmtres-UG5rE9L1373hMYMA" ,
"type" : "assessment-results" ,
"data" : {
"attributes" : {
"drifted" : true ,
"succeeded" : true ,
"error-msg" : null ,
"created-at" : "2022-07-02T22:29:58+00:00" ,
} ,
"links" : {
"self" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/"
"json-output" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/json-output"
"json-schema" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/json-schema"
"log-output" : "/api/v2/assessment-results/asmtres-UG5rE9L1373hMYMA/log-output"
}
}
}
» Retrieve the JSON output from the assessment executionThe following endpoints retrieve files documenting the plan, schema, and logged runtime associated with the specified assessment result. They provide complete context for an assessment result. The responses do not adhere to JSON API spec.
You cannot access these endpoints with organization tokens . You must access them with a user token or team token that has admin level access to the workspace. Refer to Permissions for details.
» JSON PlanThe following endpoint returns the JSON plan output associated with the assessment result.
GET api/v2/assessment-results/:assessment_result_id/json-output
» Sample Request$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm/json-output
$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm/json-output
» JSON Schema fileThe following endpoint returns the JSON provider schema associated with the assessment result.
GET api/v2/assessment-results/:assessment_result_id/json-schema
» Sample Request$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm/json-schema
$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm/json-schema
» JSON Log OutputThe following endpoint returns Terraform JSON log output.
GET api/v2/assessment-results/assessment_result_id/log-output
» Sample Request$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm/log-output
$ curl \
--header "Authorization: Bearer $TOKEN " \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/assessment-results/asmtres-cHh5777xm/log-output