REST Endpoints - Revision history

Craig at 00:05, 16 December 2025

2025-12-16T00:05:02Z

← Older revision		Revision as of 00:05, 16 December 2025
Line 3,406:		Line 3,406:
	To retrieve job execution statistics. Assumes [[Built-in_Jobs#Obsidian_Execution_Statistics_Job\|Execution Statistics Job]] has run to completion at least once.		To retrieve job execution statistics. Assumes [[Built-in_Jobs#Obsidian_Execution_Statistics_Job\|Execution Statistics Job]] has run to completion at least once.

	== GET a list of job statistics ==		== GET a list of job execution statistics ==
	'''<code>GET http(s)://localhost/rest/stats[?jobNickname=jobname&job_id=1&duration=six_months&unit=seconds&status=completed&acrossHosts=false&host=prod.obsidian-a1&host=prod.obsidian-a2]</code>'''		'''<code>GET http(s)://localhost/rest/stats[?jobNickname=jobname&job_id=1&duration=six_months&unit=seconds&status=completed&acrossHosts=false&host=prod.obsidian-a1&host=prod.obsidian-a2]</code>'''

2025-12-15T21:57:07Z

GET a list of job statistics

← Older revision		Revision as of 21:57, 15 December 2025
Line 3,417:		Line 3,417:
	\| jobId \|\| N \|\| Allows targeting only specific jobs by id in the stats export. Supports multiple values.		\| jobId \|\| N \|\| Allows targeting only specific jobs by id in the stats export. Supports multiple values.
	\|-		\|-
	\| duration \|\| N \|\| Allows targeting stats durations. See [[Unified_API#Enumerations\|Enumerations]] for valid values. Supports multiple values.		\| duration \|\| N \|\| Allows targeting stats durations. See [[Unified_API#Enumerations\|Enumerations]] for valid values - case-insensitive. Supports multiple values.
	\|-		\|-
	\| unit \|\| N \|\| Allows targeting stats units. See [[Unified_API#Enumerations\|Enumerations]] for valid values. Supports multiple values.		\| unit \|\| N \|\| Allows targeting stats units. See [[Unified_API#Enumerations\|Enumerations]] for valid values - case-insensitive. Supports multiple values.
	\|-		\|-
	\| status \|\| N \|\| Allows targeting stats terminal statuses. See [[Unified_API#Enumerations\|Enumerations]] for valid values. Supports multiple values.		\| status \|\| N \|\| Allows targeting stats terminal statuses. See [[Unified_API#Enumerations\|Enumerations]] for valid values - case-insensitive. Supports multiple values.
	\|-		\|-
	\| host \|\| N \|\| Allows targeting stats from specific hosts. Supports multiple values.		\| host \|\| N \|\| Allows targeting stats from specific hosts. Supports multiple values.

2025-12-15T21:54:47Z

@@ Line 3,397: / Line 3,397: @@
 {	"alias": "@1105AMTuesdays",
 	"schedule": "5 11 * * 2"
+}
 </pre>

2025-12-14T01:15:09Z

← Older revision		Revision as of 01:15, 14 December 2025
Line 3,316:		Line 3,316:
	''As of version 5.0.''		''As of version 5.0.''

	These ~~endpoinds~~ can be used to manage schedule aliases. See [[Admin_Schedule_Aliases\|Schedule Aliases]] for more details.		These endpoints can be used to manage schedule aliases. See [[Admin_Schedule_Aliases\|Schedule Aliases]] for more details.

	==GET a list of schedule aliases ==		==GET a list of schedule aliases ==

2025-07-28T15:52:45Z

GET health details on an existing scheduling host

← Older revision		Revision as of 15:52, 28 July 2025
Line 1,899:		Line 1,899:
	'''Response bean class:''' <code>com.carfey.ops.api.bean.host.HostDetail</code>		'''Response bean class:''' <code>com.carfey.ops.api.bean.host.HostDetail</code>

	The intended use of this endpoint is as a health check. This endpoint response is to be parsed to evaluate health as it will ~~return 200 response regardless of~~ health details.		The intended use of this endpoint is as a health check. This endpoint response is to be parsed to evaluate health as it will include full health details with 200 response code if all is well, and a 400 if any part of system is unhealthy including license verification, job queuer and/or job spawner.

	~~Returns the requested host~~ with ~~health status~~, or a ~~404~~ if ~~not found~~.

	'''Note:''' The name field corresponds to the host name, as described [[Getting_Started#Setting_Host_Names\|here]]. Explicit host names should be set if you intend to rely known host names in this endpoint. Heartbeat time indicates when the server last performed the heartbeat health check against the database.		'''Note:''' The name field corresponds to the host name, as described [[Getting_Started#Setting_Host_Names\|here]]. Explicit host names should be set if you intend to rely known host names in this endpoint. Heartbeat time indicates when the server last performed the heartbeat health check against the database.

2025-07-18T01:08:41Z

GET health details on an existing scheduling host

← Older revision		Revision as of 01:08, 18 July 2025
Line 1,891:		Line 1,891:
	==GET health details on an existing scheduling host==		==GET health details on an existing scheduling host==
	''As of Obsidian 6.3.0''		''As of Obsidian 6.3.0''

	<code>GET http(s)://localhost/rest/hosts/{id}/health</code>		<code>GET http(s)://localhost/rest/hosts/{id}/health</code>

2025-07-18T01:08:27Z

GET health details on an existing scheduling host

← Older revision		Revision as of 01:08, 18 July 2025
Line 1,890:		Line 1,890:

	==GET health details on an existing scheduling host==		==GET health details on an existing scheduling host==
			''As of Obsidian 6.3.0''
	<code>GET http(s)://localhost/rest/hosts/{id}/health</code>		<code>GET http(s)://localhost/rest/hosts/{id}/health</code>

Line 1,924:		Line 1,925:
	}		}
	</pre>		</pre>


	==GET licence details on an existing scheduling host==		==GET licence details on an existing scheduling host==

2025-07-18T01:08:03Z

Scheduling Hosts Endpoints

@@ Line 1,888: / Line 1,888: @@
+}
 </pre>
 ==GET licence details on an existing scheduling host==

2024-10-16T17:53:27Z

Event Hooks Endpoints

@@ Line 2,016: / Line 2,016: @@
                  "heartbeat": "2024-06-01T16:52:09-0400",
                  "markedInactiveAt": "2024-06-01T16:52:09-0400" --if applicable
+             }
+         ]

2024-06-10T21:05:03Z

Event Hooks Endpoints