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 BackgroundAssets API

The BackgroundAssets API from iOS — 4 operation(s) for backgroundassets.

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

Tagged areas include BackgroundAssets. 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 5 operations across 4 paths, and defines 33 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/.

5 operations 4 paths 33 schemas 3 GET1 PATCH1 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 BackgroundAssets 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 5

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

BackgroundAssets 5
POST
/v1/backgroundAssets
Create Background Assets
backgroundAssets_createInstance body → 400401403422201409429
GET
/v1/backgroundAssets/{id}
Get Background Assets
backgroundAssets_getInstance 5 params → 400401403404200429
PATCH
/v1/backgroundAssets/{id}
Update Background Assets
backgroundAssets_updateInstance 1 param body → 400401403404422200409429
GET
/v1/backgroundAssets/{id}/relationships/versions
List Related Background Assets / Versions
backgroundAssets_versions_getToManyRelationship 2 params → 400401403404200429
GET
/v1/backgroundAssets/{id}/versions
List Related Background Assets / Versions
backgroundAssets_versions_getToManyRelated 16 params → 400401403404200429

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are DeliveryFileUploadOperation (8 properties), BackgroundAssetVersionAppStoreRelease (5 properties), App (5 properties), BackgroundAssetVersion (5 properties). Each schema is shown below with its type and property counts.

PagedDocumentLinks
object
3 properties 1 required
ResourceLinks
object
1 property
BackgroundAssetResponse
object
3 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
StateDetail
object
2 properties
BackgroundAssetVersionExternalBetaRelease
object
5 properties 2 required
AppMediaAssetState
object
3 properties
BackgroundAssetVersionAppStoreRelease
object
5 properties 2 required
Platform
string
BackgroundAssetCreateRequest
object
1 property 1 required
DocumentLinks
object
1 property 1 required
BackgroundAssetVersionsResponse
object
4 properties 2 required
Checksums
object
2 properties
BackgroundAssetVersionExternalBetaReleaseState
string
ErrorResponse
object
1 property
BackgroundAssetVersionInternalBetaRelease
object
5 properties 2 required
BackgroundAssetVersionState
string
App
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
ChecksumAlgorithm
string
BackgroundAsset
object
5 properties 2 required
BackgroundAssetUpdateRequest
object
1 property 1 required
BackgroundAssetVersionAppStoreReleaseState
string
BackgroundAssetVersion
object
5 properties 2 required
ErrorSourcePointer
object
1 property 1 required
BackgroundAssetVersionsLinkagesResponse
object
3 properties 2 required
PagingInformation
object
1 property 1 required
BackgroundAssetUploadFile
object
4 properties 2 required
DeliveryFileUploadOperation
object
8 properties
AppMediaStateError
object
2 properties
HttpHeader
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-backgroundassets-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