POST api/FairPlayDataSets
Creates a new FairPlay data set.
Request Information
URI Parameters
None.
Body Parameters
Data to use for the new data set.
NewFairPlayDataSet| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name of the data set. |
string |
Max length: 256 Min length: 1 |
| ApplicationSecretKey |
The application secret key. |
Collection of byte |
Max length: 16 Min length: 16 |
| ProvisioningData |
The provisioning data of Apple FairPlay SDK v5+ credential bundles. |
Collection of byte |
None. |
| ApplicationCertificate |
The X.509 application certificate. May be a single DER cert or a concatenated bundle; the server will pick the cert whose public key matches the private key. |
Collection of byte |
Required |
| PrivateKey |
A single RSA private key (1024- or 2048-bit) in the PKCS#1 PEM format, not password protected. |
Collection of byte |
Required |
Request Formats
application/json, text/json
{
"Name": "sample string 1",
"ApplicationSecretKey": "QEA=",
"ProvisioningData": "QEA=",
"ApplicationCertificate": "QEA=",
"PrivateKey": "QEA="
}
Response Information
Resource Description
FairPlayDataSet| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The ID of the data set. |
globally unique identifier |
Required |
| Name |
The name of the data set. |
string |
None. |
| CertificateHash |
The hash of the certificate. |
Collection of byte |
Required Max length: 20 Min length: 20 |
| CertificateHash256 |
The SHA256 hash of the certificate. |
Collection of byte |
Max length: 32 Min length: 32 |
| Created |
The date when the data set was created (in the ISO 8601 format). |
date |
Required |
| Updated |
The date when the data set was updated last time (in the ISO 8601 format). |
date |
None. |
Status Codes
All HTTP status codes must be expected, but the following status codes are the most probable:
- Created (201) - The data set is successfully added.
- BadRequest (400) - The data for a new data set is invalid.
Response Formats
application/json, text/json
{
"Id": "0077b31f-fae8-4fc4-bad1-0974dd045d12",
"Name": "sample string 2",
"CertificateHash": "QEA=",
"CertificateHash256": "QEA=",
"Created": "2026-09-07T14:42:26.3336858+00:00",
"Updated": "2026-09-07T14:42:26.3336858+00:00"
}