# Schedules

## List all Schedules

Example:

```shell
curl  'https://<your domain>/v1alpha1/schedules?pageSize=1&pageToken=1' \
      -H "X-unSkript-API-Key:>token>"
```

{% openapi src="<https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45>" path="/v1alpha1/schedules" method="get" %}
[schedule\_api\_updated.json](https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media\&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45)
{% endopenapi %}

## Create a Schedule

This schedules "unSkript Rules" to run at 5 AM (GMT) every day:

```shell
curl  -X POST 'https://<api domain>/v1alpha1/schedules' \
      -H "X-unSkript-API-Key:<api token>" \
	  -d '{"schedule":{"proxyId":"1499f27c-640sdfds6-4fbd-bd1b-c6f92800018f", 
	       "runbookName":"unSkript rulez", 
	       "runbookId":"14fac589-5849-403b-afcf-ed80as79099500",  
	       "schedule":"* 5 * * *"}}'
```

{% openapi src="<https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45>" path="/v1alpha1/schedules" method="post" %}
[schedule\_api\_updated.json](https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media\&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45)
{% endopenapi %}

## Get a Specific Schedule's details

```shell
curl  'https://<domain>/v1alpha1/schedules/97b8208a-7b05-4212-b1c3-2e0f0abe8060' \
      -H "X-unSkript-API-Key:<api key>"
	  

```

{% openapi src="<https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45>" path="/v1alpha1/schedules/{scheduleId}" method="get" %}
[schedule\_api\_updated.json](https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media\&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45)
{% endopenapi %}

## Delete a schedule

```bash
curl  -X DELETE 'https://<domain>/v1alpha1/schedules/c67888f8-2df8-4248-9280-5c4b3589cf43' \
      -H "X-unSkript-API-Key:<api token>"
```

{% openapi src="<https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45>" path="/v1alpha1/schedules/{scheduleId}" method="delete" %}
[schedule\_api\_updated.json](https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media\&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45)
{% endopenapi %}

## Update a Schedule

{% openapi src="<https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45>" path="/v1alpha1/schedules/{scheduleId}" method="patch" %}
[schedule\_api\_updated.json](https://491011674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm4p7lGuBAXN5jCVyoF7P%2Fuploads%2FEDKcyONZ05VjsDO6kBU2%2Fschedule_api_updated.json?alt=media\&token=8a7b13a2-72dd-4fbb-91f5-4f2f25be4b45)
{% endopenapi %}