Jump to

• Request
• Response

Instances Health Check Create

post

/api/v2/instances/{id}/health_check/

Manually Initiate a Health Check

For purposes of error remediation or debugging, a health check can be manually initiated by making a POST request to this endpoint.

This will submit the work unit to the target node through the receptor mesh and wait for it to finish. The model will be updated with the result. Up-to-date values of the fields will be returned in the response data.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : InstanceHealthCheck

Type: object

Show Source

• capacity: integer
  Title: Capacity

  Read Only: true
• cpu: string(decimal)
  Title: Cpu

  Read Only: true
• cpu_capacity: integer
  Title: Cpu capacity

  Read Only: true
• errors: string
  Title: Errors

  Read Only: true

  Minimum Length: 1

  Any error details from the last health check.
• hostname: string
  Title: Hostname

  Read Only: true

  Minimum Length: 1
• ip_address: string
  Title: Ip address

  Read Only: true

  Minimum Length: 1
• last_health_check: string(date-time)
  Title: Last health check

  Read Only: true

  Last time a health check was ran on this instance to refresh cpu, memory, and capacity.
• mem_capacity: integer
  Title: Mem capacity

  Read Only: true
• memory: integer
  Title: Memory

  Read Only: true

  Total system memory of this instance in bytes.
• uuid: string
  Title: Uuid

  Read Only: true

  Minimum Length: 1
• version: string
  Title: Version

  Read Only: true

  Minimum Length: 1

{
    "properties":{
        "capacity":{
            "readOnly":true,
            "title":"Capacity",
            "type":"integer"
        },
        "cpu":{
            "format":"decimal",
            "readOnly":true,
            "title":"Cpu",
            "type":"string"
        },
        "cpu_capacity":{
            "readOnly":true,
            "title":"Cpu capacity",
            "type":"integer"
        },
        "errors":{
            "description":"Any error details from the last health check.",
            "minLength":"1",
            "readOnly":true,
            "title":"Errors",
            "type":"string"
        },
        "hostname":{
            "minLength":"1",
            "readOnly":true,
            "title":"Hostname",
            "type":"string",
            "x-nullable":true
        },
        "ip_address":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ip address",
            "type":"string",
            "x-nullable":true
        },
        "last_health_check":{
            "description":"Last time a health check was ran on this instance to refresh cpu, memory, and capacity.",
            "format":"date-time",
            "readOnly":true,
            "title":"Last health check",
            "type":"string",
            "x-nullable":true
        },
        "mem_capacity":{
            "readOnly":true,
            "title":"Mem capacity",
            "type":"integer"
        },
        "memory":{
            "description":"Total system memory of this instance in bytes.",
            "readOnly":true,
            "title":"Memory",
            "type":"integer"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string",
            "x-nullable":true
        },
        "version":{
            "minLength":"1",
            "readOnly":true,
            "title":"Version",
            "type":"string",
            "x-nullable":true
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : InstanceHealthCheck

Type: object

Show Source

• capacity: integer
  Title: Capacity

  Read Only: true
• cpu: string(decimal)
  Title: Cpu

  Read Only: true
• cpu_capacity: integer
  Title: Cpu capacity

  Read Only: true
• errors: string
  Title: Errors

  Read Only: true

  Minimum Length: 1

  Any error details from the last health check.
• hostname: string
  Title: Hostname

  Read Only: true

  Minimum Length: 1
• ip_address: string
  Title: Ip address

  Read Only: true

  Minimum Length: 1
• last_health_check: string(date-time)
  Title: Last health check

  Read Only: true

  Last time a health check was ran on this instance to refresh cpu, memory, and capacity.
• mem_capacity: integer
  Title: Mem capacity

  Read Only: true
• memory: integer
  Title: Memory

  Read Only: true

  Total system memory of this instance in bytes.
• uuid: string
  Title: Uuid

  Read Only: true

  Minimum Length: 1
• version: string
  Title: Version

  Read Only: true

  Minimum Length: 1

{
    "properties":{
        "capacity":{
            "readOnly":true,
            "title":"Capacity",
            "type":"integer"
        },
        "cpu":{
            "format":"decimal",
            "readOnly":true,
            "title":"Cpu",
            "type":"string"
        },
        "cpu_capacity":{
            "readOnly":true,
            "title":"Cpu capacity",
            "type":"integer"
        },
        "errors":{
            "description":"Any error details from the last health check.",
            "minLength":"1",
            "readOnly":true,
            "title":"Errors",
            "type":"string"
        },
        "hostname":{
            "minLength":"1",
            "readOnly":true,
            "title":"Hostname",
            "type":"string",
            "x-nullable":true
        },
        "ip_address":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ip address",
            "type":"string",
            "x-nullable":true
        },
        "last_health_check":{
            "description":"Last time a health check was ran on this instance to refresh cpu, memory, and capacity.",
            "format":"date-time",
            "readOnly":true,
            "title":"Last health check",
            "type":"string",
            "x-nullable":true
        },
        "mem_capacity":{
            "readOnly":true,
            "title":"Mem capacity",
            "type":"integer"
        },
        "memory":{
            "description":"Total system memory of this instance in bytes.",
            "readOnly":true,
            "title":"Memory",
            "type":"integer"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string",
            "x-nullable":true
        },
        "version":{
            "minLength":"1",
            "readOnly":true,
            "title":"Version",
            "type":"string",
            "x-nullable":true
        }
    },
    "type":"object"
}

Back to Top