System

System Service handles the API for health checks and version.

health system

get

Check server health

Responses

200

OK response.

No content

get/api/health

GET /api/health HTTP/1.1
Host: localhost:80
Accept: */*

200

OK response.

No content

latest-plugin-version system

post

Get the latest plugin version

Body

Plugin Reported Version

commitstringRequired

Build identifier

Example: 96381692bf3a2bd7904769c6886e832435768b57

versionstringRequired

Version number

Example: v0.123.0

Responses

200

OK response.

application/json

Plugin version

commitstringOptional

Build identifier

Example: 96381692bf3a2bd7904769c6886e832435768b57

versionstringOptional

Version number

Example: 0.2.0

post/api/latest-plugin-version

POST /api/latest-plugin-version HTTP/1.1
Host: localhost:80
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "commit": "96381692bf3a2bd7904769c6886e832435768b57",
  "version": "v0.123.0"
}

200

OK response.

{
  "commit": "96381692bf3a2bd7904769c6886e832435768b57",
  "version": "0.2.0"
}

get-provisioner-config system

get

Get provisioner configuration with supported versions and settings.

Path parameters

provisionerstring · enumRequired

Provisioner type to get configuration for.

Example: allPossible values:

Responses

200

OK response.

application/json

Provisioner configuration response

get/api/provisioners/{provisioner}/config

GET /api/provisioners/{provisioner}/config HTTP/1.1
Host: localhost:80
Accept: */*

200

OK response.

{
  "awscdk": {
    "versions": {
      "Eius veritatis repudiandae rem.": {
        "languages": {
          "Autem porro id enim ea.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          },
          "Ipsum sunt autem natus est possimus.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          },
          "Nesciunt vel eveniet qui sit laborum odio.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          }
        }
      },
      "Explicabo quia.": {
        "languages": {
          "Autem porro id enim ea.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          },
          "Ipsum sunt autem natus est possimus.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          },
          "Nesciunt vel eveniet qui sit laborum odio.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          }
        }
      },
      "Unde maxime sequi voluptates facere.": {
        "languages": {
          "Autem porro id enim ea.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          },
          "Ipsum sunt autem natus est possimus.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          },
          "Nesciunt vel eveniet qui sit laborum odio.": {
            "versions": {
              "Autem omnis.": {
                "package_manager": {
                  "Aliquam ipsam.": [
                    "Quaerat cumque sed.",
                    "Voluptas aut ut ipsum ipsa nam.",
                    "Aut ab aperiam iure esse."
                  ],
                  "Autem est magni quaerat fugit atque eveniet.": [
                    "Voluptas tempore labore voluptates exercitationem distinctio.",
                    "Blanditiis voluptates eligendi aut ut corporis facere."
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "opentofu": {
    "versions": [
      "Ipsum rem corporis voluptatem quia.",
      "Tempore quisquam dicta itaque."
    ]
  },
  "terraform": {
    "versions": [
      "Dignissimos reprehenderit cum enim at corporis et.",
      "Maiores sit.",
      "Repellat expedita.",
      "Sequi dolores voluptas."
    ]
  },
  "terragrunt": {
    "versions": [
      "Nihil aut consequatur ducimus voluptatem suscipit quidem.",
      "Et inventore.",
      "Aliquid nihil ipsam.",
      "Quas ea quasi eum quae."
    ]
  }
}

list-supported-provisioner-versions system

get

List supported provisioner versions.

Path parameters

provisionerstring · enumRequired

Provisioner defines the provisioning tool to use.

Example: terragruntPossible values:

Responses

200

OK response.

application/json

string[]OptionalExample: ["Molestiae et itaque quia possimus qui.","Dolorum perferendis reiciendis et sint laborum."]

get/api/provisioners/supported/{provisioner}

GET /api/provisioners/supported/{provisioner} HTTP/1.1
Host: localhost:80
Accept: */*

200

OK response.

[
  "Ab expedita.",
  "Iste est eos.",
  "Aperiam aut ea qui perspiciatis.",
  "Explicabo iste quaerat cupiditate exercitationem."
]

version system

get

Get server version

Responses

200

OK response.

application/json

Service version

commitstringRequired

Build identifier

Example: 96381692bf3a2bd7904769c6886e832435768b57

deployment_modestring · enumRequired

Determines if the service is running on saas or smp

Example: saasPossible values:

versionstringRequired

Version number

Example: v0.123.0

get/api/version

GET /api/version HTTP/1.1
Host: localhost:80
Accept: */*

200

OK response.

{
  "commit": "96381692bf3a2bd7904769c6886e832435768b57",
  "deployment_mode": "saas",
  "version": "v0.123.0"
}