Skip to Content

IBA API — Crons

1 endpoint. Server: https://api.tunnelflight.com/api

Run cron

GET /crons/run/{cron_name}

Endpoint: GET /crons/run/:cron_name

This endpoint is used to trigger the execution of a specific cron job identified by cron_name. It allows users to manually run scheduled tasks that are defined in the system.

Path Parameters

  • cron_name (string): The name of the cron job that you wish to execute. This parameter is required and should correspond to an existing cron job in the system.

Response Structure

Upon successful execution of the cron job, the response will typically include the following fields:

  • status (string): Indicates the result of the cron job execution (e.g., “success”, “failed”).

  • message (string): Provides additional information regarding the execution, such as errors or success messages.

  • timestamp (string): The time at which the cron job was executed.

This endpoint is useful for administrators or automated systems that need to execute cron jobs on demand.

Path parameters

NameTypeRequiredDescription
cron_namestringyesExample: test_cron

Headers

NameTypeRequiredDescription
AuthorizationstringyesBearer token. Required for every request.
client-idstringyesClient identifier issued by IBA. Required for every request.
tokenstringnoExample: sLlWSCYeLBeCv0bVFs71

Responses

2XX — Successful response

Try it

curl --request GET \ --url 'https://api.tunnelflight.com/api/crons/run/{cron_name}' \ --header 'Authorization: Bearer <token>' \ --header 'client-id: <client-id>' \ --header 'token: <token>'

View source on GitHub → 

Last updated on