Harness

system

System version and health

system#health

Check service health

Securityx-api-key
Responses
204

No Content response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

get/pm/api/v1/system/health
Request samples 
system#version
Check service version


Securityx-api-key 
Responses 
200
OK response.


500
InternalServer: Internal Server Error response.


502
BadGateway: Bad Gateway response.


get/pm/api/v1/system/version
Request samples 
Response samples 
application/json
{
  • "commit": "96381692bf3a2bd7904769c6886e832435768b57",
  • "version": "v0.123.0"
}
health system
Check server health


Securityx-api-key 
Responses 
200
OK response.


get/iacm/api/health
Request samples 
latest-plugin-version system
Get the latest plugin version


Securityx-api-key 
Request 
Request Body schema: application/json
required
commit
required
string
Build identifier


 
deployment_mode
required
string
Determines if the service is running on saas or smp


 Enum: "saas" "smp"  
version
required
string
Version number


 
Responses 
200
OK response.


post/iacm/api/latest-plugin-version
Request samples 
application/json
{
  • "commit": "96381692bf3a2bd7904769c6886e832435768b57",
  • "deployment_mode": "smp",
  • "version": "v0.123.0"
}
Response samples 
application/json
{
  • "commit": "96381692bf3a2bd7904769c6886e832435768b57",
  • "version": "0.2.0"
}
list-supported-provisioner-versions system
List supported provisioner versions.


Securityx-api-key 
Request 
path Parameters
provisioner
required
string
Provisioner defines the provisioning tool to use.


 Enum: "terraform" "opentofu"  
 Example:  terraform
Responses 
200
OK response.


get/iacm/api/provisioners/supported/{provisioner}
Request samples 
Response samples 
application/json
[
  • "Cumque repellat culpa suscipit expedita.",
  • "Temporibus quo reprehenderit qui doloribus.",
  • "Quibusdam voluptatum.",
  • "Delectus voluptate veritatis et."
]
version system
Get server version


Securityx-api-key 
Responses 
200
OK response.


get/iacm/api/version
Request samples 
Response samples 
application/json
{
  • "commit": "96381692bf3a2bd7904769c6886e832435768b57",
  • "deployment_mode": "saas",
  • "version": "v0.123.0"
}
➔ Next to repository