Admin Notifications

Generated admin notifications operations.

POST/v1/admin/notifications/broadcastRun server notifications broadcastadmin

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

Request body application/json · required

Example

{
  "actions": [
    {
      "arguments": {
        "key": "string"
      },
      "command": "string",
      "kind": "string",
      "label": "string",
      "target": {
        "entityId": "id_8h2k4q",
        "libraryId": "id_8h2k4q",
        "view": "string"
      }
    }
  ],
  "audience": "string",
  "body": "string",
  "dedupeKey": "string",
  "expiresInDays": 0,
  "operationId": "id_8h2k4q",
  "severity": "string",
  "title": "Fargo"
}

Schema

actionsarray of objectrequired
- argumentsobject
- commandstring
- kindstringrequired
- labelstringrequired
- targetobject
  - entityIdstring
  - libraryIdstring
  - viewstringrequired
audiencestringrequired
bodystringrequired
dedupeKeystringrequired
expiresInDaysintegerrequired
operationIdstringrequired
severitystringrequired
titlestringrequired

Responses

200Successapplication/json

Example

{
  "data": {
    "audience": "string",
    "created": 0,
    "dedupeKey": "string",
    "delivered": 0,
    "ids": [
      "string"
    ],
    "revision": 0,
    "updated": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- audiencestringrequired
- createdintegerrequired
- dedupeKeystringrequired
- deliveredintegerrequired
- idsarray of stringrequired
- revisionintegerrequired
- updatedintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

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/notifications/broadcast" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "actions": [
    {
      "arguments": {
        "key": "string"
      },
      "command": "string",
      "kind": "string",
      "label": "string",
      "target": {
        "entityId": "id_8h2k4q",
        "libraryId": "id_8h2k4q",
        "view": "string"
      }
    }
  ],
  "audience": "string",
  "body": "string",
  "dedupeKey": "string",
  "expiresInDays": 0,
  "operationId": "id_8h2k4q",
  "severity": "string",
  "title": "Fargo"
}'

GET/v1/admin/notifications/settingsRead server notifications settingsadmin

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

Responses

200Successapplication/json

Example

{
  "data": {
    "certificateWarningDays": 0,
    "maintenanceIntervalMinutes": 0,
    "noticeAudience": {
      "key": "string"
    },
    "retentionDays": 0,
    "retentionSettingsField": "string",
    "revision": 0,
    "storageCriticalPercent": 0,
    "storageWarningPercent": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- certificateWarningDaysintegerrequired
- maintenanceIntervalMinutesintegerrequired
- noticeAudienceobjectrequired
- retentionDaysintegerrequired
- retentionSettingsFieldstringrequired
- revisionintegerrequired
- storageCriticalPercentintegerrequired
- storageWarningPercentintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/notifications/settings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PATCH/v1/admin/notifications/settingsChange server notifications settingsadmin

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

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "certificateWarningDays": 0,
  "expectedRevision": 0,
  "noticeAudience": {
    "key": "string"
  },
  "storageCriticalPercent": 0,
  "storageWarningPercent": 0
}

Schema

certificateWarningDaysintegerrequired
expectedRevisionintegerrequired
noticeAudienceobject
storageCriticalPercentintegerrequired
storageWarningPercentintegerrequired

Responses

200Successapplication/json

Example

{
  "data": {
    "certificateWarningDays": 0,
    "maintenanceIntervalMinutes": 0,
    "noticeAudience": {
      "key": "string"
    },
    "retentionDays": 0,
    "retentionSettingsField": "string",
    "revision": 0,
    "storageCriticalPercent": 0,
    "storageWarningPercent": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- certificateWarningDaysintegerrequired
- maintenanceIntervalMinutesintegerrequired
- noticeAudienceobjectrequired
- retentionDaysintegerrequired
- retentionSettingsFieldstringrequired
- revisionintegerrequired
- storageCriticalPercentintegerrequired
- storageWarningPercentintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/admin/notifications/settings" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"certificateWarningDays":0,"expectedRevision":0,"noticeAudience":{"key":"string"},"storageCriticalPercent":0,"storageWarningPercent":0}'