System
System Service handles the API for health checks and version.
Get the latest plugin version
Body
Plugin Reported Version
commitstringRequiredExample:
Build identifier
96381692bf3a2bd7904769c6886e832435768b57versionstringRequiredExample:
Version number
v0.123.0Responses
200
OK response.
application/json
Plugin version
commitstringOptionalExample:
Build identifier
96381692bf3a2bd7904769c6886e832435768b57versionstringOptionalExample:
Version number
0.2.0post/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 configuration with supported versions and settings.
Path parameters
provisionerstring · enumRequiredExample:
Provisioner type to get configuration for.
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.
Path parameters
provisionerstring · enumRequiredExample:
Provisioner defines the provisioning tool to use.
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."
]Get server version
Responses
200
OK response.
application/json
Service version
commitstringRequiredExample:
Build identifier
96381692bf3a2bd7904769c6886e832435768b57deployment_modestring · enumRequiredExample:
Determines if the service is running on saas or smp
saasPossible values: versionstringRequiredExample:
Version number
v0.123.0get/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?