# Blue Prism Schedules API

**Canonical:** https://apis.io/apis/blue-prism/blue-prism-schedules-api/  
**Provider:** Blue Prism — https://apis.io/providers/blue-prism/  
**Base URL:** https://{address}/api/v7  
**Documentation:** https://documentation.blueprism.com/bp-7-5/en-us/bp-api/api-spec-home.htm

Blue Prism Schedules API is one of 18 APIs that [Blue Prism](https://apis.io/providers/blue-prism/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Schedule. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

The Schedules API from Blue Prism — 14 operation(s) for schedules.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v7/schedules` | Return a list of schedules in the environment |
| POST | `/api/v7/schedules` | Create a new schedule definition |
| GET | `/api/v7/schedules/{scheduleId}` | Return requested schedule summary |
| PUT | `/api/v7/schedules/{scheduleId}` | Update a given schedule |
| DELETE | `/api/v7/schedules/{scheduleId}` | Delete a specified schedule |
| POST | `/api/v7/schedules/{scheduleId}/clones` | Clone a new schedule definition |
| POST | `/api/v7/schedules/{scheduleId}/sessions` | Create a session and set a schedule to run at a specific date and time |
| DELETE | `/api/v7/schedules/{scheduleId}/sessions` | Request the schedule to stop |
| DELETE | `/api/v7/schedules/{scheduleId}/runs/active` | Request the schedule to stop |
| GET | `/api/v7/schedules/{scheduleId}/tasks` | Return a list of tasks in a schedule |
| POST | `/api/v7/schedules/{scheduleId}/tasks` | Create a task in a schedule |
| GET | `/api/v7/schedules/{scheduleId}/tasks/{taskId}` | Return a given scheduled task |
| DELETE | `/api/v7/schedules/{scheduleId}/tasks/{taskId}` | Delete a given scheduled task |
| PUT | `/api/v7/schedules/{scheduleId}/tasks/{taskId}` | Update a given scheduled task |
| DELETE | `/api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions/{sessionId}` | Delete scheduled task session |
| GET | `/api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions` | Return a list of the scheduled sessions for a specified task |
| POST | `/api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions` | Create a scheduled session in task |
| GET | `/api/v7/schedules/tasks/{taskId}/sessions` | Return a list of the scheduled sessions for a specified task |
| PUT | `/api/v7/schedules/{scheduleId}/tasks/{taskId}/scheduledSessionParameters` | Update start-up parameters |
| GET | `/api/v7/schedules/{scheduleId}/tasks/{taskId}/scheduledSessionParameters` | Return start-up parameters |
| GET | `/api/v7/schedules/{scheduleId}/logs` | Return all logs for a specified schedule |
| GET | `/api/v7/schedules/logs` | Return all schedule logs |
| POST | `/api/v7/schedules/{scheduleId}/runs` | Create a session and set a schedule to run at a specific date and time |

## Machine-readable artifacts (13)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/openapi/blue-prism-schedules-api-openapi.yml
- **Documentation** — https://documentation.blueprism.com/bp-7-5/en-us/bp-api/api-spec-home.htm
- **APIReference** — https://documentation.blueprism.com/bp-7-5/en-us/bp-api/bpe-7-5-1-api-spec.html
- **GettingStarted** — https://documentation.blueprism.com/bp-7-5/en-us/Guides/bp-api/api-introduction.htm
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/authentication/blue-prism-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/scopes/blue-prism-scopes.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/conventions/blue-prism-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/errors/blue-prism-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/data-model/blue-prism-data-model.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/asyncapi/blue-prism-webhooks.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/lifecycle/blue-prism-lifecycle.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/conformance/blue-prism-conformance.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/rate-limits/blue-prism-rate-limits.yml

## Other Blue Prism APIs (12)

- [Process Intelligence API](https://apis.io/apis/blue-prism/process-intelligence/)
- [Blue Prism Calendars API](https://apis.io/apis/blue-prism/blue-prism-calendars-api/)
- [Blue Prism Dashboards API](https://apis.io/apis/blue-prism/blue-prism-dashboards-api/)
- [Blue Prism Encryption Schemes API](https://apis.io/apis/blue-prism/blue-prism-encryption-schemes-api/)
- [Blue Prism Environment Variables API](https://apis.io/apis/blue-prism/blue-prism-environment-variables-api/)
- [Blue Prism Health API](https://apis.io/apis/blue-prism/blue-prism-health-api/)
- [Blue Prism Licenses API](https://apis.io/apis/blue-prism/blue-prism-licenses-api/)
- [Blue Prism Pools API](https://apis.io/apis/blue-prism/blue-prism-pools-api/)
- [Blue Prism Processes API](https://apis.io/apis/blue-prism/blue-prism-processes-api/)
- [Blue Prism Resources API](https://apis.io/apis/blue-prism/blue-prism-resources-api/)
- [Blue Prism Schedule Logs API](https://apis.io/apis/blue-prism/blue-prism-schedulelogs-api/)
- [Blue Prism Sessions API](https://apis.io/apis/blue-prism/blue-prism-sessions-api/)

## Tags

Schedule

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/blue-prism/blue-prism-schedules-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/blue-prism/.