Skip to content

Home

Introduction

Development

IDEs

Services

Service manager

API Explorer

Integrate endpoint status

An endpoint's status indicates its current state and behavior. It only changes when an endpoint is started or stopped. Depending on the current status of an endpoint, some actions may or may not be performed. For instance, configuring an endpoint's properties or deleting it is not possible unless the endpoint is stopped.

Status types

There are five possible endpoint statuses:

  • STOPPED

    The status of endpoints that are not running. In this state, an endpoint will not listen for events.

  • PAUSED

  • STARTED

    The status of endpoints that are currently running. In this state, an endpoint will listen for events and will act as configured once an event is intercepted.

  • STARTED_WITH_ERROR

    The status of endpoints that have managed to start-up but encountered non-fatal errors.

  • ERROR

    The status of endpoints that have completely failed to start-up because of fatal errors.

  • UNRECOGNIZED

    The status of endpoints whose states are unknown; if an endpoint has this as its status, it most likely means that the EndpointManager has failed to set the status properly.

Configuration

An endpoint's state cannot be set manually; its value solely depends on what the EndpointManager assigns.

As discussed in the introductory page for Integrate endpoints, endpoints have statuses and they can be changed by starting or stopping an endpoint. In order to start or stop an endpoint, simply follow the steps below:

  1. If you need to start or stop multiple endpoints at the same time, select all endpoints that need to be started or stopped. For now, this is only possible in Coder Studio. Simply press the key while clicking on the names of the endpoints that need to be started or stopped under the Coder Navigator view.
  2. Right click on any endpoint you want to start or stop > Start or Stop.
  3. Confirm your action.

Starting Integrate endpoints

Starting an Integrate endpoint