Update a job template

PATCH /api/job-templates/{id}

Update a job template

Operation ID: updateJobTemplate

Authentication

Option 1

• BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

• CookieAuth (apiKey) Session cookie set after login + TOTP verification

Path parameters

• id — integer, required Resource ID

Request body

The request body is required.

application/json

• Type: object
• Properties:
  • name (string)
  • description (string)
  • yaml_content (string)
  • status (string)

Success responses

200

Template updated with DAG

Content type: application/json

• Type: JobTemplate & object
• All of:
  • Variant 1:
    • Reference: JobTemplate
      • Type: object
      • Properties:
        • id (integer)
        • name (string)
        • description (string | null)
          • Nullable: yes
        • yaml_content (string)
        • status (string)
          • Allowed values: active, archived
        • created_at (string)
          • Format: date-time
        • updated_at (string)
          • Format: date-time
  • Variant 2:
    • Type: object
    • Properties:
      • dag (object | null)
        • Nullable: yes
        • Properties:
          • tasks (object)
            • Additional properties: allowed
          • levels (array<array<string>>)
            • Items:
              • Type: array<string>
              • Items:
                • Type: string
      • connectors (object | null)
        • Nullable: yes
        • Additional properties:
          • Type: object
          • Properties:
            • type (string)

Error responses

400

Validation error

Content type: application/json

• Reference: Error
  • Type: object
  • Properties:
    • error (string)
      • Example: NOT_FOUND
    • message (string)
      • Example: Resource not found

Example:

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

Examples

cURL

curl --request PATCH \
  --url 'https://your-envoy.example.com/api/job-templates/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "description": "string",
  "yaml_content": "string",
  "status": "string"
}'

JavaScript (fetch)

const response = await fetch('https://your-envoy.example.com/api/job-templates/YOUR_ID', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "yaml_content": "string",
    "status": "string"
  }),
});
 
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);