Harthelm Docs
REST APIManaged services

List the team's managed services

Needs `team.view`. Standalone instances and the ones bound to the team's landscapes (`workspace_id` set; a landscape's `managed` services in `harthelm.yml`), ordered by name. Tombstones (status `deleted`, kept `marketplace.tombstoneDays`, default 7) only with `include_deleted`. Secrets are never returned.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/teams/{team}/managed-services

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Path Parameters

team*integer

Numeric resource id.

Formatint64
Range1 <= value

Query Parameters

workspace?integer

Only the instances bound to this workspace's landscape.

Formatint64
Range1 <= value
include_deleted?boolean

Add the recently deleted instances (tombstones).

Defaultfalse
limit?integer

Maximum number of items per page.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from next_cursor of the previous page.

Lengthlength <= 1024

Response Body

A page of managed services.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/teams/1/managed-services'
{  "next_cursor": "string",  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "team_id": 1,      "workspace_id": 1,      "name": "string",      "provider": "string",      "provider_version": "string",      "plan": "string",      "resources": {        "property1": 0,        "property2": 0      },      "config": {},      "secrets": [        {          "name": "string",          "vault_key": "string",          "revision": 1,          "rotated_at": "2019-08-24T14:15:22Z"        }      ],      "details": {},      "status": "creating",      "status_detail": "string",      "paused": true,      "backups": true,      "public": true,      "browser": {        "url": "http://example.com",        "kind": "management",        "public": true,        "public_allowed": true,        "sso": true      },      "last_dump_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "created_by": 1,      "updated_at": "2019-08-24T14:15:22Z",      "deleted_at": "2019-08-24T14:15:22Z",      "purge_after": "2019-08-24T14:15:22Z"    }  ]}

The history of a managed service

Needs `team.view`. What the platform did and what the backend reported, newest first.

List managed-service providers

With `team` (needs `team.view`): the team's catalog, the enabled providers offered to the team; one the cluster cannot run (no CNPG operator for PostgreSQL) is listed with `available` false and the reason, so the console can show why. Without `team`: every provider version, disabled ones included (cluster admins only, 403 otherwise). Ordered by display name, then name and version.