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

Cloudera Audit Service API

Read, archive and configure retention for CDP control plane audit events. 11 operations.

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

Tagged areas include Audit, Compliance, and Logging. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 11 paths, and defines 36 schemas. It is described by OpenAPI 2.0, at version 0.9.163.

Requests are made against the base URL https://api.us-west-1.cdp.cloudera.com.

11 operations 11 paths 36 schemas 11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
0.9.163
Base URL
https://api.us-west-1.cdp.cloudera.com
License
Apache 2.0
Terms of Service
Resource Areas
1

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 11 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 11
POST
/api/v1/audit/archiveAuditEvents
Archive audit events.
archiveAuditEvents 1 param → 200default
POST
/api/v1/audit/batchEventsForArchiving
Create batches of audit events to be archived.
batchEventsForArchiving 1 param → 200default
POST
/api/v1/audit/configureArchiving
Configures the audit system for archiving audit events to external cloud storage.
configureArchiving 1 param → 200default
POST
/api/v1/audit/getArchivingConfig
Retrieve the current archiving configuration.
getArchivingConfig 1 param → 200default
POST
/api/v1/audit/getArchivingStatus
Retrieve the status for an archive process.
getArchivingStatus 1 param → 200default
POST
/api/v1/audit/getBatchEventsForArchivingStatus
Get the status of creating batches of audit events to be archived.
getBatchEventsForArchivingStatus 1 param → 200default
POST
/api/v1/audit/listEvents
List all audit events recorded in a specified time span, and optionally with a specified request ID and/or event source.
listEvents 1 param → 200default
POST
/api/v1/audit/listEventsInArchiveBatch
List events contained in a single archive batch.
listEventsInArchiveBatch 1 param → 200default
POST
/api/v1/audit/listOutstandingArchiveBatches
List outstanding (unarchived) archive batches.
listOutstandingArchiveBatches 1 param → 200default
POST
/api/v1/audit/listRecentArchiveRuns
List recent archive runs.
listRecentArchiveRuns 1 param → 200default
POST
/api/v1/audit/markArchiveBatchesAsSuccessful
Mark archive batches as successful.
markArchiveBatchesAsSuccessful 1 param → 200default

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are CdpAuditEvent (13 properties), ListEventsRequest (13 properties), InteractiveLoginEvent (11 properties), ArchiveRun (8 properties). Each schema is shown below with its type and property counts.

Error
object
An object returned on an error.
2 properties
ArchivingConfigInfo
object
Object for holding archiving configuration information for the audit service.
4 properties
ConfigureArchivingRequest
object
Request object for the ConfigureArchiving method.
5 properties 3 required
ConfigureArchivingResponse
object
Response object for the ConfigureArchiving method.
1 property
GetArchivingConfigRequest
object
Request object for the GetArchivingConfig method.
GetArchivingConfigResponse
object
Response object for the GetArchivingConfig method.
1 property
ListEventsRequest
object
Request object for the ListEvents method.
13 properties 2 required
ApiRequestEventCriteria
object
Filter criteria for listing API request audit events.
2 properties
CdpServiceEventCriteria
object
Filter criteria for listing CDP service audit events.
1 property
InteractiveLoginEventCriteria
object
Filter criteria for listing interactive login audit events.
5 properties
ListEventsResponse
object
Response object for the ListEvents method.
2 properties
ApiRequestEvent
object
The model for an API request event, as a part of CdpAuditEvent. These events are triggered by requests to public CDP API services.
6 properties
CdpServiceEvent
object
The model for a service event, as a part of CdpAuditEvent. These events are created by Cloudera CDP services, but are not directly triggered by a request to a…
3 properties
InteractiveLoginEvent
object
The model for a login event, as a part of CdpAuditEvent. CDP logs attempts to interactively login to the CDP console. This includes logins using Cloudera SSO a…
11 properties 4 required
ActorIdentity
object
Identity information about the actor that initiated an event. Only one of the fields in this message may be set.
2 properties
CdpAuditEvent
object
The model for an audit event.
13 properties 7 required
ArchiveAuditEventsRequest
object
Request to archive audit events.
2 properties 2 required
ArchiveAuditEventsResponse
object
Response from archiving audit events.
3 properties
GetArchivingStatusRequest
object
Request to get status for an archive process.
1 property 1 required
GetArchivingStatusResponse
object
Information about a current archive process.
3 properties
BatchEventsForArchivingRequest
object
Request to create batches of audit events for archiving.
2 properties 2 required
BatchEventsForArchivingResponse
object
Response from creating batches of audit events for archiving.
1 property
GetBatchEventsForArchivingStatusRequest
object
Request to get the status of creating batches of audit events to be archived.
1 property
GetBatchEventsForArchivingStatusResponse
object
Response from getting the status of creating batches of audit events to be archived.
2 properties
ListOutstandingArchiveBatchesRequest
object
Request to list outstanding archive batches.
4 properties
ListOutstandingArchiveBatchesResponse
object
The response from listing outstanding archive batches.
2 properties
ListEventsInArchiveBatchRequest
object
Request to list events contained in a single archive batch.
1 property 1 required
ListEventsInArchiveBatchResponse
object
Response from listing events contained in a single archive batch.
1 property
MarkArchiveBatchesAsSuccessfulRequest
object
Request to mark archive batches as successful.
1 property
MarkArchiveBatchesAsSuccessfulResponse
object
Response from marking archive batches as successful.
2 properties
ArchiveBatch
object
Information about a batch of audit events that were archived.
4 properties
ListRecentArchiveRunsRequest
object
Request to list recent archive runs.
1 property
ListRecentArchiveRunsResponse
object
The response from listing recent archive runs.
1 property
ArchiveRun
object
The public model for an archive run.
8 properties
ArchiveRunStatus
string
Archive run status. CREATED - Indicates that an archive run has been created but has not yet completed. SUCCEEDED - Indicates that an archive run completed suc…
AsyncTaskStatus
string
Archive task status. OPEN - Task is still in progress COMPLETED - Task has completed successfully FAILED - Task has failed CANCELED - Task was canceled TERMINA…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudera-audit-openapi.yml Raw ↑

Other APIs Cloudera publishes across the network.

Cloudera Private Links API
Cloudera Compute Service API
Cloudera Consumption API
Cloudera Data Catalog API
Cloudera Data Hub API
Cloudera Datalake API
Cloudera Data Engineering API
Cloudera DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Data Warehouse API
Cloudera Environments API
Where this information came from

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