Activity API

See the activity in your organization or environment.

List activity in an environment

List activity logs within an environment.

get

/ v1 / environments / :environment_id / activity

curl --request GET \
     --url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4/activity \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

environment_id

string

required

The ID of the environment. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Query Parameters

after

string

A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.

limit

integer (int64)

The maximum number of results to return. Must be between 1 and 240.

sort_by

enum

A base64 encoded cursor that can be used to paginate results. One of created_at, -created_at, +created_at, created_at.

Responses

200

OK response.

data

array (object)

required

An array of results.

Show attributes

created_at

string (date-time)

required

The time the activity was recorded.

data

object

Additional data.

Show attributes

object

environment_id

string

required

The environment in which the activity occurred. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

object

required

The object of the activity.

Show attributes

object

object_type

enum

required

The type of the object. One of environment, variable, deployment, service, component, component_binding.

subject

object

required

The account or API key that performed the action.

Show attributes

avatar

string

The avatar of the subject.

string

required

The ID of the account or API key. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name

string

required

The name of the subject.

subject_type

enum

required

The type of the subject. One of account, api_key, system.

timestamp

string (date-time)

required

The time the activity occurred.

verb

enum

required

The action performed. One of create, update, delete, deploy_started, deploy_succeeded, deploy_canceled, deploy_failed.

has_more

boolean

required

Whether there are more results available.

next_page

string

The cursor for the next page of results as a base64 encoded string. Must match the pattern ^[a-zA-Z0-9+/=]+$.

400

Bad Request response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

401

Unauthorized response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

403

Forbidden response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

404

Not Found response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

408

Request Timeout response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

409

Conflict response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

429

Too Many Requests response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

500

Internal Server Error response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

501

Not Implemented response.

cause

unknown

The cause of the error.

code

enum

required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

string

required

The message of the error.

API Reference

Explore the API reference by resource type