How long activity history is kept for this Account

GET

/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/activity/retention

How many days of audit history the Account keeps (retention_days), resolved from its subscription plan by the same rule the nightly retention sweep enforces. Enterprise plans read their override. No operational capability is required. retention_days is null when the Account has no subscription or no usable retention policy.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Responses

application/json

dataWorkspaceActivityRetentionResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Returned object

WorkspaceActivityRetentionResponseDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/workspace/activity/retention" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Response

{
  "data": {
    "retention_days": 0
  }
}

GETResolve the caller's operational authority in the Environment
GETList identities within the caller's operational scope
GETList an identity's responsibilities within the caller's scope
GETList the identity roles the caller may grant
GETList the hierarchy locations the caller may assign at
GETList the hierarchy nodes the caller can see in this Environment
GETList identity invitations within the caller's scope
POSTInvite an identity into a location with a role
GETList scoped operational activity within the caller's scope
GETDownload the scoped activity feed as CSV
POSTResend a scoped invitation
DELETERevoke a scoped invitation
POSTGrant an identity a role at a hierarchy node
PATCHMove or re-role an existing assignment
DELETERemove an identity's role assignment

Was this page helpful?

Tell us how we can improve this guide.