v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
tenant_APNs certificate

Upload APNs certificate

⚠️ iOS/iPadOS/tvOS only. This is step 3 of the APNs certificate setup workflow.

Uploads the signed APNs certificate obtained from Apple's Push Certificates Portal to Esper, completing the APNs setup for the tenant.

About Upload APNs Certificate

This endpoint completes the APNs certificate workflow by accepting the signed certificate file and the Apple ID used to sign it. The id path parameter refers to the APNSCertInfo record created when the CSR was generated via POST /api/tenant/v0/apnscertificates/. The request uses multipart/form-data with two required fields: file (the signed certificate binary) and apple_id (the Apple ID used at Apple's Push Certificates Portal). On success, the certificate record transitions from CSR_GENERATED to COMPLETED state and the tenant's iOS devices can receive push-delivered management commands. The apple_id submitted here must match the one used at Apple's portal — a mismatch will prevent successful activation.

Key Fields

id (path) — APNs certificate record UUID from the CSR generation step (required)

file (body, required) — Signed APNs certificate binary obtained from Apple's Push Certificates Portal

apple_id (body, required) — Apple ID used to sign the certificate at Apple's portal

Common Use Cases

Completing initial APNs certificate setup after uploading the CSR to Apple and downloading the signed certificate

Renewing an expiring APNs certificate by uploading the newly signed renewal certificate

Best Practices

Ensure apple_id exactly matches the Apple ID used at Apple's Push Certificates Portal — mismatches will prevent activation and cannot be corrected without regenerating the CSR

For annual renewal, use the same Apple ID as the original certificate — renewing with a different Apple ID creates a new certificate rather than renewing the existing one, which can disrupt existing device enrollments

After upload, confirm the record's state has transitioned to COMPLETED using GET /api/tenant/v0/apnscertificates/{id}/ before relying on push delivery for device management

Workflow

Generate CSR via POST /api/tenant/v0/apnscertificates/ → obtain id

Upload CSR to Apple Push Certificates Portal with the intended Apple ID → download signed certificate

PUT signed certificate + Apple ID to this endpoint using the id from step 1

put/tenant/v0/apnscertificates/{id}/

Path parameters

idstring required

ID of the APNs certificate meta object

Response

Uploaded APNs certificate meta Information

codeinteger
messagestring