Skip to main content
POST
/
projects
/
{project_reference}
/
jobs
Create Job
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "target": "<string>",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "config": {},
  "timeout_seconds": 2,
  "backoff_limit": 1
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cron_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "submitted",
  "target": "<string>",
  "config": {},
  "context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timeout_seconds": 123,
  "backoff_limit": 123,
  "exit_code": 123,
  "failed_reason": "<string>",
  "artifacts": [
    null
  ],
  "logs": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

​
project_reference
string
required

Project ID or slug

Body

application/json
​
name
string
required

Job name

​
target
string
required

Target image or command

​
environment_id
string<uuid>

Environment ID to scope this job to

​
config
object

Job configuration

​
timeout_seconds
integer

Timeout in seconds (default: 300)

Required range: x >= 1
​
backoff_limit
integer

Number of retries (default: 3)

Required range: x >= 0

Response

Job created

​
id
string<uuid>
required
​
project_id
string<uuid>
required
​
environment_id
string<uuid> | null
required
​
cron_job_id
string<uuid> | null
required
​
name
string
required
​
status
enum<string>
required
Available options:
submitted,
working,
completed,
failed,
canceled
​
target
string
required
​
config
object
required
​
context_id
string<uuid> | null
required
​
timeout_seconds
number
required
​
backoff_limit
number
required
​
exit_code
number | null
required
​
failed_reason
string | null
required
​
artifacts
null[]
required
​
logs
string | null
required
​
started_at
string | null
required
​
completed_at
string | null
required
​
created_by
string<uuid> | null
required
​
created_at
string
required
​
updated_at
string
required