Reference: Activity metadata

Information about an activity.

You can get information about activities that occur in your Snaplex through the public API GET /activities/{env_org}.

The response has an entries component, which includes several of the following information:

Key Type Description
_id string The ID of the activity.
asset_label string The label or name of the asset.
asset_path string The path to the affected asset.

Format: /{env_org}/{project_space}/{project_name}

asset_type string The type of the asset affected by the activity's action.
Possible values:
  • API
  • Dir
  • Plex
  • Proxy
by_whom string The entity that performed the activity.
create_time string The time when the activity's action was performed. Format: UTC
display_type string The type of the information, which indicates how it should be displayed.
Possible values:
  • Proxy
event_type string The type of event or activity that occurred.
Possible values:
  • Session events:
    • session_start
    • session_end
    • sso_session_start
  • Asset events:
    • asset_create
    • asset_delete
    • asset_rename
    • asset_update
    • asset_owner_change
    • asset_move
    • asset_access
  • User events:
    • user_create
    • user_update
    • user_delete
    • user_auth_failure
    • user_lockout
    • user_unlock
    • password_change
    • password_reset
  • Group events:
    • group_create
    • group_update
    • group_delete
  • Org events:
    • org_add_user
    • org_remove_user
    • org_provision
    • org_concurrent_call_limit
    • org_settings_update
  • Policy events:
    • policy_create
    • policy_update
    • policy_delete
  • Security (ACL) events:
    • acl_add
    • acl_remove
  • Snaplex events:
    • plex_node_add
    • plex_node_restart
    • plex_node_crash
    • plex_node_enter_maintenance_mode
    • plex_node_leave_maintenance_mode
    • plex_version_update
    • plex_pipeline_interrupter
    • cluster_initiated
    • cluster_idle
    • cluster_terminated
    • cluster_unknown
  • Project events:
    • project_pipeline_validation
  • Distribution events:
    • dist_change
    • dist_override
    • dist_subscribe
  • APIM events:
    • publish_version
    • unpublish_version
    • deprecate_version
    • retire_version
    • publish_proxy
    • unpublish_proxy
    • deprecate_proxy
    • retire_proxy
    • approve_devportal_user
    • pending_devportal_user
    • deny_devportal_user
    • remove_devportal_user
    • pending_subscription
    • approve_subscription
    • deny_subscription
    • revoke_subscription
    • application_subscription_update
    • subscription_token_update
  • Git events:
    • git_checkout
    • git_commit
    • git_checkout_overwrite
    • git_pull
    • git_untrack
  • SnapGPT events:
    • snapgpt_analyze_pipeline
    • snapgpt_describe_pipeline
    • snapgpt_generate_expression
    • snapgpt_generate_pipeline
    • snapgpt_qna
    • snapgpt_refine_pipeline
    • snapgpt_refine_snap
  • Admin events:
    • snaplogic_admin_update
group_name string The name of the group to manage.
ip_address string

In Session events: The IP address of the user that started the session.

In Snaplex events: The IP address of the Snaplex.

new_name string If event_type is asset_rename, the new name of the asset.
org_label string The label or name of the Environment/Org where the activity occurred.
parent_path string The path to the parent of the activity.

Format: /{env_org}/{project_space}

parent_type string The type of the parent activity. Possible values:
  • apim
  • Project
partition_label string
perm » perms array An array containing one or more of the following permissions:
  • "R" – read
  • "W" – write
  • "X" – execute

Learn more: Permissions in Manager and in APIs

perm » subject_type string The type of the subject.
Possible values:
  • USER
perm » inherit Boolean If true, the permissions assigned to the project or project space also apply to all assets under it.
perms_entry string

perm » subject

perms_subject

string The user or asset to be assigned the permissions.
project_label string The label or name of the Project where the activity occurred.
snaplogic_admin_update Boolean
template string The template for the log message that describes the activity.
user_id string

Session events: The same value as by_whom.

User events: The username or email address associated with the user account being managed.