NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Unique ID for the cron. |
|
| ID of the user who created the cron job. |
|
| ID of the user who owns the cron job. |
|
| ID of the namespace the cron job belongs to if any. |
|
| The name of the cron job. |
|
| The schedule of the cron job, will be one of:
|
|
| The build manifest the cron job submits on its interval. |
|
| The RFC3339 formatted string at which the cron job will next run. |
|
| The build manifest the cron job submits on its interval. |
|
| The RFC3339 formatted string at which the cron job will next run. |
|
| The build manifest the cron job submits on its interval. |
|
| The RFC3339 formatted string at which the cron job will next run. |
|
| The build manifest the cron job submits on its interval. |
|
| The RFC3339 formatted string at which the cron job will next run. |
|
| The RFC3339 formatted string at which the cron job was created. |
|
| The API URL to the cron entity itself. |
|
| The user who authored the cron job. |
|
| The user the cron job belongs to. |
|
| The namespace the cron job belongs to, if any. |
List the cron jobs for the currently authenticated user. The following parameters can be given as query parameters to the URL. This requires the cron:read
permission.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the cron jobs with names like the given value. |
This will return a list of cron jobs. The list will be paginated to 25 cron jobs per page, and will be ordered by the most recently created cron jobs first. If the crons were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/cron?page=1>; rel="prev",
<https://api.djinn-ci.com/cron?page=3>; rel="next"
This will create a cron job for the currently authenticated user. This requires the cron:write
permission.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| Yes | The name of the cron job. |
|
| No | The cron job's schedule, will be one of:
this will default to |
|
| Yes | The manifest to use for the cron job. |
This will get the builds on the given cron job. The following parameters can be given as query parameters to the URL. This requires the cron:read
permission.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| No | Get the builds with the given tag name. |
|
| No | Get the builds with tags like the given value. |
|
| No | Get the builds with the given status, will be one of:
|
This will return a list of builds. The list will be paginated to 25 builds per page, and will be ordered by the most recently submitted builds first. If the builds were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/cron/:id/builds?page=1>; rel="prev",
<https://api.djinn-ci.com/cron/:id/builds?page=3>; rel="next"
This will update the given cron job. This requies the cron:write
permission.
Note: If no parameters are sent in the request body, then nothing happens to the cron job.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| Yes | The name of the cron job. |
|
| No | The cron job's schedule, will be one of:
this will default to |
|
| Yes | The manifest to use for the cron job. |
This will return the updated cron job.
This will delete the cron job by the given :id
. This requires the cron:delete
permission.
This returns no content in the response body.