Show a cron job on a status page as a heartbeat component. Attaching one already there renames it.
POST
/status_page/{status_page_id}/cron_job/{cron_job_id}
const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cron_job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"friendly_name":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cron_job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "friendly_name": "example" }'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” status_page_id
required
string format: uuid
Status page identifier
cron_job_id
required
string format: uuid
Cron job identifier
Request Body required
Section titled “Request Body required ” Media type application/json
object
friendly_name
required
The name the page shows. Up to 256 characters.
string
Example generated
{ "friendly_name": "example"}Responses
Section titled “ Responses ”The cron job is on the page
Invalid request body, or the page already shows 100 components
Missing or invalid authentication
Status page or cron job not found
Internal server error