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

OneTrust Consent & Preferences — Cookie Consent

The Cookie Consent APIs are used to integrate external systems and streamline the flow of data with Cookie Consent in the OneTrust Platform. (44 operations.)

OneTrust Consent & Preferences — Cookie Consent is one of 37 APIs that OneTrust publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Application, Cookies, Domains, Geolocation Rules, and Scans. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 44 operations across 39 paths, organized into 7 resource areas, and defines 86 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{hostname}.

44 operations 39 paths 86 schemas 2 DELETE23 GET10 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://app.onetrust.com
Authentication
OAuth 2.0
License
Resource Areas
7

Authentication & Security 1

OneTrust Consent & Preferences — Cookie Consent declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAUTH2) using the clientCredentials flow, exposing 2 scopes.

Paths & Operations 44

Across 39 paths, the API surfaces 44 operations — 2 DELETE, 23 GET, 10 POST, 9 PUT. They span 7 resource areas: Applications, Scripts, Cookies, Domains, Geolocation Rules, Templates, Scans. Each is listed below with its method, path, parameters, and response codes.

Applications 12

The Applications APIs are used to manage application configurations and their associated consent experiences.

POST
/api/cmp/v1/application
Create Application
createApplication body → 201400401403429500
PUT
/api/cmp/v1/application/{id}/scan
Scan Application
scanApplication 1 param body → 201400401403429500
GET
/api/cmp/v1/applications
Get List of Applications
getApplications 5 params → 200400401403429500
GET
/api/cmp/v1/applications/{id}/branding-attributes
Get Branding Attributes for Application
getApplicationBrandingAttributeList 1 param → 200400401403429500
PUT
/api/cmp/v1/applications/{id}/branding-attributes
Update Branding Attributes for Application
updateApplicationBrandingAttributesForPublicApi 1 param body → 200400401403429500
GET
/api/cmp/v1/applications/{id}/scans
Get List of Application Scans
getScans 5 params → 200400401403429500
GET
/api/cmp/v1/applications/{id}/scans/{scanId}
Get Application Scan
getSingleScan 2 params → 200400401403429500
GET
/api/cmp/v1/applications/{id}/scans/{scanId}/permissions
Get List of Scan Permissions
getScanPermissions 2 params → 200400401403429500
GET
/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest
Get Scan Privacy Manifest
getAppPrivacyManifest 3 params → 200400401403429500
GET
/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest/{dataType}
Get Privacy Manifest Data Type
getAppPrivacyManifestDatatype 4 params → 200400401403429500
GET
/api/cmp/v1/applications/{id}/scans/{scanId}/sdks
Get List of Scan SDKs
getScanSdks 9 params → 200400401403429500
GET
/api/cmp/v1/applications/{id}/scans/{scanId}/sdks/{sdk}
Get Scan SDK
getScanSdkDetails 3 params → 200400401403429500
Scripts 6

The Scripts APIs are used to manage publishing of scripts to websites.

PUT
/api/cmp/v1/applications/{id}/publish
Publish Application SDK
publishAppScript 1 param body → 200400401403429500
GET
/api/cmp/v1/applications/{id}/script-details
Get Script for Application
getAppScriptDetails 1 param → 200400401403429500
PUT
/api/cmp/v1/domains/publish
Publish Script to Website
publishScriptToSite 2 params body → 200400401403429500
GET
/api/cmp/v1/domains/scripts
Get Script for Website
getScriptForWebsite 2 params → 200400401403429500
GET
/api/cmp/v1/domains/{domainId}/script-details
Get Script for Domain
getScriptDetails 2 params → 200400401403429500
GET
/api/cmp/v1/domains/{domainId}/scripts
Download Script File
downloadScriptFile 1 param → 200400401403429500
Cookies 6

The Cookies APIs are used to manage cookie definitions, categories, and their properties.

POST
/api/cmp/v1/cookies/categorized
Get Categorized Cookies
getCategorizedCookies body → 200400401403429500
PUT
/api/cmp/v1/webscans/cookies
Edit Cookies
bulkEditCookies body → 200400401403429500
POST
/api/cmp/v1/webscans/cookies
Add Cookies
bulkAddCookies body → 201400401403429500
DELETE
/api/cmp/v1/webscans/cookies
Delete Cookies
bulkDeleteCookies body → 200400401403429500
POST
/api/cmp/v1/webscans/languages/{language}/cookies/filter
Get List of Cookies by Criteria
getCookiesByFilter 7 params body → 200400401403429500
PUT
/api/cmp/v1/webscans/{scanId}/recategorize
Recategorize Cookies
recategorizeCookiesByScan 1 param → 200400401403429500
Domains 6

The Domains APIs are used to manage domain configurations and cookie scanning settings.

DELETE
/api/cmp/v1/domains/{domainId}
Delete Domain
deleteDomain 1 param → 204400401403429500
POST
/api/cmp/v1/domains/{domainId}/domaingroup
Create or Update Domain Group
createDomainGroup 1 param body → 201400401403429500
GET
/api/cmp/v1/domains/{id}/branding-attributes
Get Branding Attributes for Domain
getBrandingAttributeList 1 param → 200400401403429500
PUT
/api/cmp/v1/domains/{id}/branding-attributes
Update Branding Attributes for Domain
updateBrandingAttributesForPublicApi 1 param body → 200400401403429500
POST
/api/cmp/v1/webscans/domains/schedule
Schedule Website Scans
scheduleScans body → 200400401403429500
POST
/api/cmp/v1/webscans/domains/schedule/cancel
Cancel Scheduled Website Scans
bulkCancelDomainSchedule body → 200400401403429500
Geolocation Rules 3

The Geolocation Rules APIs are used to manage geographic rules that determine how consent experiences are applied based on user location.

GET
/api/cmp/v1/georulegroups
Get List of Geolocation Rule Groups
getGeoRuleGroups 5 params → 200400401403429500
GET
/api/cmp/v1/georulegroups/{geoRuleGroupId}
Get Geolocation Rule Group
getGeoRuleGroupDetails 1 param → 200400401403429500
PUT
/api/cmp/v1/georulegroups/{geoRuleGroupId}/assign
Assign Geolocation Rule Group
assignEntitiesToGeoRuleGroup 1 param body → 200400401403429500
Templates 2

The Templates APIs are used to manage reusable consent templates that define the structure and behavior of consent experiences.

GET
/api/cmp/v1/templates
Get List of Templates
getTemplates 5 params → 200400401403429500
GET
/api/cmp/v1/templates/{templateId}
Get Template Details
getTemplateDetails 2 params → 200400401403429500
Scans 9

The Scans APIs are used to manage website cookie scanning operations and results.

GET
/api/cmp/v1/webscans
Get List of Websites
getDomainsScannedBySort 6 params → 200400401403429500
POST
/api/cmp/v1/webscans
Scan Websites
addScans 1 param body → 200400401403429500
POST
/api/cmp/v1/webscans/archive
Archive Scans
archiveScans body → 200400401403429500
GET
/api/cmp/v1/webscans/domains/{domainId}/scans
Get List of Scans by Domain
getDomainScans 7 params → 200400401403429500
GET
/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/scandelta
Get List of Added or Removed Cookies
getScanDeltaDetails 4 params → 200400401403429500
GET
/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/scanresults
Get Scan Results
getDetailedScanResultInformation 7 params → 200400401403429500
GET
/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/summary
Get Scan Result Summary
getScanResultSummary 4 params → 200400401403429500
POST
/api/cmp/v1/webscans/status
Get Scan Statuses
checkScansStatus body → 200400401403429500
PUT
/api/cmp/v1/webscans/{scanId}/cancel
Cancel Scan
cancelScan 1 param → 200400401403429500

Schemas 86

The contract defines 86 schemas that model the data the API accepts and returns. The most detailed are CookieInformation (23 properties), DisplayGroupEntityDto (22 properties), CookieInformationDetailed (22 properties), ScriptPublishRequestDto (20 properties). Each schema is shown below with its type and property counts.

CookieSourceRequestDto
object
2 properties
CookieUpdateRequestDto
object
14 properties 1 required
DescriptionTranslationDto
object
3 properties
DomainCookieCategoryRequestDto
object
4 properties
DomainCookieSourceRequestDto
object
6 properties
EntityActionResponseDto
object
6 properties
GeoRuleGroupAssignRequestDto
object
2 properties
DomainBrandingAttributesRequestDTO
object
1 property
PublicDomainBrandingAttributeDTO
object
4 properties
BrandingAttributesUpdateResponseDTO
object
1 property
PublishRegionRuleDto
object
2 properties
ScriptPublishRequestDto
object
20 properties
PublishScriptDto
object
7 properties
PublishGeolocationRuleRequestApplicationPublicDto
object
6 properties
ApplicationBrandingAttributesRequestDTO
object
1 property
PublicApplicationBrandingAttributeDTO
object
4 properties
ApplicationScanResponsePublicDto
object
1 property
ScanWebsiteRequest
object
11 properties 1 required
TargetPagesScanEntityDto
object
4 properties
ServiceResponseDto
object
7 properties
ScanStatusResponse
object
3 properties
CookieFilters
object
6 properties
CookieResponseDto
object
18 properties
DomainCookieCategoryEntityDto
object
5 properties
PageCookieResponseDto
object
11 properties
PageableObject
object
6 properties
SortObject
object
3 properties
DomainScheduleRequest
object
6 properties 4 required
CookieCreationRequestDto
object
10 properties 3 required
CookieEntityDto
object
12 properties
EntityActionResponseDtoCookieEntityDto
object
6 properties
DomainGroupRequestDto
object
2 properties
CategorizedCookiesRequestDto
object
3 properties
CookieRequestDto
object
2 properties
CookiepediaContribsDto
object
12 properties
ApplicationRequestPublicDto
object
4 properties
ApplicationEntityPublicDto
object
5 properties
ExposedScanWebsitePageResponseDto
object
7 properties
ExposedWebsiteDetailsDto
object
14 properties
PageScanInformationResponse
object
11 properties
ScanInformationResponse
object
19 properties
ScanResultSummaryDto
object
4 properties
CookieInformationDetailed
object
22 properties
PageDto
object
11 properties
TagDto
object
14 properties
FormDataDto
object
7 properties
FormDataGroupDto
object
4 properties
StorageEntriesDto
object
4 properties
ServiceProviderBasicDetails
object
9 properties
ScanResultEntityPageResponse
object
8 properties
CookieInformation
object
23 properties
ScanDeltaDetails
object
3 properties
ScanDeltaMetadataDto
object
5 properties
PageTemplateDto
object
11 properties
TemplateDto
object
12 properties
AttributeDto
object
7 properties
BrandingAttributeDTO
object
5 properties
DisplayGroupEntityDto
object
22 properties
DisplayGroupTreeDto
object
5 properties
IABSourceIllustrationsDto
object
5 properties
TemplateDetailDto
object
5 properties
GeoRuleDto
object
5 properties
GeoRuleGroupDto
object
15 properties
PageGeoRuleGroupDto
object
11 properties
CookieCategoryDto
object
10 properties
CountryResponseDto
object
4 properties
GeoRuleDetailDto
object
16 properties
GeoRuleGroupDetailDto
object
12 properties
RegionResponseDto
object
2 properties
StateResponseDto
object
4 properties
DomainBrandingAttributesResponseDTO
object
3 properties
DomainScriptDetailsPublicDto
object
12 properties
ApplicationListPublicDto
object
14 properties
PageApplicationListPublicDto
object
11 properties
ApplicationScriptDetailsPublicDto
object
12 properties
ApplicationScanDetailDto
object
10 properties
PageApplicationScanDetailDto
object
11 properties
ApplicationScanSdkPublicDto
object
5 properties
PageApplicationScanSdkPublicDto
object
11 properties
AppPrivacyManifestResponseDataPublicDto
object
4 properties
AppPrivacyManifestResponsePublicDto
object
7 properties
AppPrivacyManifestMismatchPublicDto
object
6 properties
AppPrivacyManifestResponseDatatypePublicDto
object
2 properties
ApplicationScanPermissionPublicDto
object
5 properties
ApplicationBrandingAttributesResponseDTO
object
3 properties
BulkCookieDeletionRequest
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onetrust-consent-preferences-cookie-consent-openapi.json Raw ↑

Other APIs OneTrust publishes across the network.

OneTrust AI Governance — AI Governance
OneTrust Platform — Global Activity
OneTrust Consent & Preferences — Consent Interfaces
OneTrust Consent & Preferences — Consent Management Platform (CMP)
OneTrust Consent & Preferences — Consent Receipts
OneTrust Consent & Preferences — Cookie Consent (Swagger)
OneTrust Consent & Preferences — Cookie Domain Data
OneTrust Consent & Preferences — Cross-Device Consent
OneTrust Consent & Preferences — Mobile App Consent
OneTrust Consent & Preferences — Policy & Notice Management
OneTrust Consent & Preferences — Universal Consent & Preference Management (OAS)
OneTrust Data Use Governance — Data Catalog
Where this information came from

This is an independent, third-party profile of OneTrust Consent & Preferences — Cookie Consent, 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.