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

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": {
      "Sit voluptates quibusdam necessitatibus quis aliquid dicta.": {
        "languages": {
          "Beatae et nisi voluptatem eius voluptas mollitia.": {
            "versions": {
              "Quo ex alias velit sed non excepturi.": {
                "package_manager": {
                  "Placeat atque voluptas sint aspernatur incidunt veniam.": [
                    "Praesentium at aut laborum maiores sint.",
                    "Et occaecati repellendus consequatur numquam neque soluta.",
                    "Numquam blanditiis.",
                    "Placeat reiciendis quia est saepe."
                  ]
                }
              },
              "Sed rem id omnis quia aut dolor.": {
                "package_manager": {
                  "Placeat atque voluptas sint aspernatur incidunt veniam.": [
                    "Praesentium at aut laborum maiores sint.",
                    "Et occaecati repellendus consequatur numquam neque soluta.",
                    "Numquam blanditiis.",
                    "Placeat reiciendis quia est saepe."
                  ]
                }
              }
            }
          },
          "Illum aut labore iste consequatur.": {
            "versions": {
              "Quo ex alias velit sed non excepturi.": {
                "package_manager": {
                  "Placeat atque voluptas sint aspernatur incidunt veniam.": [
                    "Praesentium at aut laborum maiores sint.",
                    "Et occaecati repellendus consequatur numquam neque soluta.",
                    "Numquam blanditiis.",
                    "Placeat reiciendis quia est saepe."
                  ]
                }
              },
              "Sed rem id omnis quia aut dolor.": {
                "package_manager": {
                  "Placeat atque voluptas sint aspernatur incidunt veniam.": [
                    "Praesentium at aut laborum maiores sint.",
                    "Et occaecati repellendus consequatur numquam neque soluta.",
                    "Numquam blanditiis.",
                    "Placeat reiciendis quia est saepe."
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "opentofu": {
    "versions": [
      "Magni quo sed ea.",
      "Iure odio in earum dolore esse id.",
      "Distinctio iure provident aut.",
      "Qui aperiam consequatur est dolores consequatur."
    ]
  },
  "terraform": {
    "versions": [
      "Inventore incidunt asperiores quisquam.",
      "Possimus quo."
    ]
  },
  "terragrunt": {
    "versions": [
      "Ut quia voluptas eaque.",
      "Eum in aperiam et consequuntur."
    ]
  }
}

list-supported-provisioner-versions system

get

List supported provisioner versions.

Path parameters
provisionerstring · enumRequired

Provisioner defines the provisioning tool to use.

Example: awscdkPossible values:
Responses
200

OK response.

application/json
string[]OptionalExample: ["Maiores quia fugiat ut quo.","Ut earum et.","Tempore unde praesentium sapiente enim quae."]
get/api/provisioners/supported/{provisioner}
GET /api/provisioners/supported/{provisioner} HTTP/1.1
Host: localhost:80
Accept: */*
200

OK response.

[
  "Non totam.",
  "Sit voluptates vel cupiditate nemo aliquid eum.",
  "Ea temporibus blanditiis earum."
]

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": "smp",
  "version": "v0.123.0"
}

Last updated

Was this helpful?