Retrieve a Schedule

get

/api/v2/schedules/{id}/

Make GET request to this resource to retrieve a single schedule record containing the following fields:

  • rrule: A value representing the schedules iCal recurrence rule. (string)
  • id: Database ID for this schedule. (integer)
  • type: Data type for this schedule. (choice)
  • url: URL for this schedule. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • created: Timestamp when this schedule was created. (datetime)
  • modified: Timestamp when this schedule was last modified. (datetime)
  • name: Name of this schedule. (string)
  • description: Optional description of this schedule. (string)
  • extra_data: (json)
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
  • scm_branch: (string)
  • job_type: (choice)
    • None: ---------
    • "": ---------
    • run: Run
    • check: Check
  • job_tags: (string)
  • skip_tags: (string)
  • limit: (string)
  • diff_mode: (boolean)
  • verbosity: (choice)
    • None: ---------
    • 0: 0 (Normal)
    • 1: 1 (Verbose)
    • 2: 2 (More Verbose)
    • 3: 3 (Debug)
    • 4: 4 (Connection Debug)
    • 5: 5 (WinRM Debug)
  • unified_job_template: (id)
  • enabled: Enables processing of this schedule. (boolean)
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
  • next_run: The next time that the scheduled action will run. (datetime)
  • timezone: (field)
  • until: (field)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

200 Response

Back to Top