Skip to content

Get managed database binding runtime

GET
/api/databases/managed/{id}/bindings/{bindingId}/runtime
curl --request GET \
--url https://gateway.example.com/api/databases/managed/550e8400-e29b-41d4-a716-446655440000/bindings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/runtime \
--header 'Authorization: Bearer <token>'

The link’s Relay counters and its connections as the node running the workload reports them: activeStreams are the link’s open connections (it carries up to 64), openedTotal and the byte counters what it carried through that node, throttledTotal counts the connections refused at that limit by the node or a relay. connections is null while that node’s daemon does not report links. Needs databases:view and view access to the linked workload.

id
required
string
>= 1 characters
Example
550e8400-e29b-41d4-a716-446655440000
bindingId
required
string format: uuid

Successful response

Media typeapplication/json
object
data
required

Resource object. Exact fields depend on the endpoint.

object
id
string
name
string
key
additional properties
Example
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Production Postgres",
"type": "postgres",
"healthStatus": "online"
}
}

Bad request

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"path": [
"name"
],
"message": "Required"
}
]
}

Authentication required

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNAUTHORIZED",
"message": "Authentication required"
}

Forbidden

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "FORBIDDEN",
"message": "Insufficient permissions"
}

Not found

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "NOT_FOUND",
"message": "Resource not found"
}

Conflict

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "CONFLICT",
"message": "Resource already exists"
}

Unprocessable entity

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNPROCESSABLE_ENTITY",
"message": "Request could not be processed"
}

Internal server error

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}