openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 56.2 kB
JSON
{"openapi":"3.0.0","info":{"title":"watchful.li","version":"1.0.0","x-apisguru-categories":["hosting"],"x-logo":{"backgroundColor":"#1B4E65","url":"https://d2071nnd6m4201.cloudfront.net/templates/balloon/images/logo.svg"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.31"},"format":"swagger","url":"hhttps://app.watchful.net/api/v1/api-docs/","version":"1.2"}],"x-providerName":"watchful.li"},"externalDocs":{"url":"https://watchful.li/faqs/tools/watchful-rest-api.html"},"tags":[{"description":"Operations about audits","name":"audits"},{"description":"Operations about extensions","name":"extensions"},{"description":"Operations about feedbacks","name":"feedbacks"},{"description":"Operations about logs","name":"logs"},{"description":"Create reports in PDF","name":"reports"},{"description":"Operations about sites","name":"sites"},{"description":"Operations about SsoUser","name":"ssousers"},{"description":"Operations about tags","name":"tags"}],"paths":{"/audits":{"get":{"description":"Returns a list of audits","operationId":"getAudits","parameters":[{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field separete by comas. Add + / - after field for set ASC / DESC: type+,name-","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Audit"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Audit"}}}},"403":{"description":"Invalid API Key"}},"summary":"Get a list of audits","tags":["audits"]}},"/audits/metadata":{"get":{"description":"Returns a list of fields","operationId":"getFieldsAudits","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}}},"summary":"Get the list of fields","tags":["audits"]}},"/audits/{id}":{"delete":{"description":"Delete a specific audit","operationId":"deleteAuditById","parameters":[{"description":"ID of audit that needs to be deleted","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Audit correctly deleted","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Delete a specific audit","tags":["audits"]},"get":{"description":"Returns a audit based on ID","operationId":"getAuditById","parameters":[{"description":"ID of audit that needs to be fetched","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Audit"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Audit"}}}},"400":{"description":"Invalid ID"},"403":{"description":"Invalid API Key"}},"summary":"Find audit by ID","tags":["audits"]}},"/extensions":{"get":{"description":"Returns a list Extensions","operationId":"getExtensions","parameters":[{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"ext_name","required":false,"schema":{"type":"string"}},{"description":"List of sites id separated by comma","in":"query","name":"siteids","required":false,"schema":{"type":"string"}},{"description":"Do a 'LIKE' search, you can also use '%'. technical name of the extension com_xxxx","in":"query","name":"ext_prefix","required":false,"schema":{"type":"string"}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"version","required":false,"schema":{"type":"string"}},{"description":"update available for this extension","in":"query","name":"vUpdate","required":false,"schema":{"type":"integer","enum":[1,0]}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field separete by comas. Add + / - after field for set ASC / DESC: type+,name-","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extension"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Extension"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Extension"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid"}},"summary":"Get a list Extensions","tags":["extensions"]}},"/extensions/metadata":{"get":{"description":"Returns a list of fields","operationId":"getFieldsExtensions","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}}},"summary":"Get the list of fields","tags":["extensions"]}},"/extensions/{id}/ignore":{"post":{"description":"Set 'ignore updates' for a given extension / site_id","operationId":"ignoreExtensionUpdate","parameters":[{"description":"ID of the extension","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Extension successfully updated","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Update not found for the given extension"}},"summary":"Set 'ignore updates' for a given extension / site_id","tags":["extensions"]}},"/extensions/{id}/unignore":{"post":{"description":"Remove 'ignore updates' for a given extension","operationId":"unignoreExtensionUpdate","parameters":[{"description":"ID of the extension","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Extension successfully updated","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Update not found for the given extension"}},"summary":"Remove 'ignore updates' for a given extension","tags":["extensions"]}},"/extensions/{id}/update":{"post":{"description":"Update the extension on the remote site","operationId":"updateExtension","parameters":[{"description":"ID of the extension","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Extension successfully updated","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Update not found for the given extension"}},"summary":"Update the extension on the remote site","tags":["extensions"]}},"/feedbacks":{"get":{"description":"Returns a list of feedbacks","operationId":"getFeedbacks","parameters":[{"description":"Fields to return separate by comas (es. name,id)","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feedback"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Feedback"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Feedback"}}}},"403":{"description":"Invalid API Key"}},"summary":"Get feedbacks","tags":["feedbacks"]},"post":{"description":"Create a feedback","operationId":"createFeedbacks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feedback"}}},"description":"JSON object Feedback","required":true},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Audit"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Audit"}}}},"201":{"description":"Saved successfully"},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Not saved"}},"summary":"Create a feedback","tags":["feedbacks"]}},"/feedbacks/metadata":{"get":{"description":"Returns a list of fields","operationId":"getFieldsFeedbacks","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}}},"summary":"Get the list of fields","tags":["feedbacks"]}},"/logs":{"get":{"description":"Returns a list of logs","parameters":[{"description":"Type of the log","in":"query","name":"log_type","schema":{"type":"string","enum":["","plugin_sends_error","curlerror","modified_file","word_not_in_homepage","file_not_exists","update_available","new_extension","deleted_extension","extension_not_saved","modified_value_files","custom"]}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"log_entry","required":false,"schema":{"type":"string"}},{"description":"Logs after this date, format YYYY-MM-DD HH:MM:SS","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Logs before this date, format YYYY-MM-DD HH:MM:SS","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field separete by comas. Add + / - after field for set ASC / DESC: type+,name-","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Log"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Log"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Log"}}}},"403":{"description":"Invalid API Key"}},"summary":"Get a list of logs","tags":["logs"]}},"/logs/export":{"get":{"description":"Returns a file contain the list of logs","operationId":"getExportLogs","parameters":[{"description":"Format of exported file (PDF or CSV)","in":"query","name":"format","required":true,"schema":{"type":"string","enum":["csv","pdf"]}},{"description":"Site id of the log","in":"query","name":"site","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"Type of the log","in":"query","name":"filter_type","schema":{"type":"string","enum":["","plugin_sends_error","curlerror","modified_file","word_not_in_homepage","file_not_exists","update_available","new_extension","deleted_extension","extension_not_saved","modified_value_files","custom"]}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"Logs after this date, format YYYY-MM-DD HH:MM:SS","in":"query","name":"startdate","required":false,"schema":{"type":"string"}},{"description":"Logs before this date, format YYYY-MM-DD HH:MM:SS","in":"query","name":"enddate","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"startid","required":false,"schema":{"type":"integer","format":"int64","minimum":0}}],"responses":{"200":{"description":"No response was specified"},"403":{"description":"Invalid API Key"}},"summary":"Get a CSV or PDF file contain the list of logs","tags":["logs"]}},"/logs/metadata":{"get":{"description":"Returns a list of fields","operationId":"getFieldsLogs","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}}},"summary":"Get the list of fields","tags":["logs"]}},"/logs/types":{"get":{"description":"Returns a list of log types","operationId":"getTypesLogs","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}}},"summary":"Get the list of log types","tags":["logs"]}},"/logs/{id}":{"delete":{"description":"Delete a specific log","operationId":"deleteLogById","parameters":[{"description":"ID of log that needs to be deleted","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Log correctly deleted","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Delete a specific log","tags":["logs"]}},"/packages":{"post":{"responses":{"default":{"description":"No description"}}}},"/reports/sites/{id}":{"get":{"description":"Returns a PDF report based on a site ID","parameters":[{"description":"ID that needs to be fetched","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the report, format YYYY-MM-DD, default today-30day ","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"End of the report, format YYYY-MM-DD, default today","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Type of reports separate by comas: Ga,Logs,Uptime","in":"query","name":"reports","required":false,"schema":{"type":"string"}},{"description":"Type of the log to show in the report","in":"query","name":"log_type","schema":{"type":"string","enum":["","plugin_sends_error","curlerror","modified_file","word_not_in_homepage","file_not_exists","update_available","new_extension","deleted_extension","extension_not_saved","modified_value_files"]}},{"description":"Define if you want show previous values in Google Analytics graph","in":"query","name":"compare","schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"No response was specified","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Reports"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Returns a PDF report for a specific site","tags":["reports"]}},"/reports/tags/{id}":{"get":{"description":"Returns a report based on a site ID","parameters":[{"description":"ID that needs to be fetched","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the report, format YYYY-MM-DD, default today-30day ","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"End of the report, format YYYY-MM-DD, default today","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Type of reports separate by comas: Ga,Logs,Uptime","in":"query","name":"reports","required":false,"schema":{"type":"string"}},{"description":"Type of the log to show in the report","in":"query","name":"log_type","schema":{"type":"string","enum":["","plugin_sends_error","curlerror","modified_file","word_not_in_homepage","file_not_exists","update_available","new_extension","deleted_extension","extension_not_saved","modified_value_files"]}},{"description":"Define if you want show previous values in Google Analytics graph","in":"query","name":"compare","schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"No response was specified","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Reports"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Find sites by ID","tags":["reports"]}},"/sites":{"get":{"description":"Returns a list of Sites","operationId":"getSites","parameters":[{"description":"List of sites id separated by comma","in":"query","name":"siteids","required":false,"schema":{"type":"string"}},{"description":"Site name. Do a 'LIKE' search, you can also use '%'","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Access URL. Do a 'LIKE' search, you can also use '%'","in":"query","name":"access_url","required":false,"schema":{"type":"string"}},{"description":"Joomla version. Do a 'LIKE' search, you can also use '%'","in":"query","name":"j_version","required":false,"schema":{"type":"string"}},{"description":"Ip address. Do a 'LIKE' search, you can also use '%'","in":"query","name":"ip","required":false,"schema":{"type":"string"}},{"description":"Joomla core update status (1: update required, 0: update not required)","in":"query","name":"jUpdate","schema":{"type":"integer","enum":[1,0]}},{"description":"canUpdate","in":"query","name":"canUpdate","schema":{"type":"integer","enum":[1,0]}},{"description":"Is published","in":"query","name":"published","required":false,"schema":{"type":"integer","enum":[1,0]}},{"description":"Has errors","in":"query","name":"error","required":false,"schema":{"type":"string"}},{"in":"query","name":"nbUpdates","required":false,"schema":{"type":"string"}},{"description":"Is online","in":"query","name":"up","required":false,"schema":{"type":"integer","enum":[1,0]}},{"description":"Fields to return separated by commas (e.g. name,id)","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of objects to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field separete by comas. Add + / - after field for set ASC / DESC: type+,name-","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Get a list of Sites","tags":["sites"]},"post":{"description":"Create a site","operationId":"createSite","requestBody":{"$ref":"#/components/requestBodies/PostSite"},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"201":{"description":"Saved successfully"},"400":{"description":"Invalid data"},"403":{"description":"Not allowed to add sites"},"404":{"description":"Not saved"}},"summary":"Create a site","tags":["sites"]}},"/sites/metadata":{"get":{"description":"Returns a list of fields","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}}},"summary":"Get the list of fields","tags":["sites"]}},"/sites/{id}":{"delete":{"description":"Delete a specific Site","parameters":[{"description":"ID of Site that needs to be deleted","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Deleted successfully","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Delete a specific Site","tags":["sites"]},"get":{"description":"Return a site based on ID","operationId":"getSiteById","parameters":[{"description":"ID that needs to be fetched","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Find sites by ID","tags":["sites"]},"put":{"description":"Update a site","parameters":[{"description":"ID of the website that needs to be update","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"requestBody":{"$ref":"#/components/requestBodies/PostSite"},"responses":{"200":{"description":"Updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Update a site","tags":["sites"]}},"/sites/{id}/audits":{"get":{"description":"Return audits for a specific website","operationId":"getSiteAudits","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Audits"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Audits"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Return audits for a specific website","tags":["sites"]},"post":{"description":"Create an audit for the site","operationId":"createAudits","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Audit"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Audit"}}}},"201":{"description":"Saved successfully"},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Not saved"}},"summary":"Create an audit for the site","tags":["sites"]}},"/sites/{id}/backupnow":{"post":{"description":"Add the site to the backup queue","operationId":"addSiteToBackupQueue","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Add the site to the backup queue","tags":["sites"]}},"/sites/{id}/backupprofiles":{"get":{"description":"Return backup profile","operationId":"getBackupProfiles","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified"},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Return backup profile","tags":["sites"]}},"/sites/{id}/backups":{"get":{"description":"List of latest backups","operationId":"getListBackups","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified"},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"List of latest backups","tags":["sites"]}},"/sites/{id}/backupstart":{"post":{"description":"Start a remote backup for the site","operationId":"startSiteBackup","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Start a remote backup for the site","tags":["sites"]}},"/sites/{id}/backupstep":{"post":{"description":"Step (continue) a remote backup for the site","operationId":"stepSiteBackup","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Step (continue) a remote backup for the site","tags":["sites"]}},"/sites/{id}/extensions":{"get":{"description":"Get extensions for a site","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extension"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Extension"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Extension"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid"}},"summary":"Get extensions for a site","tags":["sites"]},"post":{"operationId":"installExtension","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"URL to install the extension from","in":"query","name":"url","required":true,"schema":{"type":"string","format":"url"}}],"responses":{"200":{"description":"No response was specified"},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Install extension","tags":["sites"]}},"/sites/{id}/logs":{"get":{"description":"Return logs for a specific website","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"log_entry","required":false,"schema":{"type":"string"}},{"description":"Type of the log","in":"query","name":"log_type","schema":{"type":"string","enum":["","plugin_sends_error","curlerror","modified_file","word_not_in_homepage","file_not_exists","update_available","new_extension","deleted_extension","extension_not_saved","modified_value_files"]}},{"description":"Logs after this date, format YYYY-MM-DD HH:MM:SS","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Logs before this date, format YYYY-MM-DD HH:MM:SS","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field separete by comas. Add + / - after field for set ASC / DESC: type+,name-","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Log"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Log"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Log"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Return logs for a specific website","tags":["sites"]},"post":{"description":"Create a custom log for a specific website","operationId":"CreateLog","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostLog"}}},"description":"JSON object Log (only type custom)","required":true},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Log"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Log"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Log"}}}},"201":{"description":"Saved successfully"},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Not saved"}},"summary":"Create a custom log for a specific website","tags":["sites"]}},"/sites/{id}/monitor":{"delete":{"description":"Return boolean","operationId":"deleteMonitor","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Monitor"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Monitor"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Delete uptime monitor","tags":["sites"]},"post":{"description":"Return boolean","operationId":"postMonitor","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Monitor"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Monitor"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Post uptime monitor","tags":["sites"]}},"/sites/{id}/scanner":{"get":{"description":"Scan the site for malware","operationId":"scanner","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Scan the site for malware","tags":["sites"]}},"/sites/{id}/seo":{"get":{"description":"SEO analyze for a page","operationId":"seoAnalyze","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"SEO analyze for a page","tags":["sites"]}},"/sites/{id}/tags":{"get":{"description":"Return tags for a specific website","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Bootstrap color of the tag","in":"query","name":"type","schema":{"type":"string","enum":["","default","success","warning","important","info","inverse"]}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Tag"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Return tags for a specific website","tags":["sites"]},"post":{"description":"Add tags for a specific website","operationId":"postTags","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"requestBody":{"$ref":"#/components/requestBodies/Tag"},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"201":{"description":"Saved successfully"},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Add tags for a specific website","tags":["sites"]}},"/sites/{id}/updatejoomla":{"post":{"description":"Update Joomla core on the remote site","operationId":"updateJoomla","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Joomla core successfully updated","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID or Joomla Update not found"}},"summary":"Update Joomla core on the remote site","tags":["sites"]}},"/sites/{id}/uptime":{"get":{"description":"Return uptime data","operationId":"getUptime","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uptime"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Uptime"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Uptime"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Return uptime data","tags":["sites"]}},"/sites/{id}/validate":{"get":{"description":"validate the site","operationId":"validateSite","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Log"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Log"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Log"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"validate the site, return the new logs","tags":["sites"]}},"/sites/{id}/validatedebug":{"get":{"operationId":"validateDebugSite","parameters":[{"description":"ID of the website","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Log"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Log"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Log"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"validate the site, return the debug information","tags":["sites"]}},"/ssousers":{"get":{"description":"Returns a list of SSO Users","operationId":"getSsoUsers","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"text/plain":{"schema":{"$ref":"#/components/schemas/SsoUsers"}}}},"403":{"description":"Invalid API Key"}},"summary":"Get a list of SSO Users","tags":["ssousers"]},"post":{"description":"Create a SSO User","operationId":"CreateSsoUsers","requestBody":{"$ref":"#/components/requestBodies/SsoUsers"},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"text/plain":{"schema":{"$ref":"#/components/schemas/SsoUsers"}}}},"201":{"description":"Saved successfully"},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Not saved"}},"summary":"Create a SSO User","tags":["ssousers"]}},"/ssousers/{id}":{"delete":{"description":"Delete a specific SSO User","operationId":"deleteSsoUserById","parameters":[{"description":"ID of SSO User that needs to be deleted","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"SSO User correctly deleted","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Delete a specific SSO User","tags":["ssousers"]},"get":{"description":"Returns a SSO User based on ID","operationId":"getSsoUsersById","parameters":[{"description":"ID of SSO User that needs to be fetched","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"text/plain":{"schema":{"$ref":"#/components/schemas/SsoUsers"}}}},"400":{"description":"Invalid ID"},"403":{"description":"Invalid API Key"}},"summary":"Find SSO User by ID","tags":["ssousers"]},"put":{"description":"Update a SSO User","operationId":"UpdateSsoUsers","parameters":[{"description":"ID of SSO User that needs to be updated","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"requestBody":{"$ref":"#/components/requestBodies/SsoUsers"},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SsoUsers"}},"text/plain":{"schema":{"$ref":"#/components/schemas/SsoUsers"}}}},"201":{"description":"Updated successfully"},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Not saved"}},"summary":"Update a SSO User","tags":["ssousers"]}},"/tags":{"get":{"description":"Returns a list of tags","parameters":[{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Bootstrap color of the tag","in":"query","name":"type","schema":{"type":"string","enum":["","default","success","warning","important","info","inverse"]}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field separete by comas. Add + / - after field for set ASC / DESC: type+,name-","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Tag"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"403":{"description":"Invalid API Key"}},"summary":"Get a list of tags","tags":["tags"]},"post":{"description":"Create a tag","operationId":"CreateTags","requestBody":{"$ref":"#/components/requestBodies/Tag"},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Tag"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"201":{"description":"Saved successfully"},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Not saved"}},"summary":"Create a tag","tags":["tags"]}},"/tags/metadata":{"get":{"description":"Returns a list of fields","responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}}},"summary":"Get the list of fields","tags":["tags"]}},"/tags/{id}":{"delete":{"description":"Delete a specific tag","parameters":[{"description":"ID of tag that needs to be deleted","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Tag correctly deleted","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Delete a specific tag","tags":["tags"]},"get":{"description":"Returns a tag based on ID","operationId":"getTagById","parameters":[{"description":"ID of tag that needs to be fetched","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Tag"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"400":{"description":"Invalid ID"},"403":{"description":"Invalid API Key"}},"summary":"Find tag by ID","tags":["tags"]},"put":{"description":"Update a tag","operationId":"UpdateTag","parameters":[{"description":"ID of tag","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"JSON object of the updated tag","required":true},"responses":{"200":{"description":"Updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Tag"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"400":{"description":"Invalid data"},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Update a tag","tags":["tags"]}},"/tags/{id}/sites":{"get":{"description":"Returns a list of sites based with a specific tag id","operationId":"getSitesByTags","parameters":[{"description":"ID of tag that needs to be fetched","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"access_url","required":false,"schema":{"type":"string"}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"j_version","required":false,"schema":{"type":"string"}},{"description":"Do a 'LIKE' search, you can also use '%'","in":"query","name":"ip","required":false,"schema":{"type":"string"}},{"description":"Joomla core update","in":"query","name":"jUpdate","schema":{"type":"integer","enum":[1,0]}},{"description":"is published","in":"query","name":"published","required":false,"schema":{"type":"integer","enum":[1,0]}},{"description":"have errors","in":"query","name":"error","required":false,"schema":{"type":"string"}},{"in":"query","name":"nbUpdates","required":false,"schema":{"type":"string"}},{"description":"is the website online","in":"query","name":"up","required":false,"schema":{"type":"integer","enum":[1,0]}},{"description":"Fields to return separate by comas: name,id","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Number of object to return (max 100, default 25)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"description":"Start of the return (default 0)","in":"query","name":"limitstart","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"ORDER by this field separete by comas. Add + / - after field for set ASC / DESC: type+,name-","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Site"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Site"}}}},"403":{"description":"Invalid API Key"},"404":{"description":"Invalid ID"}},"summary":"Find sites by tag ID","tags":["tags"]}}},"servers":[{"url":"https://watchful.li/api/v1"}],"components":{"requestBodies":{"PostSite":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSite"}}},"description":"JSON object Site","required":true},"Tag":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"JSON object Tag",