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 settings API

The settings API from Athenian — 13 operation(s) for settings.

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

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

This API exposes 13 operations across 13 paths, and defines 30 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.

13 operations 13 paths 30 schemas 5 GET1 PATCH3 POST4 PUT

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 settings 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 13

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

settings 13
PATCH
/settings/jira/identities
👤 Add, remove or override GitHub
set_jira_identities body → 200400403404422
GET
/settings/jira/identities/{id}
Fetch the GitHub
get_jira_identities 1 param → 200400403404422
PUT
/settings/jira/projects
🛡️👤 Set the enabled JIRA projects.
set_jira_projects body → 200400403404422
GET
/settings/jira/projects/{id}
List the currently enabled JIRA project settings.
get_jira_projects 1 param → 200404422
GET
/settings/logical_repositories/{id}
List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository every…
list_logical_repositories 1 param → 200404422
PUT
/settings/logical_repository
🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests.
set_logical_repository body → 200400403404422
POST
/settings/logical_repository/delete
🛡️ Delete a logical repository.
delete_logical_repository body → 200403404
PUT
/settings/release_match
👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories.
set_release_match body → 200400403404422
GET
/settings/release_match/{id}
List the current release matching settings. Release settings are rules by which to mark releases in GitHub repositories.
list_release_match_settings 1 param → 200404422
PUT
/settings/work_type
👤 Create or update a work type - a rule set to group PRs, releases, etc. together.
set_work_type body → 200400404
POST
/settings/work_type/delete
👤 Remove the work type given the name.
delete_work_type body → 200400404
POST
/settings/work_type/get
Fetch the definition of the work type given the name.
get_work_type body → 200400404
GET
/settings/work_types/{id}
List the current work types - rule sets to group PRs, releases, etc. together.
list_work_types 1 param → 200404

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are JIRAProject (7 properties), LogicalRepositoryRequest (6 properties), ReleaseMatchRequest (6 properties), ReleaseMatchSetting (5 properties). Each schema is shown below with its type and property counts.

JIRAProject
object
JIRA project setting.
7 properties 7 required
JIRAProjects
array
List of JIRA project activity settings.
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…
WorkTypes
array
List of work types. Response from /settings/worktypes/{account}.
WorkType
object
Definition of a work type - a set of rules to group PRs, releases, etc. together.
3 properties 3 required
LogicalPRRules
object
Rules to match PRs to logical repository.
2 properties
GenericError
object
5 properties 3 required
LogicalRepositories
array
List of configured logical repositories.
WorkTypeGetRequest
object
Identifier of a work type - a set of rules to group PRs, releases, etc. together.
2 properties 2 required
MappedJIRAIdentityChange
object
Individual GitHub
2 properties 2 required
DeveloperID
string
User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part.
ReleaseMatchSettings
object
Mapping from repository names to their release match settings.
JIRAProjectsRequest
object
Enable or disable a JIRA project.
2 properties 2 required
WorkTypeRule
object
Specific rule details: name and parameters.
2 properties 2 required
ReleaseMatchRequest
object
Release matching rule update.
6 properties 3 required
SetMappedJIRAIdentitiesRequest
object
Request body of /settings/jira/identities. Describes a patch to the GitHub
2 properties 2 required
MappedJIRAIdentities
array
List of currently mapped GitHub
LogicalRepositoryRequest
object
Set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. Release…
6 properties 5 required
LogicalRepository
object
Set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. Release…
5 properties 4 required
ReleaseMatchSetting
object
Release matching setting for a specific repository.
5 properties 3 required
RepositorySet
array
Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.
Color
string
RGB 24-bit color in hex.
WorkTypeName
string
Work type name. It is unique within the account scope.
MappedJIRAIdentity
object
GitHub user (developer) mapped to a JIRA user.
4 properties 4 required
LogicalDeploymentRules
object
Rules to match deployments to logical repository.
2 properties
NoSourceDataError
InvalidRequestError
ReleaseMatchStrategy
string
Release workflow choice: how we should detect releases. branch: merges to certain branches are considered releases and nothing else. event: releases are manual…
WorkTypePutRequest
object
Request body of PUT /settings/worktype.
2 properties 2 required
LogicalRepositoryGetRequest
object
Pointer to a logical repository.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

athenian-settings-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

Athenian align API
Athenian events 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 team API
Where this information came from

This is an independent, third-party profile of Athenian settings 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.