OneTrust Consent & Preferences — Cookie Consent

{"openapi":"3.1.0","info":{"title":"Consent & Preferences - Cookie Consent","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Cookie Consent APIs are used to integrate external systems and streamline the flow of data with Cookie Consent in the OneTrust Platform."},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Applications","description":"The Applications APIs are used to manage application configurations and their associated consent experiences.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Cookies","description":"The Cookies APIs are used to manage cookie definitions, categories, and their properties.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Domains","description":"The Domains APIs are used to manage domain configurations and cookie scanning settings.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Geolocation Rules","description":"The Geolocation Rules APIs are used to manage geographic rules that determine how consent experiences are applied based on user location.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Scans","description":"The Scans APIs are used to manage website cookie scanning operations and results.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Scripts","description":"The Scripts APIs are used to manage publishing of scripts to websites.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Templates","description":"The Templates APIs are used to manage reusable consent templates that define the structure and behavior of consent experiences.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0"},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/cmp/v1/application":{"post":{"operationId":"createApplication","summary":"Create Application","description":"Use this API to create a new application for scan and SDK publishing.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRequestPublicDto"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEntityPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/application/{id}/scan":{"put":{"operationId":"scanApplication","summary":"Scan Application","description":"Use this API to initiate an application scan with a file upload.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application to create the scan for","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"File to upload as part of the scan request. Maximum size: 500 MB.","type":"string","maxLength":524288000}},"required":["file"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScanResponsePublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/applications":{"get":{"operationId":"getApplications","summary":"Get List of Applications","description":"Use this API to retrieve a paginated list of applications. The search parameter can be used to optionally filter results by name.","tags":["Applications"],"parameters":[{"name":"searchStr","in":"query","description":"Search string to filter applications by name","required":false,"schema":{"type":"string","maxLength":255},"example":"My App"},{"name":"sortBy","in":"query","description":"Field to sort by.","required":false,"schema":{"type":"string","default":"name","enum":["name","os"]},"example":"name"},{"name":"direction","in":"query","description":"Sort direction.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"asc"},{"name":"page","in":"query","description":"Page number (0-based)","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Page size","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageApplicationListPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/branding-attributes":{"get":{"operationId":"getApplicationBrandingAttributeList","summary":"Get Branding Attributes for Application","description":"Use this API to retrieve branding attributes for the specified application.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Resource ID (Application ID)","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationBrandingAttributesResponseDTO"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]},"put":{"operationId":"updateApplicationBrandingAttributesForPublicApi","summary":"Update Branding Attributes for Application","description":"Use this API to update branding attributes for the specified application.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Resource ID (Application ID)","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationBrandingAttributesRequestDTO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BrandingAttributesUpdateResponseDTO"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/applications/{id}/publish":{"put":{"operationId":"publishAppScript","summary":"Publish Application SDK","description":"Use this API to publish the script configuration options for the specified application.","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"UUID of the application to publish for","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishGeolocationRuleRequestApplicationPublicDto"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans":{"get":{"operationId":"getScans","summary":"Get List of Application Scans","description":"Use this API to retrieve a paginated list of scans associated with a specific application. The response includes each scan's ID, status, and summary data for detected SDKs and permissions.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application to retrieve scans for","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"sortBy","in":"query","description":"Field to sort by","required":false,"schema":{"type":"string","default":"scanDate","enum":["status","scanDate","engineVersion"]},"example":"scanDate"},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"desc"},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"integer","default":10,"maximum":100,"minimum":1},"example":10}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageApplicationScanDetailDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}":{"get":{"operationId":"getSingleScan","summary":"Get Application Scan","description":"Use this API to retrieve the details of a single scan for a specific application. The response includes the scan's ID, status, date, and summary data for detected SDKs and permissions.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScanDetailDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/permissions":{"get":{"operationId":"getScanPermissions","summary":"Get List of Scan Permissions","description":"Use this API to retrieve the list of permissions detected during a specific application scan. The response includes each permission's name, category, status, description, and sensitivity.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationScanPermissionPublicDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest":{"get":{"operationId":"getAppPrivacyManifest","summary":"Get Scan Privacy Manifest","description":"Use this API to retrieve a summary of the iOS privacy manifest analysis for a specific application scan. The response includes the manifest's edit version, supported versions, total data type count, and counts broken down by alignment status. Each data type entry includes the data type identifier, the number of SDKs associated with it, declared purposes, and any detected mismatches.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - This endpoint is specific to iOS applications.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"version","in":"query","description":"Published version string of the privacy manifest to retrieve.If omitted, the latest version is used.","required":false,"schema":{"type":"string"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppPrivacyManifestResponsePublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest/{dataType}":{"get":{"operationId":"getAppPrivacyManifestDatatype","summary":"Get Privacy Manifest Data Type","description":"Use this API to retrieve detailed mismatch information for a specific data type within an iOS privacy manifest scan. The response includes a breakdown of mismatches by category, with each mismatch entry identifying the SDK package, SDK name, and the differing app and SDK values.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - This endpoint is specific to iOS applications.\\\\n> - The `dataType` path parameter corresponds to a `dataType` returned in the [Get Scan Privacy Manifest API](https://developer.onetrust.com/onetrust/reference/getappprivacymanifest) response (e.g., `USER_ID`, `OTHER_DIAGNOSTIC_DATA`).\\\\n> - Mismatch categories with no detected issues return an empty array rather than being omitted from the response.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"dataType","in":"path","description":"App Privacy Manifest data type to retrieve. Must be a valid AppPrivacyManifestDataType enum name (case-insensitive).","required":true,"schema":{"type":"string","enum":["NAME","EMAIL","PHONE_NUMBER","PHYSICAL_ADDRESS","OTHER_USER_CONTACT_INFO","HEALTH","FITNESS","PAYMENT_INFO","CREDIT_INFO","OTHER_FINANCIAL_INFO","PRECISE_LOCATION","COARSE_LOCATION","SENSITIVE_INFO","CONTACTS","MESSAGES","PHOTOS_VIDEOS","AUDIO_DATA","GAMEPLAY_CONTENT","CUSTOMER_SUPPORT","OTHER_USER_CONTENT","BROWSING_HISTORY","SEARCH_HISTORY","USER_ID","DEVICE_ID","PURCHASE_HISTORY","PRODUCT_INTERACTION","ADVERTISING_DATA","OTHER_USAGE_DATA","CRASH_DATA","PERFORMANCE_DATA","OTHER_DIAGNOSTIC_DATA","ENVIRONMENT_SCANNING","HANDS","HEAD","OTHER_DATA_TYPES","UNKNOWN"]},"example":"DEVICE_ID"},{"name":"version","in":"query","description":"Published version string of the privacy manifest to retrieve. If omitted, the latest version is used.","required":false,"schema":{"type":"string"},"example":2}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppPrivacyManifestResponseDatatypePublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/sdks":{"get":{"operationId":"getScanSdks","summary":"Get List of Scan SDKs","description":"Use this API to retrieve a paginated list of SDKs detected during a specific application scan. The response includes each SDK's ID, name, vendor, and default category. Results can be filtered and sorted using optional query parameters for name, vendor, default category, and the package ID.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - SDKs returned by this endpoint are scan-detected SDKs and are different from Tracking Technology SDKs, which have custom descriptions and categories.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"sortBy","in":"query","description":"Field to sort by","required":false,"schema":{"type":"string","default":"name","enum":["pkgId","name","category","vendor"]},"example":"name"},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"desc"},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}},{"name":"nameSearch","in":"query","description":"Filter SDKs whose name contains this value (case-insensitive)","required":false,"schema":{"type":"string"}},{"name":"vendorSearch","in":"query","description":"Filter SDKs whose vendor contains this value (case-insensitive)","required":false,"schema":{"type":"string"}},{"name":"defaultCategorySearch","in":"query","description":"Filter SDKs whose default category contains this value (case-insensitive)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageApplicationScanSdkPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/sdks/{sdk}":{"get":{"operationId":"getScanSdkDetails","summary":"Get Scan SDK","description":"Use this API to retrieve detailed information about a single SDK detected during a specific application scan. The response includes the SDK's package ID, name, vendor, default category, and description.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - SDKs returned by this endpoint are scan-detected SDKs and are different from Tracking Technology SDKs, which have custom descriptions and categories.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier a scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"sdk","in":"path","description":"Name or Key of the SDK.","required":true,"schema":{"type":"string"},"example":"org.xmlpull.v1.XmlPullParser"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScanSdkPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/script-details":{"get":{"operationId":"getAppScriptDetails","summary":"Get Script for Application","description":"Use this API to retrieve script details for the specified application.","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"ID of the Application to retrieve a script of","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScriptDetailsPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":

# --- truncated at 32 KB (204 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-consent-preferences-cookie-consent-openapi.json