Run Terraform Job

POST 
/v1/terraform/run_terraform_job

Run a terraform job

Request

application/json

Body

required

terraform_vm_region_id uuidrequired

The region ID of the region selected for the terraform job.

terraform_vm_disk_id uuidrequired

The disk ID of the disk selected for the terraform job.

terraform_vm_size_id uuidrequired

The size ID of the size selected for the terraform job.

terraform_vm_resource_group_id uuidrequired

The resource group ID of the resource group selected for the terraform job.

terraform_vm_operating_system_id uuidrequired

The operating system ID of the operating system selected for the terraform job.

terraform_vm_zone Terraform Vm Zone (integer)required

The zone of the region selected for the terraform job.

terraform_vm_count Terraform Vm Count (integer)required

The total number virtual machines assigned to the resource group

terraform_vm_routing Terraform Vm Routing (string)required

Possible values: non-empty and <= 64 characters

The routing preference for the virtual machine

terraform_user_name Terraform User Name (string)required

Possible values: non-empty and <= 64 characters

The user who triggered the terraform job.

terraform_vm_subnet_range Terraform Vm Subnet Range (string)required

Possible values: non-empty and <= 64 characters

The subnet range for the virtual machine

terraform_vm_org Terraform Vm Org (string)required

Possible values: non-empty and <= 64 characters

The organization name selected for the terraform job.

terraform_vm_product_guid uuidrequired

The product_guid selected for the terraform job.

terraform_vm_sandbox_guid uuidrequired

The sandbox guid selected for the terraform job.

terraform_vm_rhdeployment uuidrequired

The rhdeployment guid selected for the terraform job.

terraform_vm_site Terraform Vm Site (string)required

Possible values: non-empty and <= 64 characters

The site selected for the terraform job.

terraform_vm_fleet Terraform Vm Fleet (string)required

Possible values: non-empty and <= 64 characters

The fleet selected for the terraform job.he subnet range for the virtual machine

Responses

200

Successful Response

application/json

Schema

Schema

terraform_vm_region_id uuidrequired

The region ID of the region selected for the terraform job.

terraform_vm_disk_id uuidrequired

The disk ID of the disk selected for the terraform job.

terraform_vm_size_id uuidrequired

The size ID of the size selected for the terraform job.

terraform_vm_resource_group_id uuidrequired

The resource group ID of the resource group selected for the terraform job.

terraform_vm_operating_system_id uuidrequired

The operating system ID of the operating system selected for the terraform job.

terraform_user_name Terraform User Name (string)required

Possible values: non-empty and <= 64 characters

The name of the user that was logged in for the terraform job.

terraform_job_timestamp date-timerequired

The name of the user that was logged in for the terraform job.

terraform_job_raw_json Terraform Job Raw Json (string)required

Possible values: non-empty

Raw JSON data sent from portal.

terraform_job_record_id uuidrequired

Example (from schema)

{
  "terraform_vm_region_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "terraform_vm_disk_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "terraform_vm_size_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "terraform_vm_resource_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "terraform_vm_operating_system_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "terraform_user_name": "string",
  "terraform_job_timestamp": "2024-07-29T15:51:28.071Z",
  "terraform_job_raw_json": "string",
  "terraform_job_record_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...