Skip to main content

List Service Instances

GET 
/registry-svc/instances

Retrieves a list of all instances or filters them by specific criteria (e.g., host, IP).

Request​

Query Parameters

    scheme string

    Scheme to filter by

    ip string

    IP to filter by

    deploymentId string

    Deployment ID to filter by

    host string

    Host to filter by

    ip string

    IP to filter by

    id string

    Id to filter by

Responses​

OK

Schema

    instances

    object[]

  • Array [

    • deploymentId stringrequired

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

    details string

    Details

    host string

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

    id stringrequired

    Required: ID of the instance

    ip string

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

    lastHeartbeat string

    Last time the instance gave a sign of life

    nodeUrl string

    URL of the Superplatform daemon

    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.

    status stringrequired

    Possible values: [Unknown, Healthy, Degraded, Unreachable, Error]

    url stringrequired

    Full address URL of the instance.

  • ]

Loading...