Get Activity Log

JFrog REST APIs

Content Type
REST API

Description: Returns activity logs, with optional sorting and filtering parameters.

Since: AppTrust 1.16.4

Usage: GET https://{{artifactory-host}}/apptrust/api/v1/activity/log

Query Parameters (optional):

Note

All array parameters can be specified multiple times separated by commas.

Parameter

Type

Description

application_key

array:string

Filters by application key.

project_key

array:string

Filters by project key.

timestamp_from

integer

Filter by timestamp from (UNIX timestamp).

timestamp_to

integer

Filter by timestamp to (UNIX timestamp).

subject_type

array:string

Filters by subject type.

subject_name

string

Filters by subject name.

event_type

array:string

Filters by event type.

event_category

array:string

Filters by event category.

result

array:string

Filters by result (success, failure, warning).

prefix

string

Filters by prefix.

sort_by

string

Defines the field by which to sort results (timestamp, event_id, subject_type, subject_name, event_type, event_category, project_key, created_by).

The default is timestamp.

sort

string

Defines the sort direction (asc, desc).

The default is desc.

Request Body:

Parameter

Type

Description

event_id

string

The unique identifier for the activity log entry.

application_key

string

The key of the associated application, if applicable.

application_name

string

The display name of the associated application.

project_key

string

The key of the associated project.

project_name

string

The display name of the associated project.

timestamp

integer

The UNIX timestamp when the event occurred.

subject_type

string

The type of subject that triggered the event.

subject_name

string

The name of the subject that triggered the event.

event_description

string

The event description.

event_type

string

The event type.

event_category

string

The event category.

created_by

string

The user who initiated the event.

result

string

The result of the event (success, failure, warning).

additional_data

string

Additional structured data related to the event.

Sample Request:

GET 'https://{host}.jfrog.io/apptrust/api/v1/activity/log?project_key=catalina&event_category=lifecycle&sort_by=timestamp&sort=desc' Authorization: •••••• 

Sample Response:

[
  {
    "event_id": "01HN1234567890ABCDEFGHIJK",
    "timestamp": 1672531200000,
    "subject_type": "application",
    "subject_name": "catalina-app",
    "event_description": "Application version 1.2.0 promoted to QA",
    "event_type": "promote",
    "event_category": "lifecycle",
    "result": "success",
    "additional_data": {
      "version": "1.2.0",
      "stage": "QA"
    },
    "created_by": "admin@example.com",
    "application_key": "catalina-app",
    "application_name": "Catalina App",
    "project_key": "catalina",
    "project_name": "Catalina Project"
  },
  {
    "event_id": "01HN0987654321ZYXWVUTSRQP",
    "timestamp": 1672527600000,
    "subject_type": "application",
    "subject_name": "catalina-app",
    "event_description": "Application created successfully",
    "event_type": "create",
    "event_category": "lifecycle",
    "result": "success",
    "additional_data": {},
    "created_by": "admin@example.com",
    "application_key": "catalina-app",
    "application_name": "Catalina App",
    "project_key": "catalina",
    "project_name": "Catalina Project"
  }
]

Status Codes:

Code

Description

200

Success

400

Bad Request

401

Bad Credentials

403

Permission Denied

500

Internal Server Error