How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Athenian events API

The events API from Athenian — 4 operation(s) for events.

Athenian events API is one of 15 APIs that Athenian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.1.86.

Requests are made against a single base URL, {{ server_url }}/v1.

5 operations 4 paths 19 schemas 1 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.1.86
Base URL
https://api.athenian.co/v1
Authentication
API Key, HTTP Bearer
License
CC-BY-4.0
Resource Areas
1

Authentication & Security 2

Athenian events API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (apiKeyAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • apiKeyAuth — Authorization by the value of X-API-Key header aka API token. The tokens are user- and account-specific. Create them by calling /token/create. The server autom…
  • bearerAuth — Regular JSON Web Token authorization powered by Auth0. The server expects an Authorization: Bearer header and checks by sending it to Auth0. Visit [{{ serverur…

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

events 5
POST
/events/clear_cache
Reset the precomputed data related to the pushed events.
clear_precomputed_events body → 200403404422424
POST
/events/deployments
Notify about new deployments.
notify_deployments body → 200400403404422
GET
/events/deployment/{name}/labels
Retrieve the labels associated with the deployment.
get_deployment_labels 1 param → 200404
PATCH
/events/deployment/{name}/labels
Modify the labels for the deployment applying the given instructions.
modify_deployment_labels 1 param body → 200400404
POST
/events/releases
Notify about new releases. The release settings must be set to "event".
notify_releases body → 200400403404422

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are DeploymentNotification (8 properties), ReleaseNotification (6 properties), GenericError (5 properties), DeleteEventsCacheRequest (3 properties). Each schema is shown below with its type and property counts.

RepositoryID
string
Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No ".git" sh…
NotifyReleasesResponse
array
Response from /events/releases. The status of each release notification in the order of NotifyReleasesRequest.
MissingSettingsError
ReleaseNotificationStatus
string
What happened to the notification: - acceptedresolved: all is OK, we found the repository reference. - acceptedpending: we haven't found the repository referen…
GenericError
object
5 properties 3 required
CommitHash
string
Commit hash, either short (7 chars) or long (40 chars) form.
NotifiedDeployments
array
The list of notified deployments.
RepositorySet
array
Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.
DeploymentConclusion
string
State of the completed deployment. Case-insensitive.
DeployedComponent
object
Definition of the deployed software unit.
2 properties 2 required
NotifyDeploymentsRequest
array
NoSourceDataError
InvalidRequestError
DeploymentNotification
object
Push message about a deployment. We remove unresolved components after 24h.
8 properties 5 required
ReleaseNotification
object
Push message about a custom release event.
6 properties 2 required
DeploymentModifyLabelsRequest
object
Request to modify the labels associated with the deployment. Each property in this object represents a command to execute.
2 properties
DeleteEventsCacheRequest
object
Definition of the cache reset operation.
3 properties 3 required
DeploymentLabels
object
Arbitrary key-value metadata that associates with the deployment.
NotifyReleasesRequest
array
Request body of /events/releases: list of release notifications.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

athenian-events-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

Athenian align API
Athenian filter API
Athenian get API
Athenian histograms API
Athenian integrations API
Athenian metrics API
Athenian pagination API
Athenian registration API
Athenian reposet API
Athenian security API
Athenian settings API
Athenian team API
Where this information came from

This is an independent, third-party profile of Athenian events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.