LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Cortex API
  2. REST API operations

Custom Events

Last updated 1 month ago

Was this helpful?

Use these operations to interact with custom events in Cortex.

Required permissions

Edit entities: Your API key must have the Edit entities permission.

Operations

List custom events for entity

get
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters
typestringOptional
timestampstring · date-timeOptionalDeprecated

Use 'startTime' instead

startTimestring · date-timeOptional

If provided, events with greater than or equal to timestamp will be returned (a date-time without a time-zone in the ISO-8601 calendar system)

endTimestring · date-timeOptional

If provided, events with less than or equal to timestamp will be returned (a date-time without a time-zone in the ISO-8601 calendar system)

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250
pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0
Responses
200
Successfully retrieved custom events
application/json
400
Bad Request
application/json
404
Entity not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "events": [
    {
      "customData": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "description": "text",
      "timestamp": "2025-05-20T05:16:49.990Z",
      "title": "Created K8s pod",
      "type": "POD_CREATION",
      "url": "https://cortex.io",
      "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Retrieve custom event by UUID

get
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired
Responses
200
Successfully retrieved custom event
application/json
400
Bad Request
application/json
404
Entity or custom event not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/catalog/{tagOrId}/custom-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-05-20T05:16:49.990Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Delete ALL custom events for an entity

delete
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters
typestringOptional
timestampstring · date-timeOptionalDeprecated

Use 'startTime' instead

startTimestring · date-timeOptional

If provided, events with greater than or equal to timestamp will be deleted (a date-time without a time-zone in the ISO-8601 calendar system)

endTimestring · date-timeOptional

If provided, events with less than or equal to timestamp will be deleted (a date-time without a time-zone in the ISO-8601 calendar system)

Responses
200
Successfully deleted custom events
204
No Content
400
Bad Request
404
Entity not found
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
delete
DELETE /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Delete custom events by UUID

delete
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired
Responses
200
Successfully deleted custom event
204
No Content
400
Bad Request
404
Entity or custom event not found
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
delete
DELETE /api/v1/catalog/{tagOrId}/custom-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

  • Required permissions
  • Operations
  • GETList custom events for entity
  • GETRetrieve custom event by UUID
  • POSTCreate custom event for entity
  • PUTUpdate custom event by UUID
  • DELETEDelete ALL custom events for an entity
  • DELETEDelete custom events by UUID

Create custom event for entity

post
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body
descriptionstringOptional

Optional description of custom event

timestampstring · date-timeRequired

Time when event occurred

titlestringRequired

Name for custom event

Example: Created K8s pod
typestringRequired

Type of custom event

Example: POD_CREATION
urlstringOptional

Optional URL associated with custom event

Example: https://cortex.io
Responses
200
Successfully created custom event
application/json
400
Bad Request
application/json
404
Entity not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
post
POST /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-05-20T05:16:49.990Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io"
}
{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-05-20T05:16:49.990Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Update custom event by UUID

put
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired
Body
descriptionstringOptional

Optional description of custom event

timestampstring · date-timeRequired

Time when event occurred

titlestringRequired

Name for custom event

Example: Created K8s pod
typestringRequired

Type of custom event

Example: POD_CREATION
urlstringOptional

Optional URL associated with custom event

Example: https://cortex.io
Responses
200
Successfully updated custom event
application/json
400
Bad Request
application/json
404
Entity or custom event not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
put
PUT /api/v1/catalog/{tagOrId}/custom-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-05-20T05:16:49.990Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io"
}
{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-05-20T05:16:49.990Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}