Register Instance

PUT /registry-svc/instance

Registers an instance. Idempoent.

Request

required

deploymentId stringrequired

The ID of the deployment that this instance is an instance of.

host string

Host of the instance address. Required if URL is not provided

id stringrequired

ip string

IP of the instance address. Optional: to register by IP instead of host

path string

Path of the instance address. Optional (e.g., "/api")

port integer

Port of the instance address. Required if URL is not provided

scheme string

Scheme of the instance address. Required if URL is not provided.

url stringrequired

Full address URL of the instance.

Created

Schema

object

{}

Invalid JSON

Schema

error string

{
  "error": "string"
}

Unauthorized

Schema

error string

{
  "error": "string"
}

Internal Server Error

Schema

error string

{
  "error": "string"
}