Skip to content

[C33 - INT-756] Add docker repository to events v4 endpoint #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaparent merged 9 commits into from
Jul 21, 2026
Merged

[C33 - INT-756] Add docker repository to events v4 endpoint #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
89b2cac
Create docker repository schema
mataai Jul 7, 2026
8e5e1c1
Add docker repository to docs
mataai Jul 7, 2026
3a45b01
fix openapi v4 spec
mataai Jul 21, 2026
d3907d2
Update openapi spect
mataai Jul 21, 2026
c96d8a6
move docker image to it's own branch
mataai Jul 21, 2026
6c3b869
remove stuff that shouldn't be in this PR
mataai Jul 21, 2026
53c500e
fix error in label
mataai Jul 21, 2026
1adf91b
update docker repository description
mataai Jul 21, 2026
c3037bc
fix broken link
mataai Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 120 additions & 1 deletion docs/api-reference/spec/firework-v4-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,9 @@
{
"$ref": "#/components/schemas/FinancialEvent"
},
{
"$ref": "#/components/schemas/DockerRepositoryEvent"
},
{
"$ref": "#/components/schemas/ForumPostEvent"
},
Expand Down Expand Up @@ -458,6 +461,7 @@
"bucket": "#/components/schemas/BucketEvent",
"chat_message": "#/components/schemas/ChatMessageEvent",
"cc": "#/components/schemas/FinancialEvent",
"docker_repository": "#/components/schemas/DockerRepositoryEvent",
"forum_post": "#/components/schemas/ForumPostEvent",
"invalid_credential": "#/components/schemas/InvalidCredentialEvent",
"leaked_credential": "#/components/schemas/LeakedCredentialEvent",
Expand Down Expand Up @@ -4625,6 +4629,121 @@
],
"title": "CredentialsQueryPayload"
},
"DockerRepositoryEvent": {
"properties": {
"event_type": {
"type": "string",
"const": "docker_repository",
"title": "Event Type",
"default": "docker_repository"
},
"data": {
"$ref": "#/components/schemas/DockerRepositoryEventData"
},
"metadata": {
"$ref": "#/components/schemas/EventMetadata"
}
},
"type": "object",
"required": [
"data",
"metadata"
],
"title": "Docker Repository"
},
"DockerRepositoryEventData": {
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"description": "The URL of the Docker repository."
},
"star_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Star Count",
"description": "The number of stars the repository has received."
},
"pull_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pull Count",
"description": "The total number of pulls made against the repository."
},
"collaborator_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Collaborator Count",
"description": "The number of collaborators associated with the repository."
},
"last_updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Updated At",
"description": "The timestamp at which the repository was last updated."
},
"last_modified_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Modified At",
"description": "The timestamp at which the repository's metadata was last modified."
},
"registered_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Registered At",
"description": "The timestamp at which the repository was first registered."
}
},
"type": "object",
"title": "DockerRepositoryEventData"
},
"DomainAssetEnrichment": {
"properties": {
"type": {
Expand Down Expand Up @@ -9764,7 +9883,7 @@
],
"title": "SecretQuery"
},
"ServiceEvent": {
"ServiceEvent": {
Comment thread
mataai marked this conversation as resolved.
"properties": {
"event_type": {
"type": "string",
Expand Down
1 change: 1 addition & 0 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@
"event-types-v2/forum-post",
"event-types-v2/invalid-credential",
"event-types-v2/leaked-credential",
"event-types-v2/docker-repository",
"event-types-v2/listing",
"event-types-v2/mitigated-credential",
"event-types-v2/paste",
Expand Down
9 changes: 9 additions & 0 deletions docs/event-types-v2/docker-repository.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Docker Repository"
---

import DockerRepositoryExample from '/snippets/event_model_examples/docker_repository.mdx'

The `docker_repository` type represents a Docker repository description that has been recently created or updated. Repository descriptions are scanned for identifiers and secrets.

<DockerRepositoryExample />
1 change: 1 addition & 0 deletions docs/event-types-v2/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Currently these event type models are supported on the
| `bucket` | [Bucket <Icon icon="book" size={16} />](/event-types-v2/bucket) |
| `chat_message` | [Chat Message <Icon icon="book" size={16} />](/event-types-v2/chat-message) |
| `credit_card` | [Chat Message <Icon icon="book" size={16} />](/event-types-v2/chat-message) |
| `docker_repository`| [Docker Repository <Icon icon="book" size={16} />](/event-types-v2/docker-repository) |
| `document` | [Ransomleak (document) <Icon icon="book" size={16} />](/event-types-v2/ransom-leak) |
| `domain` | [Lookalike Domain (domain) <Icon icon="book" size={16} />](/event-types-v2/domain) |
| `forum_post` | [Forum Post & Topic <Icon icon="book" size={16} />](/event-types-v2/forum-post) |
Expand Down
31 changes: 31 additions & 0 deletions docs/snippets/event_model_examples/docker_repository.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{/*
If you are in pyro:
- If this file changes, you should also modify the API docs.
- https://github.com/flared/docs-api/

If you are in mintlify:
- Don't edit this directly, edit the generator in pyro.
- pyro/pyro/mintlify/test_firework_event_models.py
*/}

```json Docker Repository
{
"event_type": "docker_repository",
"data": {
"url": "https://hub.docker.com/r/flared/docker",
"star_count": 5,
"pull_count": 10000,
"collaborator_count": 2,
"last_updated_at": "2026-01-01T00:00:00",
"last_modified_at": "2025-01-01T00:00:00",
"registered_at": "2024-01-01T00:00:00"
},
"metadata": {
"estimated_created_at": "2025-01-01T00:00:00",
"flare_url": "https://app.flare.io/#/uid",
"matched_at": null,
"severity": "info",
"uid": "index/source/id"
}
}
```
6 changes: 5 additions & 1 deletion docs/snippets/event_model_examples/events_overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ import ChatMessage from '/snippets/event_model_examples/chat_message.mdx'

import CreditCard from '/snippets/event_model_examples/credit_card.mdx'


import DockerRepository from '/snippets/event_model_examples/docker_repository.mdx'

import ForumPost from '/snippets/event_model_examples/forum_post.mdx'

import Listing from '/snippets/event_model_examples/listing.mdx'
Expand All @@ -35,11 +38,12 @@ import StealerLog from '/snippets/event_model_examples/stealer_log.mdx'
<Bucket />
<ChatMessage />
<CreditCard />
<DockerRepository />
<ForumPost />
<Listing />
<LookalikeDomain />
<Paste />
<RansomLeak />
<SocialMediaAccount />
<StealerLog />
</ResponseExample>
</ResponseExample>
Loading