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

    slug string

    Slug to filter by

Responses​

OK

Schema

    instances

    object[]

  • Array [

    • deploymentId string

    The ID of the deployment that this instance is an instance of. Only instances deployed by OpenOrch have a DeploymentId. Services can be deployed through other means (Docker Compose, K8s, anything), in that case they self-register and will not have a DeploymentId.

    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

    NodeURL is the URL of the OpenOrch daemon the instance is running on. To have a NodeURL the instance must either:

    • Be deployed by OpenOrch
    • Declare the OpenOrch daemon URL when registering its instance
    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.

    slug string

    Slug of the account that owns this instance Services that want to be proxied by their slug are advised to self register their instance at startup. Keep in mind, instances might be deployed by OpenOrch yet they still won't be OpenOrch services and they won't have slugs. Think NGINX, MySQL, etc.

    status stringrequired

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

    tags string[]

    Tags are used to filter instances

    url stringrequired

    Full address URL of the instance.

  • ]

Loading...