Get the TLS certificate of a managed database and its automatic renewal status

GET

/api/databases/managed/{id}/certificate

curl --request GET \
  --url https://gateway.example.com/api/databases/managed/550e8400-e29b-41d4-a716-446655440000/certificate \
  --header 'Authorization: Bearer <token>'

• Your Gateway instance

Shows expiry, the renewal state and the last renewal error. Gateway renews the certificate while the database runs (two thirds into its lifetime or 30 days before expiry) without a restart.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Responses

200

Successful response

Media typeapplication/json

object

data

required

object

ownerType

required

string

Allowed values: managed_storage managed_database

ownerId

required

string

certificate

required

object

id

required

string

serialNumber

required

string

notBefore

required

string

notAfter

required

string

daysRemaining

required

integer

sans

required

Array<string>

renewal

required

object

state

required

Idle, delivering, awaiting_reload (delivered, the engine rereads it on its own schedule), waiting_for_daemon, ca_limited (the issuing CA ends first) or failed

string

reason

required

string | null

due

required

boolean

dueReason

required

Lifetime (2/3 passed), expiring (30 days or less), names_missing, ca_changed, or null

string | null

urgent

required

7 days or less remain: a restart is allowed to apply it

boolean

hotReloadSupported

required

boolean

skipReason

required

string | null

attempts

required

integer

lastAttemptAt

required

string | null

nextAttemptAt

required

string | null

deliveredAt

required

string | null

lastSuccessAt

required

string | null

lastError

required

string | null

lastMethod

required

string | null

lastRestarted

required

boolean

pendingSerial

required

string | null

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Production Postgres",
    "type": "postgres",
    "healthStatus": "online"
  }
}

400

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"
    }
  ]
}

401

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"
}

403

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"
}

404

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"
}

409

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"
}

422

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"
}

500

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"
}