---
title: "Ping status of a instance."
method: POST
path: "/p2p/preheat/instances/ping"
tags: ["preheat"]
---

# Ping status of a instance.

`POST /p2p/preheat/instances/ping`

This endpoint checks status of a instance, the instance can be given by ID or Endpoint URL (together with credential)

## Headers

- `X-Request-Id` string

## Request body

- Instance
  - `id` integer — Unique ID
  - `name` string — Instance name
  - `description` string — Description of instance
  - `vendor` string — Based on which driver, identified by ID
  - `endpoint` string — The service endpoint of this instance
  - `auth_mode` string — The authentication way supported
  - `auth_info` object — The auth credential data if it exists. When updating an instance (PUT `/p2p/preheat/instances/{preheat_instance_name}`), if this object is omitted or empty and `auth_mode` is not `NONE`, the previously stored credentials are kept.
  - `status` string — The health status
  - `enabled` boolean — Whether the instance is activated or not
  - `default` boolean — Whether the instance is default or not
  - `insecure` boolean — Whether the instance endpoint is insecure or not
  - `setup_timestamp` integer — The timestamp of instance setting up

## Response `200`

Success

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Instance not found (when instance is provided by ID).
- `500` — Internal server error

---

[API](https://skmtc.dev/cerit/apis/harbor-api.md) · [All operations](https://skmtc.dev/cerit/apis/harbor-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cerit/harbor-api/revisions/62d78801f8df/schema)