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

Atlassian Audit API

The Audit API from Atlassian — 4 operation(s) for audit.

Atlassian Audit API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Audit. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, //your-domain.atlassian.net.

6 operations 4 paths 10 schemas 4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
//your-domain.atlassian.net
Authentication
HTTP Basic, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian Audit API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuthDefinitions) using the authorizationCode flow, exposing 73 scopes.

  • basicAuth — You can access this resource via basic auth.
  • oAuthDefinitions — This API uses OAuth 2 with the authorizationCode grant flow.

Paths & Operations 6

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

Audit 6
GET
/wiki/rest/api/audit
Atlassian Get Audit Records
atlassianGetauditrecords 5 params → 200401403
POST
/wiki/rest/api/audit
Atlassian Create Audit Record
atlassianCreateauditrecord body → 200400401
GET
/wiki/rest/api/audit/export
Atlassian Export Audit Records
atlassianExportauditrecords 4 params → 200403
GET
/wiki/rest/api/audit/retention
Atlassian Get Retention Period
atlassianGetretentionperiod → 200403
PUT
/wiki/rest/api/audit/retention
Atlassian Set Retention Period
atlassianSetretentionperiod body → 200403
GET
/wiki/rest/api/audit/since
Atlassian Get Audit Records For Time Period
atlassianGetauditrecordsfortimeperiod 5 params → 200403

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AuditRecord (11 properties), AuditRecordCreate (10 properties), AuditRecordArray (5 properties), ChangedValue (5 properties). Each schema is shown below with its type and property counts.

GenericLinks
object
GenericAccountId
stringnull
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
AuditRecord
object
11 properties 10 required
GenericUserName
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
GenericUserKey
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
RetentionPeriod
object
2 properties 2 required
ChangedValue
object
5 properties 3 required
AuditRecordArray
object
5 properties 5 required
AffectedObject
object
2 properties 2 required
AuditRecordCreate
object
10 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-audit-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

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