See the API's various operations for details on their request parameters and response data.
| Operation | Method | Endpoint |
|---|---|---|
| CP Tag | ||
| List CP Tags | GET | /api/v1/cptags |
| Create CP Tag | POST | /api/v1/cptags |
| Origin | ||
| List origins | GET | /api/v1/origins |
| Create origin server | POST | /api/v1/origins |
| Get origin details | GET | /api/v1/origins/{id} |
| Update origins | PUT | /api/v1/origins/{id} |
| Delete origin | DELETE | /api/v1/origins/{id} |
| Publishing Locations | ||
| List publishing locations | GET | /api/v1/publishing_locations |
| S3 Storage Connection | ||
| List S3 storage connections | GET | /api/v1/s3_storage_connections |
| Create S3 storage connection | POST | /api/v1/s3_storage_connections |
| Get S3 storage connection | GET | /api/v1/s3_storage_connections/{id} |
| Update S3 storage connection | PUT | /api/v1/s3_storage_connections/{id} |
| Delete S3 storage connection | DELETE | /api/v1/s3_storage_connections/{id} |
| Stream | ||
| List streams | GET | /api/v1/streams |
| Create stream | POST | /api/v1/streams |
| Import a v4 stream | POST | /api/v1/streams/import |
| Get stream details | GET | /api/v1/streams/{id} |
| Update stream | PUT | /api/v1/streams/{id} |
| Delete stream | DELETE | /api/v1/streams/{id} |
| Event | ||
| List events | GET | /api/v1/streams/{stream_id}/events |
| Create event | POST | /api/v1/streams/{stream_id}/events |
| Get event details | GET | /api/v1/streams/{stream_id}/events/{event_name} |
| Delete event | DELETE | /api/v1/streams/{stream_id}/events/{event_name} |
| Delete event retention buffer | DELETE | /api/v1/streams/{stream_id}/events/{event_name}/retention_buffer |
| List event's deleted retention buffer | GET | /api/v1/streams/{stream_id}/events/{event_name}/retention_buffer/deleted |
| Event Export | ||
| List event exports | GET | /api/v1/streams/{stream_id}/events/{event_name}/exports |
| Create event export | POST | /api/v1/streams/{stream_id}/events/{event_name}/exports |
| Get event export | GET | /api/v1/streams/{stream_id}/events/{event_name}/exports/{export_id} |
| Cancel event export | POST | /api/v1/streams/{stream_id}/events/{event_name}/exports/{export_id}/cancel |
| Stream - Ingest Authentication | ||
| List ingest credentials | GET | /api/v1/streams/{stream_id}/ingest_credentials |
| Create ingest credential | POST | /api/v1/streams/{stream_id}/ingest_credentials |
| Update ingest credential | PUT | /api/v1/streams/{stream_id}/ingest_credentials/{credential_id} |
| Delete ingest credential | DELETE | /api/v1/streams/{stream_id}/ingest_credentials/{credential_id} |
| Log Destination | ||
| List log destinations | GET | /api/v1/streams/{stream_id}/log_destinations |
| Create log destination | POST | /api/v1/streams/{stream_id}/log_destinations |
| Get log destination details | GET | /api/v1/streams/{stream_id}/log_destinations/{log_destination_id} |
| Update log destination | PUT | /api/v1/streams/{stream_id}/log_destinations/{log_destination_id} |
| Delete log destination | DELETE | /api/v1/streams/{stream_id}/log_destinations/{log_destination_id} |
| Activate log destination | POST | /api/v1/streams/{stream_id}/log_destinations/{log_destination_id}/activate |
| Deactivate log destination | POST | /api/v1/streams/{stream_id}/log_destinations/{log_destination_id}/deactivate |
| Usage | ||
| Retrieve usage data | GET | /api/platform/v1/usage |
| Alert | ||
| List alert configurations | GET | /api/platform/v1/alert/configurations |
| Get alert configuration by ID | GET | /api/platform/v1/alert/configuration/{id} |
| Update alert configuration | PUT | /api/platform/v1/alert/configuration/{id} |
| Delete alert configuration | DELETE | /api/platform/v1/alert/configuration/{id} |
| Create alert configuration | POST | /api/platform/v1/alert/configuration |
| Subscribe to alert configuration | POST | /api/platform/v1/alert/configuration/{id}/subscribe |
| Unsubscribe from alert configuration | POST | /api/platform/v1/alert/configuration/{id}/unsubscribe |
| Activate alert configuration | POST | /api/platform/v1/alert/configuration/{id}/activate |
| Deactivate alert configuration | POST | /api/platform/v1/alert/configuration/{id}/deactivate |
| List triggered alerts | GET | /api/platform/v1/alert/triggers |
| List alert types | GET | /api/platform/v1/alert/types |
| Get alert type by ID | GET | /api/platform/v1/alert/type/{id} |