API
Portal: resources, groups, tags and dashboards
Every resource of an organization in one list, resource groups and tags, each resource's activity and access, your favourite services and recent resources, and dashboards.
What Cloud's portal is built on. Resources are addressed by kind and reference: project (a Serverless App Service, by its id), database and bucket (by resource id), domain (by hostname), repository (by resource id) and agent (by device id). Favourites, recent resources and dashboards are per person; people only, not keys.
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
GET /v1/orgs/:orgId/portal/resources | Every resource of the org you may read, of every kind (Serverless App Services, databases, buckets, domains, repositories, agents), with its resource group and tags. q keeps those with every word in their name, details, id or tags; kind, group (a resource group id, or none) and tag (key or key=value) filter; limit caps the list (default 500). total and counts (by kind) are of every resource you may read, before filters. |
GET /v1/orgs/:orgId/portal/resources/:kind/:ref | One resource with its resource group and tags. |
PUT /v1/orgs/:orgId/portal/resources/:kind/:ref | Sets a resource's resource group (groupId, or null for none) and its tags (tags: up to 20 { key, value }, keys unique; replaces them all). Needs the right to change that resource. |
GET /v1/orgs/:orgId/portal/resources/:kind/:ref/activity | What happened to a resource, newest first: its entries in the org's audit log, filtered like the log (action, actor) and paged (cursor, limit). Readable by those who may read the resource. |
GET /v1/orgs/:orgId/portal/resources/:kind/:ref/access | Who can reach a resource: each member, their role and what that role lets them do with it (manage, change or read), and the groups whose grants widen access to a Serverless App Service or a repository. Roles are changed in Tenant. |
GET /v1/orgs/:orgId/portal/groups | The org's resource groups. |
POST /v1/orgs/:orgId/portal/groups | Creates a resource group (name, optional description). Needs resources:write. |
PATCH /v1/orgs/:orgId/portal/groups/:resourceGroupId | Renames a resource group or changes its description. Needs resources:write. |
DELETE /v1/orgs/:orgId/portal/groups/:resourceGroupId | Deletes a resource group; its resources stay, outside any group. Needs resources:write. |
GET /v1/orgs/:orgId/portal/me | Your portal in this org: favourite services in order (null: the defaults), recent resources and the dashboard Dashboard opens. People only. |
PUT /v1/orgs/:orgId/portal/me | Saves your favourite services (favourites: service keys in order, null for the defaults) or the dashboard Dashboard opens (dashboardId). |
POST /v1/orgs/:orgId/portal/me/recent | Records that you opened a resource (kind, ref), for Recent. |
GET /v1/orgs/:orgId/portal/dashboards | Dashboards you can open: yours and those shared with the organization (without their tiles). |
POST /v1/orgs/:orgId/portal/dashboards | Creates a dashboard (name, optional shared and tiles); yours alone unless shared. |
GET /v1/orgs/:orgId/portal/dashboards/:dashboardId | A dashboard with its tiles. |
PUT /v1/orgs/:orgId/portal/dashboards/:dashboardId | Changes a dashboard: name, shared (owners only) and tiles (replaced; positions are compacted). |
DELETE /v1/orgs/:orgId/portal/dashboards/:dashboardId | Deletes a dashboard (its owner, or for a shared one those who manage the organization). |