Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS AppEncryptionDeclarations API

The AppEncryptionDeclarations API from iOS — 7 operation(s) for appencryptiondeclarations.

iOS AppEncryptionDeclarations API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AppEncryptionDeclarations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.

This API exposes 8 operations across 7 paths, and defines 30 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.

Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.

8 operations 7 paths 30 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iOS AppEncryptionDeclarations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (itc-bearer-token). By default, every request must be authenticated.

Paths & Operations 8

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

AppEncryptionDeclarations 8
GET
/v1/appEncryptionDeclarations
List App Encryption Declarations
appEncryptionDeclarations_getCollection 10 params → 400401403200429
POST
/v1/appEncryptionDeclarations
Create App Encryption Declarations
appEncryptionDeclarations_createInstance body → 400401403422201409429
GET
/v1/appEncryptionDeclarations/{id}
Get App Encryption Declarations
appEncryptionDeclarations_getInstance 7 params → 400401403404200429
GET
/v1/appEncryptionDeclarations/{id}/relationships/appdeprecated
Get Related App Encryption Declarations / App
appEncryptionDeclarations_app_getToOneRelationship 1 param → 400401403404200429
GET
/v1/appEncryptionDeclarations/{id}/appdeprecated
Get Related App Encryption Declarations / App
appEncryptionDeclarations_app_getToOneRelated 2 params → 400401403404200429
GET
/v1/appEncryptionDeclarations/{id}/relationships/appEncryptionDeclarationDocument
Get Related App Encryption Declarations / App Encryption Declaration Document
appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelationship 1 param → 400401403404200429
GET
/v1/appEncryptionDeclarations/{id}/appEncryptionDeclarationDocument
Get Related App Encryption Declarations / App Encryption Declaration Document
appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated 2 params → 400401403404200429
POST
/v1/appEncryptionDeclarations/{id}/relationships/buildsdeprecated
Add Related App Encryption Declarations / Builds
appEncryptionDeclarations_builds_createToManyRelationship 1 param body → 400401403404422409204429

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are UploadOperation (5 properties), Build (5 properties), App (5 properties), AppEncryptionDeclaration (5 properties). Each schema is shown below with its type and property counts.

ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties 1 required
AppEncryptionDeclarationBuildsLinkagesRequest
object
1 property 1 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
AppEncryptionDeclarationDocumentResponse
object
2 properties 2 required
AppMediaAssetState
object
3 properties
Platform
string
AppEncryptionDeclarationState
string
DocumentLinks
object
1 property 1 required
UploadOperation
object
5 properties
AppEncryptionDeclarationAppEncryptionDeclarationDocumentLinkageResponse
object
2 properties 2 required
ErrorResponse
object
1 property
AppEncryptionDeclaration
object
5 properties 2 required
AppEncryptionDeclarationCreateRequest
object
1 property 1 required
App
object
5 properties 2 required
Build
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
AppEncryptionDeclarationResponse
object
3 properties 2 required
AppEncryptionDeclarationsResponse
object
4 properties 2 required
AppEncryptionDeclarationAppLinkageResponse
object
2 properties 2 required
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required
BuildAudienceType
string
AppMediaStateError
object
2 properties
AppWithoutIncludesResponse
object
2 properties 2 required
AppEncryptionDeclarationDocument
object
4 properties 2 required
HttpHeader
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-appencryptiondeclarations-api-openapi.yml Raw ↑

Other APIs iOS publishes across the network.

App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API