Admin Downloads

Generated admin downloads operations.

POST/v1/admin/downloads/cache/releaseRelease one bounded page of a profile’s prepared download copies without withdrawing offline permissions; repeat while more is trueadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: release_profile_downloads_cache
Max body: 4 KiB

Request body application/json · required

Example

{
  "operationId": "id_8h2k4q",
  "profileKey": "string"
}

Schema

operationIdstringrequired
profileKeystringrequired

Responses

200Successapplication/json

Example

{
  "claims": 1800000,
  "more": true,
  "retained": 0
}

Schema

claimsintegerrequired
morebooleanrequired
retainedintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestidempotency_key_reuseddownloads_unavailableinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/downloads/cache/release" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operationId":"id_8h2k4q","profileKey":"string"}'

POST/v1/admin/downloads/revokeWithdraw one bounded page of a profile’s download claims and offline permissions; repeat while more is trueplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: revoke_profile_downloads
Max body: 4 KiB

Request body application/json · required

Example

{
  "operationId": "id_8h2k4q",
  "profileKey": "string"
}

Schema

operationIdstringrequired
profileKeystringrequired

Responses

200Successapplication/json

Example

{
  "claims": 1800000,
  "more": true,
  "receipts": 0
}

Schema

claimsintegerrequired
morebooleanrequired
receiptsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestidempotency_key_reuseddownloads_unavailableinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/downloads/revoke" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operationId":"id_8h2k4q","profileKey":"string"}'