1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website/docs/api/admin/events-api.md
Ivar Conradi Østhus d8478dd928
feat: clean up events (#1089)
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-11-12 13:15:51 +01:00

4.1 KiB

id title
events /api/admin/events

In order to access the admin API endpoints you need to identify yourself. Unless you're using the none authentication method, you'll need to create an ADMIN token and add an Authorization header using the token.

Events API

GET: http://unleash.host.com/api/admin/events

Used to fetch all changes in the unleash system.

Defined event types:

Feature Toggle events:

  • feature-created
  • feature-deleted
  • feature-updated
  • feature-metadata-updated
  • feature-project-change
  • feature-archived
  • feature-revived
  • feature-import
  • feature-tagged
  • feature-tag-import
  • feature-strategy-update
  • feature-strategy-add
  • feature-strategy-remove
  • drop-feature-tags
  • feature-untagged
  • feature-stale-on
  • feature-stale-off
  • drop-features
  • feature-environment-enabled
  • feature-environment-disabled

Strategy Events

  • strategy-created
  • strategy-deleted
  • strategy-deprecated
  • strategy-reactivated
  • strategy-updated
  • strategy-import
  • drop-strategies

Context field events

  • context-field-created
  • context-field-updated
  • context-field-deleted

Project events

  • project-created
  • project-updated
  • project-deleted
  • project-import
  • drop-projects

Tag events

  • tag-created
  • tag-deleted
  • tag-import
  • drop-tags

Tag type events

  • tag-type-created
  • tag-type-deleted
  • tag-type-updated
  • tag-type-import
  • drop-tag-types

Addon events

  • addon-config-created
  • addon-config-updated
  • addon-config-deleted

User events

  • user-created
  • user-updated
  • user-deleted

Environment events (Enterprise)

  • drop-environments
  • environment-import

Response

{
	"version": 2,
	"events": [{
		"id": 187,
		"type": "feature-metadata-updated",
		"createdBy": "admin",
		"createdAt": "2021-11-11T09:42:14.271Z",
		"data": {
			"name": "HelloEvents!",
			"description": "Hello Events update!",
			"type": "release",
			"project": "default",
			"stale": false,
			"variants": [],
			"createdAt": "2021-11-11T09:40:51.077Z",
			"lastSeenAt": null
		},
		"preData": {
			"name": "HelloEvents!",
			"description": "Hello Events!",
			"type": "release",
			"project": "default",
			"stale": false,
			"variants": [],
			"createdAt": "2021-11-11T09:40:51.077Z",
			"lastSeenAt": null
		},
		"tags": [{
			"value": "team-x",
			"type": "simple"
		}],
		"featureName": "HelloEvents!",
		"project": "default",
		"environment": null
	}, {
		"id": 186,
		"type": "feature-tagged",
		"createdBy": "admin",
		"createdAt": "2021-11-11T09:41:20.464Z",
		"data": {
			"type": "simple",
			"value": "team-x"
		},
		"preData": null,
		"tags": [],
		"featureName": "HelloEvents!",
		"project": null,
		"environment": null
	}, {
		"id": 184,
		"type": "feature-environment-enabled",
		"createdBy": "admin",
		"createdAt": "2021-11-11T09:41:03.782Z",
		"data": null,
		"preData": null,
		"tags": [],
		"featureName": "HelloEvents!",
		"project": "default",
		"environment": "default"
	}, {
		"id": 183,
		"type": "feature-strategy-add",
		"createdBy": "admin",
		"createdAt": "2021-11-11T09:41:00.740Z",
		"data": {
			"id": "88e1df00-1951-452f-a063-6f5e18476f87",
			"name": "flexibleRollout",
			"constraints": [],
			"parameters": {
				"groupId": "HelloEvents!",
				"rollout": 51,
				"stickiness": "default"
			}
		},
		"preData": null,
		"tags": [],
		"featureName": "HelloEvents!",
		"project": "default",
		"environment": "default"
	}, {
		"id": 182,
		"type": "feature-created",
		"createdBy": "admin",
		"createdAt": "2021-11-11T09:40:51.083Z",
		"data": {
			"name": "HelloEvents!",
			"description": "Hello Events!",
			"type": "release",
			"project": "default",
			"stale": false,
			"variants": [],
			"createdAt": "2021-11-11T09:40:51.077Z",
			"lastSeenAt": null
		},
		"preData": null,
		"tags": [],
		"featureName": "HelloEvents!",
		"project": "default",
		"environment": null
	}]
}

All events will implement the following interface:


interface IEvent {
    id: number;
    createdAt: Date;
    type: string;
    createdBy: string;
    project?: string;
    environment?: string;
    featureName?: string;
    data?: any;
    preData?: any;
    tags?: ITag[];
}