Connections

Retrieve status of a specific connection

GET

https://ditto.eclipseprojects.io/api/2/connections/{connectionId}/status

Returns the status of the connection identified by the connectionId path parameter.

curl -X GET 'https://ditto.eclipseprojects.io/api/2/connections/string/status' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://ditto.eclipseprojects.io/api/2/connections/string/status', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://ditto.eclipseprojects.io/api/2/connections/string/status',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

{
  "connectionId": "string",
  "connectedSince": "2019-01-21T08:57:24.710Z",
  "clientStatus": [
    {
      "type": "client",
      "client": "string",
      "address": "string",
      "status": "open",
      "statusDetails": "string",
      "inStateSince": "string"
    }
  ],
  "sourceStatus": [
    {
      "type": "client",
      "client": "string",
      "address": "string",
      "status": "open",
      "statusDetails": "string",
      "inStateSince": "string"
    }
  ],
  "targetStatus": [
    {
      "type": "client",
      "client": "string",
      "address": "string",
      "status": "open",
      "statusDetails": "string",
      "inStateSince": "string"
    }
  ],
  "sshTunnelStatus": [
    {
      "type": "client",
      "client": "string",
      "address": "string",
      "status": "open",
      "statusDetails": "string",
      "inStateSince": "string"
    }
  ]
}

{
  "status": 0,
  "error": "string",
  "message": "string",
  "description": "string",
  "href": "string"
}

{
  "status": 0,
  "error": "string",
  "message": "string",
  "description": "string",
  "href": "string"
}

{
  "status": 0,
  "error": "string",
  "message": "string",
  "description": "string",
  "href": "string"
}

{
  "status": 0,
  "error": "string",
  "message": "string",
  "description": "string",
  "href": "string"
}

Parameters

connectionIdstringrequiredpath

The ID of the connection

Response

200OKConnectionStatus

The request successfully returned the connection status.

Response fields application/json

Status of a connection and its resources

connectionIdstringrequired

The connection ID

connectionStatusConnectivityStatusrequired

The desired/target status of the connection

Show child attributes

The status of a connection or resource

ConnectivityStatusopenclosedfailedmisconfiguredunknown

liveStatusConnectivityStatusrequired

The current/actual status of the connection

Show child attributes

The status of a connection or resource

ConnectivityStatusopenclosedfailedmisconfiguredunknown

connectedSincestringrequired

The timestamp since when the connection is connected

Example

2019-01-21T08:57:24.710Z

clientStatusArray<ResourceStatus>

The client states of the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

sourceStatusArray<ResourceStatus>

The states of the sources the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

targetStatusArray<ResourceStatus>

The states of the targets the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

sshTunnelStatusArray<ResourceStatus>

The states of the ssh tunnel the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

400Bad RequestAdvancedError

The request could not be completed. The connectionId must be an URI.

Response fields application/json

statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

401UnauthorizedAdvancedError

The request could not be completed due to missing authentication.

Response fields application/json

statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

403ForbiddenAdvancedError

The request could not be completed due to invalid authentication.

Response fields application/json

statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

404Not FoundAdvancedError

The request could not be completed. The connection with ID connectionId was not found.

Response fields application/json

statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

Authorization

DevOpsBasichttp (basic)

Eclipse Ditto devops user (devops) + password (foobar)

DevOpsBearerhttp (bearer)

A JSON Web Token issued by a supported OAuth 2.0 Identity Provider for the Eclipse Ditto devops user.

Docs by Sourcey