Skip to content
NebulaCtrldocs
HTTP APIEndpoints

Activity

The organization's audit trail. Each operation lists its method and path, parameters, request body, responses and an example call.

List the signed-in organization's audit trail, newest first.

GET/api/v1/activity

Authorization

AuthorizationBearer <token>

An API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.

In: header

Query Parameters

action?string

Only events whose action equals this value, for example release.create.

actorId?string

Only events performed by this actor id.

projectId?string

Only events belonging to this project, directly or through their environment, service or release.

q?string

Free-text filter over the action, the actor id, and the target's readable fields (slugs, names, hostnames, image references).

from?string

Only events at or after this RFC 3339 time.

to?string

Only events at or before this RFC 3339 time.

kind?string

Only events of this kind: deploy (releases, deployments, approvals, builds, restarts), config (projects, environments, services, variables, domains, volumes, integrations), access (members, invitations, tokens, sessions) or cluster (clusters and nodes).

Value in

  • "deploy"
  • "config"
  • "access"
  • "cluster"
cursor?string

Opaque cursor from a previous response's nextCursor. Omit for the first page.

limit?integer

How many items to return.

Formatint64
Range1 <= value <= 200
Default50

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/v1/activity"
{  "$schema": "https://example.com/ActivityPage.json",  "items": [    {      "action": "string",      "actorId": "string",      "actorType": "string",      "after": null,      "at": "2019-08-24T14:15:22Z",      "before": null,      "id": "string",      "organizationId": "string",      "target": null    }  ],  "nextCursor": "string",  "total": 0}

Stream the signed-in organization's audit trail, filtered the same way as listActivity, as CSV.

GET/api/v1/activity/export

Authorization

AuthorizationBearer <token>

An API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.

In: header

Query Parameters

action?string

Only events whose action equals this value, for example release.create.

actorId?string

Only events performed by this actor id.

projectId?string

Only events belonging to this project, directly or through their environment, service or release.

q?string

Free-text filter over the action, the actor id, and the target's readable fields (slugs, names, hostnames, image references).

from?string

Only events at or after this RFC 3339 time.

to?string

Only events at or before this RFC 3339 time.

kind?string

Only events of this kind: deploy (releases, deployments, approvals, builds, restarts), config (projects, environments, services, variables, domains, volumes, integrations), access (members, invitations, tokens, sessions) or cluster (clusters and nodes).

Value in

  • "deploy"
  • "config"
  • "access"
  • "cluster"

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/v1/activity/export"
Empty

Updates

The installed version, newer releases, and updating the control plane. Each operation lists its method and path, parameters, request body, responses and an example call.

Agent

The endpoints a cluster's agent and the install scripts call. They authenticate with agent and enrollment tokens, not with API tokens. Each operation lists its method and path, parameters, request body, responses and an example call.