{"components":{"schemas":{"AssetUsageSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"asset_type":{"enum":["ASSET","SEQUENCE","NLE_PROJECT","PLACEHOLDER"],"type":"string"},"date":{"format":"date","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"string"},"operation_source":{"enum":["COLLECTION","SEARCH","NOTIFICATION","DISCOVERY","SHARE","EXTERNAL_SHARE",""],"type":"string"},"operation_type":{"enum":["VIEW","PLAY","PAUSE","DELETE","CREATE","APPROVE","REJECT","COMMENT","RENAME","EXIT","UNFOCUS","REFOCUS","SEEK"],"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"system_name":{"type":"string"},"time":{"format":"date-time","type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["asset_id","operation_type","system_name","user_id"],"type":"object"},"AssetUsagesElasticSchema":{"properties":{"count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"}},"type":"object"},"AssetUsagesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/AssetUsagesElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"AutomationRunSchema":{"properties":{"count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"date":{"format":"date","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"AutomationRunsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/AutomationRunSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"BillingCreditsSchema":{"properties":{"auto_pay":{"type":"boolean"},"country":{"readOnly":true,"type":"string"},"credits":{"format":"int32","minimum":1,"type":"integer"},"currency":{"readOnly":true,"type":"string"},"custom_message":{"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"total":{"readOnly":true,"type":"string"},"vat":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"required":["credits"],"type":"object"},"BillingCreditsVerifySchema":{"properties":{"charge":{"readOnly":true,"type":"string"},"invoice_id":{"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"}},"required":["invoice_id"],"type":"object"},"BillingCustomerCardSchema":{"properties":{"source":{"type":"string"}},"required":["source"],"type":"object"},"BillingCustomerSchema":{"properties":{"business_vat_id":{"type":"string"},"email":{"format":"email","type":"string"},"enable_subscription":{"type":"boolean"},"shipping":{"$ref":"#/components/schemas/BillingCustomerShipping"}},"required":["shipping"],"type":"object"},"BillingCustomerShipping":{"properties":{"address":{"$ref":"#/components/schemas/BillingCustomerShippingAddress"},"name":{"type":"string"},"phone":{"nullable":true,"type":"string"}},"required":["address","name"],"type":"object"},"BillingCustomerShippingAddress":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"nullable":true,"type":"string"},"postal_code":{"type":"string"},"state":{"nullable":true,"type":"string"}},"required":["city","country","line1","postal_code"],"type":"object"},"BillingCustomerShippingAddressSchema":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"nullable":true,"type":"string"},"postal_code":{"type":"string"},"state":{"nullable":true,"type":"string"}},"required":["city","country","line1","postal_code"],"type":"object"},"BillingCustomerShippingSchema":{"properties":{"address":{"$ref":"#/components/schemas/BillingCustomerShippingAddressSchema"},"name":{"type":"string"},"phone":{"nullable":true,"type":"string"}},"required":["address","name"],"type":"object"},"BillingExpirationUpdateSchema":{"properties":{"expiration_date":{"format":"date-time","type":"string"}},"required":["expiration_date"],"type":"object"},"BillingReceiptSchema":{"properties":{"receipt_url":{"type":"string"}},"type":"object"},"BillingRecipientsSchema":{"properties":{"emails":{"items":{"type":"string"},"type":"array"}},"type":"object"},"BillingSchema":{"properties":{"balance":{"type":"number"},"consumption_subtype":{"type":"string"},"consumption_type":{"type":"string"},"currency":{"enum":["USD","EUR"],"nullable":true,"type":"string"},"date":{"format":"date-time","type":"string"},"expiration_date":{"format":"date-time","nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"label":{"type":"string"},"price_list":{"nullable":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"value":{"type":"number"}},"required":["label","system_domain_id","value"],"type":"object"},"BillingSettingsSchema":{"properties":{"auto_refill_amount":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"enable_auto_top_up":{"type":"boolean"},"low_balance_trigger":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"}},"type":"object"},"BillingStatsSchema":{"properties":{"current_balance":{"type":"number"},"invoice_end_of_month":{"type":"boolean"},"new_billing_enabled":{"type":"boolean"},"stripe_id":{"type":"boolean"},"system_domain_status":{"enum":["USD","EUR"],"nullable":true,"type":"string"},"system_domain_type":{"type":"string"},"system_domain_warning_message":{"type":"string"}},"required":["system_domain_type","system_domain_warning_message"],"type":"object"},"BillingsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/BillingSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"CollectionUsageSchema":{"properties":{"collection_id":{"format":"uuid","type":"string"},"date":{"format":"date","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"string"},"operation_source":{"enum":["COLLECTION","SEARCH","NOTIFICATION"],"type":"string"},"operation_type":{"enum":["VIEW","DELETE","CREATE","RENAME"],"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"system_name":{"type":"string"},"time":{"format":"date-time","type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["collection_id","operation_type","system_name","user_id"],"type":"object"},"CollectionUsagesElasticSchema":{"properties":{"count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"}},"type":"object"},"CollectionUsagesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/CollectionUsagesElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"CreditsSchema":{"properties":{"country":{"readOnly":true,"type":"string"},"credits":{"format":"int32","minimum":1,"type":"integer"},"currency":{"readOnly":true,"type":"string"},"total":{"readOnly":true,"type":"number"},"vat":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"required":["credits"],"type":"object"},"CurrentUsageSchema":{"properties":{"automation_runs":{"readOnly":true,"type":"integer"},"edge_transcoders":{"readOnly":true,"type":"integer"},"external_storage":{"readOnly":true,"type":"integer"},"images_analyzed":{"readOnly":true,"type":"integer"},"images_face_recognition":{"readOnly":true,"type":"integer"},"shield_enabled":{"readOnly":true,"type":"boolean"},"storage":{"readOnly":true,"type":"object"},"transcription_hours":{"readOnly":true,"type":"number"},"users":{"readOnly":true,"type":"object"},"video_analyzed_hours":{"readOnly":true,"type":"number"},"video_face_recognition_hours":{"readOnly":true,"type":"number"}},"type":"object"},"DateFilterSchema":{"properties":{"from_date":{"format":"date-time","nullable":true,"type":"string"},"to_date":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"LogsRecipientReadSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"method":{"enum":["GOOGLE","AMAZON"],"type":"string"},"name":{"type":"string"},"settings":{"type":"object"}},"required":["method","name","settings"],"type":"object"},"LogsRecipientSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"method":{"enum":["GOOGLE","AMAZON"],"type":"string"},"name":{"type":"string"},"settings":{"type":"object"}},"required":["method","name","settings"],"type":"object"},"LogsRecipientsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/LogsRecipientSchema"},"readOnly":true,"type":"array"}},"type":"object"},"PaygoCostsSchema":{"properties":{"analysis_cost":{"readOnly":true,"type":"number"},"automation_cost":{"readOnly":true,"type":"number"},"edge_transcoder_cost":{"readOnly":true,"type":"number"},"external_storage_cost":{"readOnly":true,"type":"number"},"face_recognition_cost":{"readOnly":true,"type":"number"},"shield_cost":{"readOnly":true,"type":"number"},"storage_costs":{"readOnly":true,"type":"object"},"total_spend":{"readOnly":true,"type":"number"},"transcription_cost":{"readOnly":true,"type":"number"},"user_costs":{"readOnly":true,"type":"object"}},"type":"object"},"PriceSchema":{"properties":{"currency":{"enum":["EUR","USD"],"type":"string"},"name":{"type":"string"},"prices":{"type":"object"}},"required":["currency","name","prices"],"type":"object"},"PricesSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/PriceSchema"},"readOnly":true,"type":"array"}},"type":"object"},"StorageAccessElasticSchema":{"properties":{"bucket_name":{"type":"string"},"bytes_received":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bytes_sent":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"operations":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"system_domain_id":{"format":"uuid","type":"string"}},"type":"object"},"StorageAccessSchema":{"properties":{"bucket_name":{"type":"string"},"bytes_received":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bytes_sent":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"format":"date-time","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"operation_type":{"type":"string"},"operations":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"storage_type":{"enum":["FILE","HTTP","FTP","SFTP","S3","OMMS","GCS","B2","AZURE","TRANSFER"],"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"system_name":{"type":"string"}},"required":["bucket_name","operation_type","storage_type","system_name"],"type":"object"},"StorageAccessesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/StorageAccessElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"StorageUsageSchema":{"properties":{"bucket_name":{"type":"string"},"bytes_stored":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"format":"date-time","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"storage_type":{"enum":["FILE","HTTP","FTP","SFTP","S3","OMMS","GCS","B2","AZURE","TRANSFER"],"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"system_name":{"type":"string"}},"required":["bucket_name","storage_type","system_name"],"type":"object"},"StorageUsagesElasticSchema":{"properties":{"bucket_name":{"type":"string"},"bytes_stored":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"}},"type":"object"},"StorageUsagesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/StorageUsagesElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"TranscoderUsageSchema":{"properties":{"adjusted_duration_seconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"date":{"format":"date","type":"string"},"destination_bytes":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"duration_seconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_user_transcoder":{"type":"boolean"},"job_id":{"format":"uuid","nullable":true,"type":"string"},"object_id":{"format":"uuid","nullable":true,"type":"string"},"object_type":{"nullable":true,"type":"string"},"operation_type":{"enum":["TRANSCODE","TRANSCODE_AUDIO","TRANSCODE_VIDEO","TRANSCODE_IMAGE","TRANSCODE_KEYFRAMES","MEDIAINFO","CONFORM","EXTRACT_AUDIO","EXTRACT_IMAGE","ANALYZE","TRANSCRIBE","TRANSCRIBE_HUMAN","FACE_RECOGNITION_IMAGE","FACE_RECOGNITION_VIDEO"],"nullable":true,"type":"string"},"percent_done":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"source_bytes":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["FAILED","FINISHED","ABORTED"],"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"system_name":{"type":"string"},"time":{"format":"date-time","type":"string"},"transcoder_type":{"enum":["VANTAGE","FFMPEG","FFMPEG_FIRST_FRAME","IMAGEMAGICK","SUBTITLES","ENCODING_COM","ZENCODER","TELESTREAM_CLOUD","GOOGLE_VIDEO_INTELLIGENCE","GOOGLE_VISION","COLLECTION_KEYFRAMES","AMAZON_REKOGNITION_IMAGE","AMAZON_REKOGNITION_VIDEO","ELEMENTAL_MEDIACONVERT","ELEMENTAL_SERVER","MEDIAINFO","ICONIK_EDGE_TRANSCODER","NONE","REV_AI_TRANSCRIPTION","GCVI_TRANSCRIPTION","AMAZON_TRANSCRIBE","OPEN_GRAPH","LIBREOFFICE","FACE_RECOGNITION","FLICS","WILDMOKA"],"type":"string"}},"required":["status","system_name","transcoder_type"],"type":"object"},"TranscoderUsagesElasticSchema":{"properties":{"count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"type":"string"},"destination_bytes":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"duration_seconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_user_transcoder":{"type":"boolean"},"operation_type":{"enum":["TRANSCODE","TRANSCODE_AUDIO","TRANSCODE_VIDEO","TRANSCODE_IMAGE","TRANSCODE_KEYFRAMES","MEDIAINFO","CONFORM","EXTRACT_AUDIO","EXTRACT_IMAGE","ANALYZE","TRANSCRIBE","TRANSCRIBE_HUMAN","FACE_RECOGNITION_IMAGE","FACE_RECOGNITION_VIDEO"],"type":"string"},"source_bytes":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"system_domain_id":{"format":"uuid","type":"string"},"transcoder_type":{"enum":["VANTAGE","FFMPEG","FFMPEG_FIRST_FRAME","IMAGEMAGICK","SUBTITLES","ENCODING_COM","ZENCODER","TELESTREAM_CLOUD","GOOGLE_VIDEO_INTELLIGENCE","GOOGLE_VISION","COLLECTION_KEYFRAMES","AMAZON_REKOGNITION_IMAGE","AMAZON_REKOGNITION_VIDEO","ELEMENTAL_MEDIACONVERT","ELEMENTAL_SERVER","MEDIAINFO","ICONIK_EDGE_TRANSCODER","NONE","REV_AI_TRANSCRIPTION","GCVI_TRANSCRIPTION","AMAZON_TRANSCRIBE","OPEN_GRAPH","LIBREOFFICE","FACE_RECOGNITION","FLICS","WILDMOKA"],"type":"string"}},"required":["transcoder_type"],"type":"object"},"TranscoderUsagesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/TranscoderUsagesElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"TransferStatsSchema":{"properties":{"bytes_sent":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"ip":{"type":"string"},"object_info":{"type":"string"},"object_name":{"type":"string"},"time_taken_us":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["bytes_sent"],"type":"object"},"UnpublishedUserAuditSchema":{"properties":{"app_id":{"format":"uuid","type":"string"},"client_ip":{"type":"string"},"date":{"format":"date","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_acting_as_user":{"type":"boolean"},"log_recipient_id":{"format":"uuid","type":"string"},"metadata":{"type":"string"},"operation_result":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"operation_type":{"enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"type":"string"},"original_user_id":{"format":"uuid","type":"string"},"payload":{"type":"string"},"request_id":{"type":"string"},"resource":{"type":"string"},"share_id":{"format":"uuid","type":"string"},"share_user_id":{"format":"uuid","type":"string"},"sudo":{"type":"boolean"},"system_domain_id":{"format":"uuid","type":"string"},"system_name":{"type":"string"},"time":{"format":"date-time","type":"string"},"user_agent":{"type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["log_recipient_id","operation_type","system_name"],"type":"object"},"UserAuditSchema":{"properties":{"app_id":{"format":"uuid","type":"string"},"client_ip":{"type":"string"},"date":{"format":"date","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_acting_as_user":{"type":"boolean"},"metadata":{"type":"string"},"operation_result":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"operation_type":{"enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"type":"string"},"original_user_id":{"format":"uuid","type":"string"},"payload":{"type":"string"},"request_id":{"type":"string"},"resource":{"type":"string"},"share_id":{"format":"uuid","type":"string"},"share_user_id":{"format":"uuid","type":"string"},"sudo":{"type":"boolean"},"system_domain_id":{"format":"uuid","type":"string"},"system_name":{"type":"string"},"time":{"format":"date-time","type":"string"},"user_agent":{"type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["operation_type","system_name"],"type":"object"},"UserUsagesDetailedSchema":{"properties":{"date":{"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"type":{"type":"string"},"user_id":{"format":"uuid","type":"string"}},"type":"object"},"UserUsagesElasticSchema":{"properties":{"count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"date":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"format":"uuid","type":"string"},"user_name":{"type":"string"}},"type":"object"},"UserUsagesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/UserUsagesElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"}}},"info":{"title":"Iconik Stats","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/assets/":{"post":{"description":"<br/>system_domain_id will be automatically added when<br/>posting to this end point.","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUsageSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUsageSchema"}}},"description":"Usage entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Sets asset usage."}},"/v1/assets/by/{period}/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Period of stats (month or day)","in":"path","name":"period","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by to_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUsageSchema"}}},"description":"Returns asset usage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns all asset usage"}},"/v1/automations/usage/by/day/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by to_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunsSchema"}}},"description":"Returns automation runs by day"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns automation runs by day."}},"/v1/billing/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by from_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":100,"format":"int32","type":"integer"},"style":"form"},{"description":"ID of a last file on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingsSchema"}}},"description":"Returns billing data"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing info"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSchema"}}},"description":"Usage entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Updates Billing (Requires super admin access)."}},"/v1/billing/charges/{charge_id}/receipt_url/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"charge_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingReceiptSchema"}}},"description":"Billing receipts"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing receipt"}},"/v1/billing/credits/":{"post":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCreditsSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCreditsSchema"}}},"description":"Credits entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Add credits to an account"}},"/v1/billing/credits/price/":{"get":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"credits","required":true,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditsSchema"}}},"description":"Credits entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Checks the total price that needs to be paid including VAT if it's needed"}},"/v1/billing/credits/verify/":{"post":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCreditsVerifySchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCreditsVerifySchema"}}},"description":"Credits entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Verify status of add credits to an account"}},"/v1/billing/customer/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSchema"}}},"description":"Usage entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing customer"},"post":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCustomerSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCustomerSchema"}}},"description":"Usage entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Updates billing customer"}},"/v1/billing/customer/card/":{"delete":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Card deleted"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Creates billing customer card"},"post":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCustomerCardSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCustomerCardSchema"}}},"description":"Usage entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Creates billing customer card"}},"/v1/billing/invoices/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"starting_after","schema":{"type":"string"},"style":"form"},{"in":"query","name":"limit","schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"description":"Billing invoices"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing invoices"}},"/v1/billing/price_lists/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesSchema"}}},"description":"Prices"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get All Price Lists"},"put":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchema"}}},"description":"Prices"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Creates or updates a Price List"}},"/v1/billing/price_lists/{name}/{currency}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"currency","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a Price list"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"currency","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchema"}}},"description":"Prices"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a Price List"}},"/v1/billing/recipients/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingRecipientsSchema"}}},"description":"Email recipients"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Updates Billing Recipients"},"put":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingRecipientsSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingRecipientsSchema"}}},"description":"Email recipients"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Updates Billing Recipients"}},"/v1/billing/settings/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSettingsSchema"}}},"description":"Email recipients"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Updates Billing Settings"},"put":{"description":"\nRequired roles:\n - can_write_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSettingsSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSettingsSchema"}}},"description":"Email recipients"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Updates Billing Settings"}},"/v1/billing/status/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingStatsSchema"}}},"description":"Billing status"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing status"}},"/v1/billing/{system_domain_id}/{billing_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"billing_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Usage deleted"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete billing record (Requires super admin access)."}},"/v1/billing_expiration/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":100,"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingsSchema"}}},"description":"Returns billing data"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing expiration info"}},"/v1/billing_expiration/{system_domain_id}/{billing_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"billing_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Billing expiration deleted"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete billing expiration record (Requires super admin access)."},"put":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"billing_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingExpirationUpdateSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSchema"}}},"description":"Billing expiration updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update billing expiration record (Requires super admin access)."}},"/v1/collections/by/{period}/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Period of stats (month or day)","in":"path","name":"period","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by to_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionUsageSchema"}}},"description":"Returns Collection usage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns all collection usage"}},"/v1/current_usage/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":100,"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentUsageSchema"}}},"description":"Returns current usage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns current usage for system domains"}},"/v1/id/{object_id}/info/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Object ID","in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Returns asset usage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Internal endpoint to convert ID to system domain"}},"/v1/ordway/billing/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by from_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingsSchema"}}},"description":"Returns billing data"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing info"}},"/v1/ordway/billing/customer/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSchema"}}},"description":"Usage entered"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing customer"}},"/v1/ordway/billing/invoices/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"}],"responses":{"200":{"description":"Billing invoices"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns billing invoices"}},"/v1/paygo_costs/":{"get":{"description":"\nRequired roles:\n - can_read_billing\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaygoCostsSchema"}}},"description":"Returns billing data"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns monthly costs from billing"}},"/v1/storage/access/by/{period}/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Period of stats (month or day)","in":"path","name":"period","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by to_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAccessesSchema"}}},"description":"Returns a object for storage access"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns storage_access for all storages"}},"/v1/storage/usage/by/{period}/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Period of stats (month or day)","in":"path","name":"period","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by to_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageUsagesSchema"}}},"description":"Returns storage usage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns storage_usage for all storages"}},"/v1/system/logs/recipients/":{"get":{"description":"\nRequired roles:\n - can_read_logs_recipients\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last service account set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientsSchema"}}},"description":"Returns logs recipients settings"},"401":{"description":"Token is invalid"},"404":{"description":"Logs recipients settings don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get logs recipients settings"},"post":{"description":"\nRequired roles:\n - can_write_logs_recipients\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientReadSchema"}}},"description":"Returns a logs_recipient object"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create logs recipient settings"}},"/v1/system/logs/recipients/{logs_recipient_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_logs_recipients\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"logs_recipient_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Logs recipient doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete logs recipient settings"},"get":{"description":"\nRequired roles:\n - can_read_logs_recipients\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"logs_recipient_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientReadSchema"}}},"description":"Returns settings for a logs recipients"},"401":{"description":"Token is invalid"},"404":{"description":"Logs recipients settings don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get settings of a logs recipient"},"patch":{"description":"\nRequired roles:\n - can_write_logs_recipients\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"logs_recipient_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientReadSchema"}}},"description":"Returns changed system settings"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Logs recipient doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Change logs recipient settings"},"post":{"description":"\nRequired roles:\n - can_write_logs_recipients\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"logs_recipient_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_check":{"example":false,"type":"boolean"},"error_message":{"type":"string"}},"type":"object"}}},"description":"Returns a document describing storage access"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Logs recipient doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Test logs recipient connection"},"put":{"description":"\nRequired roles:\n - can_write_logs_recipients\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"logs_recipient_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRecipientReadSchema"}}},"description":"Returns changed system settings"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Logs recipient doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Change logs recipient settings"}},"/v1/transcoder/usage/by/{period}/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"period","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by to_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderUsagesSchema"}}},"description":"Returns a transcoder usage objects"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns transcoder_usage for all transcoders"}},"/v1/user/audit/by/{period}/":{"get":{"description":"\nRequired roles:\n - can_read_stats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Period of stats (month, day or day_detailed)","in":"path","name":"period","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Filter by from_date","in":"query","name":"from_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by to_date","in":"query","name":"to_date","schema":{"type":"string"},"style":"form"},{"description":"Filter by system_domain_id (Only for super admins)","in":"query","name":"system_domain_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUsagesSchema"}}},"description":"Returns user usage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns all audit"}}},"servers":[{"url":"/API/stats/"}]}