Admin Media

Generated admin media operations.

POST/v1/admin/media/deleteDelete selected media fileslibrary

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

Request body application/json · required

Example

{
  "confirmation": "string",
  "deleteFiles": true,
  "expectedRevision": 0,
  "itemIds": [
    "string"
  ],
  "operationId": "id_8h2k4q"
}

Schema

confirmationstringrequired
deleteFilesbooleanrequired
expectedRevisionintegerrequired
itemIdsarray of stringrequired
operationIdstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "bytesDeleted": 0,
    "failed": 0,
    "filesRetained": true,
    "receipts": [
      {
        "bytes": 0,
        "code": "string",
        "filesDeleted": 0,
        "filesKept": 0,
        "itemId": "id_8h2k4q",
        "removed": true,
        "title": "Fargo"
      }
    ],
    "removed": 0,
    "revision": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- bytesDeletedintegerrequired
- failedintegerrequired
- filesRetainedbooleanrequired
- receiptsarray of objectrequired
  - bytesintegerrequired
  - codestring
  - filesDeletedintegerrequired
  - filesKeptintegerrequired
  - itemIdstringrequired
  - removedbooleanrequired
  - titlestringrequired
- removedintegerrequired
- revisionintegerrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/media/delete" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirmation":"string","deleteFiles":true,"expectedRevision":0,"itemIds":["string"],"operationId":"id_8h2k4q"}'

POST/v1/admin/media/delete/previewPreview deleting selected media fileslibrary

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

Request body application/json · required

Example

{
  "itemIds": [
    "string"
  ]
}

Schema

itemIdsarray of stringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "blocked": [
      "string"
    ],
    "confirmation": "string",
    "confirmationKind": "string",
    "revision": 0,
    "targets": [
      {
        "allowMediaDeletion": true,
        "bytes": 0,
        "dependents": [
          {}
        ],
        "files": [
          {}
        ],
        "itemId": "id_8h2k4q",
        "kind": "string",
        "libraryId": "id_8h2k4q",
        "libraryName": "Fargo",
        "title": "Fargo",
        "titles": 0
      }
    ],
    "totalBytes": 0,
    "totalBytesText": "string",
    "totalFiles": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- blockedarray of stringrequired
- confirmationstringrequired
- confirmationKindstringrequired
- revisionintegerrequired
- targetsarray of objectrequired
  - allowMediaDeletionbooleanrequired
  - bytesintegerrequired
  - dependentsarray of objectrequired
    countintegerrequired
    descriptionstringrequired
    kindstringrequired
  - filesarray of objectrequired
    assetIdstringrequired
    bytesintegerrequired
    pathstringrequired
    presentbooleanrequired
    sharedbooleanrequired
  - itemIdstringrequired
  - kindstringrequired
  - libraryIdstringrequired
  - libraryNamestringrequired
  - titlestringrequired
  - titlesintegerrequired
- totalBytesintegerrequired
- totalBytesTextstringrequired
- totalFilesintegerrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/media/delete/preview" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemIds":["string"]}'