nomad/website/source/docs/http/periodic.html.md

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
http	HTTP API: /v1/periodic	docs-http-periodic	The '/v1/periodic' endpoint is used to interact with periodic jobs.

/v1/periodic

The periodic endpoint is used to interact with a single periodic job. By default, the agent's local region is used; another region can be specified using the ?region= query parameter.

PUT / POST

Description

Forces a new instance of the periodic job. A new instance will be created even if it violates the job's [`prohibit_overlap`](/docs/jobspec/index.html#prohibit_overlap) settings. As such, this should be only used to immediately run a periodic job.

Method

PUT or POST

URL

`/v1/periodic//force`

Parameters

None

Returns

```javascript
{
"EvalCreateIndex": 7,
"EvalID": "57983ddd-7fcf-3e3a-fd24-f699ccfb36f4"
}
```